Ide.Types

Documentation

newtype IdePlugins ideState

Constructors

IdePlugins

Fields

• ipMap :: Map PluginId (PluginDescriptor ideState)

data PluginDescriptor ideState

Constructors

PluginDescriptor

Fields

• pluginId :: !PluginId
• pluginRules :: !(Rules ())
• pluginCommands :: ![PluginCommand ideState]
• pluginCodeActionProvider :: !(Maybe (CodeActionProvider ideState))
• pluginCodeLensProvider :: !(Maybe (CodeLensProvider ideState))
• pluginDiagnosticProvider :: !(Maybe DiagnosticProvider)

  TODO: diagnostics are generally provided via rules, this is probably redundant.

• pluginHoverProvider :: !(Maybe (HoverProvider ideState))
• pluginSymbolsProvider :: !(Maybe (SymbolsProvider ideState))
• pluginFormattingProvider :: !(Maybe (FormattingProvider ideState IO))
• pluginCompletionProvider :: !(Maybe (CompletionProvider ideState))
• pluginRenameProvider :: !(Maybe (RenameProvider ideState))

defaultPluginDescriptor :: PluginId -> PluginDescriptor ideState

data PluginCommand ideState

Constructors

forall a.FromJSON a => PluginCommand

Fields

• commandId :: CommandId
• commandDesc :: Text
• commandFunc :: CommandFunction ideState a

newtype PluginId

Constructors

PluginId Text

Instances

Eq PluginId

Defined in Ide.Types

Methods

(==) :: PluginId -> PluginId -> Bool

(/=) :: PluginId -> PluginId -> Bool

Ord PluginId

Defined in Ide.Types

Methods

compare :: PluginId -> PluginId -> Ordering

(<) :: PluginId -> PluginId -> Bool

(<=) :: PluginId -> PluginId -> Bool

(>) :: PluginId -> PluginId -> Bool

(>=) :: PluginId -> PluginId -> Bool

max :: PluginId -> PluginId -> PluginId

min :: PluginId -> PluginId -> PluginId

Read PluginId

Defined in Ide.Types

Methods

readsPrec :: Int -> ReadS PluginId

readList :: ReadS [PluginId]

readPrec :: ReadPrec PluginId

readListPrec :: ReadPrec [PluginId]

Show PluginId

Defined in Ide.Types

Methods

showsPrec :: Int -> PluginId -> ShowS

show :: PluginId -> String

showList :: [PluginId] -> ShowS

IsString PluginId

Defined in Ide.Types

Methods

fromString :: String -> PluginId

newtype CommandId

Constructors

CommandId Text

Instances

Eq CommandId

Defined in Ide.Types

Methods

(==) :: CommandId -> CommandId -> Bool

(/=) :: CommandId -> CommandId -> Bool

Ord CommandId

Defined in Ide.Types

Methods

compare :: CommandId -> CommandId -> Ordering

(<) :: CommandId -> CommandId -> Bool

(<=) :: CommandId -> CommandId -> Bool

(>) :: CommandId -> CommandId -> Bool

(>=) :: CommandId -> CommandId -> Bool

max :: CommandId -> CommandId -> CommandId

min :: CommandId -> CommandId -> CommandId

Read CommandId

Defined in Ide.Types

Methods

readsPrec :: Int -> ReadS CommandId

readList :: ReadS [CommandId]

readPrec :: ReadPrec CommandId

readListPrec :: ReadPrec [CommandId]

Show CommandId

Defined in Ide.Types

Methods

showsPrec :: Int -> CommandId -> ShowS

show :: CommandId -> String

showList :: [CommandId] -> ShowS

IsString CommandId

Defined in Ide.Types

Methods

fromString :: String -> CommandId

data DiagnosticProvider

Constructors

DiagnosticProvider

Fields

• dpTrigger :: Set DiagnosticTrigger
• dpFunc :: DiagnosticProviderFunc

data DiagnosticProviderFunc

Constructors

DiagnosticProviderSync DiagnosticProviderFuncSync

DiagnosticProviderAsync DiagnosticProviderFuncAsync

type SymbolsProvider ideState = LspFuncs Config -> ideState -> DocumentSymbolParams -> IO (Either ResponseError [DocumentSymbol])

data FormattingType

Format the given Text as a whole or only a Range of it. Range must be relative to the text to format. To format the whole document, read the Text from the file and use FormatText as the FormattingType.

Constructors

FormatText

FormatRange Range

type FormattingProvider ideState m

Arguments

 = LspFuncs Config

-> ideState

-> FormattingType

How much to format

-> Text

Text to format

-> NormalizedFilePath

location of the file being formatted

-> FormattingOptions

Options for the formatter

-> m (Either ResponseError (List TextEdit))

Result of the formatting

To format a whole document, the FormatText FormattingType can be used. It is required to pass in the whole Document Text for that to happen, an empty text and file uri, does not suffice.

noneProvider :: FormattingProvider ideState IO

type HoverProvider ideState = ideState -> TextDocumentPositionParams -> IO (Either ResponseError (Maybe Hover))

type CodeActionProvider ideState = LspFuncs Config -> ideState -> PluginId -> TextDocumentIdentifier -> Range -> CodeActionContext -> IO (Either ResponseError (List CAResult))

type CodeLensProvider ideState = LspFuncs Config -> ideState -> PluginId -> CodeLensParams -> IO (Either ResponseError (List CodeLens))

type CommandFunction ideState a = LspFuncs Config -> ideState -> a -> IO (Either ResponseError Value, Maybe (ServerMethod, ApplyWorkspaceEditParams))

type ExecuteCommandProvider ideState = ideState -> ExecuteCommandParams -> IO (Either ResponseError Value, Maybe (ServerMethod, ApplyWorkspaceEditParams))

type CompletionProvider ideState = LspFuncs Config -> ideState -> CompletionParams -> IO (Either ResponseError CompletionResponseResult)

type RenameProvider ideState = LspFuncs Config -> ideState -> RenameParams -> IO (Either ResponseError WorkspaceEdit)

newtype WithSnippets

Constructors

WithSnippets Bool