Fields

• ioLogger :: LogAction IO (WithSeverity LspServerLog)

  The logger to use outside the main body of the server where we can't assume the ability to send messages.

• lspLogger :: LogAction (LspM config) (WithSeverity LspServerLog)

  The logger to use once the server has started and can successfully send messages.

• inwards :: IO StrictByteString

  Client input.

• outwards :: LazyByteString -> IO ()

  Function to provide output to.

• prepareOutwards :: LazyByteString -> LazyByteString

  how to prepare an outgoing response for sending. This can be used, to e.g. prepend the Content-Length header, c.f. prependHeader

• parseInwards :: Parser StrictByteString

  how to parse the input. This can be used to consume the Content-Length and Content-Type headers, c.f. parseHeaders

Fields

• host :: !String

  the host of the websocket server, e.g. "localhost"

• port :: !Int

  the port of the websocket server, e.g. 8080

Fields

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

Fields

• defaultConfig :: config

  The default value we initialize the config variable to.

• configSection :: Text

  The "config section" that this server uses. This is used to identify the settings that are relevant to the server.

• parseConfig :: config -> Value -> Either Text config

  parseConfig oldConfig newConfigObject is called whenever we get updated configuration from the client.

  parseConfig is called on the object corresponding to the server's config section, it should not itself try to look for the config section.

  Note that the Value may represent only a partial object in the case where we are handling a workspace/didChangeConfiguration request where the client sends only the changed settings. This is also the main circumstance where the old configuration argument is useful. It is generally fine for servers to ignore this case and just assume that the Value represents a full new config and ignore the old configuration. This will only be problematic in the case of clients which behave as above and *also* don't support workspace/configuration, which is discouraged.

• onConfigChange :: config -> m ()

  This callback is called any time the configuration is updated, with the new config. Servers that want to react to config changes should provide a callback here, it is not sufficient to just add e.g. a workspace/didChangeConfiguration handler.

• doInitialize :: LanguageContextEnv config -> TMessage 'Method_Initialize -> IO (Either (TResponseError 'Method_Initialize) a)

  Called *after* receiving the initialize request and *before* returning the response. This callback will be invoked to offer the language server implementation the chance to create any processes or start new threads that may be necessary for the server lifecycle. It can also return an error in the initialization if necessary.

• staticHandlers :: ClientCapabilities -> Handlers m

  Handlers for any methods you want to statically support. The handlers here cannot be unregistered during the server's lifetime and will be registered statically in the initialize request. The handlers provided can depend on the client capabilities, which are static across the lifetime of the server.

• interpretHandler :: a -> m <~> IO

  How to run the handlers in your own monad of choice, m. It is passed the result of doInitialize, so typically you will want to thread along the LanguageContextEnv as well as any other state you need to run your monad. m should most likely be built on top of LspT.

   ServerDefinition { ...
   , doInitialize = env _req -> pure $ Right env
   , interpretHandler = env -> Iso
      (runLspT env) -- how to convert from IO ~> m
      liftIO        -- how to convert from m ~> IO
   }
  

• options :: Options

  Configurable options for the server's capabilities.

Fields

• reqHandlers :: !(SMethodMap (ClientMessageHandler m 'Request))
   
• notHandlers :: !(SMethodMap (ClientMessageHandler m 'Notification))
   

Fields

• optTextDocumentSync :: Maybe TextDocumentSyncOptions
   
• optCompletionTriggerCharacters :: Maybe [Char]

  The characters that trigger completion automatically.

• optCompletionAllCommitCharacters :: Maybe [Char]

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

• optSignatureHelpTriggerCharacters :: Maybe [Char]

  The characters that trigger signature help automatically.

• optSignatureHelpRetriggerCharacters :: 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.

• optCodeActionKinds :: 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.

• optDocumentOnTypeFormattingTriggerCharacters :: 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.

• optExecuteCommandCommands :: Maybe [Text]

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

• optServerInfo :: Maybe ServerInfo

  Information about the server that can be advertised to the client.

• optSupportClientInitiatedProgress :: Bool

  Whether or not to support client-initiated progress.

• optProgressStartDelay :: Int

  The delay before starting a progress reporting session, in microseconds

• optProgressUpdateDelay :: Int

  The delay between sending progress updates, in microseconds

• optWorkspaceDidCreateFileOperationRegistrationOptions :: Maybe FileOperationRegistrationOptions

  Options for the Method_WorkspaceDidCreateFiles request, in case the language server supports it

• optWorkspaceWillCreateFileOperationRegistrationOptions :: Maybe FileOperationRegistrationOptions

  Options for the Method_WorkspaceWillCreateFiles notification, in case the language server supports it

• optWorkspaceDidRenameFileOperationRegistrationOptions :: Maybe FileOperationRegistrationOptions

  Options for the Method_WorkspaceDidRenameFiles request, in case the language server supports it

• optWorkspaceWillRenameFileOperationRegistrationOptions :: Maybe FileOperationRegistrationOptions

  Options for the Method_WorkspaceWillRenameFiles notification, in case the language server supports it

• optWorkspaceDidDeleteFileOperationRegistrationOptions :: Maybe FileOperationRegistrationOptions

  Options for the Method_WorkspaceDidDeleteFiles request, in case the language server supports it

• optWorkspaceWillDeleteFileOperationRegistrationOptions :: Maybe FileOperationRegistrationOptions

  Options for the Method_WorkspaceWillDeleteFiles notification, in case the language server supports it

Fields

• unLspT :: ReaderT (LanguageContextEnv config) m a
   

Fields

• resHandlers :: !(Handlers IO)
   
• resConfigSection :: Text
   
• resParseConfig :: !(config -> Value -> Either Text config)
   
• resOnConfigChange :: !(config -> IO ())
   
• resSendMessage :: !(FromServerMessage -> IO ())
   
• resState :: !(LanguageContextState config)
   
• resClientCapabilities :: !ClientCapabilities
   
• resRootPath :: !(Maybe FilePath)
   
• resProgressStartDelay :: Int

  The delay before starting a progress reporting session, in microseconds

• resProgressUpdateDelay :: Int

  The delay between sending progress updates, in microseconds

• resWaitSender :: !(IO ())

  An IO action that waits for the sender thread to finish sending all pending messages. This is used to ensure all responses are sent before the server exits. See Note [Shutdown]

Fields

• forward :: forall (a :: k). m a -> n a
   
• backward :: forall (a :: k). n a -> m a