Ide.Types

Documentation

newtype IdePlugins

Constructors

IdePlugins

Fields

• ipMap :: Map PluginId PluginDescriptor

data PluginDescriptor

Constructors

PluginDescriptor

Fields

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

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

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

defaultPluginDescriptor :: PluginId -> PluginDescriptor

data PluginCommand

Constructors

forall a.FromJSON a => PluginCommand

Fields

• commandId :: CommandId
• commandDesc :: Text
• commandFunc :: CommandFunction 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 = 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 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.

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

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

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

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

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

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

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

newtype WithSnippets

Constructors

WithSnippets Bool