Categorypkg.nimblebun.works/go-lsp
modulepackage
1.1.0
Repository: https://github.com/nimblebun/go-lsp.git
Documentation: pkg.go.dev
Overview
Versions
1
Dependencies
2
Dependents
17
Files
3.6k SLOC

# README

Language Server Protocol types for Go

This is a module that contains type definitions and documentation for the Language Server Protocol Specification. It aims to provide up-to-date and clear definitions to use in a language server.

LSP spec support: 3.15, 3.16.

Getting Started

go get pkg.nimblebun.works/go-lsp

Import it in your project:

import (
  "pkg.nimblebun.works/go-lsp"
)

You can now use the types and constants defined in lsp. See the documentation for more information.

Disclaimer

Our goal was to create an organized, easy to use, well-documented, and up-to-date LSP module for the Go programming language. To achieve this goal, we decided not to rely on automated tools to generate the Go types, but to write everything ourselves by hand. As a result, even though we tried to be as precise as possible, there could be typos in the definitions or the JSON names. If you notice a typo or bug, please report it in the Issue Tracker!

Future Plans

Future plans for this module include designing a language server SDK, effectively making the module a swiss-army knife for creating language servers in Go easily.

License

MIT. Type declarations and documentations are taken from the official specification document.

# Functions

NewCreateFile instantiates a CreateFile struct.
NewDeleteFile instantiates a DeleteFile struct.
NewRenameFile instantiates a RenameFile struct.

# Constants

CAKEmpty defines an empty kind.
CAKQuickFix is the base kind for quickfix actions: 'quickfix'.
CAKRefactor is the base kind for refactoring actions: 'refactor'.
CAKRefactorExtract is the base kind for refactoring extraction actions: 'refactor.extract'.
CAKRefactorInline is the base kind for refactoring inline actions: 'refactor.inline'.
CAKRefactorRewrite is the base kind for refactoring rewrite actions: 'refactor.rewrite'.
CAKSource is the base kind for source actions: `source`.
CAKSourceOrganizeImports is the base kind for an organize imports source action `source.organizeImports`.
CIKClass represents a class completion item kind.
CIKColor represents a color completion item kind.
CIKConstant represents a constant completion item kind.
CIKConstructor represents a constructor completion item kind.
CIKEnum represents an enum completion item kind.
CIKEnumMember represents an enum member completion item kind.
CIKEvent represents a event completion item kind.
CIKField represents a field completion item kind.
CIKFile represents a file completion item kind.
CIKFolder represents a folder completion item kind.
CIKFunction represents a function completion item kind.
CIKInterface represents an interface completion item kind.
CIKKeyword represents a keyword completion item kind.
CIKMethod represents a method completion item kind.
CIKModule represents a module completion item kind.
CIKOperator represents an operator completion item kind.
CIKProperty represents a property completion item kind.
CIKReference represents a reference completion item kind.
CIKSnippet represents a snippet completion item kind.
CIKStruct represents a struct completion item kind.
CIKText represents a text completion item kind.
CIKTypeParameter represents a type parameter completion item kind.
CIKUnit represents a unit completion item kind.
CIKValue represents a value completion item kind.
CIKVariable represents a variable completion item kind.
CITDeprecated will render a completion as obsolete, usually using a strike-out .
CTKInvoked means the completion was triggered by typing an identifier (24x7 code complete), manual invocation (e.g Ctrl+Space) or via API.
CTKTriggerCharacter means the completion was triggered by a trigger character specified by the `triggerCharacters` properties of `CompletionRegistrationOptions`.
CTKTriggerForIncompleteCompletions means the completion was re-triggered as the current completion list is incomplete.
DocumentHighlightKindRead denotes read-access of a symbol, like reading a variable.
DocumentHighlightKindText denotes a textual occurrence.
DocumentHighlightKindWrite denotes write-access of a symbol, like writing to a variable.
DSError reports an error.
DSHint reports a hint.
DSInformation reports an information.
DSWarning reports a warning.
DTDeprecated reports deprecated or obsolete code.
DTUnnecessary reports unused or unnecessary code.
FCTChanged means the file got changed.
FCTCreated means the file got created.
FCTDeleted means the file got deleted.
FHKAbort means applying the workspace change is simply aborted if one of the changes provided fails.
FHKTextOnlyTransactional means if the workspace edit contains only textual file changes, they are executed transactionally.
FHKTransactional means all operations are executed transactional.
FHKUndo means the client tries to undo the operations already executed.
FoldingRangeKindComment denotes that the folding range is for a comment.
FoldingRangeKindImports denotes that the folding range is for imports or includes.
FoldingRangeKindRegion denotes that the folding range is for a region (e.g.
FOPKindFile means the pattern matches a file only.
FOPKindFolder means the pattern matches a folder only.
InsertTextModeAdjustIndentation means 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.
InsertTextModeAsIs means the insertion or replace strings is taken as it is.
ITFPlainText means the primary text to be inserted is treated as a plain string.
ITFSnippet means the primary text to be inserted is treated as a snippet.
MKMarkdown denotes that markdown is supported as a content format.
MKPlainText denotes that plaintext is supported as a content format.
No description provided by the author
No description provided by the author
No description provided by the author
MTError is an error message.
MTInfo is an information message.
MTLog is a log message.
MTWarning is a warning message.
PSDefaultBehaviorIdentifier means the client's default behavior is to select the identifier according the to language's syntax rule.
ROKCreate refers to a file/folder creation operation.
ROKDelete refers to a file/folder deletion operation.
ROKRename refers to a file/folder rename operation.
SHTriggerKindContentChange means the signature help was triggered by the cursor moving or by the document content changing.
SHTriggerKindInvoked means the signature help was invoked manually by the user or by a command.
SHTriggerKindTriggerCharacter means the signature help was triggered by a trigger character.
SKArray denotes an array symbol kind.
SKBoolean denotes a boolean symbol kind.
SKClass denotes a class symbol kind.
SKConstant denotes a constant symbol kind.
SKConstructor denotes a constructor symbol kind.
SKEnum denotes an enum symbol kind.
SKEnumMember denotes an enum member symbol kind.
SKEvent denotes an event symbol kind.
SKField denotes a field symbol kind.
SKFile denotes a file symbol kind.
SKFunction denotes a function symbol kind.
SKInterface denotes an interface symbol kind.
SKKey denotes a key symbol kind.
SKMethod denotes a method symbol kind.
SKModule denotes a module symbol kind.
SKNamespace denotes a namespace symbol kind.
SKNull denotes a null symbol kind.
SKNumber denotes a number symbol kind.
SKObject denotes an object symbol kind.
SKOperator denotes an operator symbol kind.
SKPackage denotes a package symbol kind.
SKProperty denotes a property symbol kind.
SKString denotes a string symbol kind.
SKStruct denotes a struct symbol kind.
SKTypeParameter denotes a type parameter symbol kind.
SKVariable denotes a variable symbol kind.
STDeprecated will render a symbol as obsolete, usually using a strike-out.
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
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
STTType represents a generic type.
No description provided by the author
No description provided by the author
TDSaveReasonAfterDelay represents a document save that was automatic after a delay.
TDSaveReasonFocusOut represents a document save that happened when the editor lost focus.
TDSaveReasonManual represents a document save that was manually triggered, for example, by the user pressing save, by starting debugging, or by an API call.
TDSyncKindFull means cocuments are synced by always sending the full content of the document.
TDSyncKindIncremental means documents are synced by sending the full content on open.
TDSyncKindNone means documents should not be synced at all.
No description provided by the author
TraceMessages means only the messages will be traced.
TraceOff means tracing is turned off.
TraceVerbose means tracing will be detailed.
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
WKChange means the watcher is interested in change events.
WKCreate means the watcher is interested in create events.
WKDelete means the watcher is interested in delete events.

# Structs

ApplyWorkspaceEditParams contains the fields sent in a `workspace/applyEdit` request.
ApplyWorkspaceEditResponse contains the fields from a `workspace/applyEdit` response.
CallHierarchyClientCapabilities contains information about the client's call hierarchy capabilities.
CallHierarchyIncomingCall represents a single incoming call.
CallHierarchyIncomingCallsParams contains the data the client sends through a `callHierarchy/incomingCalls` request.
CallHierarchyItem represents a single item in the call hierarchy.
CallHierarchyOptions specifies the options for settin up call hierarchy support for a language server.
CallHierarchyOutgoingCall represents a single outgoing call.
CallHierarchyOutgoingCallsParams contains the data the client sends through a `callHierarchy/outgoingCalls` request.
CallHierarchyPrepareParams contains the data the client sends through a `textDocument/prepareCallHierarchy` request.
CallHierarchyRegistrationOptions describes options to be used when registering for call hierarchy capabilities.
CancelParams contains the parameters of the `$/cancelRequest` method.
ChangeAnnotation represents dditional information that describes document changes.
ClientCapabilities defines workspace-specific client capabilities.
ClientInfo contains information about the client.
CodeAction represents a change that can be performed in code.
CodeActionClientCapabilities contains information about the client's code action capabilities.
CodeActionContext contains additional diagnostic information about the context in which a code action is run.
CodeActionOptions contains the options for the code action handler.
CodeActionParams contains the fields sent in a `textDocument/codeAction` request.
CodeActionRegistrationOptions contains the options for the code action handler registration.
CodeDescription represents a structure to capture a description for an error code.
CodeLens represents a command that should be shown along with source text, like the number of references, a way to run tests, etc.
CodeLensClientCapabilities contains information about the client's CodeLens capabilities.
CodeLensOptions contains the options for the CodeLens handler.
CodeLensParams contains the fields sent in a `textDocument/codeLens` request.
CodeLensRegistrationOptions contains the options for the CodeLens handler registration.
CodeLensWorkspaceCapabilities contains information about the client's workspace CodeLens capabilities.
Color represents a color in RGBA space.
ColorInformation contains the color information for a given range.
ColorPresentation contains the presentation data of a color value.
ColorPresentationParams contains the fields sent in a `textDocument/colorPresentation` request.
Command represents a reference to a command.
CompletionClientCapabilities contains information about the client's completion capabilities.
CompletionContext contains additional information about the context in which a completion request is triggered.
CompletionItem describes a single completion item.
CompletionList represents a collection of `CompletionItem`s to be presented in the editor.
CompletionOptions contains the options for the completion handler.
CompletionParams contains the fields sent in a `textDocument/completion` request.
CompletionRegistrationOptions contains the options for the completion handler registration.
ConfigurationItem defines a single configuration item.
ConfigurationParams contains the parameters contained in a `workspace/configuration` request.
CreateFile defines a file creation operation.
CreateFileOptions contains options to create a file.
DeclarationClientCapabilities contains information about the client's go-to-declaration capabilities.
DeclarationOptions contains the options for the go-to-declaration handler.
DeclarationParams contains the fields sent in a `textDocument/declaration` request.
DeclarationRegistrationOptions contains the options for the go-to-declaration handler registration.
DefinitionClientCapabilities contains information about the client's go-to-definition capabilities.
DefinitionOptions contains the options for the go-to-definition handler.
DefinitionParams contains the fields sent in a `textDocument/definition` request.
DefinitionRegistrationOptions contains the options for the go-to-definition handler registration.
DeleteFile defines a file deletion operation.
DeleteFileOptions contains options to delete a file.
The parameters sent in notifications/requests for user-initiated deletes of files.
Diagnostic represents a diagnostic, such as a compiler error or warning.
DiagnosticRelatedInformation represents a related message and source code location for a diagnostic.
DidChangeConfigurationClientCapabilities contains information about the client's configuration change capabilities.
DidChangeConfigurationParams contains the parameters contained in a `workspace/didChangeConfiguration` request.
DidChangeTextDocumentParams contains the data the client sends through a `textDocument/didChange` notification.
DidChangeWatchedFilesClientCapabilities contains information about the client's file watcher change capabilities.
DidChangeWatchedFilesParams contains the parameters of a request of method `workspace/didChangeWatchedFiles`.
DidChangeWatchedFilesRegistrationOptions describes options to be used when registering for file system change events.
DidChangeWorkspaceFoldersParams are the parameters contained in a `workspace/didChangeWorkspaceFolders` notification.
DidCloseTextDocumentParams contains the parameters sent in a `textDocument/didClose` notification.
DidOpenTextDocumentParams contains the data the client sends through a `textDocument/didOpen` request.
DidSaveTextDocumentParams contains the parameters sent in a `textDocument/didSave` notification.
DocumentColorClientCapabilities contains information about the client's document color capabilities.
DocumentColorOptions contains the options for the document color handler.
DocumentColorParams contains the fields sent in a `textDocument/documentColor` request.
DocumentColorRegistrationOptions contains the options for the document color handler registration.
DocumentFilter denotes a document through properties like `language`, `scheme` or `pattern`.
DocumentFormattingClientCapabilities contains information about the client's document formatting capabilities.
DocumentFormattingOptions contains the options for the document formatting handler.
DocumentFormattingParams contains the fields sent in a `textDocument/formatting` request.
DocumentFormattingRegistrationOptions contains the options for the document formatting handler registration.
DocumentHighlight is a range inside a text document which deserves special attention.
DocumentHighlightClientCapabilities contains information about the client's document highlight capabilities.
DocumentHighlightOptions contains the options for the document highlight handler.
DocumentHighlightParams contains the fields sent in a `textDocument/documentHighlight` request.
DocumentHighlightRegistrationOptions contains the options for the document highlight handler registration.
DocumentLink is a range in a text document that links to an internal or external resource, like another text document or a web site.
DocumentLinkClientCapabilities contains information about the client's document link capabilities.
DocumentLinkOptions contains the options for the document link handler.
DocumentLinkParams contains the fields sent in a `textDocument/documentLink` request.
DocumentLinkRegistrationOptions contains the options for the document link handler registration.
DocumentOnTypeFormattingClientCapabilities contains information about the client's document on-type formatting capabilities.
DocumentOnTypeFormattingOptions contains the options for the document on-type formatting handler.
DocumentOnTypeFormattingParams contains the fields sent in a `textDocument/onTypeFormatting` request.
DocumentOnTypeFormattingRegistrationOptions contains the options for the document on-type formatting handler registration.
DocumentRangeFormattingClientCapabilities contains information about the client's document formatting capabilities.
DocumentRangeFormattingOptions contains the options for the document range formatting handler.
DocumentRangeFormattingParams contains the fields sent in a `textDocument/rangeFormatting` request.
DocumentRangeFormattingRegistrationOptions contains the options for the document range formatting handler registration.
DocumentSymbol represents programming constructs like variables, classes, interfaces etc.
DocumentSymbolClientCapabilities contains information about the client's document symbol capabilities.
DocumentSymbolOptions contains the options for the document symbol handler.
DocumentSymbolParams contains the fields sent in a `textDocument/documentSymbol` request.
DocumentSymbolRegistrationOptions contains the options for the document symbol handler registration.
ExecuteCommandClientCapabilities contains information about the client's command execution capabilities.
ExecuteCommandOptions contains the options for the command execution handler.
ExecuteCommandParams contains the fields sent in a `workspace/executeCommand` request.
ExecuteCommandRegistrationOptions contains the command execution registration options.
Represents information on a file/folder delete.
FileEvent is an event describing a file change.
A filter to describe in which file operation requests or notifications the server is interested in.
A pattern to describe in which file operation requests or notifications the server is interested in.
Matching options for the file operation pattern.
The options to register for file operations.
Represents information on a file/folder rename.
FileSystemWatcher defines a watcher on a given glob pattern.
FoldingRange represents a folding range for the client.
FoldingRangeClientCapabilities contains information about the client's folding range provider capabilities.
FoldingRangeOptions contains the options for the folding range provider handler.
FoldingRangeParams contains the fields sent in a `textDocument/foldingRange` request.
FoldingRangeRegistrationOptions contains the options for the folding range provider handler registration.
FormattingOptions is a value-object describing what options formatting should use.
Hover is the result of a hover request.
HoverClientCapabilities contains information about the client's hover capabilities.
HoverOptions contains the options for the hover handler.
HoverParams contains the fields sent in a `textDocument/hover` request.
HoverRegistrationOptions contains the options for the hover handler registration.
ID is a JSON-RPC 2.0 request ID.
ImplementationClientCapabilities contains information about the client's go-to-implementation capabilities.
ImplementationOptions contains the options for the go-to-implementation handler.
ImplementationParams contains the fields sent in a `textDocument/implementation` request.
ImplementationRegistrationOptions contains the options for the go-to-implementation handler registration.
InitializeParams is a struct containing the parameters of an `initialize` request.
InitializeResult contains the fields of the `result` parameter in a response payload for an `initialize` request.
A special text edit to provide an insert and a replace operation.
LinkedEditingRangeClientCapabilities contains information about the client's linked editing range capabilities.
LinkedEditingRangeOptions specifies the options for settin up linked editing range support for a language server.
LinkedEditingRangeParams contains the data the client sends through a `textDocument/linkedEditingRange` request.
LinkedEditingRangeRegistrationOptions describes options to be used when registering for linked editing range capabilities.
LinkedEditingRanges represents a set of linked editing ranges.
Location represents a location inside a resource, such as a line inside a text file.
LocationLink represents a link between a source and a target location.
LogMessageParams is the payload that is sent on a `window/logMessage` notification.
Client capabilities specific to the used markdown parser.
MarkupContent represents a string value, which content is interpreted based on its kind flag.
MessageActionItem encapsulates a message action.
Moniker represents a single moniker.
MonikerClientCapabilities contains information about the client's moniker capabilities.
MonikerOptions specifies the options for settin up moniker support for a language server.
MonikerParams contains the data the client sends through a `textDocument/moniker` request.
MonikerRegistrationOptions describes options to be used when registering for moniker capabilities.
ParameterInformation represents a parameter of a callable-signature.
PartialResultParams is a parameter literal used to pass a partial result token.
Position in a text document expressed as zero-based line and zero-based character offset.
PrepareRenameParams contains the fields sent in a `textDocument/prepareRename` request.
ProgressParams denotes a token-value pair for a progress.
PublishDiagnosticsClientCapabilities contains information about the client's diagnostics publishing capabilities.
PublishDiagnosticsParams contains the parameters sent in a `textDocument/publishDiagnostics` notification.
Range is a range in a text document expressed as (zero-based) start and end positions.
ReferenceClientCapabilities contains information about the client's find references capabilities.
ReferenceContext defines additional context to a reference parameter.
ReferenceOptions contains the options for the find references handler.
ReferenceParams contains the fields sent in a `textDocument/references` request.
ReferenceRegistrationOptions contains the options for the find references handler registration.
Registration contains general parameters to register for a capability.
RegistrationParams is the req payload sent in a `client/registerCapability` request.
Client capabilities specific to regular expressions.
RenameClientCapabilities contains information about the client's file rename capabilities.
RenameFile defines a file rename operation.
RenameFileOptions contains options to rename a file.
The parameters sent in notifications/requests for user-initiated renames of files.
RenameOptions contains the options for the rename handler.
RenameParams contains the fields sent in a `textDocument/rename` request.
RenameRegistrationOptions contains the options for the rename handler registration.
SaveOptions contains the options that need to be taken into consideration when saving.
SelectionRangeClientCapabilities contains information about the client's selection range provider capabilities.
SelectionRangeOptions contains the options for the selection range provider handler.
SelectionRangeParams contains the fields sent in a `textDocument/selectionRange` request.
SelectionRangeRegistrationOptions contains the options for the selection range provider handler registration.
SemanticTokens represents a set of semantic tokens for a document.
SemanticTokensClientCapabilities contains information about the client's semantic tokens capabilities.
SemanticTokensDelta represents a set of semantic tokens edits for a document.
SemanticTokensDeltaParams contains the data the client sends through a `textDocument/semanticTokens/full/delta` request.
SemanticTokensDeltaPartialResult is similar to SemanticTokensDelta but only contains the edits (without the result ID).
SemanticTokensEdit represents data about a single semantic tokens edit within the document.
SemanticTokensLegend represents a mapping of semantic token types and modifiers.
SemanticTokensOptions specifies the options for settin up semantic token support for a language server.
SemanticTokenParams contains the data the client sends through a `textDocument/semanticTokens/full` request.
SemanticTokensPartialResult is similar to SemanticTokens but only contains the tokens (without the result ID).
SemanticTokensRangeParams contains the data the client sends through a `textDocument/semanticTokens/range` request.
SemanticTokensRegistrationOptions describes options to be used when registering for semantic token capabilities.
SemanticTokensWorkspaceClientCapabilities contains information about the client's semantic tokens workspace capabilities.
ServerCapabilities defines the capabilities of the language server.
ServerInfo contains information about the server.
ShowDocumentClientCapabilities contains information about the client's show document capabilities.
Params to show a document.
The result of a show document request.
ShowMessageParams is the payload that is sent on a `window/showMessage` notification.
ShowMessageRequestClientCapabilities contains information about the client's show message request capabilities.
ShowMessageRequestParams is the payload that is sent on a `window/showMessageRequest` request.
SignatureHelp represents the signature of something callable.
SignatureHelpClientCapabilities contains information about the client's signature help capabilities.
SignatureHelpContext contains additional information about the context in which a signature help request was triggered.
SignatureHelpOptions contains the options for the signature help handler.
SignatureHelpParams contains the fields sent in a `textDocument/signatureHelp` request.
SignatureHelpRegistrationOptions contains the options for the signature help handler registration.
SignatureInformation represents the signature of something callable.
StaticRegistrationOptions can be used to register a feature in the initialize result with a given server control ID to be able to un-register the feature later on.
SymbolInformation represents information about programming constructs like variables, classes, interfaces etc.
TextDocumentChangeRegistrationOptions describes options to be used when registering for text document change events.
TextDocumentClientCapabilities define capabilities the editor / tool provides on text documents.
TextDocumentContentChangeEvent is an event describing a change to a text document.
TextDocumentEdit describes textual changes on a single text document.
TextDocumentIdentifier encapsulates the URI of a given text document.
TextDocumentItem is an item to transfer a text document from the client to the server.
TextDocumentPositionParams is a parameter literal used in requests to pass a text document and a position inside that document.
TextDocumentRegistrationOptions denotes options to dynamically register for requests for a set of text documents.
TextDocumentSaveRegistrationOptions contains the registration options of textDocument/save.
TextDocumentSyncClientCapabilities contains information about the client's text document sync capabilities.
TextDocumentSyncOptions specifies the options for setting up text document sync.
TextEdit represents a textual edit applicable to a text document.
TypeDefinitionClientCapabilities contains information about the client's go-to-type-definition capabilities.
TypeDefinitionOptions contains the options for the go-to-type-definition handler.
TypeDefinitionParams contains the fields sent in a `textDocument/typeDefinition` request.
TypeDefinitionRegistrationOptions contains the options for the go-to-type-definition handler registration.
Unregistration contains general parameters to unregister a capability.
UnregistrationParams is the payload sent in a `client/unregisterCapability` request.
VersionedTextDocumentIdentifier is an identifier to denote a specific version of a text document.
WillSaveTextDocumentParams contains the parameters sent in a will save text document notification.
WorkDoneProgressBegin is the payload that must be sent in a `$/progress` notification.
WorkDoneProgressCancelParams is the request payload sent in a `window/workDoneProgress/cancel` request.
WorkDoneProgressCreateParams is the request payload sent in a `window/workDoneProgress/create` request.
WorkDoneProgressEnd is the payload that needs to be sent to signal the end of a progress reporting.
WorkDoneProgressOptions is the type definition for the server capability.
WorkDoneProgressParams contains the parameters of a progress report.
WorkDoneProgressReport is the payload that needs to be sent to report progress.
WorkspaceEdit represents changes to many resources managed in the workspace.
WorkspaceEditClientCapabilities contains information about the client's workspace edit capabilities.
WorkspaceFolder is a structure that defines the reference to a workspace folder.
WorkspaceFoldersChangeEvent contains information about a workspace folder change event.
WorkspaceFoldersServerCapabilities contains information about the server's workspace folders capabilities.
WorkspaceSymbolClientCapabilities contains information about the client's workspace symbol capabilities.
WorkspaceSymbolOptions is a literal for WorkDoneProgressOptions for symbols in a workspace.
WorkspaceSymbolParams contains the fields sent in a `workspace/symbol` request.
WorkspaceSymbolRegistrationOptions contains the workspace symbol registration options.

# Interfaces

WorkspaceEditDocumentChange is an interface that can be interpreted as a `TextDocumentEdit`, `CreateFile`, `RenameFile`, or `DeleteFile`.

# Type aliases

ChangeAnnotationIdentifier is an identifier referring to a change annotation managed by a workspace edit.
CodeActionKind defines a set of predefined code action kinds.
CompletionItemKind specifies the type of a completion.
CompletionItemTag defines extra annotations that tweak the rendering of a completion item.
CompletionTriggerKind specifies how a completion was triggered.
DiagnosticSeverity denotes the severity of a given problem in a document.
DiagnosticTag denotes the status of a given code snippet in a document.
DocumentHighlightKind defines a document highlight kind.
DocumentSelector is the combination of one or more document filters.
DocumentURI is a document's unique resource identifier.
FailureHandlingKind defines how the client should behave on a workspace edit failure.
FileChangeType defines the type of a file event.
A pattern kind describing if a glob pattern matches a file a folder or both.
FoldingRangeKind contains the known range kinds.
InsertTextFormat 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.
MarkupKind describes the content type that a client supports in various result literals like `Hover`, `ParameterInfo` or `CompletionItem`.
MessageType defines the type of a message.
MonikerKind represents the kind of moniker.
PrepareSupportDefaultBehavior indicates the default behavior for the client's prepare support.
ProgressToken represents a token provided by the client or server.
ResourceOperationKind defines a kind of resource operation.
SemanticTokenModifiers represents a modifier for a semantic token.
SemanticTokenType represents the type of a semantic token.
SignatureHelpTriggerKind defines how a signature help was triggered.
SymbolKind specifies the type of a symbol.
Symbol tags are extra annotations that tweak the rendering of a symbol.
TextDocumentSaveReason represents reasons why a text document is saved.
TextDocumentSyncKind defines how the host (editor) should sync document changes to the language server.
TokenFormat represents the format of a semantic token.
TraceType specifies the type of trace that needs to be done in a communication between the client and the server.
UniquenessLevel represents a level of uniqueness for a moniker.
URI is a generic unique resource identifier.
WatchKind defines the kind of the file system watcher.