blob: becb255b1fb8a5e35607a78bf91c5f2c041070fa [file] [log] [blame]
// Copyright 2022 The Go Authors. All rights reserved.
// Use of this source code is governed by a BSD-style
// license that can be found in the LICENSE file.
// Code generated for LSP. DO NOT EDIT.
package protocol
// Code generated from version 3.17.0 of protocol/metaModel.json.
// git hash 8de18faed635819dd2bc631d2c26ce4a18f7cf4a (as of 2023-01-14)
import "encoding/json"
// created for And
type And_Param_workspace_configuration struct { // line 141
ParamConfiguration
PartialResultParams
}
/*
* A special text edit with an additional change annotation.
*
* @since 3.16.0.
*/
type AnnotatedTextEdit struct { // line 9392
// The actual identifier of the change annotation
AnnotationID ChangeAnnotationIdentifier `json:"annotationId"`
TextEdit
}
// The parameters passed via a apply workspace edit request.
type ApplyWorkspaceEditParams struct { // line 6003
/*
* 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.
*/
Label string `json:"label,omitempty"`
// The edits to apply.
Edit WorkspaceEdit `json:"edit"`
}
/*
* The result returned from the apply workspace edit request.
*
* @since 3.17 renamed from ApplyWorkspaceEditResponse
*/
type ApplyWorkspaceEditResult struct { // line 6026
// Indicates whether the edit was applied or not.
Applied bool `json:"applied"`
/*
* 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.
*/
FailureReason string `json:"failureReason,omitempty"`
/*
* 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.
*/
FailedChange uint32 `json:"failedChange,omitempty"`
}
// A base for all symbol information.
type BaseSymbolInformation struct { // line 8986
// The name of this symbol.
Name string `json:"name"`
// The kind of this symbol.
Kind SymbolKind `json:"kind"`
/*
* Tags for this symbol.
*
* @since 3.16.0
*/
Tags []SymbolTag `json:"tags,omitempty"`
/*
* 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
* symbols.
*/
ContainerName string `json:"containerName,omitempty"`
}
// @since 3.16.0
type CallHierarchyClientCapabilities struct { // line 12167
/*
* 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.
*/
DynamicRegistration bool `json:"dynamicRegistration,omitempty"`
}
/*
* Represents an incoming call, e.g. a caller of a method or constructor.
*
* @since 3.16.0
*/
type CallHierarchyIncomingCall struct { // line 2801
// The item that makes the call.
From CallHierarchyItem `json:"from"`
/*
* The ranges at which the calls appear. This is relative to the caller
* denoted by [`this.from`](#CallHierarchyIncomingCall.from).
*/
FromRanges []Range `json:"fromRanges"`
}
/*
* The parameter of a `callHierarchy/incomingCalls` request.
*
* @since 3.16.0
*/
type CallHierarchyIncomingCallsParams struct { // line 2777
Item CallHierarchyItem `json:"item"`
WorkDoneProgressParams
PartialResultParams
}
/*
* Represents programming constructs like functions or constructors in the context
* of call hierarchy.
*
* @since 3.16.0
*/
type CallHierarchyItem struct { // line 2678
// The name of this item.
Name string `json:"name"`
// The kind of this item.
Kind SymbolKind `json:"kind"`
// Tags for this item.
Tags []SymbolTag `json:"tags,omitempty"`
// More detail for this item, e.g. the signature of a function.
Detail string `json:"detail,omitempty"`
// The resource identifier of this item.
URI DocumentURI `json:"uri"`
// The range enclosing this symbol not including leading/trailing whitespace but everything else, e.g. comments and code.
Range Range `json:"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`](#CallHierarchyItem.range).
*/
SelectionRange Range `json:"selectionRange"`
/*
* A data entry field that is preserved between a call hierarchy prepare and
* incoming calls or outgoing calls requests.
*/
Data interface{} `json:"data,omitempty"`
}
/*
* Call hierarchy options used during static registration.
*
* @since 3.16.0
*/
type CallHierarchyOptions struct { // line 6539
WorkDoneProgressOptions
}
/*
* Represents an outgoing call, e.g. calling a getter from a method or a method from a constructor etc.
*
* @since 3.16.0
*/
type CallHierarchyOutgoingCall struct { // line 2851
// The item that is called.
To CallHierarchyItem `json:"to"`
/*
* The range at which this item is called. This is the range relative to the caller, e.g the item
* passed to [`provideCallHierarchyOutgoingCalls`](#CallHierarchyItemProvider.provideCallHierarchyOutgoingCalls)
* and not [`this.to`](#CallHierarchyOutgoingCall.to).
*/
FromRanges []Range `json:"fromRanges"`
}
/*
* The parameter of a `callHierarchy/outgoingCalls` request.
*
* @since 3.16.0
*/
type CallHierarchyOutgoingCallsParams struct { // line 2827
Item CallHierarchyItem `json:"item"`
WorkDoneProgressParams
PartialResultParams
}
/*
* The parameter of a `textDocument/prepareCallHierarchy` request.
*
* @since 3.16.0
*/
type CallHierarchyPrepareParams struct { // line 2660
TextDocumentPositionParams
WorkDoneProgressParams
}
/*
* Call hierarchy options used during static or dynamic registration.
*
* @since 3.16.0
*/
type CallHierarchyRegistrationOptions struct { // line 2755
TextDocumentRegistrationOptions
CallHierarchyOptions
StaticRegistrationOptions
}
type CancelParams struct { // line 6198
// The request id to cancel.
ID interface{} `json:"id"`
}
/*
* Additional information that describes document changes.
*
* @since 3.16.0
*/
type ChangeAnnotation struct { // line 6836
/*
* A human-readable string describing the actual change. The string
* is rendered prominent in the user interface.
*/
Label string `json:"label"`
/*
* A flag which indicates that user confirmation is needed
* before applying the change.
*/
NeedsConfirmation bool `json:"needsConfirmation,omitempty"`
/*
* A human-readable string which is rendered less prominent in
* the user interface.
*/
Description string `json:"description,omitempty"`
}
// An identifier to refer to a change annotation stored with a workspace edit.
type ChangeAnnotationIdentifier = string // (alias) line 14002
// Defines the capabilities provided by the client.
type ClientCapabilities struct { // line 9700
// Workspace specific client capabilities.
Workspace WorkspaceClientCapabilities `json:"workspace,omitempty"`
// Text document specific client capabilities.
TextDocument TextDocumentClientCapabilities `json:"textDocument,omitempty"`
/*
* Capabilities specific to the notebook document support.
*
* @since 3.17.0
*/
NotebookDocument *NotebookDocumentClientCapabilities `json:"notebookDocument,omitempty"`
// Window specific client capabilities.
Window WindowClientCapabilities `json:"window,omitempty"`
/*
* General client capabilities.
*
* @since 3.16.0
*/
General *GeneralClientCapabilities `json:"general,omitempty"`
// Experimental client capabilities.
Experimental interface{} `json:"experimental,omitempty"`
}
/*
* A code action represents a change that can be performed in code, e.g. to fix a problem or
* to refactor code.
*
* A CodeAction must set either `edit` and/or a `command`. If both are supplied, the `edit` is applied first, then the `command` is executed.
*/
type CodeAction struct { // line 5401
// A short, human-readable, title for this code action.
Title string `json:"title"`
/*
* The kind of the code action.
*
* Used to filter code actions.
*/
Kind CodeActionKind `json:"kind,omitempty"`
// The diagnostics that this code action resolves.
Diagnostics []Diagnostic `json:"diagnostics,omitempty"`
/*
* Marks this as a preferred action. Preferred actions are used by the `auto fix` command and can be targeted
* by keybindings.
*
* A quick fix should be marked preferred if it properly addresses the underlying error.
* A refactoring should be marked preferred if it is the most reasonable choice of actions to take.
*
* @since 3.15.0
*/
IsPreferred bool `json:"isPreferred,omitempty"`
/*
* Marks that the code action cannot currently be applied.
*
* Clients should follow the following guidelines regarding disabled code actions:
*
* - Disabled code actions are not shown in automatic [lightbulbs](https://code.visualstudio.com/docs/editor/editingevolved#_code-action)
* code action menus.
*
* - Disabled actions are shown as faded out in the code action menu when the user requests a more specific type
* of code action, such as refactorings.
*
* - If the user has a [keybinding](https://code.visualstudio.com/docs/editor/refactoring#_keybindings-for-code-actions)
* that auto applies a code action and only disabled code actions are returned, the client should show the user an
* error message with `reason` in the editor.
*
* @since 3.16.0
*/
Disabled *PDisabledMsg_textDocument_codeAction `json:"disabled,omitempty"`
// The workspace edit this code action performs.
Edit WorkspaceEdit `json:"edit,omitempty"`
/*
* 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.
*/
Command *Command `json:"command,omitempty"`
/*
* A data entry field that is preserved on a code action between
* a `textDocument/codeAction` and a `codeAction/resolve` request.
*
* @since 3.16.0
*/
Data interface{} `json:"data,omitempty"`
}
// The Client Capabilities of a [CodeActionRequest](#CodeActionRequest).
type CodeActionClientCapabilities struct { // line 11747
// Whether code action supports dynamic registration.
DynamicRegistration bool `json:"dynamicRegistration,omitempty"`
/*
* 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
*/
CodeActionLiteralSupport PCodeActionLiteralSupportPCodeAction `json:"codeActionLiteralSupport,omitempty"`
/*
* Whether code action supports the `isPreferred` property.
*
* @since 3.15.0
*/
IsPreferredSupport bool `json:"isPreferredSupport,omitempty"`
/*
* Whether code action supports the `disabled` property.
*
* @since 3.16.0
*/
DisabledSupport bool `json:"disabledSupport,omitempty"`
/*
* Whether code action supports the `data` property which is
* preserved between a `textDocument/codeAction` and a
* `codeAction/resolve` request.
*
* @since 3.16.0
*/
DataSupport bool `json:"dataSupport,omitempty"`
/*
* Whether the client supports resolving additional code action
* properties via a separate `codeAction/resolve` request.
*
* @since 3.16.0
*/
ResolveSupport *PResolveSupportPCodeAction `json:"resolveSupport,omitempty"`
/*
* Whether the client honors the change annotations in
* text edits and resource operations returned via the
* `CodeAction#edit` property by for example presenting
* the workspace edit in the user interface and asking
* for confirmation.
*
* @since 3.16.0
*/
HonorsChangeAnnotations bool `json:"honorsChangeAnnotations,omitempty"`
}
/*
* Contains additional diagnostic information about the context in which
* a [code action](#CodeActionProvider.provideCodeActions) is run.
*/
type CodeActionContext struct { // line 9052
/*
* 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.
*/
Diagnostics []Diagnostic `json:"diagnostics"`
/*
* 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.
*/
Only []CodeActionKind `json:"only,omitempty"`
/*
* The reason why code actions were requested.
*
* @since 3.17.0
*/
TriggerKind CodeActionTriggerKind `json:"triggerKind,omitempty"`
}
// A set of predefined code action kinds
type CodeActionKind string // line 13352
// Provider options for a [CodeActionRequest](#CodeActionRequest).
type CodeActionOptions struct { // line 9091
/*
* 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.
*/
CodeActionKinds []CodeActionKind `json:"codeActionKinds,omitempty"`
/*
* The server provides support to resolve additional
* information for a code action.
*
* @since 3.16.0
*/
ResolveProvider bool `json:"resolveProvider,omitempty"`
WorkDoneProgressOptions
}
// The parameters of a [CodeActionRequest](#CodeActionRequest).
type CodeActionParams struct { // line 5327
// The document in which the command was invoked.
TextDocument TextDocumentIdentifier `json:"textDocument"`
// The range for which the command was invoked.
Range Range `json:"range"`
// Context carrying additional information.
Context CodeActionContext `json:"context"`
WorkDoneProgressParams
PartialResultParams
}
// Registration options for a [CodeActionRequest](#CodeActionRequest).
type CodeActionRegistrationOptions struct { // line 5495
TextDocumentRegistrationOptions
CodeActionOptions
}
/*
* The reason why code actions were requested.
*
* @since 3.17.0
*/
type CodeActionTriggerKind uint32 // line 13632
/*
* Structure to capture a description for an error code.
*
* @since 3.16.0
*/
type CodeDescription struct { // line 10052
// An URI to open with more information about the diagnostic error.
Href URI `json:"href"`
}
/*
* A code lens represents a [command](#Command) that should be shown along with
* source text, like the number of references, a way to run tests, etc.
*
* 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.
*/
type CodeLens struct { // line 5618
// The range in which this code lens is valid. Should only span a single line.
Range Range `json:"range"`
// The command this code lens represents.
Command Command `json:"command,omitempty"`
/*
* A data entry field that is preserved on a code lens item between
* a [CodeLensRequest](#CodeLensRequest) and a [CodeLensResolveRequest]
* (#CodeLensResolveRequest)
*/
Data interface{} `json:"data,omitempty"`
}
// The client capabilities of a [CodeLensRequest](#CodeLensRequest).
type CodeLensClientCapabilities struct { // line 11861
// Whether code lens supports dynamic registration.
DynamicRegistration bool `json:"dynamicRegistration,omitempty"`
}
// Code Lens provider options of a [CodeLensRequest](#CodeLensRequest).
type CodeLensOptions struct { // line 9147
// Code lens has a resolve provider as well.
ResolveProvider bool `json:"resolveProvider,omitempty"`
WorkDoneProgressOptions
}
// The parameters of a [CodeLensRequest](#CodeLensRequest).
type CodeLensParams struct { // line 5594
// The document to request code lens for.
TextDocument TextDocumentIdentifier `json:"textDocument"`
WorkDoneProgressParams
PartialResultParams
}
// Registration options for a [CodeLensRequest](#CodeLensRequest).
type CodeLensRegistrationOptions struct { // line 5650
TextDocumentRegistrationOptions
CodeLensOptions
}
// @since 3.16.0
type CodeLensWorkspaceClientCapabilities struct { // line 11019
/*
* Whether the client implementation supports a refresh request sent from the
* server to the client.
*
* Note that this event is global and will force the client to refresh all
* code lenses currently shown. It should be used with absolute care and is
* useful for situation where a server for example detect a project wide
* change that requires such a calculation.
*/
RefreshSupport bool `json:"refreshSupport,omitempty"`
}
// Represents a color in RGBA space.
type Color struct { // line 6438
// The red component of this color in the range [0-1].
Red float64 `json:"red"`
// The green component of this color in the range [0-1].
Green float64 `json:"green"`
// The blue component of this color in the range [0-1].
Blue float64 `json:"blue"`
// The alpha component of this color in the range [0-1].
Alpha float64 `json:"alpha"`
}
// Represents a color range from a document.
type ColorInformation struct { // line 2261
// The range in the document where this color appears.
Range Range `json:"range"`
// The actual color value for this color range.
Color Color `json:"color"`
}
type ColorPresentation struct { // line 2343
/*
* 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.
*/
Label string `json:"label"`
/*
* An [edit](#TextEdit) which is applied to a document when selecting
* this presentation for the color. When `falsy` the [label](#ColorPresentation.label)
* is used.
*/
TextEdit *TextEdit `json:"textEdit,omitempty"`
/*
* An optional array of additional [text edits](#TextEdit) that are applied when
* selecting this color presentation. Edits must not overlap with the main [edit](#ColorPresentation.textEdit) nor with themselves.
*/
AdditionalTextEdits []TextEdit `json:"additionalTextEdits,omitempty"`
}
// Parameters for a [ColorPresentationRequest](#ColorPresentationRequest).
type ColorPresentationParams struct { // line 2303
// The text document.
TextDocument TextDocumentIdentifier `json:"textDocument"`
// The color to request presentations for.
Color Color `json:"color"`
// The range where the color would be inserted. Serves as a context.
Range Range `json:"range"`
WorkDoneProgressParams
PartialResultParams
}
/*
* Represents a reference to a command. Provides a title which
* will be used to represent a command in the UI and, optionally,
* an array of arguments which will be passed to the command handler
* function when invoked.
*/
type Command struct { // line 5367
// Title of the command, like `save`.
Title string `json:"title"`
// The identifier of the actual command handler.
Command string `json:"command"`
/*
* Arguments that the command handler should be
* invoked with.
*/
Arguments []json.RawMessage `json:"arguments,omitempty"`
}
// Completion client capabilities
type CompletionClientCapabilities struct { // line 11194
// Whether completion supports dynamic registration.
DynamicRegistration bool `json:"dynamicRegistration,omitempty"`
/*
* The client supports the following `CompletionItem` specific
* capabilities.
*/
CompletionItem PCompletionItemPCompletion `json:"completionItem,omitempty"`
CompletionItemKind *PCompletionItemKindPCompletion `json:"completionItemKind,omitempty"`
/*
* 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
*/
InsertTextMode InsertTextMode `json:"insertTextMode,omitempty"`
/*
* The client supports to send additional context information for a
* `textDocument/completion` request.
*/
ContextSupport bool `json:"contextSupport,omitempty"`
/*
* The client supports the following `CompletionList` specific
* capabilities.
*
* @since 3.17.0
*/
CompletionList *PCompletionListPCompletion `json:"completionList,omitempty"`
}
// Contains additional information about the context in which a completion request is triggered.
type CompletionContext struct { // line 8648
// How the completion was triggered.
TriggerKind CompletionTriggerKind `json:"triggerKind"`
/*
* The trigger character (a single character) that has trigger code complete.
* Is undefined if `triggerKind !== CompletionTriggerKind.TriggerCharacter`
*/
TriggerCharacter string `json:"triggerCharacter,omitempty"`
}
/*
* A completion item represents a text snippet that is
* proposed to complete text that is being typed.
*/
type CompletionItem struct { // line 4550
/*
* The label of this completion item.
*
* The label property is also by default the text that
* is inserted when selecting this completion.
*
* If label details are provided the label itself should
* be an unqualified name of the completion item.
*/
Label string `json:"label"`
/*
* Additional details for the label
*
* @since 3.17.0
*/
LabelDetails *CompletionItemLabelDetails `json:"labelDetails,omitempty"`
/*
* The kind of this completion item. Based of the kind
* an icon is chosen by the editor.
*/
Kind CompletionItemKind `json:"kind,omitempty"`
/*
* Tags for this completion item.
*
* @since 3.15.0
*/
Tags []CompletionItemTag `json:"tags,omitempty"`
/*
* A human-readable string with additional information
* about this item, like type or symbol information.
*/
Detail string `json:"detail,omitempty"`
// A human-readable string that represents a doc-comment.
Documentation string `json:"documentation,omitempty"`
/*
* Indicates if this item is deprecated.
* @deprecated Use `tags` instead.
*/
Deprecated bool `json:"deprecated,omitempty"`
/*
* 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.
*/
Preselect bool `json:"preselect,omitempty"`
/*
* A string that should be used when comparing this item
* with other items. When `falsy` the [label](#CompletionItem.label)
* is used.
*/
SortText string `json:"sortText,omitempty"`
/*
* A string that should be used when filtering a set of
* completion items. When `falsy` the [label](#CompletionItem.label)
* is used.
*/
FilterText string `json:"filterText,omitempty"`
/*
* A string that should be inserted into a document when selecting
* this completion. When `falsy` the [label](#CompletionItem.label)
* is used.
*
* The `insertText` is subject to interpretation by the client side.
* Some tools might not take the string literally. For example
* VS Code when code complete is requested in this example
* `con<cursor position>` and a completion item with an `insertText` of
* `console` is provided it will only insert `sole`. Therefore it is
* recommended to use `textEdit` instead since it avoids additional client
* side interpretation.
*/
InsertText string `json:"insertText,omitempty"`
/*
* 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`.
*
* Please note that the insertTextFormat doesn't apply to
* `additionalTextEdits`.
*/
InsertTextFormat InsertTextFormat `json:"insertTextFormat,omitempty"`
/*
* 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
*/
InsertTextMode InsertTextMode `json:"insertTextMode,omitempty"`
/*
* An [edit](#TextEdit) which is applied to a document when selecting
* this completion. When an edit is provided the value of
* [insertText](#CompletionItem.insertText) is ignored.
*
* Most editors support two different operations when accepting a completion
* item. One is to insert a completion text and the other is to replace an
* existing text with a completion text. Since this can usually not be
* predetermined by a server it can report both ranges. Clients need to
* signal support for `InsertReplaceEdits` via the
* `textDocument.completion.insertReplaceSupport` client capability
* property.
*
* *Note 1:* The text edit's range as well as both ranges from an insert
* replace edit must be a [single line] and they must contain the position
* at which completion has been requested.
* *Note 2:* If an `InsertReplaceEdit` is returned the edit's insert range
* must be a prefix of the edit's replace range, that means it must be
* contained and starting at the same position.
*
* @since 3.16.0 additional type `InsertReplaceEdit`
*/
TextEdit *TextEdit `json:"textEdit,omitempty"`
/*
* The edit text used if the completion item is part of a CompletionList and
* CompletionList defines an item default for the text edit range.
*
* Clients will only honor this property if they opt into completion list
* item defaults using the capability `completionList.itemDefaults`.
*
* If not provided and a list's default range is provided the label
* property is used as a text.
*
* @since 3.17.0
*/
TextEditText string `json:"textEditText,omitempty"`
/*
* An optional array of additional [text edits](#TextEdit) that are applied when
* selecting this completion. Edits must not overlap (including the same insert position)
* with the main [edit](#CompletionItem.textEdit) nor with themselves.
*
* Additional text edits should be used to change text unrelated to the current cursor position
* (for example adding an import statement at the top of the file if the completion item will
* insert an unqualified type).
*/
AdditionalTextEdits []TextEdit `json:"additionalTextEdits,omitempty"`
/*
* 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.
*/
CommitCharacters []string `json:"commitCharacters,omitempty"`
/*
* An optional [command](#Command) that is executed *after* inserting this completion. *Note* that
* additional modifications to the current document should be described with the
* [additionalTextEdits](#CompletionItem.additionalTextEdits)-property.
*/
Command *Command `json:"command,omitempty"`
/*
* A data entry field that is preserved on a completion item between a
* [CompletionRequest](#CompletionRequest) and a [CompletionResolveRequest](#CompletionResolveRequest).
*/
Data interface{} `json:"data,omitempty"`
}
// The kind of a completion entry.
type CompletionItemKind uint32 // line 13160
/*
* Additional details for a completion item label.
*
* @since 3.17.0
*/
type CompletionItemLabelDetails struct { // line 8671
/*
* 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.
*/
Detail string `json:"detail,omitempty"`
/*
* An optional string which is rendered less prominently after {@link CompletionItem.detail}. Should be used
* for fully qualified names and file paths.
*/
Description string `json:"description,omitempty"`
}
/*
* Completion item tags are extra annotations that tweak the rendering of a completion
* item.
*
* @since 3.15.0
*/
type CompletionItemTag uint32 // line 13270
/*
* Represents a collection of [completion items](#CompletionItem) to be presented
* in the editor.
*/
type CompletionList struct { // line 4758
/*
* 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.
*/
IsIncomplete bool `json:"isIncomplete"`
/*
* 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
* be used if a completion item itself doesn't specify the value.
*
* If a completion list specifies a default value and a completion item
* also specifies a corresponding value the one from the item is used.
*
* Servers are only allowed to return default values if the client
* signals support for this via the `completionList.itemDefaults`
* capability.
*
* @since 3.17.0
*/
ItemDefaults *PItemDefaultsMsg_textDocument_completion `json:"itemDefaults,omitempty"`
// The completion items.
Items []CompletionItem `json:"items"`
}
// Completion options.
type CompletionOptions struct { // line 8727
/*
* 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
* code complete will automatically pop up present `console` besides others as a
* completion item. Characters that make up identifiers don't need to be listed here.
*
* If code complete should automatically be trigger on characters not being valid inside
* an identifier (for example `.` in JavaScript) list them in `triggerCharacters`.
*/
TriggerCharacters []string `json:"triggerCharacters,omitempty"`
/*
* 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`
*
* If a server provides both `allCommitCharacters` and commit characters on an individual
* completion item the ones on the completion item win.
*
* @since 3.2.0
*/
AllCommitCharacters []string `json:"allCommitCharacters,omitempty"`
/*
* The server provides support to resolve additional
* information for a completion item.
*/
ResolveProvider bool `json:"resolveProvider,omitempty"`
/*
* The server supports the following `CompletionItem` specific
* capabilities.
*
* @since 3.17.0
*/
CompletionItem *PCompletionItemPCompletionProvider `json:"completionItem,omitempty"`
WorkDoneProgressOptions
}
// Completion parameters
type CompletionParams struct { // line 4519
/*
* The completion context. This is only available it the client specifies
* to send this using the client capability `textDocument.completion.contextSupport === true`
*/
Context CompletionContext `json:"context,omitempty"`
TextDocumentPositionParams
WorkDoneProgressParams
PartialResultParams
}
// Registration options for a [CompletionRequest](#CompletionRequest).
type CompletionRegistrationOptions struct { // line 4875
TextDocumentRegistrationOptions
CompletionOptions
}
// How a completion was triggered
type CompletionTriggerKind uint32 // line 13581
type ConfigurationItem struct { // line 6401
// The scope to get the configuration section for.
ScopeURI string `json:"scopeUri,omitempty"`
// The configuration section asked for.
Section string `json:"section,omitempty"`
}
// The parameters of a configuration request.
type ConfigurationParams struct { // line 2207
Items []ConfigurationItem `json:"items"`
}
// Create file operation.
type CreateFile struct { // line 6717
// A create
Kind string `json:"kind"`
// The resource to create.
URI DocumentURI `json:"uri"`
// Additional options
Options *CreateFileOptions `json:"options,omitempty"`
ResourceOperation
}
// Options to create a file.
type CreateFileOptions struct { // line 9437
// Overwrite existing file. Overwrite wins over `ignoreIfExists`
Overwrite bool `json:"overwrite,omitempty"`
// Ignore if exists.
IgnoreIfExists bool `json:"ignoreIfExists,omitempty"`
}
/*
* The parameters sent in notifications/requests for user-initiated creation of
* files.
*
* @since 3.16.0
*/
type CreateFilesParams struct { // line 3197
// An array of all files/folders created in this operation.
Files []FileCreate `json:"files"`
}
// The declaration of a symbol representation as one or many [locations](#Location).
type Declaration = []Location // (alias) line 13859
// @since 3.14.0
type DeclarationClientCapabilities struct { // line 11535
/*
* 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.
*/
DynamicRegistration bool `json:"dynamicRegistration,omitempty"`
// The client supports additional metadata in the form of declaration links.
LinkSupport bool `json:"linkSupport,omitempty"`
}
/*
* Information about where a symbol is declared.
*
* Provides additional metadata over normal [location](#Location) declarations, including the range of
* the declaring symbol.
*
* Servers should prefer returning `DeclarationLink` over `Declaration` if supported
* by the client.
*/
type DeclarationLink = LocationLink // (alias) line 13879
type DeclarationOptions struct { // line 6496
WorkDoneProgressOptions
}
type DeclarationParams struct { // line 2516
TextDocumentPositionParams
WorkDoneProgressParams
PartialResultParams
}
type DeclarationRegistrationOptions struct { // line 2536
DeclarationOptions
TextDocumentRegistrationOptions
StaticRegistrationOptions
}
/*
* The definition of a symbol represented as one or many [locations](#Location).
* For most programming languages there is only one location at which a symbol is
* defined.
*
* Servers should prefer returning `DefinitionLink` over `Definition` if supported
* by the client.
*/
type Definition = Or_Definition // (alias) line 13777
// Client Capabilities for a [DefinitionRequest](#DefinitionRequest).
type DefinitionClientCapabilities struct { // line 11560
// Whether definition supports dynamic registration.
DynamicRegistration bool `json:"dynamicRegistration,omitempty"`
/*
* The client supports additional metadata in the form of definition links.
*
* @since 3.14.0
*/
LinkSupport bool `json:"linkSupport,omitempty"`
}
/*
* Information about where a symbol is defined.
*
* Provides additional metadata over normal [location](#Location) definitions, including the range of
* the defining symbol
*/
type DefinitionLink = LocationLink // (alias) line 13797
// Server Capabilities for a [DefinitionRequest](#DefinitionRequest).
type DefinitionOptions struct { // line 8939
WorkDoneProgressOptions
}
// Parameters for a [DefinitionRequest](#DefinitionRequest).
type DefinitionParams struct { // line 5039
TextDocumentPositionParams
WorkDoneProgressParams
PartialResultParams
}
// Registration options for a [DefinitionRequest](#DefinitionRequest).
type DefinitionRegistrationOptions struct { // line 5060
TextDocumentRegistrationOptions
DefinitionOptions
}
// Delete file operation
type DeleteFile struct { // line 6799
// A delete
Kind string `json:"kind"`
// The file to delete.
URI DocumentURI `json:"uri"`
// Delete options.
Options *DeleteFileOptions `json:"options,omitempty"`
ResourceOperation
}
// Delete file options
type DeleteFileOptions struct { // line 9485
// Delete the content recursively if a folder is denoted.
Recursive bool `json:"recursive,omitempty"`
// Ignore the operation if the file doesn't exist.
IgnoreIfNotExists bool `json:"ignoreIfNotExists,omitempty"`
}
/*
* The parameters sent in notifications/requests for user-initiated deletes of
* files.
*
* @since 3.16.0
*/
type DeleteFilesParams struct { // line 3322
// An array of all files/folders deleted in this operation.
Files []FileDelete `json:"files"`
}
/*
* Represents a diagnostic, such as a compiler error or warning. Diagnostic objects
* are only valid in the scope of a resource.
*/
type Diagnostic struct { // line 8545
// The range at which the message applies
Range Range `json:"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.
*/
Severity DiagnosticSeverity `json:"severity,omitempty"`
// The diagnostic's code, which usually appear in the user interface.
Code interface{} `json:"code,omitempty"`
/*
* An optional property to describe the error code.
* Requires the code field (above) to be present/not null.
*
* @since 3.16.0
*/
CodeDescription *CodeDescription `json:"codeDescription,omitempty"`
/*
* A human-readable string describing the source of this
* diagnostic, e.g. 'typescript' or 'super lint'. It usually
* appears in the user interface.
*/
Source string `json:"source,omitempty"`
// The diagnostic's message. It usually appears in the user interface
Message string `json:"message"`
/*
* Additional metadata about the diagnostic.
*
* @since 3.15.0
*/
Tags []DiagnosticTag `json:"tags,omitempty"`
/*
* An array of related diagnostic information, e.g. when symbol-names within
* a scope collide all definitions can be marked via this property.
*/
RelatedInformation []DiagnosticRelatedInformation `json:"relatedInformation,omitempty"`
/*
* A data entry field that is preserved between a `textDocument/publishDiagnostics`
* notification and `textDocument/codeAction` request.
*
* @since 3.16.0
*/
Data interface{} `json:"data,omitempty"`
}
/*
* Client capabilities specific to diagnostic pull requests.
*
* @since 3.17.0
*/
type DiagnosticClientCapabilities struct { // line 12434
/*
* 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.
*/
DynamicRegistration bool `json:"dynamicRegistration,omitempty"`
// Whether the clients supports related documents for document diagnostic pulls.
RelatedDocumentSupport bool `json:"relatedDocumentSupport,omitempty"`
}
/*
* Diagnostic options.
*
* @since 3.17.0
*/
type DiagnosticOptions struct { // line 7298
/*
* An optional identifier under which the diagnostics are
* managed by the client.
*/
Identifier string `json:"identifier,omitempty"`
/*
* 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.
*/
InterFileDependencies bool `json:"interFileDependencies"`
// The server provides support for workspace diagnostics as well.
WorkspaceDiagnostics bool `json:"workspaceDiagnostics"`
WorkDoneProgressOptions
}
/*
* Diagnostic registration options.
*
* @since 3.17.0
*/
type DiagnosticRegistrationOptions struct { // line 3877
TextDocumentRegistrationOptions
DiagnosticOptions
StaticRegistrationOptions
}
/*
* Represents a related message and source code location for a diagnostic. This should be
* used to point to code locations that cause or related to a diagnostics, e.g when duplicating
* a symbol in a scope.
*/
type DiagnosticRelatedInformation struct { // line 10067
// The location of this related diagnostic information.
Location Location `json:"location"`
// The message of this related diagnostic information.
Message string `json:"message"`
}
/*
* Cancellation data returned from a diagnostic request.
*
* @since 3.17.0
*/
type DiagnosticServerCancellationData struct { // line 3863
RetriggerRequest bool `json:"retriggerRequest"`
}
// The diagnostic's severity.
type DiagnosticSeverity uint32 // line 13530
/*
* The diagnostic tags.
*
* @since 3.15.0
*/
type DiagnosticTag uint32 // line 13560
/*
* Workspace client capabilities specific to diagnostic pull requests.
*
* @since 3.17.0
*/
type DiagnosticWorkspaceClientCapabilities struct { // line 11137
/*
* Whether the client implementation supports a refresh request sent from
* the server to the client.
*
* Note that this event is global and will force the client to refresh all
* pulled diagnostics currently shown. It should be used with absolute care and
* is useful for situation where a server for example detects a project wide
* change that requires such a calculation.
*/
RefreshSupport bool `json:"refreshSupport,omitempty"`
}
type DidChangeConfigurationClientCapabilities struct { // line 10863
// Did change configuration notification supports dynamic registration.
DynamicRegistration bool `json:"dynamicRegistration,omitempty"`
}
// The parameters of a change configuration notification.
type DidChangeConfigurationParams struct { // line 4166
// The actual changed settings
Settings interface{} `json:"settings"`
}
type DidChangeConfigurationRegistrationOptions struct { // line 4180
Section *OrPSection_workspace_didChangeConfiguration `json:"section,omitempty"`
}
/*
* The params sent in a change notebook document notification.
*
* @since 3.17.0
*/
type DidChangeNotebookDocumentParams struct { // line 3996
/*
* 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.
*/
NotebookDocument VersionedNotebookDocumentIdentifier `json:"notebookDocument"`
/*
* The actual changes to the notebook document.
*
* The changes describe single state changes to the notebook document.
* So if there are two changes c1 (at array index 0) and c2 (at array
* index 1) for a notebook in state S then c1 moves the notebook from
* S to S' and c2 from S' to S''. So c1 is computed on the state S and
* c2 is computed on the state S'.
*
* To mirror the content of a notebook using change events use the following approach:
* - start with the same initial content
* - apply the 'notebookDocument/didChange' notifications in the order you receive them.
* - apply the `NotebookChangeEvent`s in a single notification in the order
* you receive them.
*/
Change NotebookDocumentChangeEvent `json:"change"`
}
// The change text document notification's parameters.
type DidChangeTextDocumentParams struct { // line 4309
/*
* The document that did change. The version number points
* to the version after all provided content changes have
* been applied.
*/
TextDocument VersionedTextDocumentIdentifier `json:"textDocument"`
/*
* 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
* S to S' and c2 from S' to S''. So c1 is computed on the state S and c2 is computed
* on the state S'.
*
* To mirror the content of a document using change events use the following approach:
* - start with the same initial content
* - apply the 'textDocument/didChange' notifications in the order you receive them.
* - apply the `TextDocumentContentChangeEvent`s in a single notification in the order
* you receive them.
*/
ContentChanges []TextDocumentContentChangeEvent `json:"contentChanges"`
}
type DidChangeWatchedFilesClientCapabilities struct { // line 10877
/*
* 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.
*/
DynamicRegistration bool `json:"dynamicRegistration,omitempty"`
/*
* Whether the client has support for {@link RelativePattern relative pattern}
* or not.
*
* @since 3.17.0
*/
RelativePatternSupport bool `json:"relativePatternSupport,omitempty"`
}
// The watched files change notification's parameters.
type DidChangeWatchedFilesParams struct { // line 4450
// The actual file events.
Changes []FileEvent `json:"changes"`
}
// Describe options to be used when registered for text document change events.
type DidChangeWatchedFilesRegistrationOptions struct { // line 4467
// The watchers to register.
Watchers []FileSystemWatcher `json:"watchers"`
}
// The parameters of a `workspace/didChangeWorkspaceFolders` notification.
type DidChangeWorkspaceFoldersParams struct { // line 2193
// The actual workspace folder change event.
Event WorkspaceFoldersChangeEvent `json:"event"`
}
/*
* The params sent in a close notebook document notification.
*
* @since 3.17.0
*/
type DidCloseNotebookDocumentParams struct { // line 4034
// The notebook document that got closed.
NotebookDocument NotebookDocumentIdentifier `json:"notebookDocument"`
/*
* The text documents that represent the content
* of a notebook cell that got closed.
*/
CellTextDocuments []TextDocumentIdentifier `json:"cellTextDocuments"`
}
// The parameters sent in a close text document notification
type DidCloseTextDocumentParams struct { // line 4354
// The document that was closed.
TextDocument TextDocumentIdentifier `json:"textDocument"`
}
/*
* The params sent in an open notebook document notification.
*
* @since 3.17.0
*/
type DidOpenNotebookDocumentParams struct { // line 3970
// The notebook document that got opened.
NotebookDocument NotebookDocument `json:"notebookDocument"`
/*
* The text documents that represent the content
* of a notebook cell.
*/
CellTextDocuments []TextDocumentItem `json:"cellTextDocuments"`
}
// The parameters sent in an open text document notification
type DidOpenTextDocumentParams struct { // line 4295
// The document that was opened.
TextDocument TextDocumentItem `json:"textDocument"`
}
/*
* The params sent in a save notebook document notification.
*
* @since 3.17.0
*/
type DidSaveNotebookDocumentParams struct { // line 4019
// The notebook document that got saved.
NotebookDocument NotebookDocumentIdentifier `json:"notebookDocument"`
}
// The parameters sent in a save text document notification
type DidSaveTextDocumentParams struct { // line 4368
// The document that was saved.
TextDocument TextDocumentIdentifier `json:"textDocument"`
/*
* Optional the content when saved. Depends on the includeText value
* when the save notification was requested.
*/
Text *string `json:"text,omitempty"`
}
type DocumentColorClientCapabilities struct { // line 11901
/*
* 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.
*/
DynamicRegistration bool `json:"dynamicRegistration,omitempty"`
}
type DocumentColorOptions struct { // line 6476
WorkDoneProgressOptions
}
// Parameters for a [DocumentColorRequest](#DocumentColorRequest).
type DocumentColorParams struct { // line 2237
// The text document.
TextDocument TextDocumentIdentifier `json:"textDocument"`
WorkDoneProgressParams
PartialResultParams
}
type DocumentColorRegistrationOptions struct { // line 2283
TextDocumentRegistrationOptions
DocumentColorOptions
StaticRegistrationOptions
}
/*
* Parameters of the document diagnostic request.
*
* @since 3.17.0
*/
type DocumentDiagnosticParams struct { // line 3790
// The text document.
TextDocument TextDocumentIdentifier `json:"textDocument"`
// The additional identifier provided during registration.
Identifier string `json:"identifier,omitempty"`
// The result id of a previous response if provided.
PreviousResultID string `json:"previousResultId,omitempty"`
WorkDoneProgressParams
PartialResultParams
}
type DocumentDiagnosticReport = Or_DocumentDiagnosticReport // (alias) line 13909
/*
* The document diagnostic report kinds.
*
* @since 3.17.0
*/
type DocumentDiagnosticReportKind string // line 12748
/*
* A partial result for a document diagnostic report.
*
* @since 3.17.0
*/
type DocumentDiagnosticReportPartialResult struct { // line 3833
RelatedDocuments map[DocumentURI]interface{} `json:"relatedDocuments"`
}
/*
* A document filter describes a top level text document or
* a notebook cell document.
*
* @since 3.17.0 - proposed support for NotebookCellTextDocumentFilter.
*/
type DocumentFilter = Or_DocumentFilter // (alias) line 14118
// Client capabilities of a [DocumentFormattingRequest](#DocumentFormattingRequest).
type DocumentFormattingClientCapabilities struct { // line 11915
// Whether formatting supports dynamic registration.
DynamicRegistration bool `json:"dynamicRegistration,omitempty"`
}
// Provider options for a [DocumentFormattingRequest](#DocumentFormattingRequest).
type DocumentFormattingOptions struct { // line 9241
WorkDoneProgressOptions
}
// The parameters of a [DocumentFormattingRequest](#DocumentFormattingRequest).
type DocumentFormattingParams struct { // line 5746
// The document to format.
TextDocument TextDocumentIdentifier `json:"textDocument"`
// The format options.
Options FormattingOptions `json:"options"`
WorkDoneProgressParams
}
// Registration options for a [DocumentFormattingRequest](#DocumentFormattingRequest).
type DocumentFormattingRegistrationOptions struct { // line 5774
TextDocumentRegistrationOptions
DocumentFormattingOptions
}
/*
* A document highlight is a range inside a text document which deserves
* special attention. Usually a document highlight is visualized by changing
* the background color of its range.
*/
type DocumentHighlight struct { // line 5140
// The range this highlight applies to.
Range Range `json:"range"`
// The highlight kind, default is [text](#DocumentHighlightKind.Text).
Kind DocumentHighlightKind `json:"kind,omitempty"`
}
// Client Capabilities for a [DocumentHighlightRequest](#DocumentHighlightRequest).
type DocumentHighlightClientCapabilities struct { // line 11650
// Whether document highlight supports dynamic registration.
DynamicRegistration bool `json:"dynamicRegistration,omitempty"`
}
// A document highlight kind.
type DocumentHighlightKind uint32 // line 13327
// Provider options for a [DocumentHighlightRequest](#DocumentHighlightRequest).
type DocumentHighlightOptions struct { // line 8975
WorkDoneProgressOptions
}
// Parameters for a [DocumentHighlightRequest](#DocumentHighlightRequest).
type DocumentHighlightParams struct { // line 5119
TextDocumentPositionParams
WorkDoneProgressParams
PartialResultParams
}
// Registration options for a [DocumentHighlightRequest](#DocumentHighlightRequest).
type DocumentHighlightRegistrationOptions struct { // line 5163
TextDocumentRegistrationOptions
DocumentHighlightOptions
}
/*
* 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.
*/
type DocumentLink struct { // line 5689
// The range this link applies to.
Range Range `json:"range"`
// The uri this link points to. If missing a resolve request is sent later.
Target string `json:"target,omitempty"`
/*
* 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
* trigger the link, such as `{0} (ctrl + click)`. The specific instructions vary depending on OS,
* user settings, and localization.
*
* @since 3.15.0
*/
Tooltip string `json:"tooltip,omitempty"`
/*
* A data entry field that is preserved on a document link between a
* DocumentLinkRequest and a DocumentLinkResolveRequest.
*/
Data interface{} `json:"data,omitempty"`
}
// The client capabilities of a [DocumentLinkRequest](#DocumentLinkRequest).
type DocumentLinkClientCapabilities struct { // line 11876
// Whether document link supports dynamic registration.
DynamicRegistration bool `json:"dynamicRegistration,omitempty"`
/*
* Whether the client supports the `tooltip` property on `DocumentLink`.
*
* @since 3.15.0
*/
TooltipSupport bool `json:"tooltipSupport,omitempty"`
}
// Provider options for a [DocumentLinkRequest](#DocumentLinkRequest).
type DocumentLinkOptions struct { // line 9168
// Document links have a resolve provider as well.
ResolveProvider bool `json:"resolveProvider,omitempty"`
WorkDoneProgressOptions
}
// The parameters of a [DocumentLinkRequest](#DocumentLinkRequest).
type DocumentLinkParams struct { // line 5665
// The document to provide document links for.
TextDocument TextDocumentIdentifier `json:"textDocument"`
WorkDoneProgressParams
PartialResultParams
}
// Registration options for a [DocumentLinkRequest](#DocumentLinkRequest).
type DocumentLinkRegistrationOptions struct { // line 5731
TextDocumentRegistrationOptions
DocumentLinkOptions
}
// Client capabilities of a [DocumentOnTypeFormattingRequest](#DocumentOnTypeFormattingRequest).
type DocumentOnTypeFormattingClientCapabilities struct { // line 11945
// Whether on type formatting supports dynamic registration.
DynamicRegistration bool `json:"dynamicRegistration,omitempty"`
}
// Provider options for a [DocumentOnTypeFormattingRequest](#DocumentOnTypeFormattingRequest).
type DocumentOnTypeFormattingOptions struct { // line 9263
// A character on which formatting should be triggered, like `{`.
FirstTriggerCharacter string `json:"firstTriggerCharacter"`
// More trigger characters.
MoreTriggerCharacter []string `json:"moreTriggerCharacter,omitempty"`
}
// The parameters of a [DocumentOnTypeFormattingRequest](#DocumentOnTypeFormattingRequest).
type DocumentOnTypeFormattingParams struct { // line 5840
// The document to format.
TextDocument TextDocumentIdentifier `json:"textDocument"`
/*
* 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.
*/
Position Position `json:"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).
*/
Ch string `json:"ch"`
// The formatting options.
Options FormattingOptions `json:"options"`
}
// Registration options for a [DocumentOnTypeFormattingRequest](#DocumentOnTypeFormattingRequest).
type DocumentOnTypeFormattingRegistrationOptions struct { // line 5878
TextDocumentRegistrationOptions
DocumentOnTypeFormattingOptions
}
// Client capabilities of a [DocumentRangeFormattingRequest](#DocumentRangeFormattingRequest).
type DocumentRangeFormattingClientCapabilities struct { // line 11930
// Whether range formatting supports dynamic registration.
DynamicRegistration bool `json:"dynamicRegistration,omitempty"`
}
// Provider options for a [DocumentRangeFormattingRequest](#DocumentRangeFormattingRequest).
type DocumentRangeFormattingOptions struct { // line 9252
WorkDoneProgressOptions
}
// The parameters of a [DocumentRangeFormattingRequest](#DocumentRangeFormattingRequest).
type DocumentRangeFormattingParams struct { // line 5789
// The document to format.
TextDocument TextDocumentIdentifier `json:"textDocument"`
// The range to format
Range Range `json:"range"`
// The format options
Options FormattingOptions `json:"options"`
WorkDoneProgressParams
}
// Registration options for a [DocumentRangeFormattingRequest](#DocumentRangeFormattingRequest).
type DocumentRangeFormattingRegistrationOptions struct { // line 5825
TextDocumentRegistrationOptions
DocumentRangeFormattingOptions
}
/*
* A document selector is the combination of one or many document filters.
*
* @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.
*/
type DocumentSelector = []DocumentFilter // (alias) line 13990
/*
* Represents programming constructs like variables, classes, interfaces etc.
* that appear in a document. Document symbols can be hierarchical and they
* have two ranges: one that encloses its definition and one that points to
* its most interesting range, e.g. the range of an identifier.
*/
type DocumentSymbol struct { // line 5231
/*
* 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.
*/
Name string `json:"name"`
// More detail for this symbol, e.g the signature of a function.
Detail string `json:"detail,omitempty"`
// The kind of this symbol.
Kind SymbolKind `json:"kind"`
/*
* Tags for this document symbol.
*
* @since 3.16.0
*/
Tags []SymbolTag `json:"tags,omitempty"`
/*
* Indicates if this symbol is deprecated.
*
* @deprecated Use tags instead
*/
Deprecated bool `json:"deprecated,omitempty"`
/*
* 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.
*/
Range Range `json:"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`.
*/
SelectionRange Range `json:"selectionRange"`
// Children of this symbol, e.g. properties of a class.
Children []DocumentSymbol `json:"children,omitempty"`
}
// Client Capabilities for a [DocumentSymbolRequest](#DocumentSymbolRequest).
type DocumentSymbolClientCapabilities struct { // line 11665
// Whether document symbol supports dynamic registration.
DynamicRegistration bool `json:"dynamicRegistration,omitempty"`
/*
* Specific capabilities for the `SymbolKind` in the
* `textDocument/documentSymbol` request.
*/
SymbolKind *PSymbolKindPDocumentSymbol `json:"symbolKind,omitempty"`
// The client supports hierarchical document symbols.
HierarchicalDocumentSymbolSupport bool `json:"hierarchicalDocumentSymbolSupport,omitempty"`
/*
* 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
*/
TagSupport *PTagSupportPDocumentSymbol `json:"tagSupport,omitempty"`
/*
* The client supports an additional label presented in the UI when
* registering a document symbol provider.
*
* @since 3.16.0
*/
LabelSupport bool `json:"labelSupport,omitempty"`
}
// Provider options for a [DocumentSymbolRequest](#DocumentSymbolRequest).
type DocumentSymbolOptions struct { // line 9030
/*
* A human-readable string that is shown when multiple outlines trees
* are shown for the same document.
*
* @since 3.16.0
*/
Label string `json:"label,omitempty"`
WorkDoneProgressOptions
}
// Parameters for a [DocumentSymbolRequest](#DocumentSymbolRequest).
type DocumentSymbolParams struct { // line 5178
// The text document.
TextDocument TextDocumentIdentifier `json:"textDocument"`
WorkDoneProgressParams
PartialResultParams
}
// Registration options for a [DocumentSymbolRequest](#DocumentSymbolRequest).
type DocumentSymbolRegistrationOptions struct { // line 5312
TextDocumentRegistrationOptions
DocumentSymbolOptions
}
type DocumentURI string
// Predefined error codes.
type ErrorCodes int32 // line 12769
// The client capabilities of a [ExecuteCommandRequest](#ExecuteCommandRequest).
type ExecuteCommandClientCapabilities struct { // line 10988
// Execute command supports dynamic registration.
DynamicRegistration bool `json:"dynamicRegistration,omitempty"`
}
// The server capabilities of a [ExecuteCommandRequest](#ExecuteCommandRequest).
type ExecuteCommandOptions struct { // line 9311
// The commands to be executed on the server
Commands []string `json:"commands"`
WorkDoneProgressOptions
}
// The parameters of a [ExecuteCommandRequest](#ExecuteCommandRequest).
type ExecuteCommandParams struct { // line 5960
// The identifier of the actual command handler.
Command string `json:"command"`
// Arguments that the command should be invoked with.
Arguments []json.RawMessage `json:"arguments,omitempty"`
WorkDoneProgressParams
}
// Registration options for a [ExecuteCommandRequest](#ExecuteCommandRequest).
type ExecuteCommandRegistrationOptions struct { // line 5992
ExecuteCommandOptions
}
type ExecutionSummary struct { // line 10188
/*
* A strict monotonically increasing value
* indicating the execution order of a cell
* inside a notebook.
*/
ExecutionOrder uint32 `json:"executionOrder"`
/*
* Whether the execution was successful or
* not if known by the client.
*/
Success bool `json:"success,omitempty"`
}
// created for Literal (Lit_NotebookDocumentSyncOptions_notebookSelector_Elem_Item0_cells_Elem)
type FCellsPNotebookSelector struct { // line 9857
Language string `json:"language"`
}
// created for Literal (Lit_CodeActionClientCapabilities_codeActionLiteralSupport_codeActionKind)
type FCodeActionKindPCodeActionLiteralSupport struct { // line 11768
/*
* 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.
*/
ValueSet []CodeActionKind `json:"valueSet"`
}
// created for Literal (Lit_CompletionList_itemDefaults_editRange_Item1)
type FEditRangePItemDefaults struct { // line 4798
Insert Range `json:"insert"`
Replace Range `json:"replace"`
}
// created for Literal (Lit_SemanticTokensClientCapabilities_requests_full_Item1)
type FFullPRequests struct { // line 12231
/*
* The client will send the `textDocument/semanticTokens/full/delta` request if
* the server provides a corresponding handler.
*/
Delta bool `json:"delta"`
}
// created for Literal (Lit_CompletionClientCapabilities_completionItem_insertTextModeSupport)
type FInsertTextModeSupportPCompletionItem struct { // line 11321
ValueSet []InsertTextMode `json:"valueSet"`
}
// created for Literal (Lit_SignatureHelpClientCapabilities_signatureInformation_parameterInformation)
type FParameterInformationPSignatureInformation struct { // line 11487
/*
* The client supports processing label offsets instead of a
* simple label string.
*
* @since 3.14.0
*/
LabelOffsetSupport bool `json:"labelOffsetSupport"`
}
// created for Literal (Lit_SemanticTokensClientCapabilities_requests_range_Item1)
type FRangePRequests struct { // line 12211
}
// created for Literal (Lit_CompletionClientCapabilities_completionItem_resolveSupport)
type FResolveSupportPCompletionItem struct { // line 11297
// The properties that a client can resolve lazily.
Properties []string `json:"properties"`
}
// created for Literal (Lit_NotebookDocumentChangeEvent_cells_structure)
type FStructurePCells struct { // line 7492
// The change to the cell array.
Array NotebookCellArrayChange `json:"array"`
// Additional opened cell text documents.
DidOpen []TextDocumentItem `json:"didOpen"`
// Additional closed cell text documents.
DidClose []TextDocumentIdentifier `json:"didClose"`
}
// created for Literal (Lit_CompletionClientCapabilities_completionItem_tagSupport)
type FTagSupportPCompletionItem struct { // line 11263
// The tags supported by the client.
ValueSet []CompletionItemTag `json:"valueSet"`
}
// created for Literal (Lit_NotebookDocumentChangeEvent_cells_textContent_Elem)
type FTextContentPCells struct { // line 7550
Document VersionedTextDocumentIdentifier `json:"document"`
Changes []TextDocumentContentChangeEvent `json:"changes"`
}
type FailureHandlingKind string // line 13719
// The file event type
type FileChangeType uint32 // line 13480
/*
* Represents information on a file/folder create.
*
* @since 3.16.0
*/
type FileCreate struct { // line 6667
// A file:// URI for the location of the file/folder being created.
URI string `json:"uri"`
}
/*
* Represents information on a file/folder delete.
*
* @since 3.16.0
*/
type FileDelete struct { // line 6916
// A file:// URI for the location of the file/folder being deleted.
URI string `json:"uri"`
}
// An event describing a file change.
type FileEvent struct { // line 8500
// The file's uri.
URI DocumentURI `json:"uri"`
// The change type.
Type FileChangeType `json:"type"`
}
/*
* Capabilities relating to events from file operations by the user in the client.
*
* These events do not come from the file system, they come from user operations
* like renaming a file in the UI.
*
* @since 3.16.0
*/
type FileOperationClientCapabilities struct { // line 11035
// Whether the client supports dynamic registration for file requests/notifications.
DynamicRegistration bool `json:"dynamicRegistration,omitempty"`
// The client has support for sending didCreateFiles notifications.
DidCreate bool `json:"didCreate,omitempty"`
// The client has support for sending willCreateFiles requests.
WillCreate bool `json:"willCreate,omitempty"`
// The client has support for sending didRenameFiles notifications.
DidRename bool `json:"didRename,omitempty"`
// The client has support for sending willRenameFiles requests.
WillRename bool `json:"willRename,omitempty"`
// The client has support for sending didDeleteFiles notifications.
DidDelete bool `json:"didDelete,omitempty"`
// The client has support for sending willDeleteFiles requests.
WillDelete bool `json:"willDelete,omitempty"`
}
/*
* A filter to describe in which file operation requests or notifications
* the server is interested in receiving.
*
* @since 3.16.0
*/
type FileOperationFilter struct { // line 6869
// A Uri scheme like `file` or `untitled`.
Scheme string `json:"scheme,omitempty"`
// The actual file operation pattern.
Pattern FileOperationPattern `json:"pattern"`
}
/*
* Options for notifications/requests for user operations on files.
*
* @since 3.16.0
*/
type FileOperationOptions struct { // line 9991
// The server is interested in receiving didCreateFiles notifications.
DidCreate *FileOperationRegistrationOptions `json:"didCreate,omitempty"`
// The server is interested in receiving willCreateFiles requests.
WillCreate *FileOperationRegistrationOptions `json:"willCreate,omitempty"`
// The server is interested in receiving didRenameFiles notifications.
DidRename *FileOperationRegistrationOptions `json:"didRename,omitempty"`
// The server is interested in receiving willRenameFiles requests.
WillRename *FileOperationRegistrationOptions `json:"willRename,omitempty"`
// The server is interested in receiving didDeleteFiles file notifications.
DidDelete *FileOperationRegistrationOptions `json:"didDelete,omitempty"`
// The server is interested in receiving willDeleteFiles file requests.
WillDelete *FileOperationRegistrationOptions `json:"willDelete,omitempty"`
}
/*
* A pattern to describe in which file operation requests or notifications
* the server is interested in receiving.
*
* @since 3.16.0
*/
type FileOperationPattern struct { // line 9509
/*
* 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 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`)
*/
Glob string `json:"glob"`
/*
* Whether to match files or folders with this pattern.
*
* Matches both if undefined.
*/
Matches FileOperationPatternKind `json:"matches,omitempty"`
// Additional options used during matching.
Options *FileOperationPatternOptions `json:"options,omitempty"`
}
/*
* A pattern kind describing if a glob pattern matches a file a folder or
* both.
*
* @since 3.16.0
*/
type FileOperationPatternKind string // line 13653
/*
* Matching options for the file operation pattern.
*
* @since 3.16.0
*/
type FileOperationPatternOptions struct { // line 10172
// The pattern should be matched ignoring casing.
IgnoreCase bool `json:"ignoreCase,omitempty"`
}
/*
* The options to register for file operations.
*
* @since 3.16.0
*/
type FileOperationRegistrationOptions struct { // line 3286
// The actual filters.
Filters []FileOperationFilter `json:"filters"`
}
/*
* Represents information on a file/folder rename.
*
* @since 3.16.0
*/
type FileRename struct { // line 6893
// A file:// URI for the original location of the file/folder being renamed.
OldURI string `json:"oldUri"`
// A file:// URI for the new location of the file/folder being renamed.
NewURI string `json:"newUri"`
}
type FileSystemWatcher struct { // line 8522
/*
* The glob pattern to watch. See {@link GlobPattern glob pattern} for more detail.
*
* @since 3.17.0 support for relative patterns.
*/
GlobPattern GlobPattern `json:"globPattern"`
/*
* The kind of events of interest. If omitted it defaults
* to WatchKind.Create | WatchKind.Change | WatchKind.Delete
* which is 7.
*/
Kind WatchKind `json:"kind,omitempty"`
}
/*
* 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.
*/
type FoldingRange struct { // line 2437
/*
* 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.
*/
StartLine uint32 `json:"startLine"`
// The zero-based character offset from where the folded range starts. If not defined, defaults to the length of the start line.
StartCharacter uint32 `json:"startCharacter,omitempty"`
/*
* 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.
*/
EndLine uint32 `json:"endLine"`
// The zero-based character offset before the folded range ends. If not defined, defaults to the length of the end line.
EndCharacter uint32 `json:"endCharacter,omitempty"`
/*
* 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 [FoldingRangeKind](#FoldingRangeKind) for an enumeration of standardized kinds.
*/
Kind string `json:"kind,omitempty"`
/*
* 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.
*
* @since 3.17.0
*/
CollapsedText string `json:"collapsedText,omitempty"`
}
type FoldingRangeClientCapabilities struct { // line 12004
/*
* 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.
*/
DynamicRegistration bool `json:"dynamicRegistration,omitempty"`
/*
* 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.
*/
RangeLimit uint32 `json:"rangeLimit,omitempty"`
/*
* 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.
*/
LineFoldingOnly bool `json:"lineFoldingOnly,omitempty"`
/*
* Specific options for the folding range kind.
*
* @since 3.17.0
*/
FoldingRangeKind *PFoldingRangeKindPFoldingRange `json:"foldingRangeKind,omitempty"`
/*
* Specific options for the folding range.
*
* @since 3.17.0
*/
FoldingRange *PFoldingRangePFoldingRange `json:"foldingRange,omitempty"`
}
// A set of predefined range kinds.
type FoldingRangeKind string // line 12841
type FoldingRangeOptions struct { // line 6486
WorkDoneProgressOptions
}
// Parameters for a [FoldingRangeRequest](#FoldingRangeRequest).
type FoldingRangeParams struct { // line 2413
// The text document.
TextDocument TextDocumentIdentifier `json:"textDocument"`
WorkDoneProgressParams
PartialResultParams
}
type FoldingRangeRegistrationOptions struct { // line 2496
TextDocumentRegistrationOptions
FoldingRangeOptions
StaticRegistrationOptions
}
// Value-object describing what options formatting should use.
type FormattingOptions struct { // line 9189
// Size of a tab in spaces.
TabSize uint32 `json:"tabSize"`
// Prefer spaces over tabs.
InsertSpaces bool `json:"insertSpaces"`
/*
* Trim trailing whitespace on a line.
*
* @since 3.15.0
*/
TrimTrailingWhitespace bool `json:"trimTrailingWhitespace,omitempty"`
/*
* Insert a newline character at the end of the file if one does not exist.
*
* @since 3.15.0
*/
InsertFinalNewline bool `json:"insertFinalNewline,omitempty"`
/*
* Trim all newlines after the final newline at the end of the file.
*
* @since 3.15.0
*/
TrimFinalNewlines bool `json:"trimFinalNewlines,omitempty"`
}
/*
* A diagnostic report with a full set of problems.
*
* @since 3.17.0
*/
type FullDocumentDiagnosticReport struct { // line 7240
// A full document diagnostic report.
Kind string `json:"kind"`
/*
* An optional result id. If provided it will
* be sent on the next diagnostic request for the
* same document.
*/
ResultID string `json:"resultId,omitempty"`
// The actual items.
Items []Diagnostic `json:"items"`
}
/*
* General client capabilities.
*
* @since 3.16.0
*/
type GeneralClientCapabilities struct { // line 10690
/*
* 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
*/
StaleRequestSupport *PStaleRequestSupportPGeneral `json:"staleRequestSupport,omitempty"`
/*
* Client capabilities specific to regular expressions.
*
* @since 3.16.0
*/
RegularExpressions *RegularExpressionsClientCapabilities `json:"regularExpressions,omitempty"`
/*
* Client capabilities specific to the client's markdown parser.
*
* @since 3.16.0
*/
Markdown *MarkdownClientCapabilities `json:"markdown,omitempty"`
/*
* 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
* sides.
*
* To keep the protocol backwards compatible the following applies: if
* the value 'utf-16' is missing from the array of position encodings
* servers can assume that the client supports UTF-16. UTF-16 is
* therefore a mandatory encoding.
*
* If omitted it defaults to ['utf-16'].
*
* Implementation considerations: since the conversion from one encoding
* into another requires the content of the file / line the conversion
* is best done where the file is read which is usually on the server
* side.
*
* @since 3.17.0
*/
PositionEncodings []PositionEncodingKind `json:"positionEncodings,omitempty"`
}
/*
* The glob pattern. Either a string pattern or a relative pattern.
*
* @since 3.17.0
*/
type GlobPattern = string // (alias) line 14136
// The result of a hover request.
type Hover struct { // line 4907
// The hover's content
Contents MarkupContent `json:"contents"`
/*
* An optional range inside the text document that is used to
* visualize the hover, e.g. by changing the background color.
*/
Range Range `json:"range,omitempty"`
}
type HoverClientCapabilities struct { // line 11428
// Whether hover supports dynamic registration.
DynamicRegistration bool `json:"dynamicRegistration,omitempty"`
/*
* Client supports the following content formats for the content
* property. The order describes the preferred format of the client.
*/
ContentFormat []MarkupKind `json:"contentFormat,omitempty"`
}
// Hover options.
type HoverOptions struct { // line 8796
WorkDoneProgressOptions
}
// Parameters for a [HoverRequest](#HoverRequest).
type HoverParams struct { // line 4890
TextDocumentPositionParams
WorkDoneProgressParams
}
// Registration options for a [HoverRequest](#HoverRequest).
type HoverRegistrationOptions struct { // line 4946
TextDocumentRegistrationOptions
HoverOptions
}
// @since 3.6.0
type ImplementationClientCapabilities struct { // line 11609
/*
* 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.
*/
DynamicRegistration bool `json:"dynamicRegistration,omitempty"`
/*
* The client supports additional metadata in the form of definition links.
*
* @since 3.14.0
*/
LinkSupport bool `json:"linkSupport,omitempty"`
}
type ImplementationOptions struct { // line 6338
WorkDoneProgressOptions
}
type ImplementationParams struct { // line 2071
TextDocumentPositionParams
WorkDoneProgressParams
PartialResultParams
}
type ImplementationRegistrationOptions struct { // line 2111
TextDocumentRegistrationOptions
ImplementationOptions
StaticRegistrationOptions
}
/*
* The data type of the ResponseError if the
* initialize request fails.
*/
type InitializeError struct { // line 4148
/*
* 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
* (3) if user selected retry the initialize method is sent again.
*/
Retry bool `json:"retry"`
}
type InitializeParams struct { // line 4090
XInitializeParams
WorkspaceFoldersInitializeParams
}
// The result returned from an initialize request.
type InitializeResult struct { // line 4104
// The capabilities the language server provides.
Capabilities ServerCapabilities `json:"capabilities"`
/*
* Information about the server.
*
* @since 3.15.0
*/
ServerInfo PServerInfoMsg_initialize `json:"serverInfo,omitempty"`
}
type InitializedParams struct { // line 4162
}
/*
* Inlay hint information.
*
* @since 3.17.0
*/
type InlayHint struct { // line 3667
// The position of this hint.
Position *Position `json:"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.
*/
Label []InlayHintLabelPart `json:"label"`
/*
* The kind of this hint. Can be omitted in which case the client
* should fall back to a reasonable default.
*/
Kind InlayHintKind `json:"kind,omitempty"`
/*
* 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.
*/
TextEdits []TextEdit `json:"textEdits,omitempty"`
// The tooltip text when you hover over this item.
Tooltip *OrPTooltip_textDocument_inlayHint `json:"tooltip,omitempty"`
/*
* 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.
*/
PaddingLeft bool `json:"paddingLeft,omitempty"`
/*
* 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.
*/
PaddingRight bool `json:"paddingRight,omitempty"`
/*
* A data entry field that is preserved on an inlay hint between
* a `textDocument/inlayHint` and a `inlayHint/resolve` request.
*/
Data interface{} `json:"data,omitempty"`
}
/*
* Inlay hint client capabilities.
*
* @since 3.17.0
*/
type InlayHintClientCapabilities struct { // line 12395
// Whether inlay hints support dynamic registration.
DynamicRegistration bool `json:"dynamicRegistration,omitempty"`
/*
* Indicates which properties a client can resolve lazily on an inlay
* hint.
*/
ResolveSupport *PResolveSupportPInlayHint `json:"resolveSupport,omitempty"`
}
/*
* Inlay hint kinds.
*
* @since 3.17.0
*/
type InlayHintKind uint32 // line 13059
/*
* An inlay hint label part allows for interactive and composite labels
* of inlay hints.
*
* @since 3.17.0
*/
type InlayHintLabelPart struct { // line 7067
// The value of this label part.
Value string `json:"value"`
/*
* 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.
*/
Tooltip *OrPTooltipPLabel `json:"tooltip,omitempty"`
/*
* An optional source code location that represents this
* label part.
*
* The editor will use this location for the hover and for code navigation
* features: This part will become a clickable link that resolves to the
* definition of the symbol at the given location (not necessarily the
* location itself), it shows the hover that shows at the given location,
* and it shows a context menu with further code navigation commands.
*
* Depending on the client capability `inlayHint.resolveSupport` clients
* might resolve this property late using the resolve request.
*/
Location *Location `json:"location,omitempty"`
/*
* An optional command for this label part.
*
* Depending on the client capability `inlayHint.resolveSupport` clients
* might resolve this property late using the resolve request.
*/
Command *Command `json:"command,omitempty"`
}
/*
* Inlay hint options used during static registration.
*
* @since 3.17.0
*/
type InlayHintOptions struct { // line 7140
/*
* The server provides support to resolve additional
* information for an inlay hint item.
*/
ResolveProvider bool `json:"resolveProvider,omitempty"`
WorkDoneProgressOptions
}
/*
* A parameter literal used in inlay hint requests.
*
* @since 3.17.0
*/
type InlayHintParams struct { // line 3638
// The text document.
TextDocument TextDocumentIdentifier `json:"textDocument"`
// The document range for which inlay hints should be computed.
Range Range `json:"range"`
WorkDoneProgressParams
}
/*
* Inlay hint options used during static or dynamic registration.
*
* @since 3.17.0
*/
type InlayHintRegistrationOptions struct { // line 3768
InlayHintOptions
TextDocumentRegistrationOptions
StaticRegistrationOptions
}
/*
* Client workspace capabilities specific to inlay hints.
*
* @since 3.17.0
*/
type InlayHintWorkspaceClientCapabilities struct { // line 11121
/*
* Whether the client implementation supports a refresh request sent from
* the server to the client.
*
* Note that this event is global and will force the client to refresh all
* inlay hints currently shown. It should be used with absolute care and
* is useful for situation where a server for example detects a project wide
* change that requires such a calculation.
*/
RefreshSupport bool `json:"refreshSupport,omitempty"`
}
/*
* Inline value information can be provided by different means:
* - directly as a text value (class InlineValueText).
* - as a name to use for a variable lookup (class InlineValueVariableLookup)
* - as an evaluatable expression (class InlineValueEvaluatableExpression)
* The InlineValue types combines all inline value types into one type.
*
* @since 3.17.0
*/
type InlineValue = Or_InlineValue // (alias) line 13887
/*
* Client capabilities specific to inline values.
*
* @since 3.17.0
*/
type InlineValueClientCapabilities struct { // line 12379
// Whether implementation supports dynamic registration for inline value providers.
DynamicRegistration bool `json:"dynamicRegistration,omitempty"`
}
// @since 3.17.0
type InlineValueContext struct { // line 6953
// The stack frame (as a DAP Id) where the execution has stopped.
FrameID int32 `json:"frameId"`
/*
* The document range where execution has stopped.
* Typically the end position of the range denotes the line where the inline values are shown.
*/
StoppedLocation Range `json:"stoppedLocation"`
}
/*
* Provide an inline value through an expression evaluation.
* If only a range is specified, the expression will be extracted from the underlying document.
* An optional expression can be used to override the extracted expression.
*
* @since 3.17.0
*/
type InlineValueEvaluatableExpression struct { // line 7031
/*
* The document range for which the inline value applies.
* The range is used to extract the evaluatable expression from the underlying document.
*/
Range Range `json:"range"`
// If specified the expression overrides the extracted expression.
Expression string `json:"expression,omitempty"`
}
/*
* Inline value options used during static registration.
*
* @since 3.17.0
*/
type InlineValueOptions struct { // line 7055
WorkDoneProgressOptions
}
/*
* A parameter literal used in inline value requests.
*
* @since 3.17.0
*/
type InlineValueParams struct { // line 3579
// The text document.
TextDocument TextDocumentIdentifier `json:"textDocument"`
// The document range for which inline values should be computed.
Range Range `json:"range"`
/*
* Additional information about the context in which inline values were
* requested.
*/
Context InlineValueContext `json:"context"`
WorkDoneProgressParams
}
/*
* Inline value options used during static or dynamic registration.
*
* @since 3.17.0
*/
type InlineValueRegistrationOptions struct { // line 3616
InlineValueOptions
TextDocumentRegistrationOptions
StaticRegistrationOptions
}
/*
* Provide inline value as text.
*
* @since 3.17.0
*/
type InlineValueText struct { // line 6976
// The document range for which the inline value applies.
Range Range `json:"range"`
// The text of the inline value.
Text string `json:"text"`
}
/*
* Provide inline value through a variable lookup.
* If only a range is specified, the variable name will be extracted from the underlying document.
* An optional variable name can be used to override the extracted name.
*
* @since 3.17.0
*/
type InlineValueVariableLookup struct { // line 6999
/*
* The document range for which the inline value applies.
* The range is used to extract the variable name from the underlying document.
*/
Range Range `json:"range"`
// If specified the name of the variable to look up.
VariableName string `json:"variableName,omitempty"`
// How to perform the lookup.
CaseSensitiveLookup bool `json:"caseSensitiveLookup"`
}
/*
* Client workspace capabilities specific to inline values.
*
* @since 3.17.0
*/
type InlineValueWorkspaceClientCapabilities struct { // line 11105
/*
* Whether the client implementation supports a refresh request sent from the
* server to the client.
*
* Note that this event is global and will force the client to refresh all
* inline values currently shown. It should be used with absolute care and is
* useful for situation where a server for example detects a project wide
* change that requires such a calculation.
*/
RefreshSupport bool `json:"refreshSupport,omitempty"`
}
/*
* A special text edit to provide an insert and a replace operation.
*
* @since 3.16.0
*/
type InsertReplaceEdit struct { // line 8696
// The string to be inserted.
NewText string `json:"newText"`
// The range if the insert is requested
Insert Range `json:"insert"`
// The range if the replace is requested.
Replace Range `json:"replace"`
}
/*
* Defines whether the insert text in a completion item should be interpreted as
* plain text or a snippet.
*/
type InsertTextFormat uint32 // line 13286
/*
* How whitespace and indentation is handled during completion
* item insertion.
*
* @since 3.16.0
*/
type InsertTextMode uint32 // line 13306
type LSPAny = interface{}
/*
* LSP arrays.
* @since 3.17.0
*/
type LSPArray = []interface{} // (alias) line 13805
type LSPErrorCodes int32 // line 12809
/*
* LSP object definition.
* @since 3.17.0
*/
type LSPObject struct { // line 9618
}
/*
* Client capabilities for the linked editing range request.
*
* @since 3.16.0
*/
type LinkedEditingRangeClientCapabilities struct { // line 12331
/*
* 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.
*/
DynamicRegistration bool `json:"dynamicRegistration,omitempty"`
}
type LinkedEditingRangeOptions struct { // line 6657
WorkDoneProgressOptions
}
type LinkedEditingRangeParams struct { // line 3134
TextDocumentPositionParams
WorkDoneProgressParams
}
type LinkedEditingRangeRegistrationOptions struct { // line 3177
TextDocumentRegistrationOptions
LinkedEditingRangeOptions
StaticRegistrationOptions
}
/*
* The result of a linked editing range request.
*
* @since 3.16.0
*/
type LinkedEditingRanges struct { // line 3150
/*
* A list of ranges that can be edited together. The ranges must have
* identical length and contain identical text content. The ranges cannot overlap.
*/
Ranges []Range `json:"ranges"`
/*
* 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.
*/
WordPattern string `json:"wordPattern,omitempty"`
}
// created for Literal (Lit_NotebookDocumentFilter_Item1)
type Lit_NotebookDocumentFilter_Item1 struct { // line 14302
// The type of the enclosing notebook.
NotebookType string `json:"notebookType,omitempty"`
// A Uri [scheme](#Uri.scheme), like `file` or `untitled`.
Scheme string `json:"scheme"`
// A glob pattern.
Pattern string `json:"pattern,omitempty"`
}
// created for Literal (Lit_NotebookDocumentFilter_Item2)
type Lit_NotebookDocumentFilter_Item2 struct { // line 14335
// The type of the enclosing notebook.
NotebookType string `json:"notebookType,omitempty"`
// A Uri [scheme](#Uri.scheme), like `file` or `untitled`.
Scheme string `json:"scheme,omitempty"`
// A glob pattern.
Pattern string `json:"pattern"`
}
// created for Literal (Lit_NotebookDocumentSyncOptions_notebookSelector_Elem_Item1)
type Lit_NotebookDocumentSyncOptions_notebookSelector_Elem_Item1 struct { // line 9878
/*
* The notebook to be synced If a string
* value is provided it matches against the
* notebook type. '*' matches every notebook.
*/
Notebook *Or_NotebookDocumentSyncOptions_notebookSelector_Elem_Item1_notebook `json:"notebook,omitempty"`
// The cells of the matching notebook to be synced.
Cells []Lit_NotebookDocumentSyncOptions_notebookSelector_Elem_Item1_cells_Elem `json:"cells"`
}
// created for Literal (Lit_NotebookDocumentSyncOptions_notebookSelector_Elem_Item1_cells_Elem)
type Lit_NotebookDocumentSyncOptions_notebookSelector_Elem_Item1_cells_Elem struct { // line 9904
Language string `json:"language"`
}
// created for Literal (Lit_PrepareRenameResult_Item2)
type Lit_PrepareRenameResult_Item2 struct { // line 13958
DefaultBehavior bool `json:"defaultBehavior"`
}
// created for Literal (Lit_TextDocumentContentChangeEvent_Item1)
type Lit_TextDocumentContentChangeEvent_Item1 struct { // line 14066
// The new text of the whole document.
Text string `json:"text"`
}
// created for Literal (Lit_TextDocumentFilter_Item2)
type Lit_TextDocumentFilter_Item2 struct { // line 14226
// A language id, like `typescript`.
Language string `json:"language,omitempty"`
// A Uri [scheme](#Uri.scheme), like `file` or `untitled`.
Scheme string `json:"scheme,omitempty"`
// A glob pattern, like `*.{ts,js}`.
Pattern string `json:"pattern"`
}
/*
* Represents a location inside a resource, such as a line
* inside a text file.
*/
type Location struct { // line 2091
URI DocumentURI `json:"uri"`
Range Range `json:"range"`
}
/*
* Represents the connection of two locations. Provides additional metadata over normal [locations](#Location),
* including an origin range.
*/
type LocationLink struct { // line 6277
/*
* Span of the origin of this link.
*
* Used as the underlined span for mouse interaction. Defaults to the word range at
* the definition position.
*/
OriginSelectionRange *Range `json:"originSelectionRange,omitempty"`
// The target resource identifier of this link.
TargetURI DocumentURI `json:"targetUri"`
/*
* 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.
*/
TargetRange Range `json:"targetRange"`
/*
* 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`
*/
TargetSelectionRange Range `json:"targetSelectionRange"`
}
// The log message parameters.
type LogMessageParams struct { // line 4273
// The message type. See {@link MessageType}
Type MessageType `json:"type"`
// The actual message.
Message string `json:"message"`
}
type LogTraceParams struct { // line 6178
Message string `json:"message"`
Verbose string `json:"verbose,omitempty"`
}
/*
* Client capabilities specific to the used markdown parser.
*
* @since 3.16.0
*/
type MarkdownClientCapabilities struct { // line 12550
// The name of the parser.
Parser string `json:"parser"`
// The version of the parser.
Version string `json:"version,omitempty"`
/*
* A list of HTML tags that the client allows / supports in
* Markdown.
*
* @since 3.17.0
*/
AllowedTags []string `json:"allowedTags,omitempty"`
}
/*
* 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
* is semantically equal to the optional language identifier in fenced code blocks in GitHub
* issues. See https://help.github.com/articles/creating-and-highlighting-code-blocks/#syntax-highlighting
*
* The pair of a language and a value is an equivalent to markdown:
* ```${language}
* ${value}
* ```
*
* Note that markdown strings will be sanitized - that means html will be escaped.
* @deprecated use MarkupContent instead.
*/
type MarkedString = Or_MarkedString // (alias) line 14084
/*
* A `MarkupContent` literal represents a string value which content is interpreted base on its
* kind flag. Currently the protocol supports `plaintext` and `markdown` as markup kinds.
*
* If the kind is `markdown` then the value can contain fenced code blocks like in GitHub issues.
* See https://help.github.com/articles/creating-and-highlighting-code-blocks/#syntax-highlighting
*
* Here is an example how such a string can be constructed using JavaScript / TypeScript:
* ```ts
* let markdown: MarkdownContent = {
* kind: MarkupKind.Markdown,
* value: [
* '# Header',
* 'Some text',
* '```typescript',
* 'someCode();',
* '```'
* ].join('\n')
* };
* ```
*
* *Please Note* that clients might sanitize the return markdown. A client could decide to
* remove HTML from the markdown to avoid script execution.
*/
type MarkupContent struct { // line 7118
// The type of the Markup
Kind MarkupKind `json:"kind"`
// The content itself
Value string `json:"value"`
}
/*
* Describes the content type that a client supports in various
* result literals like `Hover`, `ParameterInfo` or `CompletionItem`.
*
* Please note that `MarkupKinds` must not start with a `$`. This kinds
* are reserved for internal usage.
*/
type MarkupKind string // line 13433
type MessageActionItem struct { // line 4260
// A short title like 'Retry', 'Open Log' etc.
Title string `json:"title"`
}
// The message type
type MessageType uint32 // line 13080
/*
* Moniker definition to match LSIF 0.5 moniker definition.
*
* @since 3.16.0
*/
type Moniker struct { // line 3360
// The scheme of the moniker. For example tsc or .Net
Scheme string `json:"scheme"`
/*
* The identifier of the moniker. The value is opaque in LSIF however
* schema owners are allowed to define the structure if they want.
*/
Identifier string `json:"identifier"`
// The scope in which the moniker is unique
Unique UniquenessLevel `json:"unique"`
// The moniker kind if known.
Kind MonikerKind `json:"kind,omitempty"`
}
/*
* Client capabilities specific to the moniker request.
*
* @since 3.16.0
*/
type MonikerClientCapabilities struct { // line 12347
/*
* 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.
*/
DynamicRegistration bool `json:"dynamicRegistration,omitempty"`
}
/*
* The moniker kind.
*
* @since 3.16.0
*/
type MonikerKind string // line 13033
type MonikerOptions struct { // line 6931
WorkDoneProgressOptions
}
type MonikerParams struct { // line 3340
TextDocumentPositionParams
WorkDoneProgressParams
PartialResultParams
}
type MonikerRegistrationOptions struct { // line 3400
TextDocumentRegistrationOptions
MonikerOptions
}
// created for Literal (Lit_MarkedString_Item1)
type Msg_MarkedString struct { // line 14094
Language string `json:"language"`
Value string `json:"value"`
}
// created for Literal (Lit_NotebookDocumentFilter_Item0)
type Msg_NotebookDocumentFilter struct { // line 14269
// The type of the enclosing notebook.
NotebookType string `json:"notebookType"`
// A Uri [scheme](#Uri.scheme), like `file` or `untitled`.
Scheme string `json:"scheme"`
// A glob pattern.
Pattern string `json:"pattern"`
}
// created for Literal (Lit_PrepareRenameResult_Item1)
type Msg_PrepareRename2Gn struct { // line 13937
Range Range `json:"range"`
Placeholder string `json:"placeholder"`
}
// created for Literal (Lit_TextDocumentContentChangeEvent_Item0)
type Msg_TextDocumentContentChangeEvent struct { // line 14034
// The range of the document that changed.
Range *Range `json:"range"`
/*
* The optional length of the range that got replaced.
*
* @deprecated use range instead.
*/
RangeLength uint32 `json:"rangeLength"`
// The new text for the provided range.
Text string `json:"text"`
}
// created for Literal (Lit_TextDocumentFilter_Item1)
type Msg_TextDocumentFilter struct { // line 14193
// A language id, like `typescript`.
Language string `json:"language"`
// A Uri [scheme](#Uri.scheme), like `file` or `untitled`.
Scheme string `json:"scheme"`
// A glob pattern, like `*.{ts,js}`.
Pattern string `json:"pattern"`
}
// created for Literal (Lit__InitializeParams_clientInfo)
type Msg_XInitializeParams_clientInfo struct { // line 7678
// The name of the client as defined by the client.
Name string `json:"name"`
// The client's version as defined by the client.
Version string `json:"version"`
}
/*
* A notebook cell.
*
* A cell's document URI must be unique across ALL notebook
* cells and can therefore be used to uniquely identify a
* notebook cell or the cell's text document.
*
* @since 3.17.0
*/
type NotebookCell struct { // line 9624
// The cell's kind
Kind NotebookCellKind `json:"kind"`
/*
* The URI of the cell's text document
* content.
*/
Document DocumentURI `json:"document"`
/*
* Additional metadata stored with the cell.
*
* Note: should always be an object literal (e.g. LSPObject)
*/
Metadata *LSPObject `json:"metadata,omitempty"`
/*
* Additional execution summary information
* if supported by the client.
*/
ExecutionSummary *ExecutionSummary `json:"executionSummary,omitempty"`
}
/*
* A change describing how to move a `NotebookCell`
* array from state S to S'.
*
* @since 3.17.0
*/
type NotebookCellArrayChange struct { // line 9665
// The start oftest of the cell that changed.
Start uint32 `json:"start"`
// The deleted cells
DeleteCount uint32 `json:"deleteCount"`
// The new cells, if any
Cells []NotebookCell `json:"cells,omitempty"`
}
/*
* A notebook cell kind.
*
* @since 3.17.0
*/
type NotebookCellKind uint32 // line 13674
/*
* A notebook cell text document filter denotes a cell text
* document by different properties.
*
* @since 3.17.0
*/
type NotebookCellTextDocumentFilter struct { // line 10139
/*
* 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.
*/
Notebook NotebookDocumentFilter `json:"notebook"`
/*
* A language id like `python`.
*
* Will be matched against the language id of the
* notebook cell document. '*' matches every language.
*/
Language string `json:"language,omitempty"`
}
/*
* A notebook document.
*
* @since 3.17.0
*/
type NotebookDocument struct { // line 7359
// The notebook document's uri.
URI URI `json:"uri"`
// The type of the notebook.
NotebookType string `json:"notebookType"`
/*
* The version number of this document (it will increase after each
* change, including undo/redo).
*/
Version int32 `json:"version"`
/*
* Additional metadata stored with the notebook
* document.
*
* Note: should always be an object literal (e.g. LSPObject)
*/
Metadata *LSPObject `json:"metadata,omitempty"`
// The cells of a notebook.
Cells []NotebookCell `json:"cells"`
}
/*
* A change event for a notebook document.
*
* @since 3.17.0
*/
type NotebookDocumentChangeEvent struct { // line 7471
/*
* The changed meta data if any.
*
* Note: should always be an object literal (e.g. LSPObject)
*/
Metadata *LSPObject `json:"metadata,omitempty"`
// Changes to cells
Cells *PCellsPChange `json:"cells,omitempty"`
}
/*
* Capabilities specific to the notebook document support.
*
* @since 3.17.0
*/
type NotebookDocumentClientCapabilities struct { // line 10639
/*
* Capabilities specific to notebook document synchronization
*
* @since 3.17.0
*/
Synchronization NotebookDocumentSyncClientCapabilities `json:"synchronization"`
}
/*
* 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
*/
type NotebookDocumentFilter = Msg_NotebookDocumentFilter // (alias) line 14263
/*
* A literal to identify a notebook document in the client.
*
* @since 3.17.0
*/
type NotebookDocumentIdentifier struct { // line 7587
// The notebook document's uri.
URI URI `json:"uri"`
}
/*
* Notebook specific client capabilities.
*
* @since 3.17.0
*/
type NotebookDocumentSyncClientCapabilities struct { // line 12459
/*
* 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.
*/
DynamicRegistration bool `json:"dynamicRegistration,omitempty"`
// The client supports sending execution summary data per cell.
ExecutionSummarySupport bool `json:"executionSummarySupport,omitempty"`
}
/*
* Options specific to a notebook plus its cells
* to be synced to the server.
*
* If a selector provides a notebook document
* filter but no cell selector all cells of a
* matching notebook document will be synced.
*
* If a selector provides no notebook document
* filter but only a cell selector all notebook
* document that contain at least one matching
* cell will be synced.
*
* @since 3.17.0
*/
type NotebookDocumentSyncOptions struct { // line 9821
// The notebooks to be synced
NotebookSelector []PNotebookSelectorPNotebookDocumentSync `json:"notebookSelector"`
/*
* Whether save notification should be forwarded to
* the server. Will only be honored if mode === `notebook`.
*/
Save bool `json:"save,omitempty"`
}
/*
* Registration options specific to a notebook.
*
* @since 3.17.0
*/
type NotebookDocumentSyncRegistrationOptions struct { // line 9941
NotebookDocumentSyncOptions
StaticRegistrationOptions
}
// A text document identifier to optionally denote a specific version of a text document.
type OptionalVersionedTextDocumentIdentifier struct { // line 9363
/*
* 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
* `null` to indicate that the version is unknown and the content on disk is the
* truth (as specified with document content ownership).
*/
Version int32 `json:"version"`
TextDocumentIdentifier
}
// created for Or [FEditRangePItemDefaults Range]
type OrFEditRangePItemDefaults struct { // line 4791
Value interface{} `json:"value"`
}
// created for Or [NotebookDocumentFilter string]
type OrFNotebookPNotebookSelector struct { // line 9838
Value interface{} `json:"value"`
}
// created for Or [Location PLocationMsg_workspace_symbol]
type OrPLocation_workspace_symbol struct { // line 5540
Value interface{} `json:"value"`
}
// created for Or [[]string string]
type OrPSection_workspace_didChangeConfiguration struct { // line 4186
Value interface{} `json:"value"`
}
// created for Or [MarkupContent string]
type OrPTooltipPLabel struct { // line 7081
Value interface{} `json:"value"`
}
// created for Or [MarkupContent string]
type OrPTooltip_textDocument_inlayHint struct { // line 3722
Value interface{} `json:"value"`
}
// created for Or [int32 string]
type Or_CancelParams_id struct { // line 6204
Value interface{} `json:"value"`
}
// created for Or [MarkupContent string]
type Or_CompletionItem_documentation struct { // line 4605
Value interface{} `json:"value"`
}
// created for Or [InsertReplaceEdit TextEdit]
type Or_CompletionItem_textEdit struct { // line 4687
Value interface{} `json:"value"`
}
// created for Or [Location []Location]
type Or_Definition struct { // line 13780
Value interface{} `json:"value"`
}
// created for Or [int32 string]
type Or_Diagnostic_code struct { // line 8568
Value interface{} `json:"value"`
}
// created for Or [RelatedFullDocumentDiagnosticReport RelatedUnchangedDocumentDiagnosticReport]
type Or_DocumentDiagnosticReport struct { // line 13912
Value interface{} `json:"value"`
}
// created for Or [FullDocumentDiagnosticReport UnchangedDocumentDiagnosticReport]
type Or_DocumentDiagnosticReportPartialResult_relatedDocuments_Value struct { // line 3845
Value interface{} `json:"value"`
}
// created for Or [NotebookCellTextDocumentFilter TextDocumentFilter]
type Or_DocumentFilter struct { // line 14121
Value interface{} `json:"value"`
}
// created for Or [MarkedString MarkupContent []MarkedString]
type Or_Hover_contents struct { // line 4913
Value interface{} `json:"value"`
}
// created for Or [[]InlayHintLabelPart string]
type Or_InlayHint_label struct { // line 3681
Value interface{} `json:"value"`
}
// created for Or [InlineValueEvaluatableExpression InlineValueText InlineValueVariableLookup]
type Or_InlineValue struct { // line 13890
Value interface{} `json:"value"`
}
// created for Or [Msg_MarkedString string]
type Or_MarkedString struct { // line 14087
Value interface{} `json:"value"`
}
// created for Or [NotebookDocumentFilter string]
type Or_NotebookCellTextDocumentFilter_notebook struct { // line 10145
Value interface{} `json:"value"`
}
// created for Or [NotebookDocumentFilter string]
type Or_NotebookDocumentSyncOptions_notebookSelector_Elem_Item1_notebook struct { // line 9884
Value interface{} `json:"value"`
}
// created for Or [FullDocumentDiagnosticReport UnchangedDocumentDiagnosticReport]
type Or_RelatedFullDocumentDiagnosticReport_relatedDocuments_Value struct { // line 7174
Value interface{} `json:"value"`
}
// created for Or [FullDocumentDiagnosticReport UnchangedDocumentDiagnosticReport]
type Or_RelatedUnchangedDocumentDiagnosticReport_relatedDocuments_Value struct { // line 7213
Value interface{} `json:"value"`
}
// created for Or [URI WorkspaceFolder]
type Or_RelativePattern_baseUri struct { // line 10768
Value interface{} `json:"value"`
}
// created for Or [CodeAction Command]
type Or_Result_textDocument_codeAction_Item0_Elem struct { // line 1380
Value interface{} `json:"value"`
}
// created for Or [FFullPRequests bool]
type Or_SemanticTokensClientCapabilities_requests_full struct { // line 12224
Value interface{} `json:"value"`
}
// created for Or [FRangePRequests bool]
type Or_SemanticTokensClientCapabilities_requests_range struct { // line 12204
Value interface{} `json:"value"`
}
// created for Or [PFullESemanticTokensOptions bool]
type Or_SemanticTokensOptions_full struct { // line 6585
Value interface{} `json:"value"`
}
// created for Or [PRangeESemanticTokensOptions bool]
type Or_SemanticTokensOptions_range struct { // line 6565
Value interface{} `json:"value"`
}
// created for Or [CallHierarchyOptions CallHierarchyRegistrationOptions bool]
type Or_ServerCapabilities_callHierarchyProvider struct { // line 8248
Value interface{} `json:"value"`
}
// created for Or [CodeActionOptions bool]
type Or_ServerCapabilities_codeActionProvider struct { // line 8056
Value interface{} `json:"value"`
}
// created for Or [DocumentColorOptions DocumentColorRegistrationOptions bool]
type Or_ServerCapabilities_colorProvider struct { // line 8092
Value interface{} `json:"value"`
}
// created for Or [DeclarationOptions DeclarationRegistrationOptions bool]
type Or_ServerCapabilities_declarationProvider struct { // line 7918
Value interface{} `json:"value"`
}
// created for Or [DefinitionOptions bool]
type Or_ServerCapabilities_definitionProvider struct { // line 7940
Value interface{} `json:"value"`
}
// created for Or [DiagnosticOptions DiagnosticRegistrationOptions]
type Or_ServerCapabilities_diagnosticProvider struct { // line 8405
Value interface{} `json:"value"`
}
// created for Or [DocumentFormattingOptions bool]
type Or_ServerCapabilities_documentFormattingProvider struct { // line 8132
Value interface{} `json:"value"`
}
// created for Or [DocumentHighlightOptions bool]
type Or_ServerCapabilities_documentHighlightProvider struct { // line 8020
Value interface{} `json:"value"`
}
// created for Or [DocumentRangeFormattingOptions bool]
type Or_ServerCapabilities_documentRangeFormattingProvider struct { // line 8150
Value interface{} `json:"value"`
}
// created for Or [DocumentSymbolOptions bool]
type Or_ServerCapabilities_documentSymbolProvider struct { // line 8038
Value interface{} `json:"value"`
}
// created for Or [FoldingRangeOptions FoldingRangeRegistrationOptions bool]
type Or_ServerCapabilities_foldingRangeProvider struct { // line 8195
Value interface{} `json:"value"`
}
// created for Or [HoverOptions bool]
type Or_ServerCapabilities_hoverProvider struct { // line 7891
Value interface{} `json:"value"`
}
// created for Or [ImplementationOptions ImplementationRegistrationOptions bool]
type Or_ServerCapabilities_implementationProvider struct { // line 7980
Value interface{} `json:"value"`
}
// created for Or [InlayHintOptions InlayHintRegistrationOptions bool]
type Or_ServerCapabilities_inlayHintProvider struct { // line 8382
Value interface{} `json:"value"`
}
// created for Or [InlineValueOptions InlineValueRegistrationOptions bool]
type Or_ServerCapabilities_inlineValueProvider struct { // line 8359
Value interface{} `json:"value"`
}
// created for Or [LinkedEditingRangeOptions LinkedEditingRangeRegistrationOptions bool]
type Or_ServerCapabilities_linkedEditingRangeProvider struct { // line 8271
Value interface{} `json:"value"`
}
// created for Or [MonikerOptions MonikerRegistrationOptions bool]
type Or_ServerCapabilities_monikerProvider struct { // line 8313
Value interface{} `json:"value"`
}
// created for Or [NotebookDocumentSyncOptions NotebookDocumentSyncRegistrationOptions]
type Or_ServerCapabilities_notebookDocumentSync struct { // line 7863
Value interface{} `json:"value"`
}
// created for Or [ReferenceOptions bool]
type Or_ServerCapabilities_referencesProvider struct { // line 8002
Value interface{} `json:"value"`
}
// created for Or [RenameOptions bool]
type Or_ServerCapabilities_renameProvider struct { // line 8177
Value interface{} `json:"value"`
}
// created for Or [SelectionRangeOptions SelectionRangeRegistrationOptions bool]
type Or_ServerCapabilities_selectionRangeProvider struct { // line 8217
Value interface{} `json:"value"`
}
// created for Or [SemanticTokensOptions SemanticTokensRegistrationOptions]
type Or_ServerCapabilities_semanticTokensProvider struct { // line 8294
Value interface{} `json:"value"`
}
// created for Or [TextDocumentSyncKind TextDocumentSyncOptions]
type Or_ServerCapabilities_textDocumentSync struct { // line 7845
Value interface{} `json:"value"`
}
// created for Or [TypeDefinitionOptions TypeDefinitionRegistrationOptions bool]
type Or_ServerCapabilities_typeDefinitionProvider struct { // line 7958
Value interface{} `json:"value"`
}
// created for Or [TypeHierarchyOptions TypeHierarchyRegistrationOptions bool]
type Or_ServerCapabilities_typeHierarchyProvider struct { // line 8336
Value interface{} `json:"value"`
}
// created for Or [WorkspaceSymbolOptions bool]
type Or_ServerCapabilities_workspaceSymbolProvider struct { // line 8114
Value interface{} `json:"value"`
}
// created for Or [MarkupContent string]
type Or_SignatureInformation_documentation struct { // line 8862
Value interface{} `json:"value"`
}
// created for Or [AnnotatedTextEdit TextEdit]
type Or_TextDocumentEdit_edits_Elem struct { // line 6698
Value interface{} `json:"value"`
}
// created for Or [SaveOptions bool]
type Or_TextDocumentSyncOptions_save struct { // line 9804
Value interface{} `json:"value"`
}
// created for Or [WorkspaceFullDocumentDiagnosticReport WorkspaceUnchangedDocumentDiagnosticReport]
type Or_WorkspaceDocumentDiagnosticReport struct { // line 14013
Value interface{} `json:"value"`
}
// created for Or [CreateFile DeleteFile RenameFile TextDocumentEdit]
type Or_WorkspaceEdit_documentChanges_Elem struct { // line 3242
Value interface{} `json:"value"`
}
// created for Or [Declaration []DeclarationLink]
type Or_textDocument_declaration struct { // line 257
Value interface{} `json:"value"`
}
// created for Literal (Lit_NotebookDocumentChangeEvent_cells)
type PCellsPChange struct { // line 7486
/*
* Changes to the cell structure to add or
* remove cells.
*/
Structure FStructurePCells `json:"structure"`
/*
* Changes to notebook cells properties like its
* kind, execution summary or metadata.
*/
Data []NotebookCell `json:"data"`
// Changes to the text content of notebook cells.
TextContent []FTextContentPCells `json:"textContent"`
}
// created for Literal (Lit_WorkspaceEditClientCapabilities_changeAnnotationSupport)
type PChangeAnnotationSupportPWorkspaceEdit struct { // line 10842
/*
* 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.
*/
GroupsOnLabel bool `json:"groupsOnLabel"`
}
// created for Literal (Lit_CodeActionClientCapabilities_codeActionLiteralSupport)
type PCodeActionLiteralSupportPCodeAction struct { // line 11762
/*
* The code action kind is support with the following value
* set.
*/
CodeActionKind FCodeActionKindPCodeActionLiteralSupport `json:"codeActionKind"`
}
// created for Literal (Lit_CompletionClientCapabilities_completionItemKind)
type PCompletionItemKindPCompletion struct { // line 11360
/*
* 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
* to a default value when unknown.
*
* If this property is not present the client only supports
* the completion items kinds from `Text` to `Reference` as defined in
* the initial version of the protocol.
*/
ValueSet []CompletionItemKind `json:"valueSet"`
}
// created for Literal (Lit_CompletionClientCapabilities_completionItem)
type PCompletionItemPCompletion struct { // line 11209
/*
* Client supports snippets as insert text.
*
* A snippet can define tab stops and placeholders with `$1`, `$2`
* and `${3:foo}`. `$0` defines the final tab stop, it defaults to
* the end of the snippet. Placeholders with equal identifiers are linked,
* that is typing in one will update others too.
*/
SnippetSupport bool `json:"snippetSupport"`
// Client supports commit characters on a completion item.
CommitCharactersSupport bool `json:"commitCharactersSupport"`
/*
* Client supports the following content formats for the documentation
* property. The order describes the preferred format of the client.
*/
DocumentationFormat []MarkupKind `json:"documentationFormat"`
// Client supports the deprecated property on a completion item.
DeprecatedSupport bool `json:"deprecatedSupport"`
// Client supports the preselect property on a completion item.
PreselectSupport bool `json:"preselectSupport"`
/*
* 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
*/
TagSupport FTagSupportPCompletionItem `json:"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
*/
InsertReplaceSupport bool `json:"insertReplaceSupport"`
/*
* 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
*/
ResolveSupport FResolveSupportPCompletionItem `json:"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
*/
InsertTextModeSupport FInsertTextModeSupportPCompletionItem `json:"insertTextModeSupport"`
/*
* The client has support for completion item label
* details (see also `CompletionItemLabelDetails`).
*
* @since 3.17.0
*/
LabelDetailsSupport bool `json:"labelDetailsSupport"`
}
// created for Literal (Lit_CompletionOptions_completionItem)
type PCompletionItemPCompletionProvider struct { // line 8767
/*
* The server has support for completion item label
* details (see also `CompletionItemLabelDetails`) when
* receiving a completion item in a resolve call.
*
* @since 3.17.0
*/
LabelDetailsSupport bool `json:"labelDetailsSupport"`
}
// created for Literal (Lit_CompletionClientCapabilities_completionList)
type PCompletionListPCompletion struct { // line 11402
/*
* The client supports the following itemDefaults on
* a completion list.
*
* The value lists the supported property names of the
* `CompletionList.itemDefaults` object. If omitted
* no properties are supported.
*
* @since 3.17.0
*/
ItemDefaults []string `json:"itemDefaults"`
}
// created for Literal (Lit_CodeAction_disabled)
type PDisabledMsg_textDocument_codeAction struct { // line 5446
/*
* Human readable description of why the code action is currently disabled.
*
* This is displayed in the code actions UI.
*/
Reason string `json:"reason"`
}
// created for Literal (Lit_FoldingRangeClientCapabilities_foldingRangeKind)
type PFoldingRangeKindPFoldingRange struct { // line 12037
/*
* 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.
*/
ValueSet []FoldingRangeKind `json:"valueSet"`
}
// created for Literal (Lit_FoldingRangeClientCapabilities_foldingRange)
type PFoldingRangePFoldingRange struct { // line 12062
/*
* 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
*/
CollapsedText bool `json:"collapsedText"`
}
// created for Literal (Lit_SemanticTokensOptions_full_Item1)
type PFullESemanticTokensOptions struct { // line 6592
// The server supports deltas for full documents.
Delta bool `json:"delta"`
}
// created for Literal (Lit_CompletionList_itemDefaults)
type PItemDefaultsMsg_textDocument_completion struct { // line 4772
/*
* A default commit character set.
*
* @since 3.17.0
*/
CommitCharacters []string `json:"commitCharacters"`
/*
* A default edit range.
*
* @since 3.17.0
*/
EditRange OrFEditRangePItemDefaults `json:"editRange"`
/*
* A default insert text format.
*
* @since 3.17.0
*/
InsertTextFormat InsertTextFormat `json:"insertTextFormat"`
/*
* A default insert text mode.
*
* @since 3.17.0
*/
InsertTextMode InsertTextMode `json:"insertTextMode"`
/*
* A default data value.
*
* @since 3.17.0
*/
Data interface{} `json:"data"`
}
// created for Literal (Lit_WorkspaceSymbol_location_Item1)
type PLocationMsg_workspace_symbol struct { // line 5547
URI DocumentURI `json:"uri"`
}
// created for Literal (Lit_ShowMessageRequestClientCapabilities_messageActionItem)
type PMessageActionItemPShowMessage struct { // line 12490
/*
* Whether the client supports additional attributes which
* are preserved and send back to the server in the
* request's response.
*/
AdditionalPropertiesSupport bool `json:"additionalPropertiesSupport"`
}
// created for Literal (Lit_NotebookDocumentSyncOptions_notebookSelector_Elem_Item0)
type PNotebookSelectorPNotebookDocumentSync struct { // line 9832
/*
* The notebook to be synced If a string
* value is provided it matches against the
* notebook type. '*' matches every notebook.
*/
Notebook OrFNotebookPNotebookSelector `json:"notebook"`
// The cells of the matching notebook to be synced.
Cells []FCellsPNotebookSelector `json:"cells"`
}
// created for Literal (Lit_SemanticTokensOptions_range_Item1)
type PRangeESemanticTokensOptions struct { // line 6572
}
// created for Literal (Lit_SemanticTokensClientCapabilities_requests)
type PRequestsPSemanticTokens struct { // line 12198
/*
* The client will send the `textDocument/semanticTokens/range` request if
* the server provides a corresponding handler.
*/
Range bool `json:"range"`
/*
* The client will send the `textDocument/semanticTokens/full` request if
* the server provides a corresponding handler.
*/
Full interface{} `json:"full"`
}
// created for Literal (Lit_CodeActionClientCapabilities_resolveSupport)
type PResolveSupportPCodeAction struct { // line 11827
// The properties that a client can resolve lazily.
Properties []string `json:"properties"`
}
// created for Literal (Lit_InlayHintClientCapabilities_resolveSupport)
type PResolveSupportPInlayHint struct { // line 12410
// The properties that a client can resolve lazily.
Properties []string `json:"properties"`
}
// created for Literal (Lit_WorkspaceSymbolClientCapabilities_resolveSupport)
type PResolveSupportPSymbol struct { // line 10964
/*
* The properties that a client can resolve lazily. Usually
* `location.range`
*/
Properties []string `json:"properties"`
}
// created for Literal (Lit_InitializeResult_serverInfo)
type PServerInfoMsg_initialize struct { // line 4118
// The name of the server as defined by the server.
Name string `json:"name"`
// The server's version as defined by the server.
Version string `json:"version"`
}
// created for Literal (Lit_SignatureHelpClientCapabilities_signatureInformation)
type PSignatureInformationPSignatureHelp struct { // line 11469
/*
* Client supports the following content formats for the documentation
* property. The order describes the preferred format of the client.
*/
DocumentationFormat []MarkupKind `json:"documentationFormat"`
// Client capabilities specific to parameter information.
ParameterInformation FParameterInformationPSignatureInformation `json:"parameterInformation"`
/*
* The client supports the `activeParameter` property on `SignatureInformation`
* literal.
*
* @since 3.16.0
*/
ActiveParameterSupport bool `json:"activeParameterSupport"`
}
// created for Literal (Lit_GeneralClientCapabilities_staleRequestSupport)
type PStaleRequestSupportPGeneral struct { // line 10696
// The client will actively cancel the request.
Cancel bool `json:"cancel"`
/*
* The list of requests for which the client
* will retry the request if it receives a
* response with error code `ContentModified`
*/
RetryOnContentModified []string `json:"retryOnContentModified"`
}
// created for Literal (Lit_DocumentSymbolClientCapabilities_symbolKind)
type PSymbolKindPDocumentSymbol struct { // line 11680
/*
* 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
* to a default value when unknown.
*
* If this property is not present the client only supports
* the symbol kinds from `File` to `Array` as defined in
* the initial version of the protocol.
*/
ValueSet []SymbolKind `json:"valueSet"`
}
// created for Literal (Lit_WorkspaceSymbolClientCapabilities_symbolKind)
type PSymbolKindPSymbol struct { // line 10916
/*
* 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
* to a default value when unknown.
*
* If this property is not present the client only supports
* the symbol kinds from `File` to `Array` as defined in
* the initial version of the protocol.
*/
ValueSet []SymbolKind `json:"valueSet"`
}
// created for Literal (Lit_DocumentSymbolClientCapabilities_tagSupport)
type PTagSupportPDocumentSymbol struct { // line 11713
// The tags supported by the client.
ValueSet []SymbolTag `json:"valueSet"`
}
// created for Literal (Lit_PublishDiagnosticsClientCapabilities_tagSupport)
type PTagSupportPPublishDiagnostics struct { // line 12113
// The tags supported by the client.
ValueSet []DiagnosticTag `json:"valueSet"`
}
// created for Literal (Lit_WorkspaceSymbolClientCapabilities_tagSupport)
type PTagSupportPSymbol struct { // line 10940
// The tags supported by the client.
ValueSet []SymbolTag `json:"valueSet"`
}
// The parameters of a configuration request.
type ParamConfiguration struct { // line 2207
Items []ConfigurationItem `json:"items"`
}
type ParamInitialize struct { // line 4090
XInitializeParams
WorkspaceFoldersInitializeParams
}
/*
* Represents a parameter of a callable-signature. A parameter can
* have a label and a doc-comment.
*/
type ParameterInformation struct { // line 10089
/*
* The label of this parameter information.
*
* Either a string or an inclusive start and exclusive end offsets within its containing
* signature label. (see SignatureInformation.label). The offsets are based on a UTF-16
* string representation as `Position` and `Range` does.
*
* *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`.
*/
Label string `json:"label"`
/*
* The human-readable doc-comment of this parameter. Will be shown
* in the UI but can be omitted.
*/
Documentation string `json:"documentation,omitempty"`
}
type PartialResultParams struct { // line 2223
/*
* An optional token that a server can use to report partial results (e.g. streaming) to
* the client.
*/
PartialResultToken ProgressToken `json:"partialResultToken,omitempty"`
}
/*
* 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 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
*/
type Pattern = string // (alias) line 14372
/*
* Position in a text document expressed as zero-based line and character
* offset. Prior to 3.17 the offsets were always based on a UTF-16 string
* representation. So a string of the form `a𐐀b` the character offset of the
* character `a` is 0, the character offset of `𐐀` is 1 and the character
* offset of b is 3 since `𐐀` is represented using two code units in UTF-16.
* Since 3.17 clients and servers can agree on a different string encoding
* representation (e.g. UTF-8). The client announces it's supported encoding
* via the client capability [`general.positionEncodings`](#clientCapabilities).
* The value is an array of position encodings the client supports, with
* decreasing preference (e.g. the encoding at index `0` is the most preferred
* one). To stay backwards compatible the only mandatory encoding is UTF-16
* represented via the string `utf-16`. The server can pick one of the
* encodings offered by the client and signals that encoding back to the
* client via the initialize result's property
* [`capabilities.positionEncoding`](#serverCapabilities). If the string value
* `utf-16` is missing from the client's capability `general.positionEncodings`
* servers can safely assume that the client supports UTF-16. If the server
* omits the position encoding in its initialize result the encoding defaults
* to the string value `utf-16`. Implementation considerations: since the
* conversion from one encoding into another requires the content of the
* file / line the conversion is best done where the file is read which is
* usually on the server side.
*
* Positions are line end character agnostic. So you can not specify a position
* that denotes `\r|\n` or `\n|` where `|` represents the character offset.
*
* @since 3.17.0 - support for negotiated position encoding.
*/
type Position struct { // line 6506
/*
* 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.
*/
Line uint32 `json:"line"`
/*
* Character offset on a line in a document (zero-based).
*
* The meaning of this offset is determined by the negotiated
* `PositionEncodingKind`.
*
* If the character value is greater than the line length it defaults back to the
* line length.
*/
Character uint32 `json:"character"`
}
/*
* A set of predefined position encoding kinds.
*
* @since 3.17.0
*/
type PositionEncodingKind string // line 13453
type PrepareRename2Gn = Msg_PrepareRename2Gn // (alias) line 13927
type PrepareRenameParams struct { // line 5944
TextDocumentPositionParams
WorkDoneProgressParams
}
type PrepareRenameResult = Msg_PrepareRename2Gn // (alias) line 13927
type PrepareSupportDefaultBehavior uint32 // line 13748
/*
* A previous result id in a workspace pull request.
*
* @since 3.17.0
*/
type PreviousResultID struct { // line 7336
/*
* The URI for which the client knowns a
* result id.
*/
URI DocumentURI `json:"uri"`
// The value of the previous result id.
Value string `json:"value"`
}
/*
* A previous result id in a workspace pull request.
*
* @since 3.17.0
*/
type PreviousResultId struct { // line 7336
/*
* The URI for which the client knowns a
* result id.
*/
URI DocumentURI `json:"uri"`
// The value of the previous result id.
Value string `json:"value"`
}
type ProgressParams struct { // line 6220
// The progress token provided by the client or server.
Token ProgressToken `json:"token"`
// The progress data.
Value interface{} `json:"value"`
}
type ProgressToken = interface{} // (alias) line 13974
// The publish diagnostic client capabilities.
type PublishDiagnosticsClientCapabilities struct { // line 12098
// Whether the clients accepts diagnostics with related information.
RelatedInformation bool `json:"relatedInformation,omitempty"`
/*
* 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
*/
TagSupport *PTagSupportPPublishDiagnostics `json:"tagSupport,omitempty"`
/*
* Whether the client interprets the version property of the
* `textDocument/publishDiagnostics` notification's parameter.
*
* @since 3.15.0
*/
VersionSupport bool `json:"versionSupport,omitempty"`
/*
* Client supports a codeDescription property
*
* @since 3.16.0
*/
CodeDescriptionSupport bool `json:"codeDescriptionSupport,omitempty"`
/*
* Whether code action supports the `data` property which is
* preserved between a `textDocument/publishDiagnostics` and
* `textDocument/codeAction` request.
*
* @since 3.16.0
*/
DataSupport bool `json:"dataSupport,omitempty"`
}
// The publish diagnostic notification's parameters.
type PublishDiagnosticsParams struct { // line 4484
// The URI for which diagnostic information is reported.
URI DocumentURI `json:"uri"`
/*
* Optional the version number of the document the diagnostics are published for.
*
* @since 3.15.0
*/
Version int32 `json:"version,omitempty"`
// An array of diagnostic information items.
Diagnostics []Diagnostic `json:"diagnostics"`
}
/*
* A range in a text document expressed as (zero-based) start and end positions.
*
* If you want to specify a range that contains a line including the line ending
* character(s) then use an end position denoting the start of the next line.
* For example:
* ```ts
* {
* start: { line: 5, character: 23 }
* end : { line 6, character : 0 }
* }
* ```
*/
type Range struct { // line 6316
// The range's start position.
Start Position `json:"start"`
// The range's end position.
End Position `json:"end"`
}
// Client Capabilities for a [ReferencesRequest](#ReferencesRequest).
type ReferenceClientCapabilities struct { // line 11635
// Whether references supports dynamic registration.
DynamicRegistration bool `json:"dynamicRegistration,omitempty"`
}
/*
* Value-object that contains additional information when
* requesting references.
*/
type ReferenceContext struct { // line 8950
// Include the declaration of the current symbol.
IncludeDeclaration bool `json:"includeDeclaration"`
}
// Reference options.
type ReferenceOptions struct { // line 8964
WorkDoneProgressOptions
}
// Parameters for a [ReferencesRequest](#ReferencesRequest).
type ReferenceParams struct { // line 5075
Context ReferenceContext `json:"context"`
TextDocumentPositionParams
WorkDoneProgressParams
PartialResultParams
}
// Registration options for a [ReferencesRequest](#ReferencesRequest).
type ReferenceRegistrationOptions struct { // line 5104
TextDocumentRegistrationOptions
ReferenceOptions
}
// General parameters to to register for an notification or to register a provider.
type Registration struct { // line 7602
/*
* The id used to register the request. The id can be used to deregister
* the request again.
*/
ID string `json:"id"`
// The method / capability to register for.
Method string `json:"method"`
// Options necessary for the registration.
RegisterOptions interface{} `json:"registerOptions,omitempty"`
}
type RegistrationParams struct { // line 4060
Registrations []Registration `json:"registrations"`
}
/*
* Client capabilities specific to regular expressions.
*
* @since 3.16.0
*/
type RegularExpressionsClientCapabilities struct { // line 12526
// The engine's name.
Engine string `json:"engine"`
// The engine's version.
Version string `json:"version,omitempty"`
}
/*
* A full diagnostic report with a set of related documents.
*
* @since 3.17.0
*/
type RelatedFullDocumentDiagnosticReport struct { // line 7162
/*
* 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
* such a language is C/C++ where marco definitions in a file
* a.cpp and result in errors in a header file b.hpp.
*
* @since 3.17.0
*/
RelatedDocuments map[DocumentURI]interface{} `json:"relatedDocuments,omitempty"`
FullDocumentDiagnosticReport
}
/*
* An unchanged diagnostic report with a set of related documents.
*
* @since 3.17.0
*/
type RelatedUnchangedDocumentDiagnosticReport struct { // line 7201
/*
* 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
* such a language is C/C++ where marco definitions in a file
* a.cpp and result in errors in a header file b.hpp.
*
* @since 3.17.0
<