A session representing one instance of launching and connecting to a server.

You can send and receive messages to the server within Session via message, sendRequest and sendNotification.

Starts a new session.

runSession "hie" fullLatestClientCaps "path/to/root/dir" $ do
  doc <- openDoc "Desktop/simple.hs" "haskell"
  diags <- waitForDiagnostics
  let pos = Position 12 5
      params = TextDocumentPositionParams doc
  hover <- request STextdocumentHover params

Starts a new session with a custom configuration.

Starts a new session with a custom configuration and server CreateProcess.

Starts a new session, using the specified handles to communicate with the server. You can use this to host the server within the same process. An example with lsp might look like:

(hinRead, hinWrite) <- createPipe
(houtRead, houtWrite) <- createPipe

forkIO $ void $ runServerWithHandles hinRead houtWrite serverDefinition
runSessionWithHandles hinWrite houtRead defaultConfig fullLatestClientCaps "." $ do
  -- ...

Stuff you can configure for a Session.

The configuration used in runSession.

An exception that can be thrown during a Session

A predicate that matches on any SessionException

Execute a block f that will throw a Timeout exception after duration seconds. This will override the global timeout for waiting for messages to arrive defined in SessionConfig.

Sends a request to the server and waits for its response. Will skip any messages in between the request and the response rsp <- request STextDocumentDocumentSymbol params Note: will skip any messages in between the request and the response.

The same as sendRequest, but discard the response.

Sends a request to the server. Unlike request, this doesn't wait for the response.

Sends a notification to the server.

Sends a response to the server.

Consumes and returns the next message, if it satisfies the specified predicate.

Since: 0.5.2.0

Consumes and returns the result of the specified predicate if it returns Just.

Since: 0.6.1.0

Matches a request or a notification coming from the server. Doesn't match Custom Messages

Matches a response coming from the server.

Like response, but matches a response for a specific id.

Matches if the message is a request.

Matches if the message is a response.

Matches if the message is a notification.

Matches any type of message.

Matches if the message is a log message notification or a show message notification/request.

Matches if the message is a configuration request from the server.

Matches a TextDocumentPublishDiagnostics (textDocument/publishDiagnostics) notification.

Returns the initialize response that was received from the server. The initialize requests and responses are not included the session, so if you need to test it use this.

Modify the client config. This will send a notification to the server that the config has changed.

Set the client config. This will send a notification to the server that the config has changed.

Modify a client config section (if already present, otherwise does nothing). This will send a notification to the server that the config has changed.

Set a client config section. This will send a notification to the server that the config has changed.

Creates a new text document. This is different from openDoc as it sends a workspace/didChangeWatchedFiles notification letting the server know that a file was created within the workspace, __provided that the server has registered for it__, and the file matches any patterns the server registered for. It does not actually create a file on disk, but is useful for convincing the server that one does exist.

Since: 11.0.0.0

Opens a text document that exists on disk, and sends a textDocument/didOpen notification to the server.

Closes a text document and sends a textDocument/didOpen notification to the server.

Changes a text document and sends a textDocument/didOpen notification to the server.

The current text contents of a document.

Parses an ApplyEditRequest, checks that it is for the passed document and returns the new content

Gets the Uri for the file corrected to the session directory.

Adds the current version to the document, as tracked by the session.

Returns the symbols in a document.

Waits for diagnostics to be published and returns them.

The same as waitForDiagnostics, but will only match a specific _source.

Expects a PublishDiagnosticsNotification and throws an UnexpectedDiagnostics exception if there are any diagnostics returned.

Returns the current diagnostics that have been sent to the client. Note that this does not wait for more to come in.

Returns the tokens of all progress sessions that have started but not yet ended.

Executes a command.

Returns the code actions in the specified range.

Returns the code actions in the specified range, resolving any with a non empty _data_ field.

Returns all the code actions in a document by querying the code actions at each of the current diagnostics' positions.

Executes a code action. Matching with the specification, if a code action contains both an edit and a command, the edit will be applied first.

Resolves the provided code action.

If a code action contains a _data_ field: resolves the code action, then executes it. Otherwise, just executes it.

Returns the completions for the position in the document.

Returns the completions for the position in the document, resolving any with a non empty _data_ field.

Returns the references for the position in the document.

Returns the declarations(s) for the term at the specified position.

Returns the definition(s) for the term at the specified position.

Returns the type definition(s) for the term at the specified position.

Returns the type definition(s) for the term at the specified position.

Renames the term at the specified position.

Returns the hover information at the specified position.

Returns the highlighted occurrences of the term at the specified position

Applies formatting to the specified document.

Applies formatting to the specified range in a document.

Applys an edit to the document and returns the updated document version.

Returns the code lenses for the specified document.

Returns the code lenses for the specified document, resolving any with a non empty _data_ field.

Resolves the provided code lens.

Returns the inlay hints in the specified range.

Returns the inlay hints in the specified range, resolving any with a non empty _data_ field.

Resolves the provided inlay hint.

Pass a param and return the response from prepareCallHierarchy

Pass a param and return the response from semanticTokensFull

Returns a list of capabilities that the server has requested to dynamically register during the Session.

Since: 0.11.0.0