Safe Haskell	None
Language	Haskell2010

Ide.Plugin

Synopsis

asGhcIdePlugin :: IdePlugins -> Plugin Config
pluginDescToIdePlugins :: [PluginDescriptor] -> IdePlugins
mkLspCommand :: PluginId -> CommandId -> Text -> Maybe [Value] -> IO Command
mkLspCmdId :: Text -> PluginId -> CommandId -> Text
allLspCmdIds :: Text -> [(PluginId, [PluginCommand])] -> [Text]
allLspCmdIds' :: Text -> IdePlugins -> [Text]
getPid :: IO Text
responseError :: Text -> ResponseError
getClientConfig :: LspFuncs Config -> IO Config
getClientConfigAction :: Action Config

Documentation

asGhcIdePlugin :: IdePlugins -> Plugin Config Source #

Map a set of plugins to the underlying ghcide engine. Main point is IdePlugins are arranged by kind of operation, Plugin is arranged by message category (Notifaction, Request etc).

pluginDescToIdePlugins :: [PluginDescriptor] -> IdePlugins Source #

mkLspCommand :: PluginId -> CommandId -> Text -> Maybe [Value] -> IO Command Source #

mkLspCmdId :: Text -> PluginId -> CommandId -> Text Source #

allLspCmdIds :: Text -> [(PluginId, [PluginCommand])] -> [Text] Source #

allLspCmdIds' :: Text -> IdePlugins -> [Text] Source #

getPid :: IO Text #

Get the operating system process id for the running server instance. This should be the same for the lifetime of the instance, and different from that of any other currently running instance.

responseError :: Text -> ResponseError Source #

getClientConfig :: LspFuncs Config -> IO Config Source #

Returns the current client configuration. It is not wise to permanently cache the returned value of this function, as clients can at runitime change their configuration.

If no custom configuration has been set by the client, this function returns our own defaults.

getClientConfigAction :: Action Config Source #

Returns the client configurarion stored in the IdeState. You can use this function to access it from shake Rules