# Functions
ParseDocumentUri interprets a string as a DocumentUri, applying VS Code workarounds; see [DocumentUri.UnmarshalText] for details.
URIFromPath returns DocumentUri for the supplied file path.
# Constants
Applying the workspace change is simply aborted if one of the changes provided fails.
The editor adjusts leading whitespace of new lines so that they match the indentation up to the cursor of the line for which the item is accepted.
Automatic after a delay.
No description provided by the author
How whitespace and indentation is handled during completion item insertion.
No description provided by the author
The file got changed.
No description provided by the author
No description provided by the author
No description provided by the author
A code-cell is source code.
Code actions were requested automatically.
The reason why code actions were requested.
No description provided by the author
A set of predefined range kinds.
No description provided by the author
Completion item tags are extra annotations that tweak the rendering of a completion item.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
The server detected that the content of a document got modified outside normal conditions.
Supports creating new files and folders.
The file event type The file got created.
A debug message.
@since 3.17.0.
Supports deleting existing files and folders.
The file got deleted.
Deprecated or obsolete code.
Symbol tags are extra annotations that tweak the rendering of a symbol.
The document diagnostic report kinds.
A report indicating that the last returned report is still accurate.
Moniker uniqueness level to define scope of the moniker.
A set of predefined code action kinds Empty kind.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
The message type An error message.
No description provided by the author
No description provided by the author
No description provided by the author
The moniker represents a symbol that is exported from a project.
No description provided by the author
No description provided by the author
A symbol kind.
No description provided by the author
A pattern kind describing if a glob pattern matches a file a folder or both.
When the editor lost focus.
No description provided by the author
The pattern matches a folder only.
Documents are synced by always sending the full content of the document.
No description provided by the author
No description provided by the author
No description provided by the author
The moniker is globally unique.
The moniker is unique inside the group to which a project belongs.
The client's default behavior is to select the identifier according the to language's syntax rule.
The moniker kind.
Folding range for an import or include.
Documents are synced by sending the full content on open.
An information message.
Completion was triggered automatically while editing.
Describes how an {@link InlineCompletionItemProvider inline completion provider} was triggered.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
How a completion was triggered Completion was triggered by typing an identifier (24x7 code complete), manual invocation (e.g Ctrl+Space) or via API.
No description provided by the author
No description provided by the author
No description provided by the author
@since 3.18.0.
Predefined Language kinds @since 3.18.0 @proposed.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
@since 3.18.0 @proposed.
No description provided by the author
@since 3.18.0 @proposed.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
@since 3.18.0 @proposed.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
The moniker represents a symbol that is local to a project (e.g.
A log message.
No description provided by the author
Represents reasons why a text document is saved.
Markdown is supported as a content format.
A notebook cell kind.
Trace messages only.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
A set of predefined token modifiers.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
A set of predefined token types.
Defines how the host (editor) should sync document changes to the language server.
Base kind for all code actions applying to the entire notebook's scope.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Turn tracing off.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
An inlay hint that is for a parameter.
No description provided by the author
Predefined error codes.
Describes the content type that a client supports in various result literals like `Hover`, `ParameterInfo` or `CompletionItem`.
Defines whether the insert text in a completion item should be interpreted as plain text or a snippet.
The moniker is unique inside a project for which a dump got created.
No description provided by the author
No description provided by the author
No description provided by the author
Base kind for quickfix actions: 'quickfix'.
Read-access of a symbol, like reading a variable.
Base kind for refactoring actions: 'refactor'.
Base kind for refactoring extraction actions: 'refactor.extract'
Example extract actions:
- Extract method - Extract function - Extract variable - Extract interface from class - ...
Base kind for refactoring inline actions: 'refactor.inline'
Example inline actions:
- Inline function - Inline variable - Inline constant - ...
Base kind for refactoring move actions: `refactor.move`
Example move actions:
- Move a function to a new file - Move a property between classes - Move method to base class - ..
Base kind for refactoring rewrite actions: 'refactor.rewrite'
Example rewrite actions:
- Convert JavaScript function to class - Add or remove parameter - Encapsulate field - Make method static - Move method to base class - ...
No description provided by the author
No description provided by the author
Folding range for a region (e.g.
No description provided by the author
Supports renaming existing files and folders.
The client has canceled a request and a server has detected the cancel.
A request failed but it was syntactically correct, e.g the method name was known and the parameters were valid.
The moniker is unique inside the moniker scheme.
The server cancelled the request.
Error code indicating that a server received a notification or request before the server has received the `initialize` request.
The diagnostic's severity.
Reports a hint.
Reports an information.
Reports a warning.
Signature help was triggered by the cursor moving or by the document content changing.
How a signature help was triggered.
Signature help was triggered by a trigger character.
No description provided by the author
The primary text to be inserted is treated as a snippet.
Base kind for source actions: `source`
Source code actions apply to the entire file.
Base kind for auto-fix source actions: `source.fixAll`.
Base kind for an organize imports source action: `source.organizeImports`.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
A document highlight kind.
The kind of a completion entry.
If the workspace edit contains only textual file changes they are executed transactional.
All operations are executed transactional.
Completion was triggered by a trigger character specified by the `triggerCharacters` properties of the `CompletionRegistrationOptions`.
Completion was re-triggered as current completion list is incomplete.
Inlay hint kinds.
No description provided by the author
No description provided by the author
No description provided by the author
Represents a generic type.
The client tries to undo the operations already executed.
No description provided by the author
No description provided by the author
The diagnostic tags.
Character offsets count UTF-16 code units.
Character offsets count UTF-32 code units.
A set of predefined position encoding kinds.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Verbose message tracing.
A warning message.
Interested in change events.
Interested in create events.
Interested in delete events.
Write-access of a symbol, like writing to a variable.
# Variables
No description provided by the author
# Structs
created for And.
A special text edit with an additional change annotation.
The parameters passed via an apply workspace edit request.
The result returned from the apply workspace edit request.
A base for all symbol information.
@since 3.16.0
See https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification#callHierarchyClientCapabilities.
Represents an incoming call, e.g.
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.
The parameter of a `callHierarchy/outgoingCalls` request.
The parameter of a `textDocument/prepareCallHierarchy` request.
Call hierarchy options used during static or dynamic registration.
See https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification#cancelParams.
Additional information that describes document changes.
@since 3.18.0
See https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification#changeAnnotationsSupportOptions.
Defines the capabilities provided by the client.
@since 3.18.0
See https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification#clientCodeActionKindOptions.
@since 3.18.0
See https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification#clientCodeActionLiteralOptions.
@since 3.18.0
See https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification#clientCodeActionResolveOptions.
@since 3.18.0
See https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification#clientCodeLensResolveOptions.
@since 3.18.0
See https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification#clientCompletionItemInsertTextModeOptions.
@since 3.18.0
See https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification#clientCompletionItemOptions.
@since 3.18.0
See https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification#clientCompletionItemOptionsKind.
@since 3.18.0
See https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification#clientCompletionItemResolveOptions.
@since 3.18.0
See https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification#clientDiagnosticsTagOptions.
@since 3.18.0
See https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification#clientFoldingRangeKindOptions.
@since 3.18.0
See https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification#clientFoldingRangeOptions.
Information about the client
@since 3.15.0 @since 3.18.0 ClientInfo type name added.
@since 3.18.0
See https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification#clientInlayHintResolveOptions.
@since 3.18.0
See https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification#clientSemanticTokensRequestFullDelta.
@since 3.18.0
See https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification#clientSemanticTokensRequestOptions.
@since 3.18.0
See https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification#clientShowMessageActionItemOptions.
@since 3.18.0
See https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification#clientSignatureInformationOptions.
@since 3.18.0
See https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification#clientSignatureParameterInformationOptions.
@since 3.18.0
See https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification#clientSymbolKindOptions.
@since 3.18.0
See https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification#clientSymbolResolveOptions.
@since 3.18.0
See https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification#clientSymbolTagOptions.
A code action represents a change that can be performed in code, e.g.
The Client Capabilities of a {@link CodeActionRequest}.
Contains additional diagnostic information about the context in which a {@link CodeActionProvider.provideCodeActions code action} is run.
Captures why the code action is currently disabled.
Documentation for a class of code actions.
Provider options for a {@link CodeActionRequest}.
The parameters of a {@link CodeActionRequest}.
Registration options for a {@link CodeActionRequest}.
Structure to capture a description for an error code.
A code lens represents a {@link Command 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 {@link CodeLensRequest}.
Code Lens provider options of a {@link CodeLensRequest}.
The parameters of a {@link CodeLensRequest}.
Registration options for a {@link CodeLensRequest}.
@since 3.16.0
See https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification#codeLensWorkspaceClientCapabilities.
Represents a color in RGBA space.
Represents a color range from a document.
See https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification#colorPresentation.
Parameters for a {@link ColorPresentationRequest}.
Represents a reference to a command.
Completion client capabilities
See https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification#completionClientCapabilities.
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.
In many cases the items of an actual completion result share the same value for properties like `commitCharacters` or the range of a text edit.
Additional details for a completion item label.
@since 3.18.0
See https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification#completionItemTagOptions.
Represents a collection of {@link CompletionItem completion items} to be presented in the editor.
The client supports the following `CompletionList` specific capabilities.
Completion options.
Completion parameters
See https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification#completionParams.
Registration options for a {@link CompletionRequest}.
See https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification#configurationItem.
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
See https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification#declarationClientCapabilities.
See https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification#declarationOptions.
See https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification#declarationParams.
See https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification#declarationRegistrationOptions.
Client Capabilities for a {@link DefinitionRequest}.
Server Capabilities for a {@link DefinitionRequest}.
Parameters for a {@link DefinitionRequest}.
Registration options for a {@link DefinitionRequest}.
Delete file operation
See https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification#deleteFile.
Delete file options
See https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification#deleteFileOptions.
The parameters sent in notifications/requests for user-initiated deletes of files.
Represents a diagnostic, such as a compiler error or warning.
Client capabilities specific to diagnostic pull requests.
Diagnostic options.
Diagnostic registration options.
Represents a related message and source code location for a diagnostic.
General diagnostics capabilities for pull and push model.
Cancellation data returned from a diagnostic request.
Workspace client capabilities specific to diagnostic pull requests.
See https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification#didChangeConfigurationClientCapabilities.
The parameters of a change configuration notification.
See https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification#didChangeConfigurationRegistrationOptions.
The params sent in a change notebook document notification.
The change text document notification's parameters.
See https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification#didChangeWatchedFilesClientCapabilities.
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
See https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification#didCloseTextDocumentParams.
The params sent in an open notebook document notification.
The parameters sent in an open text document notification
See https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification#didOpenTextDocumentParams.
The params sent in a save notebook document notification.
The parameters sent in a save text document notification
See https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification#didSaveTextDocumentParams.
DocumentChange is a union of various file edit operations.
See https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification#documentColorClientCapabilities.
See https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification#documentColorOptions.
Parameters for a {@link DocumentColorRequest}.
See https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification#documentColorRegistrationOptions.
Parameters of the document diagnostic request.
A partial result for a document diagnostic report.
Client capabilities of a {@link DocumentFormattingRequest}.
Provider options for a {@link DocumentFormattingRequest}.
The parameters of a {@link DocumentFormattingRequest}.
Registration options for a {@link DocumentFormattingRequest}.
A document highlight is a range inside a text document which deserves special attention.
Client Capabilities for a {@link DocumentHighlightRequest}.
Provider options for a {@link DocumentHighlightRequest}.
Parameters for a {@link DocumentHighlightRequest}.
Registration options for a {@link 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 {@link DocumentLinkRequest}.
Provider options for a {@link DocumentLinkRequest}.
The parameters of a {@link DocumentLinkRequest}.
Registration options for a {@link DocumentLinkRequest}.
Client capabilities of a {@link DocumentOnTypeFormattingRequest}.
Provider options for a {@link DocumentOnTypeFormattingRequest}.
The parameters of a {@link DocumentOnTypeFormattingRequest}.
Registration options for a {@link DocumentOnTypeFormattingRequest}.
Client capabilities of a {@link DocumentRangeFormattingRequest}.
Provider options for a {@link DocumentRangeFormattingRequest}.
The parameters of a {@link DocumentRangeFormattingRequest}.
Registration options for a {@link DocumentRangeFormattingRequest}.
The parameters of a {@link DocumentRangesFormattingRequest}.
Represents programming constructs like variables, classes, interfaces etc.
Client Capabilities for a {@link DocumentSymbolRequest}.
Provider options for a {@link DocumentSymbolRequest}.
Parameters for a {@link DocumentSymbolRequest}.
Registration options for a {@link DocumentSymbolRequest}.
Edit range variant that includes ranges for insert and replace operations.
The client capabilities of a {@link ExecuteCommandRequest}.
The server capabilities of a {@link ExecuteCommandRequest}.
The parameters of a {@link ExecuteCommandRequest}.
Registration options for a {@link ExecuteCommandRequest}.
See https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification#executionSummary.
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.
See https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification#fileSystemWatcher.
Represents a folding range.
See https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification#foldingRangeClientCapabilities.
See https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification#foldingRangeOptions.
Parameters for a {@link FoldingRangeRequest}.
See https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification#foldingRangeRegistrationOptions.
Client workspace capabilities specific to folding ranges
@since 3.18.0 @proposed
See https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification#foldingRangeWorkspaceClientCapabilities.
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.
See https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification#hoverClientCapabilities.
Hover options.
Parameters for a {@link HoverRequest}.
Registration options for a {@link HoverRequest}.
@since 3.6.0
See https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification#implementationClientCapabilities.
See https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification#implementationOptions.
See https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification#implementationParams.
See https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification#implementationRegistrationOptions.
See https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification#initializedParams.
The data type of the ResponseError if the initialize request fails.
See https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification#initializeParams.
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 completions.
Provides information about the context in which an inline completion was requested.
An inline completion item represents a text snippet that is proposed inline to complete text that is being typed.
Represents a collection of {@link InlineCompletionItem inline completion items} to be presented in the editor.
Inline completion options used during static registration.
A parameter literal used in inline completion requests.
Inline completion options used during static or dynamic registration.
Client capabilities specific to inline values.
@since 3.17.0
See https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification#inlineValueContext.
Provide an inline value through an expression evaluation.
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.
Client workspace capabilities specific to inline values.
A special text edit to provide an insert and a replace operation.
Client capabilities for the linked editing range request.
See https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification#linkedEditingRangeOptions.
See https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification#linkedEditingRangeParams.
See https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification#linkedEditingRangeRegistrationOptions.
The result of a linked editing range request.
created for Literal (Lit_ClientSemanticTokensRequestOptions_range_Item1).
created for Literal (Lit_SemanticTokensOptions_range_Item1).
Represents a location inside a resource, such as a line inside a text file.
Represents the connection of two locations.
Location with only uri and does not include range.
The log message parameters.
See https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification#logTraceParams.
Client capabilities specific to the used markdown parser.
@since 3.18.0 @deprecated use MarkupContent instead.
A `MarkupContent` literal represents a string value which content is interpreted base on its kind flag.
See https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification#messageActionItem.
Moniker definition to match LSIF 0.5 moniker definition.
Client capabilities specific to the moniker request.
See https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification#monikerOptions.
See https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification#monikerParams.
See https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification#monikerRegistrationOptions.
A notebook cell.
A change describing how to move a `NotebookCell` array from state S to S'.
@since 3.18.0
See https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification#notebookCellLanguage.
A notebook cell text document filter denotes a cell text document by different properties.
A notebook document.
Cell changes to a notebook document.
Structural changes to cells in a notebook document.
Content changes to a cell in a notebook document.
A change event for a notebook document.
Capabilities specific to the notebook document support.
A notebook document filter where `notebookType` is required field.
A notebook document filter where `pattern` is required field.
A notebook document filter where `scheme` is required field.
@since 3.18.0
See https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification#notebookDocumentFilterWithCells.
@since 3.18.0
See https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification#notebookDocumentFilterWithNotebook.
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.
created for Or [int32 string].
created for Or [ClientSemanticTokensRequestFullDelta bool].
created for Or [Lit_ClientSemanticTokensRequestOptions_range_Item1 bool].
created for Or [MarkupContent string].
created for Or [InsertReplaceEdit TextEdit].
created for Or [EditRangeWithInsertReplace Range].
created for Or [Location []Location].
created for Or [Location []Location].
created for Or [int32 string].
created for Or [[]string string].
created for Or [RelatedFullDocumentDiagnosticReport RelatedUnchangedDocumentDiagnosticReport].
created for Or [FullDocumentDiagnosticReport UnchangedDocumentDiagnosticReport].
created for Or [NotebookCellTextDocumentFilter TextDocumentFilter].
created for Or [Pattern RelativePattern].
created for Or [MarkedString MarkupContent []MarkedString].
created for Or [[]InlayHintLabelPart string].
created for Or [MarkupContent string].
created for Or [MarkupContent string].
created for Or [StringValue string].
created for Or [InlineValueEvaluatableExpression InlineValueText InlineValueVariableLookup].
created for Or [LSPArray LSPObject bool float64 int32 string uint32].
created for Or [MarkedStringWithLanguage string].
created for Or [NotebookDocumentFilter string].
created for Or [NotebookDocumentFilterNotebookType NotebookDocumentFilterPattern NotebookDocumentFilterScheme].
created for Or [NotebookDocumentFilter string].
created for Or [NotebookDocumentFilter string].
created for Or [NotebookDocumentFilterWithCells NotebookDocumentFilterWithNotebook].
created for Or [MarkupContent string].
created for Or [Tuple_ParameterInformation_label_Item1 string].
created for Or [PrepareRenameDefaultBehavior PrepareRenamePlaceholder Range].
created for Or [int32 string].
created for Or [FullDocumentDiagnosticReport UnchangedDocumentDiagnosticReport].
created for Or [FullDocumentDiagnosticReport UnchangedDocumentDiagnosticReport].
created for Or [URI WorkspaceFolder].
created for Or [CodeAction Command].
created for Or [CompletionList []CompletionItem].
created for Or [Declaration []DeclarationLink].
created for Or [Definition []DefinitionLink].
created for Or [[]DocumentSymbol []SymbolInformation].
created for Or [Definition []DefinitionLink].
created for Or [InlineCompletionList []InlineCompletionItem].
created for Or [SemanticTokens SemanticTokensDelta].
created for Or [Definition []DefinitionLink].
created for Or [[]SymbolInformation []WorkspaceSymbol].
created for Or [SemanticTokensFullDelta bool].
created for Or [Lit_SemanticTokensOptions_range_Item1 bool].
created for Or [CallHierarchyOptions CallHierarchyRegistrationOptions bool].
created for Or [CodeActionOptions bool].
created for Or [DocumentColorOptions DocumentColorRegistrationOptions bool].
created for Or [DeclarationOptions DeclarationRegistrationOptions bool].
created for Or [DefinitionOptions bool].
created for Or [DiagnosticOptions DiagnosticRegistrationOptions].
created for Or [DocumentFormattingOptions bool].
created for Or [DocumentHighlightOptions bool].
created for Or [DocumentRangeFormattingOptions bool].
created for Or [DocumentSymbolOptions bool].
created for Or [FoldingRangeOptions FoldingRangeRegistrationOptions bool].
created for Or [HoverOptions bool].
created for Or [ImplementationOptions ImplementationRegistrationOptions bool].
created for Or [InlayHintOptions InlayHintRegistrationOptions bool].
created for Or [InlineCompletionOptions bool].
created for Or [InlineValueOptions InlineValueRegistrationOptions bool].
created for Or [LinkedEditingRangeOptions LinkedEditingRangeRegistrationOptions bool].
created for Or [MonikerOptions MonikerRegistrationOptions bool].
created for Or [NotebookDocumentSyncOptions NotebookDocumentSyncRegistrationOptions].
created for Or [ReferenceOptions bool].
created for Or [RenameOptions bool].
created for Or [SelectionRangeOptions SelectionRangeRegistrationOptions bool].
created for Or [SemanticTokensOptions SemanticTokensRegistrationOptions].
created for Or [TextDocumentSyncKind TextDocumentSyncOptions].
created for Or [TypeDefinitionOptions TypeDefinitionRegistrationOptions bool].
created for Or [TypeHierarchyOptions TypeHierarchyRegistrationOptions bool].
created for Or [WorkspaceSymbolOptions bool].
created for Or [MarkupContent string].
created for Or [TextDocumentContentChangePartial TextDocumentContentChangeWholeDocument].
created for Or [AnnotatedTextEdit SnippetTextEdit TextEdit].
created for Or [TextDocumentFilterLanguage TextDocumentFilterPattern TextDocumentFilterScheme].
created for Or [SaveOptions bool].
created for Or [WorkspaceFullDocumentDiagnosticReport WorkspaceUnchangedDocumentDiagnosticReport].
created for Or [CreateFile DeleteFile RenameFile TextDocumentEdit].
created for Or [bool string].
created for Or [TextDocumentContentOptions TextDocumentContentRegistrationOptions].
created for Or [Location LocationUriOnly].
The parameters of a configuration request.
Represents a parameter of a callable-signature.
See https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification#initializeParams.
See https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification#partialResultParams.
Position in a text document expressed as zero-based line and character offset.
@since 3.18.0
See https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification#prepareRenameDefaultBehavior.
See https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification#prepareRenameParams.
@since 3.18.0
See https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification#prepareRenamePlaceholder.
A previous result id in a workspace pull request.
A previous result id in a workspace pull request.
See https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification#progressParams.
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 {@link ReferencesRequest}.
Value-object that contains additional information when requesting references.
Reference options.
Parameters for a {@link ReferencesRequest}.
Registration options for a {@link ReferencesRequest}.
General parameters to register for a notification or to register a provider.
See https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification#registrationParams.
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.
See https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification#renameClientCapabilities.
Rename file operation
See https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification#renameFile.
Rename file options
See https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification#renameFileOptions.
The parameters sent in notifications/requests for user-initiated renames of files.
Provider options for a {@link RenameRequest}.
The parameters of a {@link RenameRequest}.
Registration options for a {@link RenameRequest}.
A generic resource operation.
Save options.
Describes the currently selected completion item.
A selection range represents a part of a selection hierarchy.
See https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification#selectionRangeClientCapabilities.
See https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification#selectionRangeOptions.
A parameter literal used in selection range requests.
See https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification#selectionRangeRegistrationOptions.
@since 3.16.0
See https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification#semanticTokens.
@since 3.16.0
See https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification#semanticTokensClientCapabilities.
@since 3.16.0
See https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification#semanticTokensDelta.
@since 3.16.0
See https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification#semanticTokensDeltaParams.
@since 3.16.0
See https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification#semanticTokensDeltaPartialResult.
@since 3.16.0
See https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification#semanticTokensEdit.
Semantic tokens options to support deltas for full documents
@since 3.18.0
See https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification#semanticTokensFullDelta.
@since 3.16.0
See https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification#semanticTokensLegend.
@since 3.16.0
See https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification#semanticTokensOptions.
@since 3.16.0
See https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification#semanticTokensParams.
@since 3.16.0
See https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification#semanticTokensPartialResult.
@since 3.16.0
See https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification#semanticTokensRangeParams.
@since 3.16.0
See https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification#semanticTokensRegistrationOptions.
@since 3.16.0
See https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification#semanticTokensWorkspaceClientCapabilities.
Defines the capabilities provided by a language server.
@since 3.18.0
See https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification#serverCompletionItemOptions.
Information about the server
@since 3.15.0 @since 3.18.0 ServerInfo type name added.
See https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification#setTraceParams.
Client capabilities for the showDocument request.
Params to show a resource in the UI.
The result of a showDocument request.
The parameters of a notification message.
Show message request client capabilities
See https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification#showMessageRequestClientCapabilities.
See https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification#showMessageRequestParams.
Signature help represents the signature of something callable.
Client Capabilities for a {@link SignatureHelpRequest}.
Additional information about the context in which a signature help request was triggered.
Server Capabilities for a {@link SignatureHelpRequest}.
Parameters for a {@link SignatureHelpRequest}.
Registration options for a {@link SignatureHelpRequest}.
Represents the signature of something callable.
An interactive text edit.
@since 3.18.0
See https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification#staleRequestSupportOptions.
Static registration options to be returned in the initialize request.
A string value used as a snippet is a template which allows to insert text and to control the editor cursor when insertion happens.
Represents information about programming constructs like variables, classes, interfaces etc.
Describe options to be used when registered for text document change events.
Text document specific client capabilities.
@since 3.18.0
See https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification#textDocumentContentChangePartial.
@since 3.18.0
See https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification#textDocumentContentChangeWholeDocument.
Client capabilities for a text document content provider.
Text document content provider options.
Parameters for the `workspace/textDocumentContent` request.
Parameters for the `workspace/textDocumentContent/refresh` request.
Text document content provider registration options.
Describes textual changes on a text document.
A document filter where `language` is required field.
A document filter where `pattern` is required field.
A document filter where `scheme` is required field.
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.
See https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification#textDocumentSyncClientCapabilities.
See https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification#textDocumentSyncOptions.
A text edit applicable to a text document.
created for Tuple.
Since 3.6.0
See https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification#typeDefinitionClientCapabilities.
See https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification#typeDefinitionOptions.
See https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification#typeDefinitionParams.
See https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification#typeDefinitionRegistrationOptions.
@since 3.17.0
See https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification#typeHierarchyClientCapabilities.
@since 3.17.0
See https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification#typeHierarchyItem.
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.
UnmarshalError indicates that a JSON value did not conform to one of the expected cases of an LSP union type.
General parameters to unregister a request or notification.
See https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification#unregistrationParams.
A versioned notebook document identifier.
A text document identifier to denote a specific version of a text document.
See https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification#willSaveTextDocumentParams.
See https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification#windowClientCapabilities.
See https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification#workDoneProgressBegin.
See https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification#workDoneProgressCancelParams.
See https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification#workDoneProgressCreateParams.
See https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification#workDoneProgressEnd.
See https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification#workDoneProgressOptions.
See https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification#workDoneProgressParams.
See https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification#workDoneProgressReport.
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.
See https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification#workspaceEditClientCapabilities.
Additional data about a workspace edit.
A workspace folder inside a client.
The workspace folder change event.
See https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification#workspaceFoldersInitializeParams.
See https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification#workspaceFoldersServerCapabilities.
A full document diagnostic report for a workspace diagnostic result.
Defines workspace specific capabilities of the server.
A special workspace symbol that supports locations without a range.
Client capabilities for a {@link WorkspaceSymbolRequest}.
Server capabilities for a {@link WorkspaceSymbolRequest}.
The parameters of a {@link WorkspaceSymbolRequest}.
Registration options for a {@link WorkspaceSymbolRequest}.
An unchanged document diagnostic report for a workspace diagnostic result.
The initialize parameters
See https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification#_InitializeParams.
# Interfaces
TextEditResult is an interface for types that represent document symbols.
No description provided by the author
TextEditResult is an interface for types that can be used as text edits.
TextEditResult is an interface for types that represent workspace symbols.
# Type aliases
An identifier to refer to a change annotation stored with a workspace edit.
A set of predefined code action kinds.
The reason why code actions were requested.
The kind of a completion entry.
Completion item tags are extra annotations that tweak the rendering of a completion item.
How a completion was triggered.
The declaration of a symbol representation as one or many {@link Location locations}.
Information about where a symbol is declared.
The definition of a symbol represented as one or many {@link Location locations}.
Information about where a symbol is defined.
The diagnostic's severity.
The diagnostic tags.
The result of a document diagnostic pull request.
The document diagnostic report kinds.
A document filter describes a top level text document or a notebook cell document.
A document highlight kind.
A document selector is the combination of one or many document filters.
A DocumentUri is the URI of a client editor document.
Predefined error codes.
No description provided by the author
The file event type.
A pattern kind describing if a glob pattern matches a file a folder or both.
A set of predefined range kinds.
The glob pattern.
Inlay hint kinds.
Describes how an {@link InlineCompletionItemProvider inline completion provider} was triggered.
Inline value information can be provided by different means:
- directly as a text value (class InlineValueText).
Defines whether the insert text in a completion item should be interpreted as plain text or a snippet.
How whitespace and indentation is handled during completion item insertion.
Predefined Language kinds @since 3.18.0 @proposed.
LSP arrays.
No description provided by the author
LSP object definition.
MarkedString can be used to render human readable text.
Describes the content type that a client supports in various result literals like `Hover`, `ParameterInfo` or `CompletionItem`.
The message type.
The moniker kind.
A notebook cell kind.
A notebook document filter denotes a notebook document by different properties.
The glob pattern to watch relative to the base path.
A set of predefined position encoding kinds.
See https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification#prepareRenameResult.
No description provided by the author
See https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification#progressToken.
See https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification#regularExpressionEngineKind.
No description provided by the author
A set of predefined token modifiers.
A set of predefined token types.
How a signature help was triggered.
A symbol kind.
Symbol tags are extra annotations that tweak the rendering of a symbol.
An event describing a change to a text document.
A document filter denotes a document by different properties like the {@link TextDocument.languageId language}, the {@link Uri.scheme scheme} of its resource, or a glob-pattern that is applied to the {@link TextDocument.fileName path}.
Represents reasons why a text document is saved.
Defines how the host (editor) should sync document changes to the language server.
No description provided by the author
No description provided by the author
Moniker uniqueness level to define scope of the moniker.
A URI is an arbitrary URL (e.g.
No description provided by the author
A workspace diagnostic document report.