aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJongwook Choi <wookayin@gmail.com>2023-12-11 02:25:17 -0500
committerMathias Fußenegger <mfussenegger@users.noreply.github.com>2023-12-27 10:48:06 +0100
commit6c35fb421e888d0cbdfac07a5ff4579c9be7f0ec (patch)
tree03662f39cca7bcc11c7d1d8bb862dc9864828e87
parent2f43af6423193eb52e9a6635034f8c79f40f1706 (diff)
downloadrneovim-6c35fb421e888d0cbdfac07a5ff4579c9be7f0ec.tar.gz
rneovim-6c35fb421e888d0cbdfac07a5ff4579c9be7f0ec.tar.bz2
rneovim-6c35fb421e888d0cbdfac07a5ff4579c9be7f0ec.zip
fix(gen_lsp.lua): improve type name, and fix wrong type inheritance
Style improvements: 1. Anonymous classes derived from `StructureLiteralType` should have a better name. The class name can be also nested. Examples: ```diff ----@field serverInfo? anonym1 +---@field serverInfo? lsp._anonym1.serverInfo ``` ```diff ----@field insertTextModeSupport? anonym26 +---@field insertTextModeSupport? lsp._anonym26.completionItem.insertTextModeSupport ``` 2. Add one separate empty line before each `@field` definition. Without these, empty lines the doc can look confusing because descriptions also may contain empty lines. See `lsp.CompletionItem` for example: ```lua ---The kind of this completion item. Based of the kind ---an icon is chosen by the editor. ---@field kind? lsp.CompletionItemKind ---Tags for this completion item. --- ---@since 3.15.0 ---@field tags? lsp.CompletionItemTag[] ``` It might feel like "Tags for this completion item" belongs to `kind`, not `tags` due to the lack of separator blank lines. The following (after this commit) should look much better: ```diff ---The kind of this completion item. Based of the kind ---an icon is chosen by the editor. ---@field kind? lsp.CompletionItemKind +--- ---Tags for this completion item. --- ---@since 3.15.0 ---@field tags? lsp.CompletionItemTag[] ``` 3. Escape some LSP-specific annotations that can't be recognized by lua-ls. It'd be better to make them visible in LSP hover doc windows. Example: `@sample ...`. Fixes: 1. A type may extend from more than one base types (as well as mixin types). Previously only the first base class was being considered, resulting incomplete base classes for `@class` definitions. Example: `InlayHintOptions` (should have both of `resolveProvider` and `workDoneProgress`, the latter is from `WorkDoneProgressOptions`) ```diff ----@class lsp.InlayHintOptions +---@class lsp.InlayHintOptions: lsp.WorkDoneProgressOptions ``` 2. Remove `<200b>` (zero-width space) unicode characters. 3. Add the missing newline at EOF.
-rw-r--r--runtime/lua/vim/lsp/_meta/protocol.lua1182
-rw-r--r--scripts/gen_lsp.lua98
2 files changed, 1045 insertions, 235 deletions
diff --git a/runtime/lua/vim/lsp/_meta/protocol.lua b/runtime/lua/vim/lsp/_meta/protocol.lua
index dc7970c1b4..4c053cb57e 100644
--- a/runtime/lua/vim/lsp/_meta/protocol.lua
+++ b/runtime/lua/vim/lsp/_meta/protocol.lua
@@ -21,99 +21,123 @@ error('Cannot require a meta file')
---Represents a location inside a resource, such as a line
---inside a text file.
---@class lsp.Location
+---
---@field uri lsp.DocumentUri
+---
---@field range lsp.Range
----@class lsp.ImplementationRegistrationOptions: lsp.TextDocumentRegistrationOptions, lsp.StaticRegistrationOptions
+---@class lsp.ImplementationRegistrationOptions: lsp.TextDocumentRegistrationOptions, lsp.ImplementationOptions, lsp.StaticRegistrationOptions
---@class lsp.TypeDefinitionParams: lsp.TextDocumentPositionParams, lsp.WorkDoneProgressParams, lsp.PartialResultParams
----@class lsp.TypeDefinitionRegistrationOptions: lsp.TextDocumentRegistrationOptions, lsp.StaticRegistrationOptions
+---@class lsp.TypeDefinitionRegistrationOptions: lsp.TextDocumentRegistrationOptions, lsp.TypeDefinitionOptions, lsp.StaticRegistrationOptions
---A workspace folder inside a client.
---@class lsp.WorkspaceFolder
+---
---The associated URI for this workspace folder.
---@field uri lsp.URI
+---
---The name of the workspace folder. Used to refer to this
---workspace folder in the user interface.
---@field name string
---The parameters of a `workspace/didChangeWorkspaceFolders` notification.
---@class lsp.DidChangeWorkspaceFoldersParams
+---
---The actual workspace folder change event.
---@field event lsp.WorkspaceFoldersChangeEvent
---The parameters of a configuration request.
---@class lsp.ConfigurationParams
+---
---@field items lsp.ConfigurationItem[]
---Parameters for a {@link DocumentColorRequest}.
----@class lsp.DocumentColorParams
+---@class lsp.DocumentColorParams: lsp.WorkDoneProgressParams, lsp.PartialResultParams
+---
---The text document.
---@field textDocument lsp.TextDocumentIdentifier
---Represents a color range from a document.
---@class lsp.ColorInformation
+---
---The range in the document where this color appears.
---@field range lsp.Range
+---
---The actual color value for this color range.
---@field color lsp.Color
----@class lsp.DocumentColorRegistrationOptions: lsp.TextDocumentRegistrationOptions, lsp.StaticRegistrationOptions
+---@class lsp.DocumentColorRegistrationOptions: lsp.TextDocumentRegistrationOptions, lsp.DocumentColorOptions, lsp.StaticRegistrationOptions
---Parameters for a {@link ColorPresentationRequest}.
----@class lsp.ColorPresentationParams
+---@class lsp.ColorPresentationParams: lsp.WorkDoneProgressParams, lsp.PartialResultParams
+---
---The text document.
---@field textDocument lsp.TextDocumentIdentifier
+---
---The color to request presentations for.
---@field color lsp.Color
+---
---The range where the color would be inserted. Serves as a context.
---@field range lsp.Range
---@class lsp.ColorPresentation
+---
---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.
---@field label string
+---
---An {@link TextEdit edit} which is applied to a document when selecting
---this presentation for the color. When `falsy` the {@link ColorPresentation.label label}
---is used.
---@field textEdit? lsp.TextEdit
+---
---An optional array of additional {@link TextEdit text edits} that are applied when
---selecting this color presentation. Edits must not overlap with the main {@link ColorPresentation.textEdit edit} nor with themselves.
---@field additionalTextEdits? lsp.TextEdit[]
---@class lsp.WorkDoneProgressOptions
+---
---@field workDoneProgress? boolean
---General text document registration options.
---@class lsp.TextDocumentRegistrationOptions
+---
---A document selector to identify the scope of the registration. If set to null
---the document selector provided on the client side will be used.
---@field documentSelector lsp.DocumentSelector|lsp.null
---Parameters for a {@link FoldingRangeRequest}.
----@class lsp.FoldingRangeParams
+---@class lsp.FoldingRangeParams: lsp.WorkDoneProgressParams, lsp.PartialResultParams
+---
---The text document.
---@field textDocument lsp.TextDocumentIdentifier
---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.
---@class lsp.FoldingRange
+---
---The zero-based start line of the range to fold. The folded area starts after the line's last character.
---To be valid, the end must be zero or larger and smaller than the number of lines in the document.
---@field startLine uinteger
+---
---The zero-based character offset from where the folded range starts. If not defined, defaults to the length of the start line.
---@field startCharacter? uinteger
+---
---The zero-based end line of the range to fold. The folded area ends with the line's last character.
---To be valid, the end must be zero or larger and smaller than the number of lines in the document.
---@field endLine uinteger
+---
---The zero-based character offset before the folded range ends. If not defined, defaults to the length of the end line.
---@field endCharacter? uinteger
+---
---Describes the kind of the folding range such as `comment' or 'region'. The kind
---is used to categorize folding ranges and used by commands like 'Fold all comments'.
---See {@link FoldingRangeKind} for an enumeration of standardized kinds.
---@field kind? lsp.FoldingRangeKind
+---
---The text that the client should show when the specified range is
---collapsed. If not defined or not supported by the client, a default
---will be chosen by the client.
@@ -121,34 +145,40 @@ error('Cannot require a meta file')
---@since 3.17.0
---@field collapsedText? string
----@class lsp.FoldingRangeRegistrationOptions: lsp.TextDocumentRegistrationOptions, lsp.StaticRegistrationOptions
+---@class lsp.FoldingRangeRegistrationOptions: lsp.TextDocumentRegistrationOptions, lsp.FoldingRangeOptions, lsp.StaticRegistrationOptions
---@class lsp.DeclarationParams: lsp.TextDocumentPositionParams, lsp.WorkDoneProgressParams, lsp.PartialResultParams
----@class lsp.DeclarationRegistrationOptions: lsp.DeclarationOptions, lsp.StaticRegistrationOptions
+---@class lsp.DeclarationRegistrationOptions: lsp.DeclarationOptions, lsp.TextDocumentRegistrationOptions, lsp.StaticRegistrationOptions
---A parameter literal used in selection range requests.
----@class lsp.SelectionRangeParams
+---@class lsp.SelectionRangeParams: lsp.WorkDoneProgressParams, lsp.PartialResultParams
+---
---The text document.
---@field textDocument lsp.TextDocumentIdentifier
+---
---The positions inside the text document.
---@field positions lsp.Position[]
---A selection range represents a part of a selection hierarchy. A selection range
---may have a parent selection range that contains it.
---@class lsp.SelectionRange
+---
---The {@link Range range} of this selection range.
---@field range lsp.Range
+---
---The parent selection range containing this range. Therefore `parent.range` must contain `this.range`.
---@field parent? lsp.SelectionRange
----@class lsp.SelectionRangeRegistrationOptions: lsp.SelectionRangeOptions, lsp.StaticRegistrationOptions
+---@class lsp.SelectionRangeRegistrationOptions: lsp.SelectionRangeOptions, lsp.TextDocumentRegistrationOptions, lsp.StaticRegistrationOptions
---@class lsp.WorkDoneProgressCreateParams
+---
---The token to be used to report progress.
---@field token lsp.ProgressToken
---@class lsp.WorkDoneProgressCancelParams
+---
---The token to be used to report progress.
---@field token lsp.ProgressToken
@@ -162,21 +192,29 @@ error('Cannot require a meta file')
---
---@since 3.16.0
---@class lsp.CallHierarchyItem
+---
---The name of this item.
---@field name string
+---
---The kind of this item.
---@field kind lsp.SymbolKind
+---
---Tags for this item.
---@field tags? lsp.SymbolTag[]
+---
---More detail for this item, e.g. the signature of a function.
---@field detail? string
+---
---The resource identifier of this item.
---@field uri lsp.DocumentUri
+---
---The range enclosing this symbol not including leading/trailing whitespace but everything else, e.g. comments and code.
---@field range lsp.Range
+---
---The range that should be selected and revealed when this symbol is being picked, e.g. the name of a function.
---Must be contained by the {@link CallHierarchyItem.range `range`}.
---@field selectionRange lsp.Range
+---
---A data entry field that is preserved between a call hierarchy prepare and
---incoming calls or outgoing calls requests.
---@field data? lsp.LSPAny
@@ -184,20 +222,23 @@ error('Cannot require a meta file')
---Call hierarchy options used during static or dynamic registration.
---
---@since 3.16.0
----@class lsp.CallHierarchyRegistrationOptions: lsp.TextDocumentRegistrationOptions, lsp.StaticRegistrationOptions
+---@class lsp.CallHierarchyRegistrationOptions: lsp.TextDocumentRegistrationOptions, lsp.CallHierarchyOptions, lsp.StaticRegistrationOptions
---The parameter of a `callHierarchy/incomingCalls` request.
---
---@since 3.16.0
----@class lsp.CallHierarchyIncomingCallsParams
+---@class lsp.CallHierarchyIncomingCallsParams: lsp.WorkDoneProgressParams, lsp.PartialResultParams
+---
---@field item lsp.CallHierarchyItem
---Represents an incoming call, e.g. a caller of a method or constructor.
---
---@since 3.16.0
---@class lsp.CallHierarchyIncomingCall
+---
---The item that makes the call.
---@field from lsp.CallHierarchyItem
+---
---The ranges at which the calls appear. This is relative to the caller
---denoted by {@link CallHierarchyIncomingCall.from `this.from`}.
---@field fromRanges lsp.Range[]
@@ -205,64 +246,78 @@ error('Cannot require a meta file')
---The parameter of a `callHierarchy/outgoingCalls` request.
---
---@since 3.16.0
----@class lsp.CallHierarchyOutgoingCallsParams
+---@class lsp.CallHierarchyOutgoingCallsParams: lsp.WorkDoneProgressParams, lsp.PartialResultParams
+---
---@field item lsp.CallHierarchyItem
---Represents an outgoing call, e.g. calling a getter from a method or a method from a constructor etc.
---
---@since 3.16.0
---@class lsp.CallHierarchyOutgoingCall
+---
---The item that is called.
---@field to lsp.CallHierarchyItem
+---
---The range at which this item is called. This is the range relative to the caller, e.g the item
---passed to {@link CallHierarchyItemProvider.provideCallHierarchyOutgoingCalls `provideCallHierarchyOutgoingCalls`}
---and not {@link CallHierarchyOutgoingCall.to `this.to`}.
---@field fromRanges lsp.Range[]
---@since 3.16.0
----@class lsp.SemanticTokensParams
+---@class lsp.SemanticTokensParams: lsp.WorkDoneProgressParams, lsp.PartialResultParams
+---
---The text document.
---@field textDocument lsp.TextDocumentIdentifier
---@since 3.16.0
---@class lsp.SemanticTokens
+---
---An optional result id. If provided and clients support delta updating
---the client will include the result id in the next semantic token request.
---A server can then instead of computing all semantic tokens again simply
---send a delta.
---@field resultId? string
+---
---The actual tokens.
---@field data uinteger[]
---@since 3.16.0
---@class lsp.SemanticTokensPartialResult
+---
---@field data uinteger[]
---@since 3.16.0
----@class lsp.SemanticTokensRegistrationOptions: lsp.TextDocumentRegistrationOptions, lsp.StaticRegistrationOptions
+---@class lsp.SemanticTokensRegistrationOptions: lsp.TextDocumentRegistrationOptions, lsp.SemanticTokensOptions, lsp.StaticRegistrationOptions
---@since 3.16.0
----@class lsp.SemanticTokensDeltaParams
+---@class lsp.SemanticTokensDeltaParams: lsp.WorkDoneProgressParams, lsp.PartialResultParams
+---
---The text document.
---@field textDocument lsp.TextDocumentIdentifier
+---
---The result id of a previous response. The result Id can either point to a full response
---or a delta response depending on what was received last.
---@field previousResultId string
---@since 3.16.0
---@class lsp.SemanticTokensDelta
+---
---@field resultId? string
+---
---The semantic token edits to transform a previous result into a new result.
---@field edits lsp.SemanticTokensEdit[]
---@since 3.16.0
---@class lsp.SemanticTokensDeltaPartialResult
+---
---@field edits lsp.SemanticTokensEdit[]
---@since 3.16.0
----@class lsp.SemanticTokensRangeParams
+---@class lsp.SemanticTokensRangeParams: lsp.WorkDoneProgressParams, lsp.PartialResultParams
+---
---The text document.
---@field textDocument lsp.TextDocumentIdentifier
+---
---The range the semantic tokens are requested for.
---@field range lsp.Range
@@ -270,17 +325,21 @@ error('Cannot require a meta file')
---
---@since 3.16.0
---@class lsp.ShowDocumentParams
+---
---The uri to show.
---@field uri lsp.URI
+---
---Indicates to show the resource in an external program.
---To show, for example, `https://code.visualstudio.com/`
---in the default WEB browser set `external` to `true`.
---@field external? boolean
+---
---An optional property to indicate whether the editor
---showing the document should take focus or not.
---Clients might ignore this property if an external
---program is started.
---@field takeFocus? boolean
+---
---An optional selection range if the document is a text
---document. Clients might ignore the property if an
---external program is started or the file is not a text
@@ -291,6 +350,7 @@ error('Cannot require a meta file')
---
---@since 3.16.0
---@class lsp.ShowDocumentResult
+---
---A boolean indicating if the show was successful.
---@field success boolean
@@ -300,21 +360,24 @@ error('Cannot require a meta file')
---
---@since 3.16.0
---@class lsp.LinkedEditingRanges
+---
---A list of ranges that can be edited together. The ranges must have
---identical length and contain identical text content. The ranges cannot overlap.
---@field ranges lsp.Range[]
+---
---An optional word pattern (regular expression) that describes valid contents for
---the given ranges. If no pattern is provided, the client configuration's word
---pattern will be used.
---@field wordPattern? string
----@class lsp.LinkedEditingRangeRegistrationOptions: lsp.TextDocumentRegistrationOptions, lsp.StaticRegistrationOptions
+---@class lsp.LinkedEditingRangeRegistrationOptions: lsp.TextDocumentRegistrationOptions, lsp.LinkedEditingRangeOptions, lsp.StaticRegistrationOptions
---The parameters sent in notifications/requests for user-initiated creation of
---files.
---
---@since 3.16.0
---@class lsp.CreateFilesParams
+---
---An array of all files/folders created in this operation.
---@field files lsp.FileCreate[]
@@ -331,8 +394,10 @@ error('Cannot require a meta file')
---cause failure of the operation. How the client recovers from the failure is described by
---the client capability: `workspace.workspaceEdit.failureHandling`
---@class lsp.WorkspaceEdit
+---
---Holds changes to existing resources.
---@field changes? table<lsp.DocumentUri, lsp.TextEdit[]>
+---
---Depending on the client capability `workspace.workspaceEdit.resourceOperations` document changes
---are either an array of `TextDocumentEdit`s to express changes to n different text documents
---where each text document edit addresses a specific version of a text document. Or it can contain
@@ -344,6 +409,7 @@ error('Cannot require a meta file')
---If a client neither supports `documentChanges` nor `workspace.workspaceEdit.resourceOperations` then
---only plain `TextEdit`s using the `changes` property are supported.
---@field documentChanges? lsp.TextDocumentEdit|lsp.CreateFile|lsp.RenameFile|lsp.DeleteFile[]
+---
---A map of change annotations that can be referenced in `AnnotatedTextEdit`s or create, rename and
---delete file / folder operations.
---
@@ -356,6 +422,7 @@ error('Cannot require a meta file')
---
---@since 3.16.0
---@class lsp.FileOperationRegistrationOptions
+---
---The actual filters.
---@field filters lsp.FileOperationFilter[]
@@ -364,6 +431,7 @@ error('Cannot require a meta file')
---
---@since 3.16.0
---@class lsp.RenameFilesParams
+---
---An array of all files/folders renamed in this operation. When a folder is renamed, only
---the folder will be included, and not its children.
---@field files lsp.FileRename[]
@@ -373,6 +441,7 @@ error('Cannot require a meta file')
---
---@since 3.16.0
---@class lsp.DeleteFilesParams
+---
---An array of all files/folders deleted in this operation.
---@field files lsp.FileDelete[]
@@ -382,17 +451,21 @@ error('Cannot require a meta file')
---
---@since 3.16.0
---@class lsp.Moniker
+---
---The scheme of the moniker. For example tsc or .Net
---@field scheme string
+---
---The identifier of the moniker. The value is opaque in LSIF however
---schema owners are allowed to define the structure if they want.
---@field identifier string
+---
---The scope in which the moniker is unique
---@field unique lsp.UniquenessLevel
+---
---The moniker kind if known.
---@field kind? lsp.MonikerKind
----@class lsp.MonikerRegistrationOptions: lsp.TextDocumentRegistrationOptions
+---@class lsp.MonikerRegistrationOptions: lsp.TextDocumentRegistrationOptions, lsp.MonikerOptions
---The parameter of a `textDocument/prepareTypeHierarchy` request.
---
@@ -401,23 +474,31 @@ error('Cannot require a meta file')
---@since 3.17.0
---@class lsp.TypeHierarchyItem
+---
---The name of this item.
---@field name string
+---
---The kind of this item.
---@field kind lsp.SymbolKind
+---
---Tags for this item.
---@field tags? lsp.SymbolTag[]
+---
---More detail for this item, e.g. the signature of a function.
---@field detail? string
+---
---The resource identifier of this item.
---@field uri lsp.DocumentUri
+---
---The range enclosing this symbol not including leading/trailing whitespace
---but everything else, e.g. comments and code.
---@field range lsp.Range
+---
---The range that should be selected and revealed when this symbol is being
---picked, e.g. the name of a function. Must be contained by the
---{@link TypeHierarchyItem.range `range`}.
---@field selectionRange lsp.Range
+---
---A data entry field that is preserved between a type hierarchy prepare and
---supertypes or subtypes requests. It could also be used to identify the
---type hierarchy in the server, helping improve the performance on
@@ -427,28 +508,33 @@ error('Cannot require a meta file')
---Type hierarchy options used during static or dynamic registration.
---
---@since 3.17.0
----@class lsp.TypeHierarchyRegistrationOptions: lsp.TextDocumentRegistrationOptions, lsp.StaticRegistrationOptions
+---@class lsp.TypeHierarchyRegistrationOptions: lsp.TextDocumentRegistrationOptions, lsp.TypeHierarchyOptions, lsp.StaticRegistrationOptions
---The parameter of a `typeHierarchy/supertypes` request.
---
---@since 3.17.0
----@class lsp.TypeHierarchySupertypesParams
+---@class lsp.TypeHierarchySupertypesParams: lsp.WorkDoneProgressParams, lsp.PartialResultParams
+---
---@field item lsp.TypeHierarchyItem
---The parameter of a `typeHierarchy/subtypes` request.
---
---@since 3.17.0
----@class lsp.TypeHierarchySubtypesParams
+---@class lsp.TypeHierarchySubtypesParams: lsp.WorkDoneProgressParams, lsp.PartialResultParams
+---
---@field item lsp.TypeHierarchyItem
---A parameter literal used in inline value requests.
---
---@since 3.17.0
----@class lsp.InlineValueParams
+---@class lsp.InlineValueParams: lsp.WorkDoneProgressParams
+---
---The text document.
---@field textDocument lsp.TextDocumentIdentifier
+---
---The document range for which inline values should be computed.
---@field range lsp.Range
+---
---Additional information about the context in which inline values were
---requested.
---@field context lsp.InlineValueContext
@@ -456,14 +542,16 @@ error('Cannot require a meta file')
---Inline value options used during static or dynamic registration.
---
---@since 3.17.0
----@class lsp.InlineValueRegistrationOptions: lsp.InlineValueOptions, lsp.StaticRegistrationOptions
+---@class lsp.InlineValueRegistrationOptions: lsp.InlineValueOptions, lsp.TextDocumentRegistrationOptions, lsp.StaticRegistrationOptions
---A parameter literal used in inlay hint requests.
---
---@since 3.17.0
----@class lsp.InlayHintParams
+---@class lsp.InlayHintParams: lsp.WorkDoneProgressParams
+---
---The text document.
---@field textDocument lsp.TextDocumentIdentifier
+---
---The document range for which inlay hints should be computed.
---@field range lsp.Range
@@ -471,39 +559,47 @@ error('Cannot require a meta file')
---
---@since 3.17.0
---@class lsp.InlayHint
+---
---The position of this hint.
---
---If multiple hints have the same position, they will be shown in the order
---they appear in the response.
---@field position lsp.Position
+---
---The label of this hint. A human readable string or an array of
---InlayHintLabelPart label parts.
---
---*Note* that neither the string nor the label part can be empty.
---@field label string|lsp.InlayHintLabelPart[]
+---
---The kind of this hint. Can be omitted in which case the client
---should fall back to a reasonable default.
---@field kind? lsp.InlayHintKind
+---
---Optional text edits that are performed when accepting this inlay hint.
---
---*Note* that edits are expected to change the document so that the inlay
---hint (or its nearest variant) is now part of the document and the inlay
---hint itself is now obsolete.
---@field textEdits? lsp.TextEdit[]
+---
---The tooltip text when you hover over this item.
---@field tooltip? string|lsp.MarkupContent
+---
---Render padding before the hint.
---
---Note: Padding should use the editor's background color, not the
---background color of the hint itself. That means padding can be used
---to visually align/separate an inlay hint.
---@field paddingLeft? boolean
+---
---Render padding after the hint.
---
---Note: Padding should use the editor's background color, not the
---background color of the hint itself. That means padding can be used
---to visually align/separate an inlay hint.
---@field paddingRight? boolean
+---
---A data entry field that is preserved on an inlay hint between
---a `textDocument/inlayHint` and a `inlayHint/resolve` request.
---@field data? lsp.LSPAny
@@ -511,16 +607,19 @@ error('Cannot require a meta file')
---Inlay hint options used during static or dynamic registration.
---
---@since 3.17.0
----@class lsp.InlayHintRegistrationOptions: lsp.InlayHintOptions, lsp.StaticRegistrationOptions
+---@class lsp.InlayHintRegistrationOptions: lsp.InlayHintOptions, lsp.TextDocumentRegistrationOptions, lsp.StaticRegistrationOptions
---Parameters of the document diagnostic request.
---
---@since 3.17.0
----@class lsp.DocumentDiagnosticParams
+---@class lsp.DocumentDiagnosticParams: lsp.WorkDoneProgressParams, lsp.PartialResultParams
+---
---The text document.
---@field textDocument lsp.TextDocumentIdentifier
+---
---The additional identifier provided during registration.
---@field identifier? string
+---
---The result id of a previous response if provided.
---@field previousResultId? string
@@ -528,25 +627,29 @@ error('Cannot require a meta file')
---
---@since 3.17.0
---@class lsp.DocumentDiagnosticReportPartialResult
+---
---@field relatedDocuments table<lsp.DocumentUri, lsp.FullDocumentDiagnosticReport|lsp.UnchangedDocumentDiagnosticReport>
---Cancellation data returned from a diagnostic request.
---
---@since 3.17.0
---@class lsp.DiagnosticServerCancellationData
+---
---@field retriggerRequest boolean
---Diagnostic registration options.
---
---@since 3.17.0
----@class lsp.DiagnosticRegistrationOptions: lsp.TextDocumentRegistrationOptions, lsp.StaticRegistrationOptions
+---@class lsp.DiagnosticRegistrationOptions: lsp.TextDocumentRegistrationOptions, lsp.DiagnosticOptions, lsp.StaticRegistrationOptions
---Parameters of the workspace diagnostic request.
---
---@since 3.17.0
----@class lsp.WorkspaceDiagnosticParams
+---@class lsp.WorkspaceDiagnosticParams: lsp.WorkDoneProgressParams, lsp.PartialResultParams
+---
---The additional identifier provided during registration.
---@field identifier? string
+---
---The currently known diagnostic reports with their
---previous result ids.
---@field previousResultIds lsp.PreviousResultId[]
@@ -555,20 +658,24 @@ error('Cannot require a meta file')
---
---@since 3.17.0
---@class lsp.WorkspaceDiagnosticReport
+---
---@field items lsp.WorkspaceDocumentDiagnosticReport[]
---A partial result for a workspace diagnostic report.
---
---@since 3.17.0
---@class lsp.WorkspaceDiagnosticReportPartialResult
+---
---@field items lsp.WorkspaceDocumentDiagnosticReport[]
---The params sent in an open notebook document notification.
---
---@since 3.17.0
---@class lsp.DidOpenNotebookDocumentParams
+---
---The notebook document that got opened.
---@field notebookDocument lsp.NotebookDocument
+---
---The text documents that represent the content
---of a notebook cell.
---@field cellTextDocuments lsp.TextDocumentItem[]
@@ -577,11 +684,13 @@ error('Cannot require a meta file')
---
---@since 3.17.0
---@class lsp.DidChangeNotebookDocumentParams
+---
---The notebook document that did change. The version number points
---to the version after all provided changes have been applied. If
---only the text document content of a cell changes the notebook version
---doesn't necessarily have to change.
---@field notebookDocument lsp.VersionedNotebookDocumentIdentifier
+---
---The actual changes to the notebook document.
---
---The changes describe single state changes to the notebook document.
@@ -601,6 +710,7 @@ error('Cannot require a meta file')
---
---@since 3.17.0
---@class lsp.DidSaveNotebookDocumentParams
+---
---The notebook document that got saved.
---@field notebookDocument lsp.NotebookDocumentIdentifier
@@ -608,8 +718,10 @@ error('Cannot require a meta file')
---
---@since 3.17.0
---@class lsp.DidCloseNotebookDocumentParams
+---
---The notebook document that got closed.
---@field notebookDocument lsp.NotebookDocumentIdentifier
+---
---The text documents that represent the content
---of a notebook cell that got closed.
---@field cellTextDocuments lsp.TextDocumentIdentifier[]
@@ -619,6 +731,7 @@ error('Cannot require a meta file')
---@since 3.18.0
---@proposed
---@class lsp.InlineCompletionParams: lsp.TextDocumentPositionParams, lsp.WorkDoneProgressParams
+---
---Additional information about the context in which inline completions were
---requested.
---@field context lsp.InlineCompletionContext
@@ -628,6 +741,7 @@ error('Cannot require a meta file')
---@since 3.18.0
---@proposed
---@class lsp.InlineCompletionList
+---
---The inline completion items
---@field items lsp.InlineCompletionItem[]
@@ -636,12 +750,16 @@ error('Cannot require a meta file')
---@since 3.18.0
---@proposed
---@class lsp.InlineCompletionItem
+---
---The text to replace the range with. Must be set.
---@field insertText string|lsp.StringValue
+---
---A text that is used to decide if this inline completion should be shown. When `falsy` the {@link InlineCompletionItem.insertText} is used.
---@field filterText? string
+---
---The range to replace. Must begin and end on the same line.
---@field range? lsp.Range
+---
---An optional {@link Command} that is executed *after* inserting this completion.
---@field command? lsp.Command
@@ -649,28 +767,33 @@ error('Cannot require a meta file')
---
---@since 3.18.0
---@proposed
----@class lsp.InlineCompletionRegistrationOptions: lsp.InlineCompletionOptions, lsp.StaticRegistrationOptions
+---@class lsp.InlineCompletionRegistrationOptions: lsp.InlineCompletionOptions, lsp.TextDocumentRegistrationOptions, lsp.StaticRegistrationOptions
---@class lsp.RegistrationParams
+---
---@field registrations lsp.Registration[]
---@class lsp.UnregistrationParams
+---
---@field unregisterations lsp.Unregistration[]
----@class lsp.InitializeParams: lsp._InitializeParams
+---@class lsp.InitializeParams: lsp._InitializeParams, lsp.WorkspaceFoldersInitializeParams
---The result returned from an initialize request.
---@class lsp.InitializeResult
+---
---The capabilities the language server provides.
---@field capabilities lsp.ServerCapabilities
+---
---Information about the server.
---
---@since 3.15.0
----@field serverInfo? anonym1
+---@field serverInfo? lsp._anonym1.serverInfo
---The data type of the ResponseError if the
---initialize request fails.
---@class lsp.InitializeError
+---
---Indicates whether the client execute the following retry logic:
---(1) show the message provided by the ResponseError to the user
---(2) user selects retry or cancel
@@ -681,49 +804,62 @@ error('Cannot require a meta file')
---The parameters of a change configuration notification.
---@class lsp.DidChangeConfigurationParams
+---
---The actual changed settings
---@field settings lsp.LSPAny
---@class lsp.DidChangeConfigurationRegistrationOptions
+---
---@field section? string|string[]
---The parameters of a notification message.
---@class lsp.ShowMessageParams
+---
---The message type. See {@link MessageType}
---@field type lsp.MessageType
+---
---The actual message.
---@field message string
---@class lsp.ShowMessageRequestParams
+---
---The message type. See {@link MessageType}
---@field type lsp.MessageType
+---
---The actual message.
---@field message string
+---
---The message action items to present.
---@field actions? lsp.MessageActionItem[]
---@class lsp.MessageActionItem
+---
---A short title like 'Retry', 'Open Log' etc.
---@field title string
---The log message parameters.
---@class lsp.LogMessageParams
+---
---The message type. See {@link MessageType}
---@field type lsp.MessageType
+---
---The actual message.
---@field message string
---The parameters sent in an open text document notification
---@class lsp.DidOpenTextDocumentParams
+---
---The document that was opened.
---@field textDocument lsp.TextDocumentItem
---The change text document notification's parameters.
---@class lsp.DidChangeTextDocumentParams
+---
---The document that did change. The version number points
---to the version after all provided content changes have
---been applied.
---@field textDocument lsp.VersionedTextDocumentIdentifier
+---
---The actual content changes. The content changes describe single state changes
---to the document. So if there are two content changes c1 (at array index 0) and
---c2 (at array index 1) for a document in state S then c1 moves the document from
@@ -739,64 +875,78 @@ error('Cannot require a meta file')
---Describe options to be used when registered for text document change events.
---@class lsp.TextDocumentChangeRegistrationOptions: lsp.TextDocumentRegistrationOptions
+---
---How documents are synced to the server.
---@field syncKind lsp.TextDocumentSyncKind
---The parameters sent in a close text document notification
---@class lsp.DidCloseTextDocumentParams
+---
---The document that was closed.
---@field textDocument lsp.TextDocumentIdentifier
---The parameters sent in a save text document notification
---@class lsp.DidSaveTextDocumentParams
+---
---The document that was saved.
---@field textDocument lsp.TextDocumentIdentifier
+---
---Optional the content when saved. Depends on the includeText value
---when the save notification was requested.
---@field text? string
---Save registration options.
----@class lsp.TextDocumentSaveRegistrationOptions: lsp.TextDocumentRegistrationOptions
+---@class lsp.TextDocumentSaveRegistrationOptions: lsp.TextDocumentRegistrationOptions, lsp.SaveOptions
---The parameters sent in a will save text document notification.
---@class lsp.WillSaveTextDocumentParams
+---
---The document that will be saved.
---@field textDocument lsp.TextDocumentIdentifier
+---
---The 'TextDocumentSaveReason'.
---@field reason lsp.TextDocumentSaveReason
---A text edit applicable to a text document.
---@class lsp.TextEdit
+---
---The range of the text document to be manipulated. To insert
---text into a document create a range where start === end.
---@field range lsp.Range
+---
---The string to be inserted. For delete operations use an
---empty string.
---@field newText string
---The watched files change notification's parameters.
---@class lsp.DidChangeWatchedFilesParams
+---
---The actual file events.
---@field changes lsp.FileEvent[]
---Describe options to be used when registered for text document change events.
---@class lsp.DidChangeWatchedFilesRegistrationOptions
+---
---The watchers to register.
---@field watchers lsp.FileSystemWatcher[]
---The publish diagnostic notification's parameters.
---@class lsp.PublishDiagnosticsParams
+---
---The URI for which diagnostic information is reported.
---@field uri lsp.DocumentUri
+---
---Optional the version number of the document the diagnostics are published for.
---
---@since 3.15.0
---@field version? integer
+---
---An array of diagnostic information items.
---@field diagnostics lsp.Diagnostic[]
---Completion parameters
---@class lsp.CompletionParams: lsp.TextDocumentPositionParams, lsp.WorkDoneProgressParams, lsp.PartialResultParams
+---
---The completion context. This is only available it the client specifies
---to send this using the client capability `textDocument.completion.contextSupport === true`
---@field context? lsp.CompletionContext
@@ -804,6 +954,7 @@ error('Cannot require a meta file')
---A completion item represents a text snippet that is
---proposed to complete text that is being typed.
---@class lsp.CompletionItem
+---
---The label of this completion item.
---
---The label property is also by default the text that
@@ -812,39 +963,49 @@ error('Cannot require a meta file')
---If label details are provided the label itself should
---be an unqualified name of the completion item.
---@field label string
+---
---Additional details for the label
---
---@since 3.17.0
---@field labelDetails? lsp.CompletionItemLabelDetails
+---
---The kind of this completion item. Based of the kind
---an icon is chosen by the editor.
---@field kind? lsp.CompletionItemKind
+---
---Tags for this completion item.
---
---@since 3.15.0
---@field tags? lsp.CompletionItemTag[]
+---
---A human-readable string with additional information
---about this item, like type or symbol information.
---@field detail? string
+---
---A human-readable string that represents a doc-comment.
---@field documentation? string|lsp.MarkupContent
+---
---Indicates if this item is deprecated.
---@deprecated Use `tags` instead.
---@field deprecated? boolean
+---
---Select this item when showing.
---
---*Note* that only one completion item can be selected and that the
---tool / client decides which item that is. The rule is that the *first*
---item of those that match best is selected.
---@field preselect? boolean
+---
---A string that should be used when comparing this item
---with other items. When `falsy` the {@link CompletionItem.label label}
---is used.
---@field sortText? string
+---
---A string that should be used when filtering a set of
---completion items. When `falsy` the {@link CompletionItem.label label}
---is used.
---@field filterText? string
+---
---A string that should be inserted into a document when selecting
---this completion. When `falsy` the {@link CompletionItem.label label}
---is used.
@@ -857,6 +1018,7 @@ error('Cannot require a meta file')
---recommended to use `textEdit` instead since it avoids additional client
---side interpretation.
---@field insertText? string
+---
---The format of the insert text. The format applies to both the
---`insertText` property and the `newText` property of a provided
---`textEdit`. If omitted defaults to `InsertTextFormat.PlainText`.
@@ -864,12 +1026,14 @@ error('Cannot require a meta file')
---Please note that the insertTextFormat doesn't apply to
---`additionalTextEdits`.
---@field insertTextFormat? lsp.InsertTextFormat
+---
---How whitespace and indentation is handled during completion
---item insertion. If not provided the clients default value depends on
---the `textDocument.completion.insertTextMode` client capability.
---
---@since 3.16.0
---@field insertTextMode? lsp.InsertTextMode
+---
---An {@link TextEdit edit} which is applied to a document when selecting
---this completion. When an edit is provided the value of
---{@link CompletionItem.insertText insertText} is ignored.
@@ -891,6 +1055,7 @@ error('Cannot require a meta file')
---
---@since 3.16.0 additional type `InsertReplaceEdit`
---@field textEdit? lsp.TextEdit|lsp.InsertReplaceEdit
+---
---The edit text used if the completion item is part of a CompletionList and
---CompletionList defines an item default for the text edit range.
---
@@ -902,6 +1067,7 @@ error('Cannot require a meta file')
---
---@since 3.17.0
---@field textEditText? string
+---
---An optional array of additional {@link TextEdit text edits} that are applied when
---selecting this completion. Edits must not overlap (including the same insert position)
---with the main {@link CompletionItem.textEdit edit} nor with themselves.
@@ -910,14 +1076,17 @@ error('Cannot require a meta file')
---(for example adding an import statement at the top of the file if the completion item will
---insert an unqualified type).
---@field additionalTextEdits? lsp.TextEdit[]
+---
---An optional set of characters that when pressed while this completion is active will accept it first and
---then type that character. *Note* that all commit characters should have `length=1` and that superfluous
---characters will be ignored.
---@field commitCharacters? string[]
+---
---An optional {@link Command command} that is executed *after* inserting this completion. *Note* that
---additional modifications to the current document should be described with the
---{@link CompletionItem.additionalTextEdits additionalTextEdits}-property.
---@field command? lsp.Command
+---
---A data entry field that is preserved on a completion item between a
---{@link CompletionRequest} and a {@link CompletionResolveRequest}.
---@field data? lsp.LSPAny
@@ -925,11 +1094,13 @@ error('Cannot require a meta file')
---Represents a collection of {@link CompletionItem completion items} to be presented
---in the editor.
---@class lsp.CompletionList
+---
---This list it not complete. Further typing results in recomputing this list.
---
---Recomputed lists have all their items replaced (not appended) in the
---incomplete completion sessions.
---@field isIncomplete boolean
+---
---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. A completion list can therefore define item defaults which will
@@ -943,29 +1114,33 @@ error('Cannot require a meta file')
---capability.
---
---@since 3.17.0
----@field itemDefaults? anonym3
+---@field itemDefaults? lsp._anonym2.itemDefaults
+---
---The completion items.
---@field items lsp.CompletionItem[]
---Registration options for a {@link CompletionRequest}.
----@class lsp.CompletionRegistrationOptions: lsp.TextDocumentRegistrationOptions
+---@class lsp.CompletionRegistrationOptions: lsp.TextDocumentRegistrationOptions, lsp.CompletionOptions
---Parameters for a {@link HoverRequest}.
---@class lsp.HoverParams: lsp.TextDocumentPositionParams, lsp.WorkDoneProgressParams
---The result of a hover request.
---@class lsp.Hover
+---
---The hover's content
---@field contents lsp.MarkupContent|lsp.MarkedString|lsp.MarkedString[]
+---
---An optional range inside the text document that is used to
---visualize the hover, e.g. by changing the background color.
---@field range? lsp.Range
---Registration options for a {@link HoverRequest}.
----@class lsp.HoverRegistrationOptions: lsp.TextDocumentRegistrationOptions
+---@class lsp.HoverRegistrationOptions: lsp.TextDocumentRegistrationOptions, lsp.HoverOptions
---Parameters for a {@link SignatureHelpRequest}.
---@class lsp.SignatureHelpParams: lsp.TextDocumentPositionParams, lsp.WorkDoneProgressParams
+---
---The signature help context. This is only available if the client specifies
---to send this using the client capability `textDocument.signatureHelp.contextSupport === true`
---
@@ -976,8 +1151,10 @@ error('Cannot require a meta file')
---callable. There can be multiple signature but only one
---active and only one active parameter.
---@class lsp.SignatureHelp
+---
---One or more signatures.
---@field signatures lsp.SignatureInformation[]
+---
---The active signature. If omitted or the value lies outside the
---range of `signatures` the value defaults to zero or is ignored if
---the `SignatureHelp` has no signatures.
@@ -988,6 +1165,7 @@ error('Cannot require a meta file')
---In future version of the protocol this property might become
---mandatory to better express this.
---@field activeSignature? uinteger
+---
---The active parameter of the active signature.
---
---If `null`, no parameter of the signature is active (for example a named
@@ -1007,20 +1185,21 @@ error('Cannot require a meta file')
---@field activeParameter? uinteger|lsp.null
---Registration options for a {@link SignatureHelpRequest}.
----@class lsp.SignatureHelpRegistrationOptions: lsp.TextDocumentRegistrationOptions
+---@class lsp.SignatureHelpRegistrationOptions: lsp.TextDocumentRegistrationOptions, lsp.SignatureHelpOptions
---Parameters for a {@link DefinitionRequest}.
---@class lsp.DefinitionParams: lsp.TextDocumentPositionParams, lsp.WorkDoneProgressParams, lsp.PartialResultParams
---Registration options for a {@link DefinitionRequest}.
----@class lsp.DefinitionRegistrationOptions: lsp.TextDocumentRegistrationOptions
+---@class lsp.DefinitionRegistrationOptions: lsp.TextDocumentRegistrationOptions, lsp.DefinitionOptions
---Parameters for a {@link ReferencesRequest}.
---@class lsp.ReferenceParams: lsp.TextDocumentPositionParams, lsp.WorkDoneProgressParams, lsp.PartialResultParams
+---
---@field context lsp.ReferenceContext
---Registration options for a {@link ReferencesRequest}.
----@class lsp.ReferenceRegistrationOptions: lsp.TextDocumentRegistrationOptions
+---@class lsp.ReferenceRegistrationOptions: lsp.TextDocumentRegistrationOptions, lsp.ReferenceOptions
---Parameters for a {@link DocumentHighlightRequest}.
---@class lsp.DocumentHighlightParams: lsp.TextDocumentPositionParams, lsp.WorkDoneProgressParams, lsp.PartialResultParams
@@ -1029,26 +1208,31 @@ error('Cannot require a meta file')
---special attention. Usually a document highlight is visualized by changing
---the background color of its range.
---@class lsp.DocumentHighlight
+---
---The range this highlight applies to.
---@field range lsp.Range
+---
---The highlight kind, default is {@link DocumentHighlightKind.Text text}.
---@field kind? lsp.DocumentHighlightKind
---Registration options for a {@link DocumentHighlightRequest}.
----@class lsp.DocumentHighlightRegistrationOptions: lsp.TextDocumentRegistrationOptions
+---@class lsp.DocumentHighlightRegistrationOptions: lsp.TextDocumentRegistrationOptions, lsp.DocumentHighlightOptions
---Parameters for a {@link DocumentSymbolRequest}.
----@class lsp.DocumentSymbolParams
+---@class lsp.DocumentSymbolParams: lsp.WorkDoneProgressParams, lsp.PartialResultParams
+---
---The text document.
---@field textDocument lsp.TextDocumentIdentifier
---Represents information about programming constructs like variables, classes,
---interfaces etc.
---@class lsp.SymbolInformation: lsp.BaseSymbolInformation
+---
---Indicates if this symbol is deprecated.
---
---@deprecated Use tags instead
---@field deprecated? boolean
+---
---The location of this symbol. The location's range is used by a tool
---to reveal the location in the editor. If the symbol is selected in the
---tool the range's start information is used to position the cursor. So
@@ -1065,40 +1249,51 @@ error('Cannot require a meta file')
---have two ranges: one that encloses its definition and one that points to
---its most interesting range, e.g. the range of an identifier.
---@class lsp.DocumentSymbol
+---
---The name of this symbol. Will be displayed in the user interface and therefore must not be
---an empty string or a string only consisting of white spaces.
---@field name string
+---
---More detail for this symbol, e.g the signature of a function.
---@field detail? string
+---
---The kind of this symbol.
---@field kind lsp.SymbolKind
+---
---Tags for this document symbol.
---
---@since 3.16.0
---@field tags? lsp.SymbolTag[]
+---
---Indicates if this symbol is deprecated.
---
---@deprecated Use tags instead
---@field deprecated? boolean
+---
---The range enclosing this symbol not including leading/trailing whitespace but everything else
---like comments. This information is typically used to determine if the clients cursor is
---inside the symbol to reveal in the symbol in the UI.
---@field range lsp.Range
+---
---The range that should be selected and revealed when this symbol is being picked, e.g the name of a function.
---Must be contained by the `range`.
---@field selectionRange lsp.Range
+---
---Children of this symbol, e.g. properties of a class.
---@field children? lsp.DocumentSymbol[]
---Registration options for a {@link DocumentSymbolRequest}.
----@class lsp.DocumentSymbolRegistrationOptions: lsp.TextDocumentRegistrationOptions
+---@class lsp.DocumentSymbolRegistrationOptions: lsp.TextDocumentRegistrationOptions, lsp.DocumentSymbolOptions
---The parameters of a {@link CodeActionRequest}.
----@class lsp.CodeActionParams
+---@class lsp.CodeActionParams: lsp.WorkDoneProgressParams, lsp.PartialResultParams
+---
---The document in which the command was invoked.
---@field textDocument lsp.TextDocumentIdentifier
+---
---The range for which the command was invoked.
---@field range lsp.Range
+---
---Context carrying additional information.
---@field context lsp.CodeActionContext
@@ -1107,10 +1302,13 @@ error('Cannot require a meta file')
---an array of arguments which will be passed to the command handler
---function when invoked.
---@class lsp.Command
+---
---Title of the command, like `save`.
---@field title string
+---
---The identifier of the actual command handler.
---@field command string
+---
---Arguments that the command handler should be
---invoked with.
---@field arguments? lsp.LSPAny[]
@@ -1120,14 +1318,18 @@ error('Cannot require a meta file')
---
---A CodeAction must set either `edit` and/or a `command`. If both are supplied, the `edit` is applied first, then the `command` is executed.
---@class lsp.CodeAction
+---
---A short, human-readable, title for this code action.
---@field title string
+---
---The kind of the code action.
---
---Used to filter code actions.
---@field kind? lsp.CodeActionKind
+---
---The diagnostics that this code action resolves.
---@field diagnostics? lsp.Diagnostic[]
+---
---Marks this as a preferred action. Preferred actions are used by the `auto fix` command and can be targeted
---by keybindings.
---
@@ -1136,6 +1338,7 @@ error('Cannot require a meta file')
---
---@since 3.15.0
---@field isPreferred? boolean
+---
---Marks that the code action cannot currently be applied.
---
---Clients should follow the following guidelines regarding disabled code actions:
@@ -1151,13 +1354,16 @@ error('Cannot require a meta file')
--- error message with `reason` in the editor.
---
---@since 3.16.0
----@field disabled? anonym4
+---@field disabled? lsp._anonym4.disabled
+---
---The workspace edit this code action performs.
---@field edit? lsp.WorkspaceEdit
+---
---A command this code action executes. If a code action
---provides an edit and a command, first the edit is
---executed and then the command.
---@field command? lsp.Command
+---
---A data entry field that is preserved on a code action between
---a `textDocument/codeAction` and a `codeAction/resolve` request.
---
@@ -1165,10 +1371,11 @@ error('Cannot require a meta file')
---@field data? lsp.LSPAny
---Registration options for a {@link CodeActionRequest}.
----@class lsp.CodeActionRegistrationOptions: lsp.TextDocumentRegistrationOptions
+---@class lsp.CodeActionRegistrationOptions: lsp.TextDocumentRegistrationOptions, lsp.CodeActionOptions
---The parameters of a {@link WorkspaceSymbolRequest}.
----@class lsp.WorkspaceSymbolParams
+---@class lsp.WorkspaceSymbolParams: lsp.WorkDoneProgressParams, lsp.PartialResultParams
+---
---A query string to filter symbols by. Clients may send an empty
---string here to request all symbols.
---@field query string
@@ -1179,12 +1386,14 @@ error('Cannot require a meta file')
---
---@since 3.17.0
---@class lsp.WorkspaceSymbol: lsp.BaseSymbolInformation
+---
---The location of the symbol. Whether a server is allowed to
---return a location without a range depends on the client
---capability `workspace.symbol.resolveSupport`.
---
---See SymbolInformation#location for more details.
----@field location lsp.Location|anonym5
+---@field location lsp.Location|lsp._anonym5.location
+---
---A data entry field that is preserved on a workspace symbol between a
---workspace symbol request and a workspace symbol resolve request.
---@field data? lsp.LSPAny
@@ -1193,7 +1402,8 @@ error('Cannot require a meta file')
---@class lsp.WorkspaceSymbolRegistrationOptions: lsp.WorkspaceSymbolOptions
---The parameters of a {@link CodeLensRequest}.
----@class lsp.CodeLensParams
+---@class lsp.CodeLensParams: lsp.WorkDoneProgressParams, lsp.PartialResultParams
+---
---The document to request code lens for.
---@field textDocument lsp.TextDocumentIdentifier
@@ -1203,29 +1413,36 @@ error('Cannot require a meta file')
---A code lens is _unresolved_ when no command is associated to it. For performance
---reasons the creation of a code lens and resolving should be done in two stages.
---@class lsp.CodeLens
+---
---The range in which this code lens is valid. Should only span a single line.
---@field range lsp.Range
+---
---The command this code lens represents.
---@field command? lsp.Command
+---
---A data entry field that is preserved on a code lens item between
---a {@link CodeLensRequest} and a {@link CodeLensResolveRequest}
---@field data? lsp.LSPAny
---Registration options for a {@link CodeLensRequest}.
----@class lsp.CodeLensRegistrationOptions: lsp.TextDocumentRegistrationOptions
+---@class lsp.CodeLensRegistrationOptions: lsp.TextDocumentRegistrationOptions, lsp.CodeLensOptions
---The parameters of a {@link DocumentLinkRequest}.
----@class lsp.DocumentLinkParams
+---@class lsp.DocumentLinkParams: lsp.WorkDoneProgressParams, lsp.PartialResultParams
+---
---The document to provide document links for.
---@field textDocument lsp.TextDocumentIdentifier
---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.
---@class lsp.DocumentLink
+---
---The range this link applies to.
---@field range lsp.Range
+---
---The uri this link points to. If missing a resolve request is sent later.
---@field target? lsp.URI
+---
---The tooltip text when you hover over this link.
---
---If a tooltip is provided, is will be displayed in a string that includes instructions on how to
@@ -1234,86 +1451,104 @@ error('Cannot require a meta file')
---
---@since 3.15.0
---@field tooltip? string
+---
---A data entry field that is preserved on a document link between a
---DocumentLinkRequest and a DocumentLinkResolveRequest.
---@field data? lsp.LSPAny
---Registration options for a {@link DocumentLinkRequest}.
----@class lsp.DocumentLinkRegistrationOptions: lsp.TextDocumentRegistrationOptions
+---@class lsp.DocumentLinkRegistrationOptions: lsp.TextDocumentRegistrationOptions, lsp.DocumentLinkOptions
---The parameters of a {@link DocumentFormattingRequest}.
----@class lsp.DocumentFormattingParams
+---@class lsp.DocumentFormattingParams: lsp.WorkDoneProgressParams
+---
---The document to format.
---@field textDocument lsp.TextDocumentIdentifier
+---
---The format options.
---@field options lsp.FormattingOptions
---Registration options for a {@link DocumentFormattingRequest}.
----@class lsp.DocumentFormattingRegistrationOptions: lsp.TextDocumentRegistrationOptions
+---@class lsp.DocumentFormattingRegistrationOptions: lsp.TextDocumentRegistrationOptions, lsp.DocumentFormattingOptions
---The parameters of a {@link DocumentRangeFormattingRequest}.
----@class lsp.DocumentRangeFormattingParams
+---@class lsp.DocumentRangeFormattingParams: lsp.WorkDoneProgressParams
+---
---The document to format.
---@field textDocument lsp.TextDocumentIdentifier
+---
---The range to format
---@field range lsp.Range
+---
---The format options
---@field options lsp.FormattingOptions
---Registration options for a {@link DocumentRangeFormattingRequest}.
----@class lsp.DocumentRangeFormattingRegistrationOptions: lsp.TextDocumentRegistrationOptions
+---@class lsp.DocumentRangeFormattingRegistrationOptions: lsp.TextDocumentRegistrationOptions, lsp.DocumentRangeFormattingOptions
---The parameters of a {@link DocumentRangesFormattingRequest}.
---
---@since 3.18.0
---@proposed
----@class lsp.DocumentRangesFormattingParams
+---@class lsp.DocumentRangesFormattingParams: lsp.WorkDoneProgressParams
+---
---The document to format.
---@field textDocument lsp.TextDocumentIdentifier
+---
---The ranges to format
---@field ranges lsp.Range[]
+---
---The format options
---@field options lsp.FormattingOptions
---The parameters of a {@link DocumentOnTypeFormattingRequest}.
---@class lsp.DocumentOnTypeFormattingParams
+---
---The document to format.
---@field textDocument lsp.TextDocumentIdentifier
+---
---The position around which the on type formatting should happen.
---This is not necessarily the exact position where the character denoted
---by the property `ch` got typed.
---@field position lsp.Position
+---
---The character that has been typed that triggered the formatting
---on type request. That is not necessarily the last character that
---got inserted into the document since the client could auto insert
---characters as well (e.g. like automatic brace completion).
---@field ch string
+---
---The formatting options.
---@field options lsp.FormattingOptions
---Registration options for a {@link DocumentOnTypeFormattingRequest}.
----@class lsp.DocumentOnTypeFormattingRegistrationOptions: lsp.TextDocumentRegistrationOptions
+---@class lsp.DocumentOnTypeFormattingRegistrationOptions: lsp.TextDocumentRegistrationOptions, lsp.DocumentOnTypeFormattingOptions
---The parameters of a {@link RenameRequest}.
----@class lsp.RenameParams
+---@class lsp.RenameParams: lsp.WorkDoneProgressParams
+---
---The document to rename.
---@field textDocument lsp.TextDocumentIdentifier
+---
---The position at which this request was sent.
---@field position lsp.Position
+---
---The new name of the symbol. If the given name is not valid the
---request must return a {@link ResponseError} with an
---appropriate message set.
---@field newName string
---Registration options for a {@link RenameRequest}.
----@class lsp.RenameRegistrationOptions: lsp.TextDocumentRegistrationOptions
+---@class lsp.RenameRegistrationOptions: lsp.TextDocumentRegistrationOptions, lsp.RenameOptions
---@class lsp.PrepareRenameParams: lsp.TextDocumentPositionParams, lsp.WorkDoneProgressParams
---The parameters of a {@link ExecuteCommandRequest}.
----@class lsp.ExecuteCommandParams
+---@class lsp.ExecuteCommandParams: lsp.WorkDoneProgressParams
+---
---The identifier of the actual command handler.
---@field command string
+---
---Arguments that the command should be invoked with.
---@field arguments? lsp.LSPAny[]
@@ -1322,10 +1557,12 @@ error('Cannot require a meta file')
---The parameters passed via an apply workspace edit request.
---@class lsp.ApplyWorkspaceEditParams
+---
---An optional label of the workspace edit. This label is
---presented in the user interface for example on an undo
---stack to undo the workspace edit.
---@field label? string
+---
---The edits to apply.
---@field edit lsp.WorkspaceEdit
@@ -1333,34 +1570,42 @@ error('Cannot require a meta file')
---
---@since 3.17 renamed from ApplyWorkspaceEditResponse
---@class lsp.ApplyWorkspaceEditResult
+---
---Indicates whether the edit was applied or not.
---@field applied boolean
+---
---An optional textual description for why the edit was not applied.
---This may be used by the server for diagnostic logging or to provide
---a suitable error for a request that triggered the edit.
---@field failureReason? string
+---
---Depending on the client's failure handling strategy `failedChange` might
---contain the index of the change that failed. This property is only available
---if the client signals a `failureHandlingStrategy` in its client capabilities.
---@field failedChange? uinteger
---@class lsp.WorkDoneProgressBegin
+---
---@field kind "begin"
+---
---Mandatory title of the progress operation. Used to briefly inform about
---the kind of operation being performed.
---
---Examples: "Indexing" or "Linking dependencies".
---@field title string
+---
---Controls if a cancel button should show to allow the user to cancel the
---long running operation. Clients that don't support cancellation are allowed
---to ignore the setting.
---@field cancellable? boolean
+---
---Optional, more detailed associated progress message. Contains
---complementary information to the `title`.
---
---Examples: "3/25 files", "project/src/module2", "node_modules/some_dep".
---If unset, the previous progress message (if any) is still valid.
---@field message? string
+---
---Optional progress percentage to display (value 100 is considered 100%).
---If not provided infinite progress is assumed and clients are allowed
---to ignore the `percentage` value in subsequent in report notifications.
@@ -1370,18 +1615,22 @@ error('Cannot require a meta file')
---@field percentage? uinteger
---@class lsp.WorkDoneProgressReport
+---
---@field kind "report"
+---
---Controls enablement state of a cancel button.
---
---Clients that don't support cancellation or don't support controlling the button's
---enablement state are allowed to ignore the property.
---@field cancellable? boolean
+---
---Optional, more detailed associated progress message. Contains
---complementary information to the `title`.
---
---Examples: "3/25 files", "project/src/module2", "node_modules/some_dep".
---If unset, the previous progress message (if any) is still valid.
---@field message? string
+---
---Optional progress percentage to display (value 100 is considered 100%).
---If not provided infinite progress is assumed and clients are allowed
---to ignore the `percentage` value in subsequent in report notifications.
@@ -1391,41 +1640,53 @@ error('Cannot require a meta file')
---@field percentage? uinteger
---@class lsp.WorkDoneProgressEnd
+---
---@field kind "end"
+---
---Optional, a final message indicating to for example indicate the outcome
---of the operation.
---@field message? string
---@class lsp.SetTraceParams
+---
---@field value lsp.TraceValues
---@class lsp.LogTraceParams
+---
---@field message string
+---
---@field verbose? string
---@class lsp.CancelParams
+---
---The request id to cancel.
---@field id integer|string
---@class lsp.ProgressParams
+---
---The progress token provided by the client or server.
---@field token lsp.ProgressToken
+---
---The progress data.
---@field value lsp.LSPAny
---A parameter literal used in requests to pass a text document and a position inside that
---document.
---@class lsp.TextDocumentPositionParams
+---
---The text document.
---@field textDocument lsp.TextDocumentIdentifier
+---
---The position inside the text document.
---@field position lsp.Position
---@class lsp.WorkDoneProgressParams
+---
---An optional token that a server can use to report work done progress.
---@field workDoneToken? lsp.ProgressToken
---@class lsp.PartialResultParams
+---
---An optional token that a server can use to report partial results (e.g. streaming) to
---the client.
---@field partialResultToken? lsp.ProgressToken
@@ -1433,17 +1694,21 @@ error('Cannot require a meta file')
---Represents the connection of two locations. Provides additional metadata over normal {@link Location locations},
---including an origin range.
---@class lsp.LocationLink
+---
---Span of the origin of this link.
---
---Used as the underlined span for mouse interaction. Defaults to the word range at
---the definition position.
---@field originSelectionRange? lsp.Range
+---
---The target resource identifier of this link.
---@field targetUri lsp.DocumentUri
+---
---The full target range of this link. If the target for example is a symbol then target range is the
---range enclosing this symbol not including leading/trailing whitespace but everything else
---like comments. This information is typically used to highlight the range in the editor.
---@field targetRange lsp.Range
+---
---The range that should be selected and revealed when this link is being followed, e.g the name of a function.
---Must be contained by the `targetRange`. See also `DocumentSymbol#range`
---@field targetSelectionRange lsp.Range
@@ -1460,56 +1725,68 @@ error('Cannot require a meta file')
---}
---```
---@class lsp.Range
+---
---The range's start position.
---@field start lsp.Position
+---
---The range's end position.
---@field end lsp.Position
----@class lsp.ImplementationOptions
+---@class lsp.ImplementationOptions: lsp.WorkDoneProgressOptions
---Static registration options to be returned in the initialize
---request.
---@class lsp.StaticRegistrationOptions
+---
---The id used to register the request. The id can be used to deregister
---the request again. See also Registration#id.
---@field id? string
----@class lsp.TypeDefinitionOptions
+---@class lsp.TypeDefinitionOptions: lsp.WorkDoneProgressOptions
---The workspace folder change event.
---@class lsp.WorkspaceFoldersChangeEvent
+---
---The array of added workspace folders
---@field added lsp.WorkspaceFolder[]
+---
---The array of the removed workspace folders
---@field removed lsp.WorkspaceFolder[]
---@class lsp.ConfigurationItem
+---
---The scope to get the configuration section for.
---@field scopeUri? lsp.URI
+---
---The configuration section asked for.
---@field section? string
---A literal to identify a text document in the client.
---@class lsp.TextDocumentIdentifier
+---
---The text document's uri.
---@field uri lsp.DocumentUri
---Represents a color in RGBA space.
---@class lsp.Color
+---
---The red component of this color in the range [0-1].
---@field red decimal
+---
---The green component of this color in the range [0-1].
---@field green decimal
+---
---The blue component of this color in the range [0-1].
---@field blue decimal
+---
---The alpha component of this color in the range [0-1].
---@field alpha decimal
----@class lsp.DocumentColorOptions
+---@class lsp.DocumentColorOptions: lsp.WorkDoneProgressOptions
----@class lsp.FoldingRangeOptions
+---@class lsp.FoldingRangeOptions: lsp.WorkDoneProgressOptions
----@class lsp.DeclarationOptions
+---@class lsp.DeclarationOptions: lsp.WorkDoneProgressOptions
---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
@@ -1539,11 +1816,13 @@ error('Cannot require a meta file')
---
---@since 3.17.0 - support for negotiated position encoding.
---@class lsp.Position
+---
---Line position in a document (zero-based).
---
---If a line number is greater than the number of lines in a document, it defaults back to the number of lines in the document.
---If a line number is negative, it defaults to 0.
---@field line uinteger
+---
---Character offset on a line in a document (zero-based).
---
---The meaning of this offset is determined by the negotiated
@@ -1553,38 +1832,45 @@ error('Cannot require a meta file')
---line length.
---@field character uinteger
----@class lsp.SelectionRangeOptions
+---@class lsp.SelectionRangeOptions: lsp.WorkDoneProgressOptions
---Call hierarchy options used during static registration.
---
---@since 3.16.0
----@class lsp.CallHierarchyOptions
+---@class lsp.CallHierarchyOptions: lsp.WorkDoneProgressOptions
---@since 3.16.0
----@class lsp.SemanticTokensOptions
+---@class lsp.SemanticTokensOptions: lsp.WorkDoneProgressOptions
+---
---The legend used by the server
---@field legend lsp.SemanticTokensLegend
+---
---Server supports providing semantic tokens for a specific range
---of a document.
----@field range? boolean|anonym6
+---@field range? boolean|lsp._anonym6.range
+---
---Server supports providing semantic tokens for a full document.
----@field full? boolean|anonym7
+---@field full? boolean|lsp._anonym7.full
---@since 3.16.0
---@class lsp.SemanticTokensEdit
+---
---The start offset of the edit.
---@field start uinteger
+---
---The count of elements to remove.
---@field deleteCount uinteger
+---
---The elements to insert.
---@field data? uinteger[]
----@class lsp.LinkedEditingRangeOptions
+---@class lsp.LinkedEditingRangeOptions: lsp.WorkDoneProgressOptions
---Represents information on a file/folder create.
---
---@since 3.16.0
---@class lsp.FileCreate
+---
---A file:// URI for the location of the file/folder being created.
---@field uri string
@@ -1593,8 +1879,10 @@ error('Cannot require a meta file')
---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.
---@class lsp.TextDocumentEdit
+---
---The text document to change.
---@field textDocument lsp.OptionalVersionedTextDocumentIdentifier
+---
---The edits to be applied.
---
---@since 3.16.0 - support for AnnotatedTextEdit. This is guarded using a
@@ -1603,30 +1891,40 @@ error('Cannot require a meta file')
---Create file operation.
---@class lsp.CreateFile: lsp.ResourceOperation
+---
---A create
---@field kind "create"
+---
---The resource to create.
---@field uri lsp.DocumentUri
+---
---Additional options
---@field options? lsp.CreateFileOptions
---Rename file operation
---@class lsp.RenameFile: lsp.ResourceOperation
+---
---A rename
---@field kind "rename"
+---
---The old (existing) location.
---@field oldUri lsp.DocumentUri
+---
---The new location.
---@field newUri lsp.DocumentUri
+---
---Rename options.
---@field options? lsp.RenameFileOptions
---Delete file operation
---@class lsp.DeleteFile: lsp.ResourceOperation
+---
---A delete
---@field kind "delete"
+---
---The file to delete.
---@field uri lsp.DocumentUri
+---
---Delete options.
---@field options? lsp.DeleteFileOptions
@@ -1634,12 +1932,15 @@ error('Cannot require a meta file')
---
---@since 3.16.0
---@class lsp.ChangeAnnotation
+---
---A human-readable string describing the actual change. The string
---is rendered prominent in the user interface.
---@field label string
+---
---A flag which indicates that user confirmation is needed
---before applying the change.
---@field needsConfirmation? boolean
+---
---A human-readable string which is rendered less prominent in
---the user interface.
---@field description? string
@@ -1649,8 +1950,10 @@ error('Cannot require a meta file')
---
---@since 3.16.0
---@class lsp.FileOperationFilter
+---
---A Uri scheme like `file` or `untitled`.
---@field scheme? string
+---
---The actual file operation pattern.
---@field pattern lsp.FileOperationPattern
@@ -1658,8 +1961,10 @@ error('Cannot require a meta file')
---
---@since 3.16.0
---@class lsp.FileRename
+---
---A file:// URI for the original location of the file/folder being renamed.
---@field oldUri string
+---
---A file:// URI for the new location of the file/folder being renamed.
---@field newUri string
@@ -1667,20 +1972,23 @@ error('Cannot require a meta file')
---
---@since 3.16.0
---@class lsp.FileDelete
+---
---A file:// URI for the location of the file/folder being deleted.
---@field uri string
----@class lsp.MonikerOptions
+---@class lsp.MonikerOptions: lsp.WorkDoneProgressOptions
---Type hierarchy options used during static registration.
---
---@since 3.17.0
----@class lsp.TypeHierarchyOptions
+---@class lsp.TypeHierarchyOptions: lsp.WorkDoneProgressOptions
---@since 3.17.0
---@class lsp.InlineValueContext
+---
---The stack frame (as a DAP Id) where the execution has stopped.
---@field frameId integer
+---
---The document range where execution has stopped.
---Typically the end position of the range denotes the line where the inline values are shown.
---@field stoppedLocation lsp.Range
@@ -1689,8 +1997,10 @@ error('Cannot require a meta file')
---
---@since 3.17.0
---@class lsp.InlineValueText
+---
---The document range for which the inline value applies.
---@field range lsp.Range
+---
---The text of the inline value.
---@field text string
@@ -1700,11 +2010,14 @@ error('Cannot require a meta file')
---
---@since 3.17.0
---@class lsp.InlineValueVariableLookup
+---
---The document range for which the inline value applies.
---The range is used to extract the variable name from the underlying document.
---@field range lsp.Range
+---
---If specified the name of the variable to look up.
---@field variableName? string
+---
---How to perform the lookup.
---@field caseSensitiveLookup boolean
@@ -1714,28 +2027,33 @@ error('Cannot require a meta file')
---
---@since 3.17.0
---@class lsp.InlineValueEvaluatableExpression
+---
---The document range for which the inline value applies.
---The range is used to extract the evaluatable expression from the underlying document.
---@field range lsp.Range
+---
---If specified the expression overrides the extracted expression.
---@field expression? string
---Inline value options used during static registration.
---
---@since 3.17.0
----@class lsp.InlineValueOptions
+---@class lsp.InlineValueOptions: lsp.WorkDoneProgressOptions
---An inlay hint label part allows for interactive and composite labels
---of inlay hints.
---
---@since 3.17.0
---@class lsp.InlayHintLabelPart
+---
---The value of this label part.
---@field value string
+---
---The tooltip text when you hover over this label part. Depending on
---the client capability `inlayHint.resolveSupport` clients might resolve
---this property late using the resolve request.
---@field tooltip? string|lsp.MarkupContent
+---
---An optional source code location that represents this
---label part.
---
@@ -1748,6 +2066,7 @@ error('Cannot require a meta file')
---Depending on the client capability `inlayHint.resolveSupport` clients
---might resolve this property late using the resolve request.
---@field location? lsp.Location
+---
---An optional command for this label part.
---
---Depending on the client capability `inlayHint.resolveSupport` clients
@@ -1777,15 +2096,18 @@ error('Cannot require a meta file')
---*Please Note* that clients might sanitize the return markdown. A client could decide to
---remove HTML from the markdown to avoid script execution.
---@class lsp.MarkupContent
+---
---The type of the Markup
---@field kind lsp.MarkupKind
+---
---The content itself
---@field value string
---Inlay hint options used during static registration.
---
---@since 3.17.0
----@class lsp.InlayHintOptions
+---@class lsp.InlayHintOptions: lsp.WorkDoneProgressOptions
+---
---The server provides support to resolve additional
---information for an inlay hint item.
---@field resolveProvider? boolean
@@ -1794,6 +2116,7 @@ error('Cannot require a meta file')
---
---@since 3.17.0
---@class lsp.RelatedFullDocumentDiagnosticReport: lsp.FullDocumentDiagnosticReport
+---
---Diagnostics of related documents. This information is useful
---in programming languages where code in a file A can generate
---diagnostics in a file B which A depends on. An example of
@@ -1807,6 +2130,7 @@ error('Cannot require a meta file')
---
---@since 3.17.0
---@class lsp.RelatedUnchangedDocumentDiagnosticReport: lsp.UnchangedDocumentDiagnosticReport
+---
---Diagnostics of related documents. This information is useful
---in programming languages where code in a file A can generate
---diagnostics in a file B which A depends on. An example of
@@ -1820,12 +2144,15 @@ error('Cannot require a meta file')
---
---@since 3.17.0
---@class lsp.FullDocumentDiagnosticReport
+---
---A full document diagnostic report.
---@field kind "full"
+---
---An optional result id. If provided it will
---be sent on the next diagnostic request for the
---same document.
---@field resultId? string
+---
---The actual items.
---@field items lsp.Diagnostic[]
@@ -1834,11 +2161,13 @@ error('Cannot require a meta file')
---
---@since 3.17.0
---@class lsp.UnchangedDocumentDiagnosticReport
+---
---A document diagnostic report indicating
---no changes to the last result. A server can
---only return `unchanged` if result ids are
---provided.
---@field kind "unchanged"
+---
---A result id which will be sent on the next
---diagnostic request for the same document.
---@field resultId string
@@ -1846,15 +2175,18 @@ error('Cannot require a meta file')
---Diagnostic options.
---
---@since 3.17.0
----@class lsp.DiagnosticOptions
+---@class lsp.DiagnosticOptions: lsp.WorkDoneProgressOptions
+---
---An optional identifier under which the diagnostics are
---managed by the client.
---@field identifier? string
+---
---Whether the language has inter file dependencies meaning that
---editing code in one file can result in a different diagnostic
---set in another file. Inter file dependencies are common for
---most programming languages and typically uncommon for linters.
---@field interFileDependencies boolean
+---
---The server provides support for workspace diagnostics as well.
---@field workspaceDiagnostics boolean
@@ -1862,9 +2194,11 @@ error('Cannot require a meta file')
---
---@since 3.17.0
---@class lsp.PreviousResultId
+---
---The URI for which the client knowns a
---result id.
---@field uri lsp.DocumentUri
+---
---The value of the previous result id.
---@field value string
@@ -1872,31 +2206,40 @@ error('Cannot require a meta file')
---
---@since 3.17.0
---@class lsp.NotebookDocument
+---
---The notebook document's uri.
---@field uri lsp.URI
+---
---The type of the notebook.
---@field notebookType string
+---
---The version number of this document (it will increase after each
---change, including undo/redo).
---@field version integer
+---
---Additional metadata stored with the notebook
---document.
---
---Note: should always be an object literal (e.g. LSPObject)
---@field metadata? lsp.LSPObject
+---
---The cells of a notebook.
---@field cells lsp.NotebookCell[]
---An item to transfer a text document from the client to the
---server.
---@class lsp.TextDocumentItem
+---
---The text document's uri.
---@field uri lsp.DocumentUri
+---
---The text document's language identifier.
---@field languageId string
+---
---The version number of this document (it will increase after each
---change, including undo/redo).
---@field version integer
+---
---The content of the opened text document.
---@field text string
@@ -1904,8 +2247,10 @@ error('Cannot require a meta file')
---
---@since 3.17.0
---@class lsp.VersionedNotebookDocumentIdentifier
+---
---The version number of this notebook document.
---@field version integer
+---
---The notebook document's uri.
---@field uri lsp.URI
@@ -1913,17 +2258,20 @@ error('Cannot require a meta file')
---
---@since 3.17.0
---@class lsp.NotebookDocumentChangeEvent
+---
---The changed meta data if any.
---
---Note: should always be an object literal (e.g. LSPObject)
---@field metadata? lsp.LSPObject
+---
---Changes to cells
----@field cells? anonym10
+---@field cells? lsp._anonym8.cells
---A literal to identify a notebook document in the client.
---
---@since 3.17.0
---@class lsp.NotebookDocumentIdentifier
+---
---The notebook document's uri.
---@field uri lsp.URI
@@ -1932,8 +2280,10 @@ error('Cannot require a meta file')
---@since 3.18.0
---@proposed
---@class lsp.InlineCompletionContext
+---
---Describes how the inline completion was triggered.
---@field triggerKind lsp.InlineCompletionTriggerKind
+---
---Provides information about the currently selected item in the autocomplete widget if it is visible.
---@field selectedCompletionInfo? lsp.SelectedCompletionInfo
@@ -1948,8 +2298,10 @@ error('Cannot require a meta file')
---@since 3.18.0
---@proposed
---@class lsp.StringValue
+---
---The kind of string value.
---@field kind "snippet"
+---
---The snippet string.
---@field value string
@@ -1957,38 +2309,46 @@ error('Cannot require a meta file')
---
---@since 3.18.0
---@proposed
----@class lsp.InlineCompletionOptions
+---@class lsp.InlineCompletionOptions: lsp.WorkDoneProgressOptions
---General parameters to register for a notification or to register a provider.
---@class lsp.Registration
+---
---The id used to register the request. The id can be used to deregister
---the request again.
---@field id string
+---
---The method / capability to register for.
---@field method string
+---
---Options necessary for the registration.
---@field registerOptions? lsp.LSPAny
---General parameters to unregister a request or notification.
---@class lsp.Unregistration
+---
---The id used to unregister the request or notification. Usually an id
---provided during the register request.
---@field id string
+---
---The method to unregister for.
---@field method string
---The initialize parameters
----@class lsp._InitializeParams
+---@class lsp._InitializeParams: lsp.WorkDoneProgressParams
+---
---The process Id of the parent process that started
---the server.
---
---Is `null` if the process has not been started by another process.
---If the parent process is not alive then the server should exit.
---@field processId integer|lsp.null
+---
---Information about the client
---
---@since 3.15.0
----@field clientInfo? anonym11
+---@field clientInfo? lsp._anonym11.clientInfo
+---
---The locale the client is currently showing the user interface
---in. This must not necessarily be the locale of the operating
---system.
@@ -1998,25 +2358,31 @@ error('Cannot require a meta file')
---
---@since 3.16.0
---@field locale? string
+---
---The rootPath of the workspace. Is null
---if no folder is open.
---
---@deprecated in favour of rootUri.
---@field rootPath? string|lsp.null
+---
---The rootUri of the workspace. Is null if no
---folder is open. If both `rootPath` and `rootUri` are set
---`rootUri` wins.
---
---@deprecated in favour of workspaceFolders.
---@field rootUri lsp.DocumentUri|lsp.null
+---
---The capabilities provided by the client (editor or tool)
---@field capabilities lsp.ClientCapabilities
+---
---User provided initialization options.
---@field initializationOptions? lsp.LSPAny
+---
---The initial trace setting. If omitted trace is disabled ('off').
---@field trace? lsp.TraceValues
---@class lsp.WorkspaceFoldersInitializeParams
+---
---The workspace folders configured in the client when the server starts.
---
---This property is only available if the client supports workspace folders.
@@ -2029,6 +2395,7 @@ error('Cannot require a meta file')
---Defines the capabilities provided by a language
---server.
---@class lsp.ServerCapabilities
+---
---The position encoding the server picked from the encodings offered
---by the client via the client capability `general.positionEncodings`.
---
@@ -2039,126 +2406,167 @@ error('Cannot require a meta file')
---
---@since 3.17.0
---@field positionEncoding? lsp.PositionEncodingKind
+---
---Defines how text documents are synced. Is either a detailed structure
---defining each notification or for backwards compatibility the
---TextDocumentSyncKind number.
---@field textDocumentSync? lsp.TextDocumentSyncOptions|lsp.TextDocumentSyncKind
+---
---Defines how notebook documents are synced.
---
---@since 3.17.0
---@field notebookDocumentSync? lsp.NotebookDocumentSyncOptions|lsp.NotebookDocumentSyncRegistrationOptions
+---
---The server provides completion support.
---@field completionProvider? lsp.CompletionOptions
+---
---The server provides hover support.
---@field hoverProvider? boolean|lsp.HoverOptions
+---
---The server provides signature help support.
---@field signatureHelpProvider? lsp.SignatureHelpOptions
+---
---The server provides Goto Declaration support.
---@field declarationProvider? boolean|lsp.DeclarationOptions|lsp.DeclarationRegistrationOptions
+---
---The server provides goto definition support.
---@field definitionProvider? boolean|lsp.DefinitionOptions
+---
---The server provides Goto Type Definition support.
---@field typeDefinitionProvider? boolean|lsp.TypeDefinitionOptions|lsp.TypeDefinitionRegistrationOptions
+---
---The server provides Goto Implementation support.
---@field implementationProvider? boolean|lsp.ImplementationOptions|lsp.ImplementationRegistrationOptions
+---
---The server provides find references support.
---@field referencesProvider? boolean|lsp.ReferenceOptions
+---
---The server provides document highlight support.
---@field documentHighlightProvider? boolean|lsp.DocumentHighlightOptions
+---
---The server provides document symbol support.
---@field documentSymbolProvider? boolean|lsp.DocumentSymbolOptions
+---
---The server provides code actions. CodeActionOptions may only be
---specified if the client states that it supports
---`codeActionLiteralSupport` in its initial `initialize` request.
---@field codeActionProvider? boolean|lsp.CodeActionOptions
+---
---The server provides code lens.
---@field codeLensProvider? lsp.CodeLensOptions
+---
---The server provides document link support.
---@field documentLinkProvider? lsp.DocumentLinkOptions
+---
---The server provides color provider support.
---@field colorProvider? boolean|lsp.DocumentColorOptions|lsp.DocumentColorRegistrationOptions
+---
---The server provides workspace symbol support.
---@field workspaceSymbolProvider? boolean|lsp.WorkspaceSymbolOptions
+---
---The server provides document formatting.
---@field documentFormattingProvider? boolean|lsp.DocumentFormattingOptions
+---
---The server provides document range formatting.
---@field documentRangeFormattingProvider? boolean|lsp.DocumentRangeFormattingOptions
+---
---The server provides document formatting on typing.
---@field documentOnTypeFormattingProvider? lsp.DocumentOnTypeFormattingOptions
+---
---The server provides rename support. RenameOptions may only be
---specified if the client states that it supports
---`prepareSupport` in its initial `initialize` request.
---@field renameProvider? boolean|lsp.RenameOptions
+---
---The server provides folding provider support.
---@field foldingRangeProvider? boolean|lsp.FoldingRangeOptions|lsp.FoldingRangeRegistrationOptions
+---
---The server provides selection range support.
---@field selectionRangeProvider? boolean|lsp.SelectionRangeOptions|lsp.SelectionRangeRegistrationOptions
+---
---The server provides execute command support.
---@field executeCommandProvider? lsp.ExecuteCommandOptions
+---
---The server provides call hierarchy support.
---
---@since 3.16.0
---@field callHierarchyProvider? boolean|lsp.CallHierarchyOptions|lsp.CallHierarchyRegistrationOptions
+---
---The server provides linked editing range support.
---
---@since 3.16.0
---@field linkedEditingRangeProvider? boolean|lsp.LinkedEditingRangeOptions|lsp.LinkedEditingRangeRegistrationOptions
+---
---The server provides semantic tokens support.
---
---@since 3.16.0
---@field semanticTokensProvider? lsp.SemanticTokensOptions|lsp.SemanticTokensRegistrationOptions
+---
---The server provides moniker support.
---
---@since 3.16.0
---@field monikerProvider? boolean|lsp.MonikerOptions|lsp.MonikerRegistrationOptions
+---
---The server provides type hierarchy support.
---
---@since 3.17.0
---@field typeHierarchyProvider? boolean|lsp.TypeHierarchyOptions|lsp.TypeHierarchyRegistrationOptions
+---
---The server provides inline values.
---
---@since 3.17.0
---@field inlineValueProvider? boolean|lsp.InlineValueOptions|lsp.InlineValueRegistrationOptions
+---
---The server provides inlay hints.
---
---@since 3.17.0
---@field inlayHintProvider? boolean|lsp.InlayHintOptions|lsp.InlayHintRegistrationOptions
+---
---The server has support for pull model diagnostics.
---
---@since 3.17.0
---@field diagnosticProvider? lsp.DiagnosticOptions|lsp.DiagnosticRegistrationOptions
+---
---Inline completion options used during static registration.
---
---@since 3.18.0
---@proposed
---@field inlineCompletionProvider? boolean|lsp.InlineCompletionOptions
+---
---Workspace specific server capabilities.
----@field workspace? anonym12
+---@field workspace? lsp._anonym12.workspace
+---
---Experimental server capabilities.
---@field experimental? lsp.LSPAny
---A text document identifier to denote a specific version of a text document.
---@class lsp.VersionedTextDocumentIdentifier: lsp.TextDocumentIdentifier
+---
---The version number of this document.
---@field version integer
---Save options.
---@class lsp.SaveOptions
+---
---The client is supposed to include the content on save.
---@field includeText? boolean
---An event describing a file change.
---@class lsp.FileEvent
+---
---The file's uri.
---@field uri lsp.DocumentUri
+---
---The change type.
---@field type lsp.FileChangeType
---@class lsp.FileSystemWatcher
+---
---The glob pattern to watch. See {@link GlobPattern glob pattern} for more detail.
---
---@since 3.17.0 support for relative patterns.
---@field globPattern lsp.GlobPattern
+---
---The kind of events of interest. If omitted it defaults
---to WatchKind.Create | WatchKind.Change | WatchKind.Delete
---which is 7.
@@ -2167,31 +2575,40 @@ error('Cannot require a meta file')
---Represents a diagnostic, such as a compiler error or warning. Diagnostic objects
---are only valid in the scope of a resource.
---@class lsp.Diagnostic
+---
---The range at which the message applies
---@field range lsp.Range
+---
---The diagnostic's severity. Can be omitted. If omitted it is up to the
---client to interpret diagnostics as error, warning, info or hint.
---@field severity? lsp.DiagnosticSeverity
+---
---The diagnostic's code, which usually appear in the user interface.
---@field code? integer|string
+---
---An optional property to describe the error code.
---Requires the code field (above) to be present/not null.
---
---@since 3.16.0
---@field codeDescription? lsp.CodeDescription
+---
---A human-readable string describing the source of this
---diagnostic, e.g. 'typescript' or 'super lint'. It usually
---appears in the user interface.
---@field source? string
+---
---The diagnostic's message. It usually appears in the user interface
---@field message string
+---
---Additional metadata about the diagnostic.
---
---@since 3.15.0
---@field tags? lsp.DiagnosticTag[]
+---
---An array of related diagnostic information, e.g. when symbol-names within
---a scope collide all definitions can be marked via this property.
---@field relatedInformation? lsp.DiagnosticRelatedInformation[]
+---
---A data entry field that is preserved between a `textDocument/publishDiagnostics`
---notification and `textDocument/codeAction` request.
---
@@ -2200,8 +2617,10 @@ error('Cannot require a meta file')
---Contains additional information about the context in which a completion request is triggered.
---@class lsp.CompletionContext
+---
---How the completion was triggered.
---@field triggerKind lsp.CompletionTriggerKind
+---
---The trigger character (a single character) that has trigger code complete.
---Is undefined if `triggerKind !== CompletionTriggerKind.TriggerCharacter`
---@field triggerCharacter? string
@@ -2210,9 +2629,11 @@ error('Cannot require a meta file')
---
---@since 3.17.0
---@class lsp.CompletionItemLabelDetails
+---
---An optional string which is rendered less prominently directly after {@link CompletionItem.label label},
---without any spacing. Should be used for function signatures and type annotations.
---@field detail? string
+---
---An optional string which is rendered less prominently after {@link CompletionItem.detail}. Should be used
---for fully qualified names and file paths.
---@field description? string
@@ -2221,15 +2642,19 @@ error('Cannot require a meta file')
---
---@since 3.16.0
---@class lsp.InsertReplaceEdit
+---
---The string to be inserted.
---@field newText string
+---
---The range if the insert is requested
---@field insert lsp.Range
+---
---The range if the replace is requested.
---@field replace lsp.Range
---Completion options.
----@class lsp.CompletionOptions
+---@class lsp.CompletionOptions: lsp.WorkDoneProgressOptions
+---
---Most tools trigger completion request automatically without explicitly requesting
---it using a keyboard shortcut (e.g. Ctrl+Space). Typically they do so when the user
---starts to type an identifier. For example if the user types `c` in a JavaScript file
@@ -2239,6 +2664,7 @@ error('Cannot require a meta file')
---If code complete should automatically be trigger on characters not being valid inside
---an identifier (for example `.` in JavaScript) list them in `triggerCharacters`.
---@field triggerCharacters? string[]
+---
---The list of all possible characters that commit a completion. This field can be used
---if clients don't support individual commit characters per completion item. See
---`ClientCapabilities.textDocument.completion.completionItem.commitCharactersSupport`
@@ -2248,33 +2674,39 @@ error('Cannot require a meta file')
---
---@since 3.2.0
---@field allCommitCharacters? string[]
+---
---The server provides support to resolve additional
---information for a completion item.
---@field resolveProvider? boolean
+---
---The server supports the following `CompletionItem` specific
---capabilities.
---
---@since 3.17.0
----@field completionItem? anonym13
+---@field completionItem? lsp._anonym13.completionItem
---Hover options.
----@class lsp.HoverOptions
+---@class lsp.HoverOptions: lsp.WorkDoneProgressOptions
---Additional information about the context in which a signature help request was triggered.
---
---@since 3.15.0
---@class lsp.SignatureHelpContext
+---
---Action that caused signature help to be triggered.
---@field triggerKind lsp.SignatureHelpTriggerKind
+---
---Character that caused signature help to be triggered.
---
---This is undefined when `triggerKind !== SignatureHelpTriggerKind.TriggerCharacter`
---@field triggerCharacter? string
+---
---`true` if signature help was already showing when it was triggered.
---
---Retriggers occurs when the signature help is already active and can be caused by actions such as
---typing a trigger character, a cursor move, or document content changes.
---@field isRetrigger boolean
+---
---The currently active `SignatureHelp`.
---
---The `activeSignatureHelp` has its `SignatureHelp.activeSignature` field updated based on
@@ -2285,14 +2717,18 @@ error('Cannot require a meta file')
---can have a label, like a function-name, a doc-comment, and
---a set of parameters.
---@class lsp.SignatureInformation
+---
---The label of this signature. Will be shown in
---the UI.
---@field label string
+---
---The human-readable doc-comment of this signature. Will be shown
---in the UI but can be omitted.
---@field documentation? string|lsp.MarkupContent
+---
---The parameters of this signature.
---@field parameters? lsp.ParameterInformation[]
+---
---The index of the active parameter.
---
---If `null`, no parameter of the signature is active (for example a named
@@ -2307,9 +2743,11 @@ error('Cannot require a meta file')
---@field activeParameter? uinteger|lsp.null
---Server Capabilities for a {@link SignatureHelpRequest}.
----@class lsp.SignatureHelpOptions
+---@class lsp.SignatureHelpOptions: lsp.WorkDoneProgressOptions
+---
---List of characters that trigger signature help automatically.
---@field triggerCharacters? string[]
+---
---List of characters that re-trigger signature help.
---
---These trigger characters are only active when signature help is already showing. All trigger characters
@@ -2319,30 +2757,35 @@ error('Cannot require a meta file')
---@field retriggerCharacters? string[]
---Server Capabilities for a {@link DefinitionRequest}.
----@class lsp.DefinitionOptions
+---@class lsp.DefinitionOptions: lsp.WorkDoneProgressOptions
---Value-object that contains additional information when
---requesting references.
---@class lsp.ReferenceContext
+---
---Include the declaration of the current symbol.
---@field includeDeclaration boolean
---Reference options.
----@class lsp.ReferenceOptions
+---@class lsp.ReferenceOptions: lsp.WorkDoneProgressOptions
---Provider options for a {@link DocumentHighlightRequest}.
----@class lsp.DocumentHighlightOptions
+---@class lsp.DocumentHighlightOptions: lsp.WorkDoneProgressOptions
---A base for all symbol information.
---@class lsp.BaseSymbolInformation
+---
---The name of this symbol.
---@field name string
+---
---The kind of this symbol.
---@field kind lsp.SymbolKind
+---
---Tags for this symbol.
---
---@since 3.16.0
---@field tags? lsp.SymbolTag[]
+---
---The name of the symbol containing this symbol. This information is for
---user interface purposes (e.g. to render a qualifier in the user interface
---if necessary). It can't be used to re-infer a hierarchy for the document
@@ -2350,7 +2793,8 @@ error('Cannot require a meta file')
---@field containerName? string
---Provider options for a {@link DocumentSymbolRequest}.
----@class lsp.DocumentSymbolOptions
+---@class lsp.DocumentSymbolOptions: lsp.WorkDoneProgressOptions
+---
---A human-readable string that is shown when multiple outlines trees
---are shown for the same document.
---
@@ -2360,29 +2804,34 @@ error('Cannot require a meta file')
---Contains additional diagnostic information about the context in which
---a {@link CodeActionProvider.provideCodeActions code action} is run.
---@class lsp.CodeActionContext
+---
---An array of diagnostics known on the client side overlapping the range provided to the
---`textDocument/codeAction` request. They are provided so that the server knows which
---errors are currently presented to the user for the given range. There is no guarantee
---that these accurately reflect the error state of the resource. The primary parameter
---to compute code actions is the provided range.
---@field diagnostics lsp.Diagnostic[]
+---
---Requested kind of actions to return.
---
---Actions not of this kind are filtered out by the client before being shown. So servers
---can omit computing them.
---@field only? lsp.CodeActionKind[]
+---
---The reason why code actions were requested.
---
---@since 3.17.0
---@field triggerKind? lsp.CodeActionTriggerKind
---Provider options for a {@link CodeActionRequest}.
----@class lsp.CodeActionOptions
+---@class lsp.CodeActionOptions: lsp.WorkDoneProgressOptions
+---
---CodeActionKinds that this server may return.
---
---The list of kinds may be generic, such as `CodeActionKind.Refactor`, or the server
---may list out every specific kind they provide.
---@field codeActionKinds? lsp.CodeActionKind[]
+---
---The server provides support to resolve additional
---information for a code action.
---
@@ -2390,7 +2839,8 @@ error('Cannot require a meta file')
---@field resolveProvider? boolean
---Server capabilities for a {@link WorkspaceSymbolRequest}.
----@class lsp.WorkspaceSymbolOptions
+---@class lsp.WorkspaceSymbolOptions: lsp.WorkDoneProgressOptions
+---
---The server provides support to resolve additional
---information for a workspace symbol.
---
@@ -2398,39 +2848,47 @@ error('Cannot require a meta file')
---@field resolveProvider? boolean
---Code Lens provider options of a {@link CodeLensRequest}.
----@class lsp.CodeLensOptions
+---@class lsp.CodeLensOptions: lsp.WorkDoneProgressOptions
+---
---Code lens has a resolve provider as well.
---@field resolveProvider? boolean
---Provider options for a {@link DocumentLinkRequest}.
----@class lsp.DocumentLinkOptions
+---@class lsp.DocumentLinkOptions: lsp.WorkDoneProgressOptions
+---
---Document links have a resolve provider as well.
---@field resolveProvider? boolean
---Value-object describing what options formatting should use.
---@class lsp.FormattingOptions
+---
---Size of a tab in spaces.
---@field tabSize uinteger
+---
---Prefer spaces over tabs.
---@field insertSpaces boolean
+---
---Trim trailing whitespace on a line.
---
---@since 3.15.0
---@field trimTrailingWhitespace? boolean
+---
---Insert a newline character at the end of the file if one does not exist.
---
---@since 3.15.0
---@field insertFinalNewline? boolean
+---
---Trim all newlines after the final newline at the end of the file.
---
---@since 3.15.0
---@field trimFinalNewlines? boolean
---Provider options for a {@link DocumentFormattingRequest}.
----@class lsp.DocumentFormattingOptions
+---@class lsp.DocumentFormattingOptions: lsp.WorkDoneProgressOptions
---Provider options for a {@link DocumentRangeFormattingRequest}.
----@class lsp.DocumentRangeFormattingOptions
+---@class lsp.DocumentRangeFormattingOptions: lsp.WorkDoneProgressOptions
+---
---Whether the server supports formatting multiple ranges at once.
---
---@since 3.18.0
@@ -2439,32 +2897,39 @@ error('Cannot require a meta file')
---Provider options for a {@link DocumentOnTypeFormattingRequest}.
---@class lsp.DocumentOnTypeFormattingOptions
+---
---A character on which formatting should be triggered, like `{`.
---@field firstTriggerCharacter string
+---
---More trigger characters.
---@field moreTriggerCharacter? string[]
---Provider options for a {@link RenameRequest}.
----@class lsp.RenameOptions
+---@class lsp.RenameOptions: lsp.WorkDoneProgressOptions
+---
---Renames should be checked and tested before being executed.
---
---@since version 3.12.0
---@field prepareProvider? boolean
---The server capabilities of a {@link ExecuteCommandRequest}.
----@class lsp.ExecuteCommandOptions
+---@class lsp.ExecuteCommandOptions: lsp.WorkDoneProgressOptions
+---
---The commands to be executed on the server
---@field commands string[]
---@since 3.16.0
---@class lsp.SemanticTokensLegend
+---
---The token types a server uses.
---@field tokenTypes string[]
+---
---The token modifiers a server uses.
---@field tokenModifiers string[]
---A text document identifier to optionally denote a specific version of a text document.
---@class lsp.OptionalVersionedTextDocumentIdentifier: lsp.TextDocumentIdentifier
+---
---The version number of this document. If a versioned text document identifier
---is sent from the server to the client and the file is not open in the editor
---(the server has not received an open notification before) the server can send
@@ -2476,13 +2941,16 @@ error('Cannot require a meta file')
---
---@since 3.16.0.
---@class lsp.AnnotatedTextEdit: lsp.TextEdit
+---
---The actual identifier of the change annotation
---@field annotationId lsp.ChangeAnnotationIdentifier
---A generic resource operation.
---@class lsp.ResourceOperation
+---
---The resource operation kind.
---@field kind string
+---
---An optional annotation identifier describing the operation.
---
---@since 3.16.0
@@ -2490,22 +2958,28 @@ error('Cannot require a meta file')
---Options to create a file.
---@class lsp.CreateFileOptions
+---
---Overwrite existing file. Overwrite wins over `ignoreIfExists`
---@field overwrite? boolean
+---
---Ignore if exists.
---@field ignoreIfExists? boolean
---Rename file options
---@class lsp.RenameFileOptions
+---
---Overwrite target if existing. Overwrite wins over `ignoreIfExists`
---@field overwrite? boolean
+---
---Ignores if target exists.
---@field ignoreIfExists? boolean
---Delete file options
---@class lsp.DeleteFileOptions
+---
---Delete the content recursively if a folder is denoted.
---@field recursive? boolean
+---
---Ignore the operation if the file doesn't exist.
---@field ignoreIfNotExists? boolean
@@ -2514,18 +2988,21 @@ error('Cannot require a meta file')
---
---@since 3.16.0
---@class lsp.FileOperationPattern
+---
---The glob pattern to match. Glob patterns can have the following syntax:
---- `*` to match one or more characters in a path segment
---- `?` to match on one character in a path segment
---- `**` to match any number of path segments, including none
----- `{}` to group sub patterns into an OR expression. (e.g. `**​/*.{ts,js}` matches all TypeScript and JavaScript files)
+---- `{}` to group sub patterns into an OR expression. (e.g. `**/*.{ts,js}` matches all TypeScript and JavaScript files)
---- `[]` to declare a range of characters to match in a path segment (e.g., `example.[0-9]` to match on `example.0`, `example.1`, …)
---- `[!...]` to negate a range of characters to match in a path segment (e.g., `example.[!0-9]` to match on `example.a`, `example.b`, but not `example.0`)
---@field glob string
+---
---Whether to match files or folders with this pattern.
---
---Matches both if undefined.
---@field matches? lsp.FileOperationPatternKind
+---
---Additional options used during matching.
---@field options? lsp.FileOperationPatternOptions
@@ -2533,8 +3010,10 @@ error('Cannot require a meta file')
---
---@since 3.17.0
---@class lsp.WorkspaceFullDocumentDiagnosticReport: lsp.FullDocumentDiagnosticReport
+---
---The URI for which diagnostic information is reported.
---@field uri lsp.DocumentUri
+---
---The version number for which the diagnostics are reported.
---If the document is not marked as open `null` can be provided.
---@field version integer|lsp.null
@@ -2543,8 +3022,10 @@ error('Cannot require a meta file')
---
---@since 3.17.0
---@class lsp.WorkspaceUnchangedDocumentDiagnosticReport: lsp.UnchangedDocumentDiagnosticReport
+---
---The URI for which diagnostic information is reported.
---@field uri lsp.DocumentUri
+---
---The version number for which the diagnostics are reported.
---If the document is not marked as open `null` can be provided.
---@field version integer|lsp.null
@@ -2557,15 +3038,19 @@ error('Cannot require a meta file')
---
---@since 3.17.0
---@class lsp.NotebookCell
+---
---The cell's kind
---@field kind lsp.NotebookCellKind
+---
---The URI of the cell's text document
---content.
---@field document lsp.DocumentUri
+---
---Additional metadata stored with the cell.
---
---Note: should always be an object literal (e.g. LSPObject)
---@field metadata? lsp.LSPObject
+---
---Additional execution summary information
---if supported by the client.
---@field executionSummary? lsp.ExecutionSummary
@@ -2575,10 +3060,13 @@ error('Cannot require a meta file')
---
---@since 3.17.0
---@class lsp.NotebookCellArrayChange
+---
---The start oftest of the cell that changed.
---@field start uinteger
+---
---The deleted cells
---@field deleteCount uinteger
+---
---The new cells, if any
---@field cells? lsp.NotebookCell[]
@@ -2587,43 +3075,56 @@ error('Cannot require a meta file')
---@since 3.18.0
---@proposed
---@class lsp.SelectedCompletionInfo
+---
---The range that will be replaced if this completion item is accepted.
---@field range lsp.Range
+---
---The text the range will be replaced with if this completion is accepted.
---@field text string
---Defines the capabilities provided by the client.
---@class lsp.ClientCapabilities
+---
---Workspace specific client capabilities.
---@field workspace? lsp.WorkspaceClientCapabilities
+---
---Text document specific client capabilities.
---@field textDocument? lsp.TextDocumentClientCapabilities
+---
---Capabilities specific to the notebook document support.
---
---@since 3.17.0
---@field notebookDocument? lsp.NotebookDocumentClientCapabilities
+---
---Window specific client capabilities.
---@field window? lsp.WindowClientCapabilities
+---
---General client capabilities.
---
---@since 3.16.0
---@field general? lsp.GeneralClientCapabilities
+---
---Experimental client capabilities.
---@field experimental? lsp.LSPAny
---@class lsp.TextDocumentSyncOptions
+---
---Open and close notifications are sent to the server. If omitted open close notification should not
---be sent.
---@field openClose? boolean
+---
---Change notifications are sent to the server. See TextDocumentSyncKind.None, TextDocumentSyncKind.Full
---and TextDocumentSyncKind.Incremental. If omitted it defaults to TextDocumentSyncKind.None.
---@field change? lsp.TextDocumentSyncKind
+---
---If present will save notifications are sent to the server. If omitted the notification should not be
---sent.
---@field willSave? boolean
+---
---If present will save wait until requests are sent to the server. If omitted the request should not be
---sent.
---@field willSaveWaitUntil? boolean
+---
---If present save notifications are sent to the server. If omitted the notification should not be
---sent.
---@field save? boolean|lsp.SaveOptions
@@ -2642,8 +3143,10 @@ error('Cannot require a meta file')
---
---@since 3.17.0
---@class lsp.NotebookDocumentSyncOptions
+---
---The notebooks to be synced
----@field notebookSelector anonym15|anonym17[]
+---@field notebookSelector lsp._anonym14.notebookSelector|lsp._anonym16.notebookSelector[]
+---
---Whether save notification should be forwarded to
---the server. Will only be honored if mode === `notebook`.
---@field save? boolean
@@ -2654,8 +3157,10 @@ error('Cannot require a meta file')
---@class lsp.NotebookDocumentSyncRegistrationOptions: lsp.NotebookDocumentSyncOptions, lsp.StaticRegistrationOptions
---@class lsp.WorkspaceFoldersServerCapabilities
+---
---The server has support for workspace folders
---@field supported? boolean
+---
---Whether the server wants to receive workspace folder
---change notifications.
---
@@ -2669,16 +3174,22 @@ error('Cannot require a meta file')
---
---@since 3.16.0
---@class lsp.FileOperationOptions
+---
---The server is interested in receiving didCreateFiles notifications.
---@field didCreate? lsp.FileOperationRegistrationOptions
+---
---The server is interested in receiving willCreateFiles requests.
---@field willCreate? lsp.FileOperationRegistrationOptions
+---
---The server is interested in receiving didRenameFiles notifications.
---@field didRename? lsp.FileOperationRegistrationOptions
+---
---The server is interested in receiving willRenameFiles requests.
---@field willRename? lsp.FileOperationRegistrationOptions
+---
---The server is interested in receiving didDeleteFiles file notifications.
---@field didDelete? lsp.FileOperationRegistrationOptions
+---
---The server is interested in receiving willDeleteFiles file requests.
---@field willDelete? lsp.FileOperationRegistrationOptions
@@ -2686,6 +3197,7 @@ error('Cannot require a meta file')
---
---@since 3.16.0
---@class lsp.CodeDescription
+---
---An URI to open with more information about the diagnostic error.
---@field href lsp.URI
@@ -2693,14 +3205,17 @@ error('Cannot require a meta file')
---used to point to code locations that cause or related to a diagnostics, e.g when duplicating
---a symbol in a scope.
---@class lsp.DiagnosticRelatedInformation
+---
---The location of this related diagnostic information.
---@field location lsp.Location
+---
---The message of this related diagnostic information.
---@field message string
---Represents a parameter of a callable-signature. A parameter can
---have a label and a doc-comment.
---@class lsp.ParameterInformation
+---
---The label of this parameter information.
---
---Either a string or an inclusive start and exclusive end offsets within its containing
@@ -2710,6 +3225,7 @@ error('Cannot require a meta file')
---*Note*: a label of type string should be a substring of its containing signature label.
---Its intended use case is to highlight the parameter label part in the `SignatureInformation.label`.
---@field label string|{ [1]: uinteger, [2]: uinteger }
+---
---The human-readable doc-comment of this parameter. Will be shown
---in the UI but can be omitted.
---@field documentation? string|lsp.MarkupContent
@@ -2719,11 +3235,13 @@ error('Cannot require a meta file')
---
---@since 3.17.0
---@class lsp.NotebookCellTextDocumentFilter
+---
---A filter that matches against the notebook
---containing the notebook cell. If a string
---value is provided it matches against the
---notebook type. '*' matches every notebook.
---@field notebook string|lsp.NotebookDocumentFilter
+---
---A language id like `python`.
---
---Will be matched against the language id of the
@@ -2734,71 +3252,89 @@ error('Cannot require a meta file')
---
---@since 3.16.0
---@class lsp.FileOperationPatternOptions
+---
---The pattern should be matched ignoring casing.
---@field ignoreCase? boolean
---@class lsp.ExecutionSummary
+---
---A strict monotonically increasing value
---indicating the execution order of a cell
---inside a notebook.
---@field executionOrder uinteger
+---
---Whether the execution was successful or
---not if known by the client.
---@field success? boolean
---Workspace specific client capabilities.
---@class lsp.WorkspaceClientCapabilities
+---
---The client supports applying batch edits
---to the workspace by supporting the request
---'workspace/applyEdit'
---@field applyEdit? boolean
+---
---Capabilities specific to `WorkspaceEdit`s.
---@field workspaceEdit? lsp.WorkspaceEditClientCapabilities
+---
---Capabilities specific to the `workspace/didChangeConfiguration` notification.
---@field didChangeConfiguration? lsp.DidChangeConfigurationClientCapabilities
+---
---Capabilities specific to the `workspace/didChangeWatchedFiles` notification.
---@field didChangeWatchedFiles? lsp.DidChangeWatchedFilesClientCapabilities
+---
---Capabilities specific to the `workspace/symbol` request.
---@field symbol? lsp.WorkspaceSymbolClientCapabilities
+---
---Capabilities specific to the `workspace/executeCommand` request.
---@field executeCommand? lsp.ExecuteCommandClientCapabilities
+---
---The client has support for workspace folders.
---
---@since 3.6.0
---@field workspaceFolders? boolean
+---
---The client supports `workspace/configuration` requests.
---
---@since 3.6.0
---@field configuration? boolean
+---
---Capabilities specific to the semantic token requests scoped to the
---workspace.
---
---@since 3.16.0.
---@field semanticTokens? lsp.SemanticTokensWorkspaceClientCapabilities
+---
---Capabilities specific to the code lens requests scoped to the
---workspace.
---
---@since 3.16.0.
---@field codeLens? lsp.CodeLensWorkspaceClientCapabilities
+---
---The client has support for file notifications/requests for user operations on files.
---
---Since 3.16.0
---@field fileOperations? lsp.FileOperationClientCapabilities
+---
---Capabilities specific to the inline values requests scoped to the
---workspace.
---
---@since 3.17.0.
---@field inlineValue? lsp.InlineValueWorkspaceClientCapabilities
+---
---Capabilities specific to the inlay hint requests scoped to the
---workspace.
---
---@since 3.17.0.
---@field inlayHint? lsp.InlayHintWorkspaceClientCapabilities
+---
---Capabilities specific to the diagnostic requests scoped to the
---workspace.
---
---@since 3.17.0.
---@field diagnostics? lsp.DiagnosticWorkspaceClientCapabilities
+---
---Capabilities specific to the folding range requests scoped to the workspace.
---
---@since 3.18.0
@@ -2807,95 +3343,126 @@ error('Cannot require a meta file')
---Text document specific client capabilities.
---@class lsp.TextDocumentClientCapabilities
+---
---Defines which synchronization capabilities the client supports.
---@field synchronization? lsp.TextDocumentSyncClientCapabilities
+---
---Capabilities specific to the `textDocument/completion` request.
---@field completion? lsp.CompletionClientCapabilities
+---
---Capabilities specific to the `textDocument/hover` request.
---@field hover? lsp.HoverClientCapabilities
+---
---Capabilities specific to the `textDocument/signatureHelp` request.
---@field signatureHelp? lsp.SignatureHelpClientCapabilities
+---
---Capabilities specific to the `textDocument/declaration` request.
---
---@since 3.14.0
---@field declaration? lsp.DeclarationClientCapabilities
+---
---Capabilities specific to the `textDocument/definition` request.
---@field definition? lsp.DefinitionClientCapabilities
+---
---Capabilities specific to the `textDocument/typeDefinition` request.
---
---@since 3.6.0
---@field typeDefinition? lsp.TypeDefinitionClientCapabilities
+---
---Capabilities specific to the `textDocument/implementation` request.
---
---@since 3.6.0
---@field implementation? lsp.ImplementationClientCapabilities
+---
---Capabilities specific to the `textDocument/references` request.
---@field references? lsp.ReferenceClientCapabilities
+---
---Capabilities specific to the `textDocument/documentHighlight` request.
---@field documentHighlight? lsp.DocumentHighlightClientCapabilities
+---
---Capabilities specific to the `textDocument/documentSymbol` request.
---@field documentSymbol? lsp.DocumentSymbolClientCapabilities
+---
---Capabilities specific to the `textDocument/codeAction` request.
---@field codeAction? lsp.CodeActionClientCapabilities
+---
---Capabilities specific to the `textDocument/codeLens` request.
---@field codeLens? lsp.CodeLensClientCapabilities
+---
---Capabilities specific to the `textDocument/documentLink` request.
---@field documentLink? lsp.DocumentLinkClientCapabilities
+---
---Capabilities specific to the `textDocument/documentColor` and the
---`textDocument/colorPresentation` request.
---
---@since 3.6.0
---@field colorProvider? lsp.DocumentColorClientCapabilities
+---
---Capabilities specific to the `textDocument/formatting` request.
---@field formatting? lsp.DocumentFormattingClientCapabilities
+---
---Capabilities specific to the `textDocument/rangeFormatting` request.
---@field rangeFormatting? lsp.DocumentRangeFormattingClientCapabilities
+---
---Capabilities specific to the `textDocument/onTypeFormatting` request.
---@field onTypeFormatting? lsp.DocumentOnTypeFormattingClientCapabilities
+---
---Capabilities specific to the `textDocument/rename` request.
---@field rename? lsp.RenameClientCapabilities
+---
---Capabilities specific to the `textDocument/foldingRange` request.
---
---@since 3.10.0
---@field foldingRange? lsp.FoldingRangeClientCapabilities
+---
---Capabilities specific to the `textDocument/selectionRange` request.
---
---@since 3.15.0
---@field selectionRange? lsp.SelectionRangeClientCapabilities
+---
---Capabilities specific to the `textDocument/publishDiagnostics` notification.
---@field publishDiagnostics? lsp.PublishDiagnosticsClientCapabilities
+---
---Capabilities specific to the various call hierarchy requests.
---
---@since 3.16.0
---@field callHierarchy? lsp.CallHierarchyClientCapabilities
+---
---Capabilities specific to the various semantic token request.
---
---@since 3.16.0
---@field semanticTokens? lsp.SemanticTokensClientCapabilities
+---
---Capabilities specific to the `textDocument/linkedEditingRange` request.
---
---@since 3.16.0
---@field linkedEditingRange? lsp.LinkedEditingRangeClientCapabilities
+---
---Client capabilities specific to the `textDocument/moniker` request.
---
---@since 3.16.0
---@field moniker? lsp.MonikerClientCapabilities
+---
---Capabilities specific to the various type hierarchy requests.
---
---@since 3.17.0
---@field typeHierarchy? lsp.TypeHierarchyClientCapabilities
+---
---Capabilities specific to the `textDocument/inlineValue` request.
---
---@since 3.17.0
---@field inlineValue? lsp.InlineValueClientCapabilities
+---
---Capabilities specific to the `textDocument/inlayHint` request.
---
---@since 3.17.0
---@field inlayHint? lsp.InlayHintClientCapabilities
+---
---Capabilities specific to the diagnostic pull model.
---
---@since 3.17.0
---@field diagnostic? lsp.DiagnosticClientCapabilities
+---
---Client capabilities specific to inline completions.
---
---@since 3.18.0
@@ -2906,12 +3473,14 @@ error('Cannot require a meta file')
---
---@since 3.17.0
---@class lsp.NotebookDocumentClientCapabilities
+---
---Capabilities specific to notebook document synchronization
---
---@since 3.17.0
---@field synchronization lsp.NotebookDocumentSyncClientCapabilities
---@class lsp.WindowClientCapabilities
+---
---It indicates whether the client supports server initiated
---progress using the `window/workDoneProgress/create` request.
---
@@ -2922,10 +3491,12 @@ error('Cannot require a meta file')
---
---@since 3.15.0
---@field workDoneProgress? boolean
+---
---Capabilities specific to the showMessage request.
---
---@since 3.16.0
---@field showMessage? lsp.ShowMessageRequestClientCapabilities
+---
---Capabilities specific to the showDocument request.
---
---@since 3.16.0
@@ -2935,21 +3506,25 @@ error('Cannot require a meta file')
---
---@since 3.16.0
---@class lsp.GeneralClientCapabilities
+---
---Client capability that signals how the client
---handles stale requests (e.g. a request
---for which the client will not process the response
---anymore since the information is outdated).
---
---@since 3.17.0
----@field staleRequestSupport? anonym18
+---@field staleRequestSupport? lsp._anonym18.staleRequestSupport
+---
---Client capabilities specific to regular expressions.
---
---@since 3.16.0
---@field regularExpressions? lsp.RegularExpressionsClientCapabilities
+---
---Client capabilities specific to the client's markdown parser.
---
---@since 3.16.0
---@field markdown? lsp.MarkdownClientCapabilities
+---
---The position encodings supported by the client. Client and server
---have to agree on the same position encoding to ensure that offsets
---(e.g. character position in a line) are interpreted the same on both
@@ -2976,25 +3551,31 @@ error('Cannot require a meta file')
---
---@since 3.17.0
---@class lsp.RelativePattern
+---
---A workspace folder or a base URI to which this pattern will be matched
---against relatively.
---@field baseUri lsp.WorkspaceFolder|lsp.URI
+---
---The actual glob pattern;
---@field pattern lsp.Pattern
---@class lsp.WorkspaceEditClientCapabilities
+---
---The client supports versioned document changes in `WorkspaceEdit`s
---@field documentChanges? boolean
+---
---The resource operations the client supports. Clients should at least
---support 'create', 'rename' and 'delete' files and folders.
---
---@since 3.13.0
---@field resourceOperations? lsp.ResourceOperationKind[]
+---
---The failure handling strategy of a client if applying the workspace edit
---fails.
---
---@since 3.13.0
---@field failureHandling? lsp.FailureHandlingKind
+---
---Whether the client normalizes line endings to the client specific
---setting.
---If set to `true` the client will normalize line ending characters
@@ -3003,21 +3584,25 @@ error('Cannot require a meta file')
---
---@since 3.16.0
---@field normalizesLineEndings? boolean
+---
---Whether the client in general supports change annotations on text edits,
---create file, rename file and delete file changes.
---
---@since 3.16.0
----@field changeAnnotationSupport? anonym19
+---@field changeAnnotationSupport? lsp._anonym19.changeAnnotationSupport
---@class lsp.DidChangeConfigurationClientCapabilities
+---
---Did change configuration notification supports dynamic registration.
---@field dynamicRegistration? boolean
---@class lsp.DidChangeWatchedFilesClientCapabilities
+---
---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.
---@field dynamicRegistration? boolean
+---
---Whether the client has support for {@link RelativePattern relative pattern}
---or not.
---
@@ -3026,29 +3611,35 @@ error('Cannot require a meta file')
---Client capabilities for a {@link WorkspaceSymbolRequest}.
---@class lsp.WorkspaceSymbolClientCapabilities
+---
---Symbol request supports dynamic registration.
---@field dynamicRegistration? boolean
+---
---Specific capabilities for the `SymbolKind` in the `workspace/symbol` request.
----@field symbolKind? anonym20
+---@field symbolKind? lsp._anonym20.symbolKind
+---
---The client supports tags on `SymbolInformation`.
---Clients supporting tags have to handle unknown tags gracefully.
---
---@since 3.16.0
----@field tagSupport? anonym21
+---@field tagSupport? lsp._anonym21.tagSupport
+---
---The client support partial workspace symbols. The client will send the
---request `workspaceSymbol/resolve` to the server to resolve additional
---properties.
---
---@since 3.17.0
----@field resolveSupport? anonym22
+---@field resolveSupport? lsp._anonym22.resolveSupport
---The client capabilities of a {@link ExecuteCommandRequest}.
---@class lsp.ExecuteCommandClientCapabilities
+---
---Execute command supports dynamic registration.
---@field dynamicRegistration? boolean
---@since 3.16.0
---@class lsp.SemanticTokensWorkspaceClientCapabilities
+---
---Whether the client implementation supports a refresh request sent from
---the server to the client.
---
@@ -3060,6 +3651,7 @@ error('Cannot require a meta file')
---@since 3.16.0
---@class lsp.CodeLensWorkspaceClientCapabilities
+---
---Whether the client implementation supports a refresh request sent from the
---server to the client.
---
@@ -3076,18 +3668,25 @@ error('Cannot require a meta file')
---
---@since 3.16.0
---@class lsp.FileOperationClientCapabilities
+---
---Whether the client supports dynamic registration for file requests/notifications.
---@field dynamicRegistration? boolean
+---
---The client has support for sending didCreateFiles notifications.
---@field didCreate? boolean
+---
---The client has support for sending willCreateFiles requests.
---@field willCreate? boolean
+---
---The client has support for sending didRenameFiles notifications.
---@field didRename? boolean
+---
---The client has support for sending willRenameFiles requests.
---@field willRename? boolean
+---
---The client has support for sending didDeleteFiles notifications.
---@field didDelete? boolean
+---
---The client has support for sending willDeleteFiles requests.
---@field willDelete? boolean
@@ -3095,6 +3694,7 @@ error('Cannot require a meta file')
---
---@since 3.17.0
---@class lsp.InlineValueWorkspaceClientCapabilities
+---
---Whether the client implementation supports a refresh request sent from the
---server to the client.
---
@@ -3108,6 +3708,7 @@ error('Cannot require a meta file')
---
---@since 3.17.0
---@class lsp.InlayHintWorkspaceClientCapabilities
+---
---Whether the client implementation supports a refresh request sent from
---the server to the client.
---
@@ -3121,6 +3722,7 @@ error('Cannot require a meta file')
---
---@since 3.17.0
---@class lsp.DiagnosticWorkspaceClientCapabilities
+---
---Whether the client implementation supports a refresh request sent from
---the server to the client.
---
@@ -3135,6 +3737,7 @@ error('Cannot require a meta file')
---@since 3.18.0
---@proposed
---@class lsp.FoldingRangeWorkspaceClientCapabilities
+---
---Whether the client implementation supports a refresh request sent from the
---server to the client.
---
@@ -3148,54 +3751,69 @@ error('Cannot require a meta file')
---@field refreshSupport? boolean
---@class lsp.TextDocumentSyncClientCapabilities
+---
---Whether text document synchronization supports dynamic registration.
---@field dynamicRegistration? boolean
+---
---The client supports sending will save notifications.
---@field willSave? boolean
+---
---The client supports sending a will save request and
---waits for a response providing text edits which will
---be applied to the document before it is saved.
---@field willSaveWaitUntil? boolean
+---
---The client supports did save notifications.
---@field didSave? boolean
---Completion client capabilities
---@class lsp.CompletionClientCapabilities
+---
---Whether completion supports dynamic registration.
---@field dynamicRegistration? boolean
+---
---The client supports the following `CompletionItem` specific
---capabilities.
----@field completionItem? anonym26
----@field completionItemKind? anonym27
+---@field completionItem? lsp._anonym23.completionItem
+---
+---@field completionItemKind? lsp._anonym27.completionItemKind
+---
---Defines how the client handles whitespace and indentation
---when accepting a completion item that uses multi line
---text in either `insertText` or `textEdit`.
---
---@since 3.17.0
---@field insertTextMode? lsp.InsertTextMode
+---
---The client supports to send additional context information for a
---`textDocument/completion` request.
---@field contextSupport? boolean
+---
---The client supports the following `CompletionList` specific
---capabilities.
---
---@since 3.17.0
----@field completionList? anonym28
+---@field completionList? lsp._anonym28.completionList
---@class lsp.HoverClientCapabilities
+---
---Whether hover supports dynamic registration.
---@field dynamicRegistration? boolean
+---
---Client supports the following content formats for the content
---property. The order describes the preferred format of the client.
---@field contentFormat? lsp.MarkupKind[]
---Client Capabilities for a {@link SignatureHelpRequest}.
---@class lsp.SignatureHelpClientCapabilities
+---
---Whether signature help supports dynamic registration.
---@field dynamicRegistration? boolean
+---
---The client supports the following `SignatureInformation`
---specific properties.
----@field signatureInformation? anonym30
+---@field signatureInformation? lsp._anonym29.signatureInformation
+---
---The client supports to send additional context information for a
---`textDocument/signatureHelp` request. A client that opts into
---contextSupport will also support the `retriggerCharacters` on
@@ -3206,17 +3824,21 @@ error('Cannot require a meta file')
---@since 3.14.0
---@class lsp.DeclarationClientCapabilities
+---
---Whether declaration supports dynamic registration. If this is set to `true`
---the client supports the new `DeclarationRegistrationOptions` return value
---for the corresponding server capability as well.
---@field dynamicRegistration? boolean
+---
---The client supports additional metadata in the form of declaration links.
---@field linkSupport? boolean
---Client Capabilities for a {@link DefinitionRequest}.
---@class lsp.DefinitionClientCapabilities
+---
---Whether definition supports dynamic registration.
---@field dynamicRegistration? boolean
+---
---The client supports additional metadata in the form of definition links.
---
---@since 3.14.0
@@ -3224,10 +3846,12 @@ error('Cannot require a meta file')
---Since 3.6.0
---@class lsp.TypeDefinitionClientCapabilities
+---
---Whether implementation supports dynamic registration. If this is set to `true`
---the client supports the new `TypeDefinitionRegistrationOptions` return value
---for the corresponding server capability as well.
---@field dynamicRegistration? boolean
+---
---The client supports additional metadata in the form of definition links.
---
---Since 3.14.0
@@ -3235,10 +3859,12 @@ error('Cannot require a meta file')
---@since 3.6.0
---@class lsp.ImplementationClientCapabilities
+---
---Whether implementation supports dynamic registration. If this is set to `true`
---the client supports the new `ImplementationRegistrationOptions` return value
---for the corresponding server capability as well.
---@field dynamicRegistration? boolean
+---
---The client supports additional metadata in the form of definition links.
---
---@since 3.14.0
@@ -3246,29 +3872,36 @@ error('Cannot require a meta file')
---Client Capabilities for a {@link ReferencesRequest}.
---@class lsp.ReferenceClientCapabilities
+---
---Whether references supports dynamic registration.
---@field dynamicRegistration? boolean
---Client Capabilities for a {@link DocumentHighlightRequest}.
---@class lsp.DocumentHighlightClientCapabilities
+---
---Whether document highlight supports dynamic registration.
---@field dynamicRegistration? boolean
---Client Capabilities for a {@link DocumentSymbolRequest}.
---@class lsp.DocumentSymbolClientCapabilities
+---
---Whether document symbol supports dynamic registration.
---@field dynamicRegistration? boolean
+---
---Specific capabilities for the `SymbolKind` in the
---`textDocument/documentSymbol` request.
----@field symbolKind? anonym31
+---@field symbolKind? lsp._anonym31.symbolKind
+---
---The client supports hierarchical document symbols.
---@field hierarchicalDocumentSymbolSupport? boolean
+---
---The client supports tags on `SymbolInformation`. Tags are supported on
---`DocumentSymbol` if `hierarchicalDocumentSymbolSupport` is set to true.
---Clients supporting tags have to handle unknown tags gracefully.
---
---@since 3.16.0
----@field tagSupport? anonym32
+---@field tagSupport? lsp._anonym32.tagSupport
+---
---The client supports an additional label presented in the UI when
---registering a document symbol provider.
---
@@ -3277,33 +3910,40 @@ error('Cannot require a meta file')
---The Client Capabilities of a {@link CodeActionRequest}.
---@class lsp.CodeActionClientCapabilities
+---
---Whether code action supports dynamic registration.
---@field dynamicRegistration? boolean
+---
---The client support code action literals of type `CodeAction` as a valid
---response of the `textDocument/codeAction` request. If the property is not
---set the request can only return `Command` literals.
---
---@since 3.8.0
----@field codeActionLiteralSupport? anonym34
+---@field codeActionLiteralSupport? lsp._anonym33.codeActionLiteralSupport
+---
---Whether code action supports the `isPreferred` property.
---
---@since 3.15.0
---@field isPreferredSupport? boolean
+---
---Whether code action supports the `disabled` property.
---
---@since 3.16.0
---@field disabledSupport? boolean
+---
---Whether code action supports the `data` property which is
---preserved between a `textDocument/codeAction` and a
---`codeAction/resolve` request.
---
---@since 3.16.0
---@field dataSupport? boolean
+---
---Whether the client supports resolving additional code action
---properties via a separate `codeAction/resolve` request.
---
---@since 3.16.0
----@field resolveSupport? anonym35
+---@field resolveSupport? lsp._anonym35.resolveSupport
+---
---Whether the client honors the change annotations in
---text edits and resource operations returned via the
---`CodeAction#edit` property by for example presenting
@@ -3315,19 +3955,23 @@ error('Cannot require a meta file')
---The client capabilities of a {@link CodeLensRequest}.
---@class lsp.CodeLensClientCapabilities
+---
---Whether code lens supports dynamic registration.
---@field dynamicRegistration? boolean
---The client capabilities of a {@link DocumentLinkRequest}.
---@class lsp.DocumentLinkClientCapabilities
+---
---Whether document link supports dynamic registration.
---@field dynamicRegistration? boolean
+---
---Whether the client supports the `tooltip` property on `DocumentLink`.
---
---@since 3.15.0
---@field tooltipSupport? boolean
---@class lsp.DocumentColorClientCapabilities
+---
---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.
@@ -3335,13 +3979,16 @@ error('Cannot require a meta file')
---Client capabilities of a {@link DocumentFormattingRequest}.
---@class lsp.DocumentFormattingClientCapabilities
+---
---Whether formatting supports dynamic registration.
---@field dynamicRegistration? boolean
---Client capabilities of a {@link DocumentRangeFormattingRequest}.
---@class lsp.DocumentRangeFormattingClientCapabilities
+---
---Whether range formatting supports dynamic registration.
---@field dynamicRegistration? boolean
+---
---Whether the client supports formatting multiple ranges at once.
---
---@since 3.18.0
@@ -3350,17 +3997,21 @@ error('Cannot require a meta file')
---Client capabilities of a {@link DocumentOnTypeFormattingRequest}.
---@class lsp.DocumentOnTypeFormattingClientCapabilities
+---
---Whether on type formatting supports dynamic registration.
---@field dynamicRegistration? boolean
---@class lsp.RenameClientCapabilities
+---
---Whether rename supports dynamic registration.
---@field dynamicRegistration? boolean
+---
---Client supports testing for validity of rename operations
---before execution.
---
---@since 3.12.0
---@field prepareSupport? boolean
+---
---Client supports the default behavior result.
---
---The value indicates the default behavior used by the
@@ -3368,6 +4019,7 @@ error('Cannot require a meta file')
---
---@since 3.16.0
---@field prepareSupportDefaultBehavior? lsp.PrepareSupportDefaultBehavior
+---
---Whether the client honors the change annotations in
---text edits and resource operations returned via the
---rename request's workspace edit by for example presenting
@@ -3378,29 +4030,35 @@ error('Cannot require a meta file')
---@field honorsChangeAnnotations? boolean
---@class lsp.FoldingRangeClientCapabilities
+---
---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.
---@field dynamicRegistration? boolean
+---
---The maximum number of folding ranges that the client prefers to receive
---per document. The value serves as a hint, servers are free to follow the
---limit.
---@field rangeLimit? uinteger
+---
---If set, the client signals that it only supports folding complete lines.
---If set, client will ignore specified `startCharacter` and `endCharacter`
---properties in a FoldingRange.
---@field lineFoldingOnly? boolean
+---
---Specific options for the folding range kind.
---
---@since 3.17.0
----@field foldingRangeKind? anonym36
+---@field foldingRangeKind? lsp._anonym36.foldingRangeKind
+---
---Specific options for the folding range.
---
---@since 3.17.0
----@field foldingRange? anonym37
+---@field foldingRange? lsp._anonym37.foldingRange
---@class lsp.SelectionRangeClientCapabilities
+---
---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.
@@ -3408,22 +4066,27 @@ error('Cannot require a meta file')
---The publish diagnostic client capabilities.
---@class lsp.PublishDiagnosticsClientCapabilities
+---
---Whether the clients accepts diagnostics with related information.
---@field relatedInformation? boolean
+---
---Client supports the tag property to provide meta data about a diagnostic.
---Clients supporting tags have to handle unknown tags gracefully.
---
---@since 3.15.0
----@field tagSupport? anonym38
+---@field tagSupport? lsp._anonym38.tagSupport
+---
---Whether the client interprets the version property of the
---`textDocument/publishDiagnostics` notification's parameter.
---
---@since 3.15.0
---@field versionSupport? boolean
+---
---Client supports a codeDescription property
---
---@since 3.16.0
---@field codeDescriptionSupport? boolean
+---
---Whether code action supports the `data` property which is
---preserved between a `textDocument/publishDiagnostics` and
---`textDocument/codeAction` request.
@@ -3433,6 +4096,7 @@ error('Cannot require a meta file')
---@since 3.16.0
---@class lsp.CallHierarchyClientCapabilities
+---
---Whether implementation supports dynamic registration. If this is set to `true`
---the client supports the new `(TextDocumentRegistrationOptions & StaticRegistrationOptions)`
---return value for the corresponding server capability as well.
@@ -3440,10 +4104,12 @@ error('Cannot require a meta file')
---@since 3.16.0
---@class lsp.SemanticTokensClientCapabilities
+---
---Whether implementation supports dynamic registration. If this is set to `true`
---the client supports the new `(TextDocumentRegistrationOptions & StaticRegistrationOptions)`
---return value for the corresponding server capability as well.
---@field dynamicRegistration? boolean
+---
---Which requests the client supports and might send to the server
---depending on the server's capability. Please note that clients might not
---show semantic tokens or degrade some of the user experience if a range
@@ -3452,17 +4118,23 @@ error('Cannot require a meta file')
---`request.range` are both set to true but the server only provides a
---range provider the client might not render a minimap correctly or might
---even decide to not show any semantic tokens at all.
----@field requests anonym41
+---@field requests lsp._anonym39.requests
+---
---The token types that the client supports.
---@field tokenTypes string[]
+---
---The token modifiers that the client supports.
---@field tokenModifiers string[]
+---
---The token formats the clients supports.
---@field formats lsp.TokenFormat[]
+---
---Whether the client supports tokens that can overlap each other.
---@field overlappingTokenSupport? boolean
+---
---Whether the client supports tokens that can span multiple lines.
---@field multilineTokenSupport? boolean
+---
---Whether the client allows the server to actively cancel a
---semantic token request, e.g. supports returning
---LSPErrorCodes.ServerCancelled. If a server does the client
@@ -3470,6 +4142,7 @@ error('Cannot require a meta file')
---
---@since 3.17.0
---@field serverCancelSupport? boolean
+---
---Whether the client uses semantic tokens to augment existing
---syntax tokens. If set to `true` client side created syntax
---tokens and semantic tokens are both used for colorization. If
@@ -3486,6 +4159,7 @@ error('Cannot require a meta file')
---
---@since 3.16.0
---@class lsp.LinkedEditingRangeClientCapabilities
+---
---Whether implementation supports dynamic registration. If this is set to `true`
---the client supports the new `(TextDocumentRegistrationOptions & StaticRegistrationOptions)`
---return value for the corresponding server capability as well.
@@ -3495,6 +4169,7 @@ error('Cannot require a meta file')
---
---@since 3.16.0
---@class lsp.MonikerClientCapabilities
+---
---Whether moniker supports dynamic registration. If this is set to `true`
---the client supports the new `MonikerRegistrationOptions` return value
---for the corresponding server capability as well.
@@ -3502,6 +4177,7 @@ error('Cannot require a meta file')
---@since 3.17.0
---@class lsp.TypeHierarchyClientCapabilities
+---
---Whether implementation supports dynamic registration. If this is set to `true`
---the client supports the new `(TextDocumentRegistrationOptions & StaticRegistrationOptions)`
---return value for the corresponding server capability as well.
@@ -3511,6 +4187,7 @@ error('Cannot require a meta file')
---
---@since 3.17.0
---@class lsp.InlineValueClientCapabilities
+---
---Whether implementation supports dynamic registration for inline value providers.
---@field dynamicRegistration? boolean
@@ -3518,20 +4195,24 @@ error('Cannot require a meta file')
---
---@since 3.17.0
---@class lsp.InlayHintClientCapabilities
+---
---Whether inlay hints support dynamic registration.
---@field dynamicRegistration? boolean
+---
---Indicates which properties a client can resolve lazily on an inlay
---hint.
----@field resolveSupport? anonym42
+---@field resolveSupport? lsp._anonym42.resolveSupport
---Client capabilities specific to diagnostic pull requests.
---
---@since 3.17.0
---@class lsp.DiagnosticClientCapabilities
+---
---Whether implementation supports dynamic registration. If this is set to `true`
---the client supports the new `(TextDocumentRegistrationOptions & StaticRegistrationOptions)`
---return value for the corresponding server capability as well.
---@field dynamicRegistration? boolean
+---
---Whether the clients supports related documents for document diagnostic pulls.
---@field relatedDocumentSupport? boolean
@@ -3540,6 +4221,7 @@ error('Cannot require a meta file')
---@since 3.18.0
---@proposed
---@class lsp.InlineCompletionClientCapabilities
+---
---Whether implementation supports dynamic registration for inline completion providers.
---@field dynamicRegistration? boolean
@@ -3547,23 +4229,27 @@ error('Cannot require a meta file')
---
---@since 3.17.0
---@class lsp.NotebookDocumentSyncClientCapabilities
+---
---Whether implementation supports dynamic registration. If this is
---set to `true` the client supports the new
---`(TextDocumentRegistrationOptions & StaticRegistrationOptions)`
---return value for the corresponding server capability as well.
---@field dynamicRegistration? boolean
+---
---The client supports sending execution summary data per cell.
---@field executionSummarySupport? boolean
---Show message request client capabilities
---@class lsp.ShowMessageRequestClientCapabilities
+---
---Capabilities specific to the `MessageActionItem` type.
----@field messageActionItem? anonym43
+---@field messageActionItem? lsp._anonym43.messageActionItem
---Client capabilities for the showDocument request.
---
---@since 3.16.0
---@class lsp.ShowDocumentClientCapabilities
+---
---The client has support for the showDocument
---request.
---@field support boolean
@@ -3572,8 +4258,10 @@ error('Cannot require a meta file')
---
---@since 3.16.0
---@class lsp.RegularExpressionsClientCapabilities
+---
---The engine's name.
---@field engine string
+---
---The engine's version.
---@field version? string
@@ -3581,10 +4269,13 @@ error('Cannot require a meta file')
---
---@since 3.16.0
---@class lsp.MarkdownClientCapabilities
+---
---The name of the parser.
---@field parser string
+---
---The version of the parser.
---@field version? string
+---
---A list of HTML tags that the client allows / supports in
---Markdown.
---
@@ -3979,11 +4670,11 @@ error('Cannot require a meta file')
---@since 3.17.0
---@alias lsp.DocumentDiagnosticReport lsp.RelatedFullDocumentDiagnosticReport|lsp.RelatedUnchangedDocumentDiagnosticReport
----@alias lsp.PrepareRenameResult lsp.Range|anonym44|anonym45
+---@alias lsp.PrepareRenameResult lsp.Range|lsp._anonym44.PrepareRenameResult|lsp._anonym45.PrepareRenameResult
---A document selector is the combination of one or many document filters.
---
----@sample `let sel:DocumentSelector = [{ language: 'typescript' }, { language: 'json', pattern: '**∕tsconfig.json' }]`;
+---\@sample `let sel:DocumentSelector = [{ language: 'typescript' }, { language: 'json', pattern: '**∕tsconfig.json' }]`;
---
---The use of a string as a document filter is deprecated @since 3.16.0.
---@alias lsp.DocumentSelector lsp.DocumentFilter[]
@@ -4000,7 +4691,7 @@ error('Cannot require a meta file')
---An event describing a change to a text document. If only a text is provided
---it is considered to be the full content of the document.
----@alias lsp.TextDocumentContentChangeEvent anonym46|anonym47
+---@alias lsp.TextDocumentContentChangeEvent lsp._anonym46.TextDocumentContentChangeEvent|lsp._anonym47.TextDocumentContentChangeEvent
---MarkedString can be used to render human readable text. It is either a markdown string
---or a code-block that provides a language and a code snippet. The language identifier
@@ -4014,7 +4705,7 @@ error('Cannot require a meta file')
---
---Note that markdown strings will be sanitized - that means html will be escaped.
---@deprecated use MarkupContent instead.
----@alias lsp.MarkedString string|anonym48
+---@alias lsp.MarkedString string|lsp._anonym48.MarkedString
---A document filter describes a top level text document or
---a notebook cell document.
@@ -4039,120 +4730,145 @@ error('Cannot require a meta file')
---- `*` to match one or more characters in a path segment
---- `?` to match on one character in a path segment
---- `**` to match any number of path segments, including none
----- `{}` to group sub patterns into an OR expression. (e.g. `**​/*.{ts,js}` matches all TypeScript and JavaScript files)
+---- `{}` to group sub patterns into an OR expression. (e.g. `**/*.{ts,js}` matches all TypeScript and JavaScript files)
---- `[]` to declare a range of characters to match in a path segment (e.g., `example.[0-9]` to match on `example.0`, `example.1`, …)
---- `[!...]` to negate a range of characters to match in a path segment (e.g., `example.[!0-9]` to match on `example.a`, `example.b`, but not `example.0`)
---
----@sample A language filter that applies to typescript files on disk: `{ language: 'typescript', scheme: 'file' }`
----@sample A language filter that applies to all package.json paths: `{ language: 'json', pattern: '**package.json' }`
+---\@sample A language filter that applies to typescript files on disk: `{ language: 'typescript', scheme: 'file' }`
+---\@sample A language filter that applies to all package.json paths: `{ language: 'json', pattern: '**package.json' }`
---
---@since 3.17.0
----@alias lsp.TextDocumentFilter anonym49|anonym50|anonym51
+---@alias lsp.TextDocumentFilter lsp._anonym49.TextDocumentFilter|lsp._anonym50.TextDocumentFilter|lsp._anonym51.TextDocumentFilter
---A notebook document filter denotes a notebook document by
---different properties. The properties will be match
---against the notebook's URI (same as with documents)
---
---@since 3.17.0
----@alias lsp.NotebookDocumentFilter anonym52|anonym53|anonym54
+---@alias lsp.NotebookDocumentFilter lsp._anonym52.NotebookDocumentFilter|lsp._anonym53.NotebookDocumentFilter|lsp._anonym54.NotebookDocumentFilter
---The glob pattern to watch relative to the base path. Glob patterns can have the following syntax:
---- `*` to match one or more characters in a path segment
---- `?` to match on one character in a path segment
---- `**` to match any number of path segments, including none
----- `{}` to group conditions (e.g. `**​/*.{ts,js}` matches all TypeScript and JavaScript files)
+---- `{}` to group conditions (e.g. `**/*.{ts,js}` matches all TypeScript and JavaScript files)
---- `[]` to declare a range of characters to match in a path segment (e.g., `example.[0-9]` to match on `example.0`, `example.1`, …)
---- `[!...]` to negate a range of characters to match in a path segment (e.g., `example.[!0-9]` to match on `example.a`, `example.b`, but not `example.0`)
---
---@since 3.17.0
---@alias lsp.Pattern string
----@class anonym1
+---@class lsp._anonym1.serverInfo
+---
---The name of the server as defined by the server.
---@field name string
+---
---The server's version as defined by the server.
---@field version? string
----@class anonym3
+---@class lsp._anonym3.itemDefaults.editRange
+---
---@field insert lsp.Range
+---
---@field replace lsp.Range
----@class anonym2
+---@class lsp._anonym2.itemDefaults
+---
---A default commit character set.
---
---@since 3.17.0
---@field commitCharacters? string[]
+---
---A default edit range.
---
---@since 3.17.0
----@field editRange? lsp.Range|anonym3
+---@field editRange? lsp.Range|lsp._anonym3.itemDefaults.editRange
+---
---A default insert text format.
---
---@since 3.17.0
---@field insertTextFormat? lsp.InsertTextFormat
+---
---A default insert text mode.
---
---@since 3.17.0
---@field insertTextMode? lsp.InsertTextMode
+---
---A default data value.
---
---@since 3.17.0
---@field data? lsp.LSPAny
----@class anonym4
+---@class lsp._anonym4.disabled
+---
---Human readable description of why the code action is currently disabled.
---
---This is displayed in the code actions UI.
---@field reason string
----@class anonym5
+---@class lsp._anonym5.location
+---
---@field uri lsp.DocumentUri
----@class anonym6
+---@class lsp._anonym6.range
----@class anonym7
+---@class lsp._anonym7.full
+---
---The server supports deltas for full documents.
---@field delta? boolean
----@class anonym9
+---@class lsp._anonym9.cells.structure
+---
---The change to the cell array.
---@field array lsp.NotebookCellArrayChange
+---
---Additional opened cell text documents.
---@field didOpen? lsp.TextDocumentItem[]
+---
---Additional closed cell text documents.
---@field didClose? lsp.TextDocumentIdentifier[]
----@class anonym10
+---@class lsp._anonym10.cells.textContent
+---
---@field document lsp.VersionedTextDocumentIdentifier
+---
---@field changes lsp.TextDocumentContentChangeEvent[]
----@class anonym8
+---@class lsp._anonym8.cells
+---
---Changes to the cell structure to add or
---remove cells.
----@field structure? anonym9
+---@field structure? lsp._anonym9.cells.structure
+---
---Changes to notebook cells properties like its
---kind, execution summary or metadata.
---@field data? lsp.NotebookCell[]
+---
---Changes to the text content of notebook cells.
----@field textContent? anonym10[]
+---@field textContent? lsp._anonym10.cells.textContent[]
----@class anonym11
+---@class lsp._anonym11.clientInfo
+---
---The name of the client as defined by the client.
---@field name string
+---
---The client's version as defined by the client.
---@field version? string
----@class anonym12
+---@class lsp._anonym12.workspace
+---
---The server supports workspace folder.
---
---@since 3.6.0
---@field workspaceFolders? lsp.WorkspaceFoldersServerCapabilities
+---
---The server is interested in notifications/requests for operations on files.
---
---@since 3.16.0
---@field fileOperations? lsp.FileOperationOptions
----@class anonym13
+---@class lsp._anonym13.completionItem
+---
---The server has support for completion item label
---details (see also `CompletionItemLabelDetails`) when
---receiving a completion item in a resolve call.
@@ -4160,43 +4876,53 @@ error('Cannot require a meta file')
---@since 3.17.0
---@field labelDetailsSupport? boolean
----@class anonym15
+---@class lsp._anonym15.notebookSelector.cells
+---
---@field language string
----@class anonym14
+---@class lsp._anonym14.notebookSelector
+---
---The notebook to be synced If a string
---value is provided it matches against the
---notebook type. '*' matches every notebook.
---@field notebook string|lsp.NotebookDocumentFilter
+---
---The cells of the matching notebook to be synced.
----@field cells? anonym15[]
+---@field cells? lsp._anonym15.notebookSelector.cells[]
----@class anonym17
+---@class lsp._anonym17.notebookSelector.cells
+---
---@field language string
----@class anonym16
+---@class lsp._anonym16.notebookSelector
+---
---The notebook to be synced If a string
---value is provided it matches against the
---notebook type. '*' matches every notebook.
---@field notebook? string|lsp.NotebookDocumentFilter
+---
---The cells of the matching notebook to be synced.
----@field cells anonym17[]
+---@field cells lsp._anonym17.notebookSelector.cells[]
----@class anonym18
+---@class lsp._anonym18.staleRequestSupport
+---
---The client will actively cancel the request.
---@field cancel boolean
+---
---The list of requests for which the client
---will retry the request if it receives a
---response with error code `ContentModified`
---@field retryOnContentModified string[]
----@class anonym19
+---@class lsp._anonym19.changeAnnotationSupport
+---
---Whether the client groups edits with equal labels into tree nodes,
---for instance all edits labelled with "Changes in Strings" would
---be a tree node.
---@field groupsOnLabel? boolean
----@class anonym20
+---@class lsp._anonym20.symbolKind
+---
---The symbol kind values the client supports. When this
---property exists the client also guarantees that it will
---handle values outside its set gracefully and falls back
@@ -4207,27 +4933,33 @@ error('Cannot require a meta file')
---the initial version of the protocol.
---@field valueSet? lsp.SymbolKind[]
----@class anonym21
+---@class lsp._anonym21.tagSupport
+---
---The tags supported by the client.
---@field valueSet lsp.SymbolTag[]
----@class anonym22
+---@class lsp._anonym22.resolveSupport
+---
---The properties that a client can resolve lazily. Usually
---`location.range`
---@field properties string[]
----@class anonym24
+---@class lsp._anonym24.completionItem.tagSupport
+---
---The tags supported by the client.
---@field valueSet lsp.CompletionItemTag[]
----@class anonym25
+---@class lsp._anonym25.completionItem.resolveSupport
+---
---The properties that a client can resolve lazily.
---@field properties string[]
----@class anonym26
+---@class lsp._anonym26.completionItem.insertTextModeSupport
+---
---@field valueSet lsp.InsertTextMode[]
----@class anonym23
+---@class lsp._anonym23.completionItem
+---
---Client supports snippets as insert text.
---
---A snippet can define tab stops and placeholders with `$1`, `$2`
@@ -4235,46 +4967,56 @@ error('Cannot require a meta file')
---the end of the snippet. Placeholders with equal identifiers are linked,
---that is typing in one will update others too.
---@field snippetSupport? boolean
+---
---Client supports commit characters on a completion item.
---@field commitCharactersSupport? boolean
+---
---Client supports the following content formats for the documentation
---property. The order describes the preferred format of the client.
---@field documentationFormat? lsp.MarkupKind[]
+---
---Client supports the deprecated property on a completion item.
---@field deprecatedSupport? boolean
+---
---Client supports the preselect property on a completion item.
---@field preselectSupport? boolean
+---
---Client supports the tag property on a completion item. Clients supporting
---tags have to handle unknown tags gracefully. Clients especially need to
---preserve unknown tags when sending a completion item back to the server in
---a resolve call.
---
---@since 3.15.0
----@field tagSupport? anonym24
+---@field tagSupport? lsp._anonym24.completionItem.tagSupport
+---
---Client support insert replace edit to control different behavior if a
---completion item is inserted in the text or should replace text.
---
---@since 3.16.0
---@field insertReplaceSupport? boolean
+---
---Indicates which properties a client can resolve lazily on a completion
---item. Before version 3.16.0 only the predefined properties `documentation`
---and `details` could be resolved lazily.
---
---@since 3.16.0
----@field resolveSupport? anonym25
+---@field resolveSupport? lsp._anonym25.completionItem.resolveSupport
+---
---The client supports the `insertTextMode` property on
---a completion item to override the whitespace handling mode
---as defined by the client (see `insertTextMode`).
---
---@since 3.16.0
----@field insertTextModeSupport? anonym26
+---@field insertTextModeSupport? lsp._anonym26.completionItem.insertTextModeSupport
+---
---The client has support for completion item label
---details (see also `CompletionItemLabelDetails`).
---
---@since 3.17.0
---@field labelDetailsSupport? boolean
----@class anonym27
+---@class lsp._anonym27.completionItemKind
+---
---The completion item kind values the client supports. When this
---property exists the client also guarantees that it will
---handle values outside its set gracefully and falls back
@@ -4285,7 +5027,8 @@ error('Cannot require a meta file')
---the initial version of the protocol.
---@field valueSet? lsp.CompletionItemKind[]
----@class anonym28
+---@class lsp._anonym28.completionList
+---
---The client supports the following itemDefaults on
---a completion list.
---
@@ -4296,24 +5039,29 @@ error('Cannot require a meta file')
---@since 3.17.0
---@field itemDefaults? string[]
----@class anonym30
+---@class lsp._anonym30.signatureInformation.parameterInformation
+---
---The client supports processing label offsets instead of a
---simple label string.
---
---@since 3.14.0
---@field labelOffsetSupport? boolean
----@class anonym29
+---@class lsp._anonym29.signatureInformation
+---
---Client supports the following content formats for the documentation
---property. The order describes the preferred format of the client.
---@field documentationFormat? lsp.MarkupKind[]
+---
---Client capabilities specific to parameter information.
----@field parameterInformation? anonym30
+---@field parameterInformation? lsp._anonym30.signatureInformation.parameterInformation
+---
---The client supports the `activeParameter` property on `SignatureInformation`
---literal.
---
---@since 3.16.0
---@field activeParameterSupport? boolean
+---
---The client supports the `activeParameter` property on
---`SignatureInformation` being set to `null` to indicate that no
---parameter should be active.
@@ -4321,7 +5069,8 @@ error('Cannot require a meta file')
---@since 3.18.0
---@field noActiveParameterSupport? boolean
----@class anonym31
+---@class lsp._anonym31.symbolKind
+---
---The symbol kind values the client supports. When this
---property exists the client also guarantees that it will
---handle values outside its set gracefully and falls back
@@ -4332,138 +5081,177 @@ error('Cannot require a meta file')
---the initial version of the protocol.
---@field valueSet? lsp.SymbolKind[]
----@class anonym32
+---@class lsp._anonym32.tagSupport
+---
---The tags supported by the client.
---@field valueSet lsp.SymbolTag[]
----@class anonym34
+---@class lsp._anonym34.codeActionLiteralSupport.codeActionKind
+---
---The code action kind values the client supports. When this
---property exists the client also guarantees that it will
---handle values outside its set gracefully and falls back
---to a default value when unknown.
---@field valueSet lsp.CodeActionKind[]
----@class anonym33
+---@class lsp._anonym33.codeActionLiteralSupport
+---
---The code action kind is support with the following value
---set.
----@field codeActionKind anonym34
+---@field codeActionKind lsp._anonym34.codeActionLiteralSupport.codeActionKind
----@class anonym35
+---@class lsp._anonym35.resolveSupport
+---
---The properties that a client can resolve lazily.
---@field properties string[]
----@class anonym36
+---@class lsp._anonym36.foldingRangeKind
+---
---The folding range kind values the client supports. When this
---property exists the client also guarantees that it will
---handle values outside its set gracefully and falls back
---to a default value when unknown.
---@field valueSet? lsp.FoldingRangeKind[]
----@class anonym37
+---@class lsp._anonym37.foldingRange
+---
---If set, the client signals that it supports setting collapsedText on
---folding ranges to display custom labels instead of the default text.
---
---@since 3.17.0
---@field collapsedText? boolean
----@class anonym38
+---@class lsp._anonym38.tagSupport
+---
---The tags supported by the client.
---@field valueSet lsp.DiagnosticTag[]
----@class anonym40
+---@class lsp._anonym40.requests.range
----@class anonym41
+---@class lsp._anonym41.requests.full
+---
---The client will send the `textDocument/semanticTokens/full/delta` request if
---the server provides a corresponding handler.
---@field delta? boolean
----@class anonym39
+---@class lsp._anonym39.requests
+---
---The client will send the `textDocument/semanticTokens/range` request if
---the server provides a corresponding handler.
----@field range? boolean|anonym40
+---@field range? boolean|lsp._anonym40.requests.range
+---
---The client will send the `textDocument/semanticTokens/full` request if
---the server provides a corresponding handler.
----@field full? boolean|anonym41
+---@field full? boolean|lsp._anonym41.requests.full
----@class anonym42
+---@class lsp._anonym42.resolveSupport
+---
---The properties that a client can resolve lazily.
---@field properties string[]
----@class anonym43
+---@class lsp._anonym43.messageActionItem
+---
---Whether the client supports additional attributes which
---are preserved and send back to the server in the
---request's response.
---@field additionalPropertiesSupport? boolean
----@class anonym44
+---@class lsp._anonym44.PrepareRenameResult
+---
---@field range lsp.Range
+---
---@field placeholder string
----@class anonym45
+---@class lsp._anonym45.PrepareRenameResult
+---
---@field defaultBehavior boolean
----@class anonym46
+---@class lsp._anonym46.TextDocumentContentChangeEvent
+---
---The range of the document that changed.
---@field range lsp.Range
+---
---The optional length of the range that got replaced.
---
---@deprecated use range instead.
---@field rangeLength? uinteger
+---
---The new text for the provided range.
---@field text string
----@class anonym47
+---@class lsp._anonym47.TextDocumentContentChangeEvent
+---
---The new text of the whole document.
---@field text string
----@class anonym48
+---@class lsp._anonym48.MarkedString
+---
---@field language string
+---
---@field value string
----@class anonym49
+---@class lsp._anonym49.TextDocumentFilter
+---
---A language id, like `typescript`.
---@field language string
+---
---A Uri {@link Uri.scheme scheme}, like `file` or `untitled`.
---@field scheme? string
----A glob pattern, like **​/*.{ts,js}. See TextDocumentFilter for examples.
+---
+---A glob pattern, like **/*.{ts,js}. See TextDocumentFilter for examples.
---@field pattern? string
----@class anonym50
+---@class lsp._anonym50.TextDocumentFilter
+---
---A language id, like `typescript`.
---@field language? string
+---
---A Uri {@link Uri.scheme scheme}, like `file` or `untitled`.
---@field scheme string
----A glob pattern, like **​/*.{ts,js}. See TextDocumentFilter for examples.
+---
+---A glob pattern, like **/*.{ts,js}. See TextDocumentFilter for examples.
---@field pattern? string
----@class anonym51
+---@class lsp._anonym51.TextDocumentFilter
+---
---A language id, like `typescript`.
---@field language? string
+---
---A Uri {@link Uri.scheme scheme}, like `file` or `untitled`.
---@field scheme? string
----A glob pattern, like **​/*.{ts,js}. See TextDocumentFilter for examples.
+---
+---A glob pattern, like **/*.{ts,js}. See TextDocumentFilter for examples.
---@field pattern string
----@class anonym52
+---@class lsp._anonym52.NotebookDocumentFilter
+---
---The type of the enclosing notebook.
---@field notebookType string
+---
---A Uri {@link Uri.scheme scheme}, like `file` or `untitled`.
---@field scheme? string
+---
---A glob pattern.
---@field pattern? string
----@class anonym53
+---@class lsp._anonym53.NotebookDocumentFilter
+---
---The type of the enclosing notebook.
---@field notebookType? string
+---
---A Uri {@link Uri.scheme scheme}, like `file` or `untitled`.
---@field scheme string
+---
---A glob pattern.
---@field pattern? string
----@class anonym54
+---@class lsp._anonym54.NotebookDocumentFilter
+---
---The type of the enclosing notebook.
---@field notebookType? string
+---
---A Uri {@link Uri.scheme scheme}, like `file` or `untitled`.
---@field scheme? string
+---
---A glob pattern.
---@field pattern string
diff --git a/scripts/gen_lsp.lua b/scripts/gen_lsp.lua
index 943e88896b..0e7eb38cca 100644
--- a/scripts/gen_lsp.lua
+++ b/scripts/gen_lsp.lua
@@ -51,7 +51,7 @@ local function read_json(opt)
end
-- Gets the Lua symbol for a given fully-qualified LSP method name.
-local function name(s)
+local function to_luaname(s)
-- "$/" prefix is special: https://microsoft.github.io/language-server-protocol/specification/#dollarRequests
return s:gsub('^%$', 'dollar'):gsub('/', '_')
end
@@ -95,7 +95,7 @@ local function gen_methods(protocol)
---@type (vim._gen_lsp.Request|vim._gen_lsp.Notification)[]
local all = vim.list_extend(protocol.requests, protocol.notifications)
table.sort(all, function(a, b)
- return name(a.method) < name(b.method)
+ return to_luaname(a.method) < to_luaname(b.method)
end)
for _, item in ipairs(all) do
if item.method then
@@ -105,7 +105,7 @@ local function gen_methods(protocol)
output[#output + 1] = indent .. '--- ' .. docstring
end
end
- output[#output + 1] = ("%s%s = '%s',"):format(indent, name(item.method), item.method)
+ output[#output + 1] = ("%s%s = '%s',"):format(indent, to_luaname(item.method), item.method)
end
end
output[#output + 1] = '}'
@@ -193,6 +193,16 @@ function M.gen(opt)
'decimal',
}
+ ---@param documentation string
+ local _process_documentation = function(documentation)
+ documentation = documentation:gsub('\n', '\n---')
+ -- Remove <200b> (zero-width space) unicode characters: e.g., `**/<200b>*`
+ documentation = documentation:gsub('\226\128\139', '')
+ -- Escape annotations that are not recognized by lua-ls
+ documentation = documentation:gsub('%^---@sample', '---\\@sample')
+ return '---' .. documentation
+ end
+
--- @class vim._gen_lsp.Type
--- @field kind string a common field for all Types.
--- @field name? string for ReferenceType, BaseType
@@ -202,8 +212,10 @@ function M.gen(opt)
--- @field value? string|vim._gen_lsp.Type for StringLiteralType, MapType, StructureLiteralType
---@param type vim._gen_lsp.Type
+ ---@param prefix? string Optional prefix associated with the this type, made of (nested) field name.
+ --- Used to generate class name for structure literal types.
---@return string
- local function parse_type(type)
+ local function parse_type(type, prefix)
-- ReferenceType | BaseType
if type.kind == 'reference' or type.kind == 'base' then
if vim.tbl_contains(simple_types, type.name) then
@@ -213,13 +225,13 @@ function M.gen(opt)
-- ArrayType
elseif type.kind == 'array' then
- return parse_type(type.element) .. '[]'
+ return parse_type(type.element, prefix) .. '[]'
-- OrType
elseif type.kind == 'or' then
local val = ''
for _, item in ipairs(type.items) do
- val = val .. parse_type(item) .. '|' --[[ @as string ]]
+ val = val .. parse_type(item, prefix) .. '|' --[[ @as string ]]
end
val = val:sub(0, -2)
return val
@@ -232,7 +244,7 @@ function M.gen(opt)
elseif type.kind == 'map' then
local key = assert(type.key)
local value = type.value --[[ @as vim._gen_lsp.Type ]]
- return 'table<' .. parse_type(key) .. ', ' .. parse_type(value) .. '>'
+ return 'table<' .. parse_type(key, prefix) .. ', ' .. parse_type(value, prefix) .. '>'
-- StructureLiteralType
elseif type.kind == 'literal' then
@@ -240,7 +252,14 @@ function M.gen(opt)
-- use | to continue the inline class to be able to add docs
-- https://github.com/LuaLS/lua-language-server/issues/2128
anonymous_num = anonymous_num + 1
- local anonym = { '---@class anonym' .. anonymous_num }
+ local anonymous_classname = 'lsp._anonym' .. anonymous_num
+ if prefix then
+ anonymous_classname = anonymous_classname .. '.' .. prefix
+ end
+ local anonym = vim.tbl_flatten { -- remove nil
+ anonymous_num > 1 and '' or nil,
+ '---@class ' .. anonymous_classname,
+ }
--- @class vim._gen_lsp.StructureLiteral translated to anonymous @class.
--- @field deprecated? string
@@ -252,27 +271,29 @@ function M.gen(opt)
---@type vim._gen_lsp.StructureLiteral
local structural_literal = assert(type.value) --[[ @as vim._gen_lsp.StructureLiteral ]]
for _, field in ipairs(structural_literal.properties) do
+ anonym[#anonym + 1] = '---'
if field.documentation then
- field.documentation = field.documentation:gsub('\n', '\n---')
- anonym[#anonym + 1] = '---' .. field.documentation
+ anonym[#anonym + 1] = _process_documentation(field.documentation)
end
anonym[#anonym + 1] = '---@field '
.. field.name
.. (field.optional and '?' or '')
.. ' '
- .. parse_type(field.type)
+ .. parse_type(field.type, prefix .. '.' .. field.name)
end
- anonym[#anonym + 1] = ''
+ -- anonym[#anonym + 1] = ''
for _, line in ipairs(anonym) do
- anonym_classes[#anonym_classes + 1] = line
+ if line then
+ anonym_classes[#anonym_classes + 1] = line
+ end
end
- return 'anonym' .. anonymous_num
+ return anonymous_classname
-- TupleType
elseif type.kind == 'tuple' then
local tuple = '{ '
for i, value in ipairs(type.items) do
- tuple = tuple .. '[' .. i .. ']: ' .. parse_type(value) .. ', '
+ tuple = tuple .. '[' .. i .. ']: ' .. parse_type(value, prefix) .. ', '
end
-- remove , at the end
tuple = tuple:sub(0, -3)
@@ -293,22 +314,22 @@ function M.gen(opt)
--- @field proposed? boolean
--- @field since? string
for _, structure in ipairs(protocol.structures) do
+ -- output[#output + 1] = ''
if structure.documentation then
- structure.documentation = structure.documentation:gsub('\n', '\n---')
- output[#output + 1] = '---' .. structure.documentation
+ output[#output + 1] = _process_documentation(structure.documentation)
end
- if structure.extends then
- local class_string = '---@class lsp.'
- .. structure.name
- .. ': '
- .. parse_type(structure.extends[1])
- for _, mixin in ipairs(structure.mixins or {}) do
- class_string = class_string .. ', ' .. parse_type(mixin)
- end
- output[#output + 1] = class_string
- else
- output[#output + 1] = '---@class lsp.' .. structure.name
+ local class_string = ('---@class lsp.%s'):format(structure.name)
+ if structure.extends or structure.mixins then
+ local inherits_from = table.concat(
+ vim.list_extend(
+ vim.tbl_map(parse_type, structure.extends or {}),
+ vim.tbl_map(parse_type, structure.mixins or {})
+ ),
+ ', '
+ )
+ class_string = class_string .. ': ' .. inherits_from
end
+ output[#output + 1] = class_string
--- @class vim._gen_lsp.Property translated to @field
--- @field deprecated? string
@@ -319,15 +340,15 @@ function M.gen(opt)
--- @field since? string
--- @field type { kind: string, name: string }
for _, field in ipairs(structure.properties or {}) do
+ output[#output + 1] = '---' -- Insert a single newline between @fields (and after @class)
if field.documentation then
- field.documentation = field.documentation:gsub('\n', '\n---')
- output[#output + 1] = '---' .. field.documentation
+ output[#output + 1] = _process_documentation(field.documentation)
end
output[#output + 1] = '---@field '
.. field.name
.. (field.optional and '?' or '')
.. ' '
- .. parse_type(field.type)
+ .. parse_type(field.type, field.name)
end
output[#output + 1] = ''
end
@@ -342,8 +363,7 @@ function M.gen(opt)
--- @field values { name: string, value: string, documentation?: string, since?: string }[]
for _, enum in ipairs(protocol.enumerations) do
if enum.documentation then
- enum.documentation = enum.documentation:gsub('\n', '\n---')
- output[#output + 1] = '---' .. enum.documentation
+ output[#output + 1] = _process_documentation(enum.documentation)
end
local enum_type = '---@alias lsp.' .. enum.name
for _, value in ipairs(enum.values) do
@@ -366,18 +386,20 @@ function M.gen(opt)
--- @field type vim._gen_lsp.Type
for _, alias in ipairs(protocol.typeAliases) do
if alias.documentation then
- alias.documentation = alias.documentation:gsub('\n', '\n---')
- output[#output + 1] = '---' .. alias.documentation
+ output[#output + 1] = _process_documentation(alias.documentation)
end
if alias.type.kind == 'or' then
local alias_type = '---@alias lsp.' .. alias.name .. ' '
for _, item in ipairs(alias.type.items) do
- alias_type = alias_type .. parse_type(item) .. '|'
+ alias_type = alias_type .. parse_type(item, alias.name) .. '|'
end
alias_type = alias_type:sub(0, -2)
output[#output + 1] = alias_type
else
- output[#output + 1] = '---@alias lsp.' .. alias.name .. ' ' .. parse_type(alias.type)
+ output[#output + 1] = '---@alias lsp.'
+ .. alias.name
+ .. ' '
+ .. parse_type(alias.type, alias.name)
end
output[#output + 1] = ''
end
@@ -387,7 +409,7 @@ function M.gen(opt)
output[#output + 1] = line
end
- tofile(opt.output_file, table.concat(output, '\n'))
+ tofile(opt.output_file, table.concat(output, '\n') .. '\n')
end
---@type vim._gen_lsp.opt