API Reference gen_lsp v0.0.1
modules
Modules
The initialize parameters
The exit event is sent from the client to the server to ask the server to exit its process.
The initialized notification is sent from the client to the server after the client is fully initialized and the server is allowed to send requests from the server to the client.
A notification sent when a notebook closes.
A notification sent when a notebook opens.
A notification sent when a notebook document is saved.
The telemetry event notification is sent from the server to the client to ask the client to log telemetry data.
The document change notification is sent from the client to the server to signal changes to a text document.
The document close notification is sent from the client to the server when the document got closed in the client. The document's truth now exists where the document's uri points to (e.g. if the document's uri is a file uri the truth now exists on disk). As with the open notification the close notification is about managing the document's content. Receiving a close notification doesn't mean that the document was open in an editor before. A close notification requires a previous open notification to be sent.
The document open notification is sent from the client to the server to signal newly opened text documents. The document's truth is now managed by the client and the server must not try to read the document's truth using the document's uri. Open in this sense means it is managed by the client. It doesn't necessarily mean that its content is presented in an editor. An open notification must not be sent more than once without a corresponding close notification send before. This means open and close notification must be balanced and the max open count is one.
The document save notification is sent from the client to the server when the document got saved in the client.
Diagnostics notification are sent from the server to the client to signal results of validation runs.
A document will save notification is sent from the client to the server before the document is actually saved.
The log message notification is sent from the server to the client to ask the client to log a particular message.
The show message notification is sent from a server to a client to ask the client to display a particular message in the user interface.
The window/workDoneProgress/cancel
notification is sent from the client to the server to cancel a progress
initiated on the server side.
The configuration change notification is sent from the client to the server when the client's configuration has changed. The notification contains the changed configuration as defined by the language client.
The watched files notification is sent from the client to the server when the client detects changes to file watched by the language client.
The workspace/didChangeWorkspaceFolders
notification is sent from the client to the server when the workspace
folder configuration changes.
The did create files notification is sent from the client to the server when files were created from within the client.
The will delete files request is sent from the client to the server before files are actually deleted as long as the deletion is triggered from within the client.
The did rename files notification is sent from the client to the server when files were renamed from within the client.
A request to resolve the incoming calls for a given CallHierarchyItem
.
A request to resolve the outgoing calls for a given CallHierarchyItem
.
The client/registerCapability
request is sent from the server to the client to register a new capability
handler on the client side.
The client/unregisterCapability
request is sent from the server to the client to unregister a previously registered capability
handler on the client side.
Request to resolve additional information for a given code action.The request's parameter is of type CodeAction the response is of type CodeAction or a Thenable that resolves to such.
A request to resolve a command for a given code lens.
Request to resolve additional information for a given completion item.The request's parameter is of type CompletionItem the response is of type CompletionItem or a Thenable that resolves to such.
Request to resolve additional information for a given document link. The request's parameter is of type DocumentLink the response is of type DocumentLink or a Thenable that resolves to such.
The initialize request is sent from the client to the server. It is sent once as the request after starting up the server. The requests parameter is of type InitializeParams the response if of type InitializeResult of a Thenable that resolves to such.
A shutdown request is sent from the client to the server. It is sent once when the client decides to shutdown the server. The only notification that is sent after a shutdown request is the exit event.
A request to provide commands for the given text document and range.
A request to provide code lens for the given text document.
A request to list all presentation for a color. The request's parameter is of type ColorPresentationParams the response is of type ColorInformation[] or a Thenable that resolves to such.
Request to request completion at a given text document position. The request's parameter is of type TextDocumentPosition the response is of type CompletionItem[] or CompletionList or a Thenable that resolves to such.
A request to resolve the type definition locations of a symbol at a given text document position. The request's parameter is of type [TextDocumentPositionParams] (#TextDocumentPositionParams) the response is of type Declaration or a typed array of DeclarationLink or a Thenable that resolves to such.
A request to resolve the definition location of a symbol at a given text document position. The request's parameter is of type [TextDocumentPosition] (#TextDocumentPosition) the response is of either type Definition or a typed array of DefinitionLink or a Thenable that resolves to such.
The document diagnostic request definition.
A request to list all color symbols found in a given text document. The request's parameter is of type DocumentColorParams the response is of type ColorInformation[] or a Thenable that resolves to such.
Request to resolve a DocumentHighlight for a given text document position. The request's parameter is of type [TextDocumentPosition] (#TextDocumentPosition) the request response is of type [DocumentHighlight[]] (#DocumentHighlight) or a Thenable that resolves to such.
A request to provide document links
A request to list all symbols found in a given text document. The request's parameter is of type TextDocumentIdentifier the response is of type SymbolInformation[] or a Thenable that resolves to such.
A request to provide folding ranges in a document. The request's parameter is of type FoldingRangeParams, the response is of type FoldingRangeList or a Thenable that resolves to such.
A request to to format a whole document.
Request to request hover information at a given text document position. The request's parameter is of type TextDocumentPosition the response is of type Hover or a Thenable that resolves to such.
A request to resolve the implementation locations of a symbol at a given text document position. The request's parameter is of type [TextDocumentPositionParams] (#TextDocumentPositionParams) the response is of type Definition or a Thenable that resolves to such.
A request to provide inlay hints in a document. The request's parameter is of type InlayHintsParams, the response is of type InlayHint[] or a Thenable that resolves to such.
A request to provide inline values in a document. The request's parameter is of type InlineValueParams, the response is of type InlineValue[] or a Thenable that resolves to such.
A request to provide ranges that can be edited together.
A request to get the moniker of a symbol at a given text document position.
The request parameter is of type TextDocumentPositionParams.
The response is of type Moniker[] or null
.
A request to format a document on type.
A request to result a CallHierarchyItem
in a document at a given position.
Can be used as an input to an incoming or outgoing call hierarchy.
A request to test and perform the setup necessary for a rename.
A request to result a TypeHierarchyItem
in a document at a given position.
Can be used as an input to a subtypes or supertypes type hierarchy.
A request to to format a range in a document.
A request to resolve project-wide references for the symbol denoted by the given text document position. The request's parameter is of type ReferenceParams the response is of type Location[] or a Thenable that resolves to such.
A request to rename a symbol.
A request to provide selection ranges in a document. The request's parameter is of type SelectionRangeParams, the response is of type SelectionRange[] or a Thenable that resolves to such.
@since 3.16.0
@since 3.16.0
A request to resolve the type definition locations of a symbol at a given text document position. The request's parameter is of type [TextDocumentPositionParams] (#TextDocumentPositionParams) the response is of type Definition or a Thenable that resolves to such.
A document will save request is sent from the client to the server before the document is actually saved. The request can return an array of TextEdits which will be applied to the text document before it is saved. Please note that clients might drop results if computing the text edits took too long or if a server constantly fails on this request. This is done to keep the save fast and reliable.
A request to resolve the subtypes for a given TypeHierarchyItem
.
A request to resolve the supertypes for a given TypeHierarchyItem
.
A request to show a document. This request might open an
external program depending on the value of the URI to open.
For example a request to open https://code.visualstudio.com/
will very likely open the URI in a WEB browser.
The show message request is sent from the server to the client to show a message and a set of options actions to the user.
The window/workDoneProgress/create
request is sent from the server to the client to initiate progress
reporting from the server.
A request sent from the server to the client to modified certain resources.
A request to refresh all code actions
The 'workspace/configuration' request is sent from the server to the client to fetch a certain configuration setting.
The workspace diagnostic request definition.
The diagnostic refresh request definition.
A request send from the client to the server to execute a command. The request might return a workspace edit which the client will apply to the workspace.
@since 3.17.0
@since 3.17.0
@since 3.16.0
A request to list project-wide symbols matching the query string given by the WorkspaceSymbolParams. The response is of type SymbolInformation[] or a Thenable that resolves to such.
A request to resolve the range inside the workspace symbol's location.
The will create files request is sent from the client to the server before files are actually created as long as the creation is triggered from within the client.
The did delete files notification is sent from the client to the server when files were deleted from within the client.
The will rename files request is sent from the client to the server before files are actually renamed as long as the rename is triggered from within the client.
The workspace/workspaceFolders
is sent from the server to the client to fetch the open workspace folders.
A special text edit with an additional change annotation.
The parameters passed via a apply workspace edit request.
The result returned from the apply workspace edit request.
A base for all symbol information.
Represents an incoming call, e.g. a caller of a method or constructor.
The parameter of a callHierarchy/incomingCalls
request.
Represents programming constructs like functions or constructors in the context of call hierarchy.
Call hierarchy options used during static registration.
Represents an outgoing call, e.g. calling a getter from a method or a method from a constructor etc.
The parameter of a callHierarchy/outgoingCalls
request.
The parameter of a textDocument/prepareCallHierarchy
request.
Call hierarchy options used during static or dynamic registration.
Additional information that describes document changes.
Defines the capabilities provided by the client.
A code action represents a change that can be performed in code, e.g. to fix a problem or to refactor code.
The Client Capabilities of a CodeActionRequest.
Contains additional diagnostic information about the context in which a code action is run.
Provider options for a CodeActionRequest.
The parameters of a CodeActionRequest.
Registration options for a CodeActionRequest.
Structure to capture a description for an error code.
A code lens represents a command that should be shown along with source text, like the number of references, a way to run tests, etc.
The client capabilities of a CodeLensRequest.
Code Lens provider options of a CodeLensRequest.
The parameters of a CodeLensRequest.
Registration options for a CodeLensRequest.
Represents a color in RGBA space.
Represents a color range from a document.
properties-1
Properties
label :: string (required)
The label of this color presentation. It will be shown on the color picker header. By default this is also the text that is inserted when selecting this color presentation.
Parameters for a ColorPresentationRequest.
Represents a reference to a command. Provides a title which will be used to represent a command in the UI and, optionally, an array of arguments which will be passed to the command handler function when invoked.
Completion client capabilities
Contains additional information about the context in which a completion request is triggered.
A completion item represents a text snippet that is proposed to complete text that is being typed.
Additional details for a completion item label.
Represents a collection of completion items to be presented in the editor.
Completion options.
Completion parameters
Registration options for a CompletionRequest.
The parameters of a configuration request.
Create file operation.
Options to create a file.
The parameters sent in notifications/requests for user-initiated creation of files.
@since 3.14.0
Client Capabilities for a DefinitionRequest.
Server Capabilities for a DefinitionRequest.
Parameters for a DefinitionRequest.
Registration options for a DefinitionRequest.
Delete file operation
Delete file options
The parameters sent in notifications/requests for user-initiated deletes of files.
Represents a diagnostic, such as a compiler error or warning. Diagnostic objects are only valid in the scope of a resource.
Client capabilities specific to diagnostic pull requests.
Diagnostic options.
Diagnostic registration options.
Represents a related message and source code location for a diagnostic. This should be used to point to code locations that cause or related to a diagnostics, e.g when duplicating a symbol in a scope.
Cancellation data returned from a diagnostic request.
Workspace client capabilities specific to diagnostic pull requests.
properties-6
Properties
dynamicRegistration :: boolean
Did change configuration notification supports dynamic registration.
The parameters of a change configuration notification.
properties-7
Properties
section :: unimplemented doc type
The params sent in a change notebook document notification.
The change text document notification's parameters.
properties-8
Properties
dynamicRegistration :: boolean
Did change watched files notification supports dynamic registration. Please note that the current protocol doesn't support static configuration for file changes from the server side.
The watched files change notification's parameters.
Describe options to be used when registered for text document change events.
The parameters of a workspace/didChangeWorkspaceFolders
notification.
The params sent in a close notebook document notification.
The parameters sent in a close text document notification
The params sent in an open notebook document notification.
The parameters sent in an open text document notification
The params sent in a save notebook document notification.
The parameters sent in a save text document notification
properties-9
Properties
dynamicRegistration :: boolean
Whether implementation supports dynamic registration. If this is set to true
the client supports the new DocumentColorRegistrationOptions
return value
for the corresponding server capability as well.
Parameters for a DocumentColorRequest.
Parameters of the document diagnostic request.
A partial result for a document diagnostic report.
Client capabilities of a DocumentFormattingRequest.
Provider options for a DocumentFormattingRequest.
The parameters of a DocumentFormattingRequest.
Registration options for a DocumentFormattingRequest.
A document highlight is a range inside a text document which deserves special attention. Usually a document highlight is visualized by changing the background color of its range.
Client Capabilities for a DocumentHighlightRequest.
Provider options for a DocumentHighlightRequest.
Parameters for a DocumentHighlightRequest.
Registration options for a DocumentHighlightRequest.
A document link is a range in a text document that links to an internal or external resource, like another text document or a web site.
The client capabilities of a DocumentLinkRequest.
Provider options for a DocumentLinkRequest.
The parameters of a DocumentLinkRequest.
Registration options for a DocumentLinkRequest.
Client capabilities of a DocumentOnTypeFormattingRequest.
Provider options for a DocumentOnTypeFormattingRequest.
The parameters of a DocumentOnTypeFormattingRequest.
Registration options for a DocumentOnTypeFormattingRequest.
Client capabilities of a DocumentRangeFormattingRequest.
Provider options for a DocumentRangeFormattingRequest.
The parameters of a DocumentRangeFormattingRequest.
Registration options for a DocumentRangeFormattingRequest.
Represents programming constructs like variables, classes, interfaces etc. that appear in a document. Document symbols can be hierarchical and they have two ranges: one that encloses its definition and one that points to its most interesting range, e.g. the range of an identifier.
Client Capabilities for a DocumentSymbolRequest.
Provider options for a DocumentSymbolRequest.
Parameters for a DocumentSymbolRequest.
Registration options for a DocumentSymbolRequest.
The client capabilities of a ExecuteCommandRequest.
The server capabilities of a ExecuteCommandRequest.
The parameters of a ExecuteCommandRequest.
Registration options for a ExecuteCommandRequest.
properties-12
Properties
executionOrder :: uinteger (required)
A strict monotonically increasing value indicating the execution order of a cell inside a notebook.
Represents information on a file/folder create.
Represents information on a file/folder delete.
An event describing a file change.
Capabilities relating to events from file operations by the user in the client.
A filter to describe in which file operation requests or notifications the server is interested in receiving.
Options for notifications/requests for user operations on files.
A pattern to describe in which file operation requests or notifications the server is interested in receiving.
Matching options for the file operation pattern.
The options to register for file operations.
Represents information on a file/folder rename.
properties-13
Properties
globPattern :: GlobPattern (required)
The glob pattern to watch. See {@link GlobPattern glob pattern} for more detail.
Represents a folding range. To be valid, start and end line must be bigger than zero and smaller than the number of lines in the document. Clients are free to ignore invalid ranges.
properties-14
Properties
dynamicRegistration :: boolean
Whether implementation supports dynamic registration for folding range
providers. If this is set to true
the client supports the new
FoldingRangeRegistrationOptions
return value for the corresponding
server capability as well.
Parameters for a FoldingRangeRequest.
Value-object describing what options formatting should use.
A diagnostic report with a full set of problems.
General client capabilities.
The result of a hover request.
Hover options.
Parameters for a HoverRequest.
Registration options for a HoverRequest.
The data type of the ResponseError if the initialize request fails.
The result returned from an initialize request.
Inlay hint information.
Inlay hint client capabilities.
An inlay hint label part allows for interactive and composite labels of inlay hints.
Inlay hint options used during static registration.
A parameter literal used in inlay hint requests.
Inlay hint options used during static or dynamic registration.
Client workspace capabilities specific to inlay hints.
Client capabilities specific to inline values.
@since 3.17.0
Provide an inline value through an expression evaluation. If only a range is specified, the expression will be extracted from the underlying document. An optional expression can be used to override the extracted expression.
Inline value options used during static registration.
A parameter literal used in inline value requests.
Inline value options used during static or dynamic registration.
Provide inline value as text.
Provide inline value through a variable lookup. If only a range is specified, the variable name will be extracted from the underlying document. An optional variable name can be used to override the extracted name.
Client workspace capabilities specific to inline values.
A special text edit to provide an insert and a replace operation.
LSP object definition. @since 3.17.0
Client capabilities for the linked editing range request.
The result of a linked editing range request.
Represents a location inside a resource, such as a line inside a text file.
Represents the connection of two locations. Provides additional metadata over normal locations, including an origin range.
The log message parameters.
Client capabilities specific to the used markdown parser.
A MarkupContent
literal represents a string value which content is interpreted base on its
kind flag. Currently the protocol supports plaintext
and markdown
as markup kinds.
Moniker definition to match LSIF 0.5 moniker definition.
Client capabilities specific to the moniker request.
A notebook cell.
A change describing how to move a NotebookCell
array from state S to S'.
A notebook cell text document filter denotes a cell text document by different properties.
A notebook document.
A change event for a notebook document.
Capabilities specific to the notebook document support.
A literal to identify a notebook document in the client.
Notebook specific client capabilities.
Options specific to a notebook plus its cells to be synced to the server.
Registration options specific to a notebook.
A text document identifier to optionally denote a specific version of a text document.
Represents a parameter of a callable-signature. A parameter can have a label and a doc-comment.
properties-31
Properties
partialResultToken :: ProgressToken
An optional token that a server can use to report partial results (e.g. streaming) to the client.
Position in a text document expressed as zero-based line and character
offset. Prior to 3.17 the offsets were always based on a UTF-16 string
representation. So a string of the form a𐐀b
the character offset of the
character a
is 0, the character offset of 𐐀
is 1 and the character
offset of b is 3 since 𐐀
is represented using two code units in UTF-16.
Since 3.17 clients and servers can agree on a different string encoding
representation (e.g. UTF-8). The client announces it's supported encoding
via the client capability general.positionEncodings
.
The value is an array of position encodings the client supports, with
decreasing preference (e.g. the encoding at index 0
is the most preferred
one). To stay backwards compatible the only mandatory encoding is UTF-16
represented via the string utf-16
. The server can pick one of the
encodings offered by the client and signals that encoding back to the
client via the initialize result's property
capabilities.positionEncoding
. If the string value
utf-16
is missing from the client's capability general.positionEncodings
servers can safely assume that the client supports UTF-16. If the server
omits the position encoding in its initialize result the encoding defaults
to the string value utf-16
. Implementation considerations: since the
conversion from one encoding into another requires the content of the
file / line the conversion is best done where the file is read which is
usually on the server side.
A previous result id in a workspace pull request.
properties-33
Properties
token :: ProgressToken (required)
The progress token provided by the client or server.
The publish diagnostic client capabilities.
The publish diagnostic notification's parameters.
A range in a text document expressed as (zero-based) start and end positions.
Client Capabilities for a ReferencesRequest.
Value-object that contains additional information when requesting references.
Reference options.
Parameters for a ReferencesRequest.
Registration options for a ReferencesRequest.
General parameters to to register for an notification or to register a provider.
properties-34
Properties
registrations :: unimplemented doc type (required)
Client capabilities specific to regular expressions.
A full diagnostic report with a set of related documents.
An unchanged diagnostic report with a set of related documents.
A relative pattern is a helper to construct glob patterns that are matched
relatively to a base URI. The common value for a baseUri
is a workspace
folder root, but it can be another absolute URI as well.
properties-35
Properties
dynamicRegistration :: boolean
Whether rename supports dynamic registration.
Rename file operation
Rename file options
The parameters sent in notifications/requests for user-initiated renames of files.
Provider options for a RenameRequest.
The parameters of a RenameRequest.
Registration options for a RenameRequest.
A generic resource operation.
Save options.
A selection range represents a part of a selection hierarchy. A selection range may have a parent selection range that contains it.
properties-36
Properties
dynamicRegistration :: boolean
Whether implementation supports dynamic registration for selection range providers. If this is set to true
the client supports the new SelectionRangeRegistrationOptions
return value for the corresponding server
capability as well.
A parameter literal used in selection range requests.
@since 3.16.0
@since 3.16.0
@since 3.16.0
@since 3.16.0
@since 3.16.0
@since 3.16.0
@since 3.16.0
@since 3.16.0
@since 3.16.0
Defines the capabilities provided by a language server.
properties-39
Properties
value :: TraceValues (required)
Client capabilities for the showDocument request.
Params to show a document.
The result of a showDocument request.
The parameters of a notification message.
Show message request client capabilities
Signature help represents the signature of something callable. There can be multiple signature but only one active and only one active parameter.
Client Capabilities for a SignatureHelpRequest.
Additional information about the context in which a signature help request was triggered.
Server Capabilities for a SignatureHelpRequest.
Parameters for a SignatureHelpRequest.
Registration options for a SignatureHelpRequest.
Represents the signature of something callable. A signature can have a label, like a function-name, a doc-comment, and a set of parameters.
Static registration options to be returned in the initialize request.
Represents information about programming constructs like variables, classes, interfaces etc.
properties-41
Properties
Describe options to be used when registered for text document change events.
Text document specific client capabilities.
Describes textual changes on a text document. A TextDocumentEdit describes all changes on a document version Si and after they are applied move the document to version Si+1. So the creator of a TextDocumentEdit doesn't need to sort the array of edits or do any kind of ordering. However the edits must be non overlapping.
A literal to identify a text document in the client.
An item to transfer a text document from the client to the server.
A parameter literal used in requests to pass a text document and a position inside that document.
General text document registration options.
Save registration options.
properties-42
Properties
dynamicRegistration :: boolean
Whether text document synchronization supports dynamic registration.
properties-43
Properties
openClose :: boolean
Open and close notifications are sent to the server. If omitted open close notification should not be sent.
A text edit applicable to a text document.
@since 3.17.0
Type hierarchy options used during static registration.
The parameter of a textDocument/prepareTypeHierarchy
request.
Type hierarchy options used during static or dynamic registration.
The parameter of a typeHierarchy/subtypes
request.
The parameter of a typeHierarchy/supertypes
request.
A diagnostic report indicating that the last returned report is still accurate.
General parameters to unregister a request or notification.
properties-47
Properties
unregisterations :: unimplemented doc type (required)
A versioned notebook document identifier.
A text document identifier to denote a specific version of a text document.
The parameters sent in a will save text document notification.
properties-48
Properties
workDoneProgress :: boolean
It indicates whether the client supports server initiated
progress using the window/workDoneProgress/create
request.
properties-49
Properties
kind :: unimplemented doc type (required)
title :: string (required)
Mandatory title of the progress operation. Used to briefly inform about the kind of operation being performed.
properties-52
Properties
kind :: unimplemented doc type (required)
message :: string
Optional, a final message indicating to for example indicate the outcome of the operation.
properties-53
Properties
workDoneProgress :: boolean
properties-54
Properties
workDoneToken :: ProgressToken
An optional token that a server can use to report work done progress.
properties-55
Properties
kind :: unimplemented doc type (required)
cancellable :: boolean
Controls enablement state of a cancel button.
Workspace specific client capabilities.
Parameters of the workspace diagnostic request.
A workspace diagnostic report.
A partial result for a workspace diagnostic report.
A workspace edit represents changes to many resources managed in the workspace. The edit
should either provide changes
or documentChanges
. If documentChanges are present
they are preferred over changes
if the client can handle versioned document edits.
properties-56
Properties
documentChanges :: boolean
The client supports versioned document changes in WorkspaceEdit
s
A workspace folder inside a client.
The workspace folder change event.
properties-57
Properties
workspaceFolders :: unimplemented doc type
The workspace folders configured in the client when the server starts.
A full document diagnostic report for a workspace diagnostic result.
A special workspace symbol that supports locations without a range.
Client capabilities for a WorkspaceSymbolRequest.
Server capabilities for a WorkspaceSymbolRequest.
The parameters of a WorkspaceSymbolRequest.
Registration options for a WorkspaceSymbolRequest.
An unchanged document diagnostic report for a workspace diagnostic result.