Documentation

Fields

• resSeqDebugContextData :: !Int
   
• resHandlers :: !Handlers
   
• resOptions :: !Options
   
• resSendResponse :: !SendFunc
   
• resVFS :: !VFSData
   
• resDiagnostics :: !DiagnosticStore
   
• resConfig :: !(Maybe config)
   
• resLspId :: !(TVar Int)
   
• resLspFuncs :: LspFuncs config
   
• resCaptureFile :: !(Maybe FilePath)
   
• resWorkspaceFolders :: ![WorkspaceFolder]
   
• resProgressData :: !ProgressData
   

Fields

• vfsData :: !VFS
   
• reverseMap :: !(Map FilePath FilePath)
   

Fields

• onInitialConfiguration :: InitializeRequest -> Either Text config

  Invoked on the first message from the language client, containg the client configuration This callback should return either the parsed configuration data or an error indicating what went wrong. The parsed configuration object will be stored internally and passed to hanlder functions as context.

• onConfigurationChange :: DidChangeConfigurationNotification -> Either Text config

  Invoked whenever the clients sends a message with a changed client configuration. This callback should return either the parsed configuration data or an error indicating what went wrong. The parsed configuration object will be stored internally and passed to hanlder functions as context.

• onStartup :: LspFuncs config -> IO (Maybe ResponseError)

  Once the initial configuration has been received, this callback will be invoked to offer the language server implementation the chance to create any processes or start new threads that may be necesary for the server lifecycle.

Fields

• clientCapabilities :: !ClientCapabilities
   
• config :: !(IO (Maybe c))

  Derived from the DidChangeConfigurationNotification message via a server-provided function.

• sendFunc :: !SendFunc
   
• getVirtualFileFunc :: !(NormalizedUri -> IO (Maybe VirtualFile))

  Function to return the VirtualFile associated with a given NormalizedUri, if there is one.

• persistVirtualFileFunc :: !(NormalizedUri -> IO (Maybe FilePath))
   
• reverseFileMapFunc :: !(IO (FilePath -> FilePath))
   
• publishDiagnosticsFunc :: !PublishDiagnosticsFunc
   
• flushDiagnosticsBySourceFunc :: !FlushDiagnosticsBySourceFunc
   
• getNextReqId :: !(IO LspId)
   
• rootPath :: !(Maybe FilePath)
   
• getWorkspaceFolders :: !(IO (Maybe [WorkspaceFolder]))
   
• withProgress :: !(forall a. Text -> ProgressCancellable -> ((Progress -> IO ()) -> IO a) -> IO a)

  Wrapper for reporting progress to the client during a long running task. withProgress title cancellable f starts a new progress reporting session, and finishes it once f is completed. f is provided with an update function that allows it to report on the progress during the session. If cancellable is Cancellable, f will be thrown a ProgressCancelledException if the user cancels the action in progress.

  Since: 0.10.0.0

• withIndefiniteProgress :: !(forall a. Text -> ProgressCancellable -> IO a -> IO a)

  Same as withProgress, but for processes that do not report the precentage complete.

  Since: 0.10.0.0

Fields

• hoverHandler :: !(Maybe (Handler HoverRequest))
   
• completionHandler :: !(Maybe (Handler CompletionRequest))
   
• completionResolveHandler :: !(Maybe (Handler CompletionItemResolveRequest))
   
• signatureHelpHandler :: !(Maybe (Handler SignatureHelpRequest))
   
• definitionHandler :: !(Maybe (Handler DefinitionRequest))
   
• typeDefinitionHandler :: !(Maybe (Handler TypeDefinitionRequest))
   
• implementationHandler :: !(Maybe (Handler ImplementationRequest))
   
• referencesHandler :: !(Maybe (Handler ReferencesRequest))
   
• documentHighlightHandler :: !(Maybe (Handler DocumentHighlightRequest))
   
• documentSymbolHandler :: !(Maybe (Handler DocumentSymbolRequest))
   
• workspaceSymbolHandler :: !(Maybe (Handler WorkspaceSymbolRequest))
   
• codeActionHandler :: !(Maybe (Handler CodeActionRequest))
   
• codeLensHandler :: !(Maybe (Handler CodeLensRequest))
   
• codeLensResolveHandler :: !(Maybe (Handler CodeLensResolveRequest))
   
• documentColorHandler :: !(Maybe (Handler DocumentColorRequest))
   
• colorPresentationHandler :: !(Maybe (Handler ColorPresentationRequest))
   
• documentFormattingHandler :: !(Maybe (Handler DocumentFormattingRequest))
   
• documentRangeFormattingHandler :: !(Maybe (Handler DocumentRangeFormattingRequest))
   
• documentOnTypeFormattingHandler :: !(Maybe (Handler DocumentOnTypeFormattingRequest))
   
• renameHandler :: !(Maybe (Handler RenameRequest))
   
• prepareRenameHandler :: !(Maybe (Handler PrepareRenameRequest))
   
• foldingRangeHandler :: !(Maybe (Handler FoldingRangeRequest))
   
• documentLinkHandler :: !(Maybe (Handler DocumentLinkRequest))
   
• documentLinkResolveHandler :: !(Maybe (Handler DocumentLinkResolveRequest))
   
• executeCommandHandler :: !(Maybe (Handler ExecuteCommandRequest))
   
• willSaveWaitUntilTextDocHandler :: !(Maybe (Handler WillSaveWaitUntilTextDocumentRequest))
   
• didChangeConfigurationParamsHandler :: !(Maybe (Handler DidChangeConfigurationNotification))
   
• didOpenTextDocumentNotificationHandler :: !(Maybe (Handler DidOpenTextDocumentNotification))
   
• didChangeTextDocumentNotificationHandler :: !(Maybe (Handler DidChangeTextDocumentNotification))

  Note: If you need to keep track of document changes, Language.Haskell.LSP.VFS will take care of these messages for you!

• didCloseTextDocumentNotificationHandler :: !(Maybe (Handler DidCloseTextDocumentNotification))
   
• didSaveTextDocumentNotificationHandler :: !(Maybe (Handler DidSaveTextDocumentNotification))
   
• didChangeWatchedFilesNotificationHandler :: !(Maybe (Handler DidChangeWatchedFilesNotification))
   
• didChangeWorkspaceFoldersNotificationHandler :: !(Maybe (Handler DidChangeWorkspaceFoldersNotification))
   
• initializedHandler :: !(Maybe (Handler InitializedNotification))
   
• willSaveTextDocumentNotificationHandler :: !(Maybe (Handler WillSaveTextDocumentNotification))
   
• cancelNotificationHandler :: !(Maybe (Handler CancelNotification))
   
• responseHandler :: !(Maybe (Handler BareResponseMessage))
   
• initializeRequestHandler :: !(Maybe (Handler InitializeRequest))
   
• exitNotificationHandler :: !(Maybe (Handler ExitNotification))
   
• customRequestHandler :: !(Maybe (Handler CustomClientRequest))
   
• customNotificationHandler :: !(Maybe (Handler CustomClientNotification))
   

Fields

• textDocumentSync :: Maybe TextDocumentSyncOptions
   
• completionTriggerCharacters :: Maybe [Char]

  The characters that trigger completion automatically.

• completionAllCommitCharacters :: Maybe [Char]

  The list of all possible characters that commit a completion. This field can be used if clients don't support individual commmit characters per completion item. See _commitCharactersSupport.

• signatureHelpTriggerCharacters :: Maybe [Char]

  The characters that trigger signature help automatically.

• signatureHelpRetriggerCharacters :: Maybe [Char]

  List of characters that re-trigger signature help. These trigger characters are only active when signature help is already showing. All trigger characters are also counted as re-trigger characters.

• codeActionKinds :: Maybe [CodeActionKind]

  CodeActionKinds that this server may return. The list of kinds may be generic, such as Refactor, or the server may list out every specific kind they provide.

• documentOnTypeFormattingTriggerCharacters :: Maybe (NonEmpty Char)

  The list of characters that triggers on type formatting. If you set documentOnTypeFormattingHandler, you **must** set this. The first character is mandatory, so a NonEmpty should be passed.

• executeCommandCommands :: Maybe [Text]

  The commands to be executed on the server. If you set executeCommandHandler, you **must** set this.