langoustine.lsp.structures
Type members
Classlikes
A special text edit with an additional change annotation.
A special text edit with an additional change annotation.
- Value parameters:
- annotationId
The actual identifier of the change annotation
- newText
The string to be inserted. For delete operations use an empty string.
- range
The range of the text document to be manipulated. To insert text into a document create a range where start === end.
- Since:
3.16.0.
- Companion:
- object
- Source:
- structures.scala
The parameters passed via a apply workspace edit request.
The parameters passed via a apply workspace edit request.
- Value parameters:
- edit
The edits to apply.
- label
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.
- Companion:
- object
- Source:
- structures.scala
The result returned from the apply workspace edit request.
The result returned from the apply workspace edit request.
- Value parameters:
- applied
Indicates whether the edit was applied or not.
- failedChange
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 afailureHandlingStrategy
in its client capabilities.- failureReason
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.
- Since:
3.17 renamed from ApplyWorkspaceEditResponse
- Companion:
- object
- Source:
- structures.scala
A base for all symbol information.
A base for all symbol information.
- Value parameters:
- containerName
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.
- kind
The kind of this symbol.
- name
The name of this symbol.
- tags
Tags for this symbol.
- Since:
3.16.0
- Companion:
- object
- Source:
- structures.scala
- Value parameters:
- dynamicRegistration
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.
- Since:
3.16.0
- Companion:
- object
- Source:
- structures.scala
Represents an incoming call, e.g. a caller of a method or constructor.
Represents an incoming call, e.g. a caller of a method or constructor.
- Value parameters:
- from
The item that makes the call.
- fromRanges
The ranges at which the calls appear. This is relative to the caller denoted by
this.from
.
- Since:
3.16.0
- Companion:
- object
- Source:
- structures.scala
The parameter of a callHierarchy/incomingCalls
request.
The parameter of a callHierarchy/incomingCalls
request.
- Value parameters:
- partialResultToken
An optional token that a server can use to report partial results (e.g. streaming) to the client.
- workDoneToken
An optional token that a server can use to report work done progress.
- Since:
3.16.0
- Companion:
- object
- Source:
- structures.scala
Represents programming constructs like functions or constructors in the context of call hierarchy.
Represents programming constructs like functions or constructors in the context of call hierarchy.
- Value parameters:
- data
A data entry field that is preserved between a call hierarchy prepare and incoming calls or outgoing calls requests.
- detail
More detail for this item, e.g. the signature of a function.
- kind
The kind of this item.
- name
The name of this item.
- range
The range enclosing this symbol not including leading/trailing whitespace but everything else, e.g. comments and code.
- selectionRange
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
.- tags
Tags for this item.
- uri
The resource identifier of this item.
- Since:
3.16.0
- Companion:
- object
- Source:
- structures.scala
Call hierarchy options used during static registration.
Call hierarchy options used during static registration.
- Since:
3.16.0
- Companion:
- object
- Source:
- structures.scala
Represents an outgoing call, e.g. calling a getter from a method or a method from a constructor etc.
Represents an outgoing call, e.g. calling a getter from a method or a method from a constructor etc.
- Value parameters:
- fromRanges
The range at which this item is called. This is the range relative to the caller, e.g the item passed to
provideCallHierarchyOutgoingCalls
and notthis.to
.- to
The item that is called.
- Since:
3.16.0
- Companion:
- object
- Source:
- structures.scala
The parameter of a callHierarchy/outgoingCalls
request.
The parameter of a callHierarchy/outgoingCalls
request.
- Value parameters:
- partialResultToken
An optional token that a server can use to report partial results (e.g. streaming) to the client.
- workDoneToken
An optional token that a server can use to report work done progress.
- Since:
3.16.0
- Companion:
- object
- Source:
- structures.scala
The parameter of a textDocument/prepareCallHierarchy
request.
The parameter of a textDocument/prepareCallHierarchy
request.
- Value parameters:
- position
The position inside the text document.
- textDocument
The text document.
- workDoneToken
An optional token that a server can use to report work done progress.
- Since:
3.16.0
- Companion:
- object
- Source:
- structures.scala
Call hierarchy options used during static or dynamic registration.
Call hierarchy options used during static or dynamic registration.
- Value parameters:
- documentSelector
A document selector to identify the scope of the registration. If set to null the document selector provided on the client side will be used.
- id
The id used to register the request. The id can be used to deregister the request again. See also Registration#id.
- Since:
3.16.0
- Companion:
- object
- Source:
- structures.scala
Additional information that describes document changes.
Additional information that describes document changes.
- Value parameters:
- description
A human-readable string which is rendered less prominent in the user interface.
- label
A human-readable string describing the actual change. The string is rendered prominent in the user interface.
- needsConfirmation
A flag which indicates that user confirmation is needed before applying the change.
- Since:
3.16.0
- Companion:
- object
- Source:
- structures.scala
Defines the capabilities provided by the client.
Defines the capabilities provided by the client.
- Value parameters:
- experimental
Experimental client capabilities.
- general
General client capabilities.
- notebookDocument
Capabilities specific to the notebook document support.
- textDocument
Text document specific client capabilities.
- window
Window specific client capabilities.
- workspace
Workspace specific client capabilities.
- Since:
3.17.0
- Companion:
- object
- Source:
- structures.scala
A code action represents a change that can be performed in code, e.g. to fix a problem or to refactor code.
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.
- Value parameters:
- command
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.
- data
A data entry field that is preserved on a code action between a
textDocument/codeAction
and acodeAction/resolve
request.- diagnostics
The diagnostics that this code action resolves.
- disabled
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 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 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.- edit
The workspace edit this code action performs.
- isPreferred
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.- kind
The kind of the code action. Used to filter code actions.
- title
A short, human-readable, title for this code action.
- Since:
3.15.0
- Companion:
- object
- Source:
- structures.scala
The Client Capabilities of a CodeActionRequest.
The Client Capabilities of a CodeActionRequest.
- Value parameters:
- codeActionLiteralSupport
The client support code action literals of type
CodeAction
as a valid response of thetextDocument/codeAction
request. If the property is not set the request can only returnCommand
literals.- dataSupport
Whether code action supports the
data
property which is preserved between atextDocument/codeAction
and acodeAction/resolve
request.- disabledSupport
Whether code action supports the
disabled
property.- dynamicRegistration
Whether code action supports dynamic registration.
- honorsChangeAnnotations
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.- isPreferredSupport
Whether code action supports the
isPreferred
property.- resolveSupport
Whether the client supports resolving additional code action properties via a separate
codeAction/resolve
request.
- Since:
3.8.0
- Companion:
- object
- Source:
- structures.scala
Contains additional diagnostic information about the context in which a code action is run.
Contains additional diagnostic information about the context in which a code action is run.
- Value parameters:
- diagnostics
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.- only
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.
- triggerKind
The reason why code actions were requested.
- Since:
3.17.0
- Companion:
- object
- Source:
- structures.scala
Provider options for a CodeActionRequest.
Provider options for a CodeActionRequest.
- Value parameters:
- codeActionKinds
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.- resolveProvider
The server provides support to resolve additional information for a code action.
- Since:
3.16.0
- Companion:
- object
- Source:
- structures.scala
The parameters of a CodeActionRequest.
The parameters of a CodeActionRequest.
- Value parameters:
- context
Context carrying additional information.
- partialResultToken
An optional token that a server can use to report partial results (e.g. streaming) to the client.
- range
The range for which the command was invoked.
- textDocument
The document in which the command was invoked.
- workDoneToken
An optional token that a server can use to report work done progress.
- Companion:
- object
- Source:
- structures.scala
Registration options for a CodeActionRequest.
Registration options for a CodeActionRequest.
- Value parameters:
- codeActionKinds
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.- documentSelector
A document selector to identify the scope of the registration. If set to null the document selector provided on the client side will be used.
- resolveProvider
The server provides support to resolve additional information for a code action.
- Since:
3.16.0
- Companion:
- object
- Source:
- structures.scala
Structure to capture a description for an error code.
Structure to capture a description for an error code.
- Value parameters:
- href
An URI to open with more information about the diagnostic error.
- Since:
3.16.0
- Companion:
- object
- Source:
- structures.scala
A code lens represents a command that should be shown along with source text, like the number of references, a way to run tests, etc.
A code lens represents a command that should be shown along with source text, like the number of references, a way to run tests, etc.
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.
- Value parameters:
- command
The command this code lens represents.
- data
A data entry field that is preserved on a code lens item between a CodeLensRequest and a [CodeLensResolveRequest] (#CodeLensResolveRequest)
- range
The range in which this code lens is valid. Should only span a single line.
- Companion:
- object
- Source:
- structures.scala
The client capabilities of a CodeLensRequest.
The client capabilities of a CodeLensRequest.
- Value parameters:
- dynamicRegistration
Whether code lens supports dynamic registration.
- Companion:
- object
- Source:
- structures.scala
Code Lens provider options of a CodeLensRequest.
Code Lens provider options of a CodeLensRequest.
- Value parameters:
- resolveProvider
Code lens has a resolve provider as well.
- Companion:
- object
- Source:
- structures.scala
The parameters of a CodeLensRequest.
The parameters of a CodeLensRequest.
- Value parameters:
- partialResultToken
An optional token that a server can use to report partial results (e.g. streaming) to the client.
- textDocument
The document to request code lens for.
- workDoneToken
An optional token that a server can use to report work done progress.
- Companion:
- object
- Source:
- structures.scala
Registration options for a CodeLensRequest.
Registration options for a CodeLensRequest.
- Value parameters:
- documentSelector
A document selector to identify the scope of the registration. If set to null the document selector provided on the client side will be used.
- resolveProvider
Code lens has a resolve provider as well.
- Companion:
- object
- Source:
- structures.scala
- Value parameters:
- refreshSupport
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.
- Since:
3.16.0
- Companion:
- object
- Source:
- structures.scala
Represents a color in RGBA space.
Represents a color in RGBA space.
- Value parameters:
- alpha
The alpha component of this color in the range [0-1].
- blue
The blue component of this color in the range [0-1].
- green
The green component of this color in the range [0-1].
- red
The red component of this color in the range [0-1].
- Companion:
- object
- Source:
- structures.scala
Represents a color range from a document.
Represents a color range from a document.
- Value parameters:
- color
The actual color value for this color range.
- range
The range in the document where this color appears.
- Companion:
- object
- Source:
- structures.scala
- Value parameters:
- additionalTextEdits
An optional array of additional text edits that are applied when selecting this color presentation. Edits must not overlap with the main edit nor with themselves.
- label
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.
- textEdit
An edit which is applied to a document when selecting this presentation for the color. When
falsy
the label is used.
- Companion:
- object
- Source:
- structures.scala
Parameters for a ColorPresentationRequest.
Parameters for a ColorPresentationRequest.
- Value parameters:
- color
The color to request presentations for.
- partialResultToken
An optional token that a server can use to report partial results (e.g. streaming) to the client.
- range
The range where the color would be inserted. Serves as a context.
- textDocument
The text document.
- workDoneToken
An optional token that a server can use to report work done progress.
- Companion:
- object
- Source:
- structures.scala
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.
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.
- Value parameters:
- arguments
Arguments that the command handler should be invoked with.
- command
The identifier of the actual command handler.
- title
Title of the command, like
save
.
- Companion:
- object
- Source:
- structures.scala
Completion client capabilities
Completion client capabilities
- Value parameters:
- completionItem
The client supports the following
CompletionItem
specific capabilities.- completionList
The client supports the following
CompletionList
specific capabilities.- contextSupport
The client supports to send additional context information for a
textDocument/completion
request.- dynamicRegistration
Whether completion supports dynamic registration.
- insertTextMode
Defines how the client handles whitespace and indentation when accepting a completion item that uses multi line text in either
insertText
ortextEdit
.
- Since:
3.17.0
- Companion:
- object
- Source:
- structures.scala
Contains additional information about the context in which a completion request is triggered.
Contains additional information about the context in which a completion request is triggered.
- Value parameters:
- triggerCharacter
The trigger character (a single character) that has trigger code complete. Is undefined if
triggerKind !== CompletionTriggerKind.TriggerCharacter
- triggerKind
How the completion was triggered.
- Companion:
- object
- Source:
- structures.scala
A completion item represents a text snippet that is proposed to complete text that is being typed.
A completion item represents a text snippet that is proposed to complete text that is being typed.
- Value parameters:
- additionalTextEdits
An optional array of additional text edits that are applied when selecting this completion. Edits must not overlap (including the same insert position) with the main edit 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).
- command
An optional command that is executed after inserting this completion. Note that additional modifications to the current document should be described with the additionalTextEdits-property.
- commitCharacters
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.- data
A data entry field that is preserved on a completion item between a CompletionRequest and a CompletionResolveRequest.
- deprecated
Indicates if this item is deprecated.
- detail
A human-readable string with additional information about this item, like type or symbol information.
- documentation
A human-readable string that represents a doc-comment.
- filterText
A string that should be used when filtering a set of completion items. When
falsy
the label is used.- insertText
A string that should be inserted into a document when selecting this completion. When
falsy
the label is used. TheinsertText
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 examplecon<cursor position>
and a completion item with aninsertText
ofconsole
is provided it will only insertsole
. Therefore it is recommended to usetextEdit
instead since it avoids additional client side interpretation.- insertTextFormat
The format of the insert text. The format applies to both the
insertText
property and thenewText
property of a providedtextEdit
. If omitted defaults toInsertTextFormat.PlainText
. Please note that the insertTextFormat doesn't apply toadditionalTextEdits
.- insertTextMode
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.- kind
The kind of this completion item. Based of the kind an icon is chosen by the editor.
- label
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.
- labelDetails
Additional details for the label
- preselect
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.
- sortText
A string that should be used when comparing this item with other items. When
falsy
the label is used.- tags
Tags for this completion item.
- textEdit
An edit which is applied to a document when selecting this completion. When an edit is provided the value of 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 thetextDocument.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 anInsertReplaceEdit
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.- textEditText
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
- Companion:
- object
- Source:
- structures.scala
Additional details for a completion item label.
Additional details for a completion item label.
- Value parameters:
- description
An optional string which is rendered less prominently after
[[CompletionItem.detail]]
. Should be used for fully qualified names and file paths.- detail
An optional string which is rendered less prominently directly after
[[CompletionItem.label label]]
, without any spacing. Should be used for function signatures and type annotations.
- Since:
3.17.0
- Companion:
- object
- Source:
- structures.scala
Represents a collection of completion items to be presented in the editor.
Represents a collection of completion items to be presented in the editor.
- Value parameters:
- isIncomplete
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.
- itemDefaults
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 thecompletionList.itemDefaults
capability.- items
The completion items.
- Since:
3.17.0
- Companion:
- object
- Source:
- structures.scala
Completion options.
Completion options.
- Value parameters:
- allCommitCharacters
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 bothallCommitCharacters
and commit characters on an individual completion item the ones on the completion item win.- completionItem
The server supports the following
CompletionItem
specific capabilities.- resolveProvider
The server provides support to resolve additional information for a completion item.
- triggerCharacters
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 presentconsole
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 intriggerCharacters
.
- Since:
3.2.0
- Companion:
- object
- Source:
- structures.scala
Completion parameters
Completion parameters
- Value parameters:
- context
The completion context. This is only available it the client specifies to send this using the client capability
textDocument.completion.contextSupport === true
- partialResultToken
An optional token that a server can use to report partial results (e.g. streaming) to the client.
- position
The position inside the text document.
- textDocument
The text document.
- workDoneToken
An optional token that a server can use to report work done progress.
- Companion:
- object
- Source:
- structures.scala
Registration options for a CompletionRequest.
Registration options for a CompletionRequest.
- Value parameters:
- allCommitCharacters
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 bothallCommitCharacters
and commit characters on an individual completion item the ones on the completion item win.- completionItem
The server supports the following
CompletionItem
specific capabilities.- documentSelector
A document selector to identify the scope of the registration. If set to null the document selector provided on the client side will be used.
- resolveProvider
The server provides support to resolve additional information for a completion item.
- triggerCharacters
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 presentconsole
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 intriggerCharacters
.
- Since:
3.2.0
- Companion:
- object
- Source:
- structures.scala
- Value parameters:
- scopeUri
The scope to get the configuration section for.
- section
The configuration section asked for.
- Companion:
- object
- Source:
- structures.scala
The parameters of a configuration request.
The parameters of a configuration request.
- Companion:
- object
- Source:
- structures.scala
Create file operation.
Create file operation.
- Value parameters:
- annotationId
An optional annotation identifier describing the operation.
- kind
The resource operation kind.
- options
Additional options
- uri
The resource to create.
- Since:
3.16.0
- Companion:
- object
- Source:
- structures.scala
Options to create a file.
Options to create a file.
- Value parameters:
- ignoreIfExists
Ignore if exists.
- overwrite
Overwrite existing file. Overwrite wins over
ignoreIfExists
- Companion:
- object
- Source:
- structures.scala
The parameters sent in notifications/requests for user-initiated creation of files.
The parameters sent in notifications/requests for user-initiated creation of files.
- Value parameters:
- files
An array of all files/folders created in this operation.
- Since:
3.16.0
- Companion:
- object
- Source:
- structures.scala
- Value parameters:
- dynamicRegistration
Whether declaration supports dynamic registration. If this is set to
true
the client supports the newDeclarationRegistrationOptions
return value for the corresponding server capability as well.- linkSupport
The client supports additional metadata in the form of declaration links.
- Since:
3.14.0
- Companion:
- object
- Source:
- structures.scala
- Value parameters:
- partialResultToken
An optional token that a server can use to report partial results (e.g. streaming) to the client.
- position
The position inside the text document.
- textDocument
The text document.
- workDoneToken
An optional token that a server can use to report work done progress.
- Companion:
- object
- Source:
- structures.scala
- Value parameters:
- documentSelector
A document selector to identify the scope of the registration. If set to null the document selector provided on the client side will be used.
- id
The id used to register the request. The id can be used to deregister the request again. See also Registration#id.
- Companion:
- object
- Source:
- structures.scala
Client Capabilities for a DefinitionRequest.
Client Capabilities for a DefinitionRequest.
- Value parameters:
- dynamicRegistration
Whether definition supports dynamic registration.
- linkSupport
The client supports additional metadata in the form of definition links.
- Since:
3.14.0
- Companion:
- object
- Source:
- structures.scala
Server Capabilities for a DefinitionRequest.
Server Capabilities for a DefinitionRequest.
- Companion:
- object
- Source:
- structures.scala
Parameters for a DefinitionRequest.
Parameters for a DefinitionRequest.
- Value parameters:
- partialResultToken
An optional token that a server can use to report partial results (e.g. streaming) to the client.
- position
The position inside the text document.
- textDocument
The text document.
- workDoneToken
An optional token that a server can use to report work done progress.
- Companion:
- object
- Source:
- structures.scala
Registration options for a DefinitionRequest.
Registration options for a DefinitionRequest.
- Value parameters:
- documentSelector
A document selector to identify the scope of the registration. If set to null the document selector provided on the client side will be used.
- Companion:
- object
- Source:
- structures.scala
Delete file operation
Delete file operation
- Value parameters:
- annotationId
An optional annotation identifier describing the operation.
- kind
The resource operation kind.
- options
Delete options.
- uri
The file to delete.
- Since:
3.16.0
- Companion:
- object
- Source:
- structures.scala
Delete file options
Delete file options
- Value parameters:
- ignoreIfNotExists
Ignore the operation if the file doesn't exist.
- recursive
Delete the content recursively if a folder is denoted.
- Companion:
- object
- Source:
- structures.scala
The parameters sent in notifications/requests for user-initiated deletes of files.
The parameters sent in notifications/requests for user-initiated deletes of files.
- Value parameters:
- files
An array of all files/folders deleted in this operation.
- Since:
3.16.0
- Companion:
- object
- Source:
- structures.scala
Represents a diagnostic, such as a compiler error or warning. Diagnostic objects are only valid in the scope of a resource.
Represents a diagnostic, such as a compiler error or warning. Diagnostic objects are only valid in the scope of a resource.
- Value parameters:
- code
The diagnostic's code, which usually appear in the user interface.
- codeDescription
An optional property to describe the error code. Requires the code field (above) to be present/not null.
- data
A data entry field that is preserved between a
textDocument/publishDiagnostics
notification andtextDocument/codeAction
request.- message
The diagnostic's message. It usually appears in the user interface
- range
The range at which the message applies
- relatedInformation
An array of related diagnostic information, e.g. when symbol-names within a scope collide all definitions can be marked via this property.
- severity
The diagnostic's severity. Can be omitted. If omitted it is up to the client to interpret diagnostics as error, warning, info or hint.
- source
A human-readable string describing the source of this diagnostic, e.g. 'typescript' or 'super lint'. It usually appears in the user interface.
- tags
Additional metadata about the diagnostic.
- Since:
3.16.0
- Companion:
- object
- Source:
- structures.scala
Client capabilities specific to diagnostic pull requests.
Client capabilities specific to diagnostic pull requests.
- Value parameters:
- dynamicRegistration
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.- relatedDocumentSupport
Whether the clients supports related documents for document diagnostic pulls.
- Since:
3.17.0
- Companion:
- object
- Source:
- structures.scala
Diagnostic options.
Diagnostic options.
- Value parameters:
- identifier
An optional identifier under which the diagnostics are managed by the client.
- interFileDependencies
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.
- workspaceDiagnostics
The server provides support for workspace diagnostics as well.
- Since:
3.17.0
- Companion:
- object
- Source:
- structures.scala
Diagnostic registration options.
Diagnostic registration options.
- Value parameters:
- documentSelector
A document selector to identify the scope of the registration. If set to null the document selector provided on the client side will be used.
- id
The id used to register the request. The id can be used to deregister the request again. See also Registration#id.
- identifier
An optional identifier under which the diagnostics are managed by the client.
- interFileDependencies
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.
- workspaceDiagnostics
The server provides support for workspace diagnostics as well.
- Since:
3.17.0
- Companion:
- object
- Source:
- structures.scala
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.
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.
- Value parameters:
- location
The location of this related diagnostic information.
- message
The message of this related diagnostic information.
- Companion:
- object
- Source:
- structures.scala
Cancellation data returned from a diagnostic request.
Cancellation data returned from a diagnostic request.
- Since:
3.17.0
- Companion:
- object
- Source:
- structures.scala
Workspace client capabilities specific to diagnostic pull requests.
Workspace client capabilities specific to diagnostic pull requests.
- Value parameters:
- refreshSupport
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.
- Since:
3.17.0
- Companion:
- object
- Source:
- structures.scala
- Value parameters:
- dynamicRegistration
Did change configuration notification supports dynamic registration.
- Companion:
- object
- Source:
- structures.scala
The parameters of a change configuration notification.
The parameters of a change configuration notification.
- Value parameters:
- settings
The actual changed settings
- Companion:
- object
- Source:
- structures.scala
The params sent in a change notebook document notification.
The params sent in a change notebook document notification.
- Value parameters:
- change
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.
- notebookDocument
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.
- Since:
3.17.0
- Companion:
- object
- Source:
- structures.scala
The change text document notification's parameters.
The change text document notification's parameters.
- Value parameters:
- contentChanges
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.
- textDocument
The document that did change. The version number points to the version after all provided content changes have been applied.
- Companion:
- object
- Source:
- structures.scala
- Value parameters:
- dynamicRegistration
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.
- relativePatternSupport
Whether the client has support for
[[RelativePattern relative pattern]]
or not.
- Since:
3.17.0
- Companion:
- object
- Source:
- structures.scala
The watched files change notification's parameters.
The watched files change notification's parameters.
- Value parameters:
- changes
The actual file events.
- Companion:
- object
- Source:
- structures.scala
Describe options to be used when registered for text document change events.
Describe options to be used when registered for text document change events.
- Value parameters:
- watchers
The watchers to register.
- Companion:
- object
- Source:
- structures.scala
The parameters of a workspace/didChangeWorkspaceFolders
notification.
The parameters of a workspace/didChangeWorkspaceFolders
notification.
- Value parameters:
- event
The actual workspace folder change event.
- Companion:
- object
- Source:
- structures.scala
The params sent in a close notebook document notification.
The params sent in a close notebook document notification.
- Value parameters:
- cellTextDocuments
The text documents that represent the content of a notebook cell that got closed.
- notebookDocument
The notebook document that got closed.
- Since:
3.17.0
- Companion:
- object
- Source:
- structures.scala
The parameters sent in a close text document notification
The parameters sent in a close text document notification
- Value parameters:
- textDocument
The document that was closed.
- Companion:
- object
- Source:
- structures.scala
The params sent in an open notebook document notification.
The params sent in an open notebook document notification.
- Value parameters:
- cellTextDocuments
The text documents that represent the content of a notebook cell.
- notebookDocument
The notebook document that got opened.
- Since:
3.17.0
- Companion:
- object
- Source:
- structures.scala
The parameters sent in an open text document notification
The parameters sent in an open text document notification
- Value parameters:
- textDocument
The document that was opened.
- Companion:
- object
- Source:
- structures.scala
The params sent in a save notebook document notification.
The params sent in a save notebook document notification.
- Value parameters:
- notebookDocument
The notebook document that got saved.
- Since:
3.17.0
- Companion:
- object
- Source:
- structures.scala
The parameters sent in a save text document notification
The parameters sent in a save text document notification
- Value parameters:
- text
Optional the content when saved. Depends on the includeText value when the save notification was requested.
- textDocument
The document that was saved.
- Companion:
- object
- Source:
- structures.scala
- Value parameters:
- dynamicRegistration
Whether implementation supports dynamic registration. If this is set to
true
the client supports the newDocumentColorRegistrationOptions
return value for the corresponding server capability as well.
- Companion:
- object
- Source:
- structures.scala
Parameters for a DocumentColorRequest.
Parameters for a DocumentColorRequest.
- Value parameters:
- partialResultToken
An optional token that a server can use to report partial results (e.g. streaming) to the client.
- textDocument
The text document.
- workDoneToken
An optional token that a server can use to report work done progress.
- Companion:
- object
- Source:
- structures.scala
- Value parameters:
- documentSelector
A document selector to identify the scope of the registration. If set to null the document selector provided on the client side will be used.
- id
The id used to register the request. The id can be used to deregister the request again. See also Registration#id.
- Companion:
- object
- Source:
- structures.scala
Parameters of the document diagnostic request.
Parameters of the document diagnostic request.
- Value parameters:
- identifier
The additional identifier provided during registration.
- partialResultToken
An optional token that a server can use to report partial results (e.g. streaming) to the client.
- previousResultId
The result id of a previous response if provided.
- textDocument
The text document.
- workDoneToken
An optional token that a server can use to report work done progress.
- Since:
3.17.0
- Companion:
- object
- Source:
- structures.scala
A partial result for a document diagnostic report.
A partial result for a document diagnostic report.
- Since:
3.17.0
- Companion:
- object
- Source:
- structures.scala
Client capabilities of a DocumentFormattingRequest.
Client capabilities of a DocumentFormattingRequest.
- Value parameters:
- dynamicRegistration
Whether formatting supports dynamic registration.
- Companion:
- object
- Source:
- structures.scala
Provider options for a DocumentFormattingRequest.
Provider options for a DocumentFormattingRequest.
- Companion:
- object
- Source:
- structures.scala
The parameters of a DocumentFormattingRequest.
The parameters of a DocumentFormattingRequest.
- Value parameters:
- options
The format options.
- textDocument
The document to format.
- workDoneToken
An optional token that a server can use to report work done progress.
- Companion:
- object
- Source:
- structures.scala
Registration options for a DocumentFormattingRequest.
Registration options for a DocumentFormattingRequest.
- Value parameters:
- documentSelector
A document selector to identify the scope of the registration. If set to null the document selector provided on the client side will be used.
- Companion:
- object
- Source:
- structures.scala
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.
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.
- Value parameters:
- kind
The highlight kind, default is text.
- range
The range this highlight applies to.
- Companion:
- object
- Source:
- structures.scala
Client Capabilities for a DocumentHighlightRequest.
Client Capabilities for a DocumentHighlightRequest.
- Value parameters:
- dynamicRegistration
Whether document highlight supports dynamic registration.
- Companion:
- object
- Source:
- structures.scala
Provider options for a DocumentHighlightRequest.
Provider options for a DocumentHighlightRequest.
- Companion:
- object
- Source:
- structures.scala
Parameters for a DocumentHighlightRequest.
Parameters for a DocumentHighlightRequest.
- Value parameters:
- partialResultToken
An optional token that a server can use to report partial results (e.g. streaming) to the client.
- position
The position inside the text document.
- textDocument
The text document.
- workDoneToken
An optional token that a server can use to report work done progress.
- Companion:
- object
- Source:
- structures.scala
Registration options for a DocumentHighlightRequest.
Registration options for a DocumentHighlightRequest.
- Value parameters:
- documentSelector
A document selector to identify the scope of the registration. If set to null the document selector provided on the client side will be used.
- Companion:
- object
- Source:
- structures.scala
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.
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.
- Value parameters:
- data
A data entry field that is preserved on a document link between a DocumentLinkRequest and a DocumentLinkResolveRequest.
- range
The range this link applies to.
- target
The uri this link points to. If missing a resolve request is sent later.
- tooltip
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
- Companion:
- object
- Source:
- structures.scala
The client capabilities of a DocumentLinkRequest.
The client capabilities of a DocumentLinkRequest.
- Value parameters:
- dynamicRegistration
Whether document link supports dynamic registration.
- tooltipSupport
Whether the client supports the
tooltip
property onDocumentLink
.
- Since:
3.15.0
- Companion:
- object
- Source:
- structures.scala
Provider options for a DocumentLinkRequest.
Provider options for a DocumentLinkRequest.
- Value parameters:
- resolveProvider
Document links have a resolve provider as well.
- Companion:
- object
- Source:
- structures.scala
The parameters of a DocumentLinkRequest.
The parameters of a DocumentLinkRequest.
- Value parameters:
- partialResultToken
An optional token that a server can use to report partial results (e.g. streaming) to the client.
- textDocument
The document to provide document links for.
- workDoneToken
An optional token that a server can use to report work done progress.
- Companion:
- object
- Source:
- structures.scala
Registration options for a DocumentLinkRequest.
Registration options for a DocumentLinkRequest.
- Value parameters:
- documentSelector
A document selector to identify the scope of the registration. If set to null the document selector provided on the client side will be used.
- resolveProvider
Document links have a resolve provider as well.
- Companion:
- object
- Source:
- structures.scala
Client capabilities of a DocumentOnTypeFormattingRequest.
Client capabilities of a DocumentOnTypeFormattingRequest.
- Value parameters:
- dynamicRegistration
Whether on type formatting supports dynamic registration.
- Companion:
- object
- Source:
- structures.scala
Provider options for a DocumentOnTypeFormattingRequest.
Provider options for a DocumentOnTypeFormattingRequest.
- Value parameters:
- firstTriggerCharacter
A character on which formatting should be triggered, like
{
.- moreTriggerCharacter
More trigger characters.
- Companion:
- object
- Source:
- structures.scala
The parameters of a DocumentOnTypeFormattingRequest.
The parameters of a DocumentOnTypeFormattingRequest.
- Value parameters:
- ch
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).
- options
The formatting options.
- position
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.- textDocument
The document to format.
- Companion:
- object
- Source:
- structures.scala
Registration options for a DocumentOnTypeFormattingRequest.
Registration options for a DocumentOnTypeFormattingRequest.
- Value parameters:
- documentSelector
A document selector to identify the scope of the registration. If set to null the document selector provided on the client side will be used.
- firstTriggerCharacter
A character on which formatting should be triggered, like
{
.- moreTriggerCharacter
More trigger characters.
- Companion:
- object
- Source:
- structures.scala
Client capabilities of a DocumentRangeFormattingRequest.
Client capabilities of a DocumentRangeFormattingRequest.
- Value parameters:
- dynamicRegistration
Whether range formatting supports dynamic registration.
- Companion:
- object
- Source:
- structures.scala
Provider options for a DocumentRangeFormattingRequest.
Provider options for a DocumentRangeFormattingRequest.
- Companion:
- object
- Source:
- structures.scala
The parameters of a DocumentRangeFormattingRequest.
The parameters of a DocumentRangeFormattingRequest.
- Value parameters:
- options
The format options
- range
The range to format
- textDocument
The document to format.
- workDoneToken
An optional token that a server can use to report work done progress.
- Companion:
- object
- Source:
- structures.scala
Registration options for a DocumentRangeFormattingRequest.
Registration options for a DocumentRangeFormattingRequest.
- Value parameters:
- documentSelector
A document selector to identify the scope of the registration. If set to null the document selector provided on the client side will be used.
- Companion:
- object
- Source:
- structures.scala
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.
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.
- Value parameters:
- children
Children of this symbol, e.g. properties of a class.
- deprecated
Indicates if this symbol is deprecated.
- detail
More detail for this symbol, e.g the signature of a function.
- kind
The kind of this symbol.
- name
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.
- range
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.
- selectionRange
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
.- tags
Tags for this document symbol.
- Since:
3.16.0
- Companion:
- object
- Source:
- structures.scala
Client Capabilities for a DocumentSymbolRequest.
Client Capabilities for a DocumentSymbolRequest.
- Value parameters:
- dynamicRegistration
Whether document symbol supports dynamic registration.
- hierarchicalDocumentSymbolSupport
The client supports hierarchical document symbols.
- labelSupport
The client supports an additional label presented in the UI when registering a document symbol provider.
- symbolKind
Specific capabilities for the
SymbolKind
in thetextDocument/documentSymbol
request.- tagSupport
The client supports tags on
SymbolInformation
. Tags are supported onDocumentSymbol
ifhierarchicalDocumentSymbolSupport
is set to true. Clients supporting tags have to handle unknown tags gracefully.
- Since:
3.16.0
- Companion:
- object
- Source:
- structures.scala
Provider options for a DocumentSymbolRequest.
Provider options for a DocumentSymbolRequest.
- Value parameters:
- label
A human-readable string that is shown when multiple outlines trees are shown for the same document.
- Since:
3.16.0
- Companion:
- object
- Source:
- structures.scala
Parameters for a DocumentSymbolRequest.
Parameters for a DocumentSymbolRequest.
- Value parameters:
- partialResultToken
An optional token that a server can use to report partial results (e.g. streaming) to the client.
- textDocument
The text document.
- workDoneToken
An optional token that a server can use to report work done progress.
- Companion:
- object
- Source:
- structures.scala
Registration options for a DocumentSymbolRequest.
Registration options for a DocumentSymbolRequest.
- Value parameters:
- documentSelector
A document selector to identify the scope of the registration. If set to null the document selector provided on the client side will be used.
- label
A human-readable string that is shown when multiple outlines trees are shown for the same document.
- Since:
3.16.0
- Companion:
- object
- Source:
- structures.scala
The client capabilities of a ExecuteCommandRequest.
The client capabilities of a ExecuteCommandRequest.
- Value parameters:
- dynamicRegistration
Execute command supports dynamic registration.
- Companion:
- object
- Source:
- structures.scala
The server capabilities of a ExecuteCommandRequest.
The server capabilities of a ExecuteCommandRequest.
- Value parameters:
- commands
The commands to be executed on the server
- Companion:
- object
- Source:
- structures.scala
The parameters of a ExecuteCommandRequest.
The parameters of a ExecuteCommandRequest.
- Value parameters:
- arguments
Arguments that the command should be invoked with.
- command
The identifier of the actual command handler.
- workDoneToken
An optional token that a server can use to report work done progress.
- Companion:
- object
- Source:
- structures.scala
Registration options for a ExecuteCommandRequest.
Registration options for a ExecuteCommandRequest.
- Value parameters:
- commands
The commands to be executed on the server
- Companion:
- object
- Source:
- structures.scala
- Value parameters:
- executionOrder
A strict monotonically increasing value indicating the execution order of a cell inside a notebook.
- success
Whether the execution was successful or not if known by the client.
- Companion:
- object
- Source:
- structures.scala
Represents information on a file/folder create.
Represents information on a file/folder create.
- Value parameters:
- uri
A file:// URI for the location of the file/folder being created.
- Since:
3.16.0
- Companion:
- object
- Source:
- structures.scala
Represents information on a file/folder delete.
Represents information on a file/folder delete.
- Value parameters:
- uri
A file:// URI for the location of the file/folder being deleted.
- Since:
3.16.0
- Companion:
- object
- Source:
- structures.scala
An event describing a file change.
An event describing a file change.
- Value parameters:
- type
The change type.
- uri
The file's uri.
- Companion:
- object
- Source:
- structures.scala
Capabilities relating to events from file operations by the user in the client.
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.
- Value parameters:
- didCreate
The client has support for sending didCreateFiles notifications.
- didDelete
The client has support for sending didDeleteFiles notifications.
- didRename
The client has support for sending didRenameFiles notifications.
- dynamicRegistration
Whether the client supports dynamic registration for file requests/notifications.
- willCreate
The client has support for sending willCreateFiles requests.
- willDelete
The client has support for sending willDeleteFiles requests.
- willRename
The client has support for sending willRenameFiles requests.
- Since:
3.16.0
- Companion:
- object
- Source:
- structures.scala
A filter to describe in which file operation requests or notifications the server is interested in receiving.
A filter to describe in which file operation requests or notifications the server is interested in receiving.
- Value parameters:
- pattern
The actual file operation pattern.
- scheme
A Uri scheme like
file
oruntitled
.
- Since:
3.16.0
- Companion:
- object
- Source:
- structures.scala
Options for notifications/requests for user operations on files.
Options for notifications/requests for user operations on files.
- Value parameters:
- didCreate
The server is interested in receiving didCreateFiles notifications.
- didDelete
The server is interested in receiving didDeleteFiles file notifications.
- didRename
The server is interested in receiving didRenameFiles notifications.
- willCreate
The server is interested in receiving willCreateFiles requests.
- willDelete
The server is interested in receiving willDeleteFiles file requests.
- willRename
The server is interested in receiving willRenameFiles requests.
- Since:
3.16.0
- Companion:
- object
- Source:
- structures.scala
A pattern to describe in which file operation requests or notifications the server is interested in receiving.
A pattern to describe in which file operation requests or notifications the server is interested in receiving.
- Value parameters:
- glob
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 onexample.0
,example.1
, …)[!...]
to negate a range of characters to match in a path segment (e.g.,example.[!0-9]
to match onexample.a
,example.b
, but notexample.0
)
- matches
Whether to match files or folders with this pattern. Matches both if undefined.
- options
Additional options used during matching.
- Since:
3.16.0
- Companion:
- object
- Source:
- structures.scala
Matching options for the file operation pattern.
Matching options for the file operation pattern.
- Value parameters:
- ignoreCase
The pattern should be matched ignoring casing.
- Since:
3.16.0
- Companion:
- object
- Source:
- structures.scala
The options to register for file operations.
The options to register for file operations.
- Value parameters:
- filters
The actual filters.
- Since:
3.16.0
- Companion:
- object
- Source:
- structures.scala
Represents information on a file/folder rename.
Represents information on a file/folder rename.
- Value parameters:
- Since:
3.16.0
- Companion:
- object
- Source:
- structures.scala
- Value parameters:
- globPattern
The glob pattern to watch. See
[[GlobPattern glob pattern]]
for more detail.- kind
The kind of events of interest. If omitted it defaults to WatchKind.Create | WatchKind.Change | WatchKind.Delete which is 7.
- Since:
3.17.0 support for relative patterns.
- Companion:
- object
- Source:
- structures.scala
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.
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.
- Value parameters:
- collapsedText
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.
- endCharacter
The zero-based character offset before the folded range ends. If not defined, defaults to the length of the end line.
- endLine
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.
- kind
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 for an enumeration of standardized kinds.
- startCharacter
The zero-based character offset from where the folded range starts. If not defined, defaults to the length of the start line.
- startLine
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.
- Since:
3.17.0
- Companion:
- object
- Source:
- structures.scala
- Value parameters:
- dynamicRegistration
Whether implementation supports dynamic registration for folding range providers. If this is set to
true
the client supports the newFoldingRangeRegistrationOptions
return value for the corresponding server capability as well.- foldingRange
Specific options for the folding range.
- foldingRangeKind
Specific options for the folding range kind.
- lineFoldingOnly
If set, the client signals that it only supports folding complete lines. If set, client will ignore specified
startCharacter
andendCharacter
properties in a FoldingRange.- rangeLimit
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.
- Since:
3.17.0
- Companion:
- object
- Source:
- structures.scala
Parameters for a FoldingRangeRequest.
Parameters for a FoldingRangeRequest.
- Value parameters:
- partialResultToken
An optional token that a server can use to report partial results (e.g. streaming) to the client.
- textDocument
The text document.
- workDoneToken
An optional token that a server can use to report work done progress.
- Companion:
- object
- Source:
- structures.scala
- Value parameters:
- documentSelector
A document selector to identify the scope of the registration. If set to null the document selector provided on the client side will be used.
- id
The id used to register the request. The id can be used to deregister the request again. See also Registration#id.
- Companion:
- object
- Source:
- structures.scala
Value-object describing what options formatting should use.
Value-object describing what options formatting should use.
- Value parameters:
- insertFinalNewline
Insert a newline character at the end of the file if one does not exist.
- insertSpaces
Prefer spaces over tabs.
- tabSize
Size of a tab in spaces.
- trimFinalNewlines
Trim all newlines after the final newline at the end of the file.
- trimTrailingWhitespace
Trim trailing whitespace on a line.
- Since:
3.15.0
- Companion:
- object
- Source:
- structures.scala
A diagnostic report with a full set of problems.
A diagnostic report with a full set of problems.
- Value parameters:
- items
The actual items.
- kind
A full document diagnostic report.
- resultId
An optional result id. If provided it will be sent on the next diagnostic request for the same document.
- Since:
3.17.0
- Companion:
- object
- Source:
- structures.scala
General client capabilities.
General client capabilities.
- Value parameters:
- markdown
Client capabilities specific to the client's markdown parser.
- positionEncodings
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.
- regularExpressions
Client capabilities specific to regular expressions.
- staleRequestSupport
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.16.0
- Companion:
- object
- Source:
- structures.scala
The result of a hover request.
The result of a hover request.
- Value parameters:
- contents
The hover's content
- range
An optional range inside the text document that is used to visualize the hover, e.g. by changing the background color.
- Companion:
- object
- Source:
- structures.scala
- Value parameters:
- contentFormat
Client supports the following content formats for the content property. The order describes the preferred format of the client.
- dynamicRegistration
Whether hover supports dynamic registration.
- Companion:
- object
- Source:
- structures.scala
Parameters for a HoverRequest.
Parameters for a HoverRequest.
- Value parameters:
- position
The position inside the text document.
- textDocument
The text document.
- workDoneToken
An optional token that a server can use to report work done progress.
- Companion:
- object
- Source:
- structures.scala
Registration options for a HoverRequest.
Registration options for a HoverRequest.
- Value parameters:
- documentSelector
A document selector to identify the scope of the registration. If set to null the document selector provided on the client side will be used.
- Companion:
- object
- Source:
- structures.scala
- Value parameters:
- dynamicRegistration
Whether implementation supports dynamic registration. If this is set to
true
the client supports the newImplementationRegistrationOptions
return value for the corresponding server capability as well.- linkSupport
The client supports additional metadata in the form of definition links.
- Since:
3.6.0
- Companion:
- object
- Source:
- structures.scala
- Value parameters:
- partialResultToken
An optional token that a server can use to report partial results (e.g. streaming) to the client.
- position
The position inside the text document.
- textDocument
The text document.
- workDoneToken
An optional token that a server can use to report work done progress.
- Companion:
- object
- Source:
- structures.scala
- Value parameters:
- documentSelector
A document selector to identify the scope of the registration. If set to null the document selector provided on the client side will be used.
- id
The id used to register the request. The id can be used to deregister the request again. See also Registration#id.
- Companion:
- object
- Source:
- structures.scala
The data type of the ResponseError if the initialize request fails.
The data type of the ResponseError if the initialize request fails.
- Value parameters:
- retry
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.
- Companion:
- object
- Source:
- structures.scala
- Value parameters:
- capabilities
The capabilities provided by the client (editor or tool)
- clientInfo
Information about the client
- initializationOptions
User provided initialization options.
- locale
The locale the client is currently showing the user interface in. This must not necessarily be the locale of the operating system. Uses IETF language tags as the value's syntax (See https://en.wikipedia.org/wiki/IETF_language_tag)
- processId
The process Id of the parent process that started the server. Is
null
if the process has not been started by another process. If the parent process is not alive then the server should exit.- rootPath
The rootPath of the workspace. Is null if no folder is open.
- rootUri
The rootUri of the workspace. Is null if no folder is open. If both
rootPath
androotUri
are setrootUri
wins.- trace
The initial trace setting. If omitted trace is disabled ('off').
- workspaceFolders
The workspace folders configured in the client when the server starts. This property is only available if the client supports workspace folders. It can be
null
if the client supports workspace folders but none are configured.
- Since:
3.15.0
- Companion:
- object
- Source:
- structures.scala
The result returned from an initialize request.
The result returned from an initialize request.
- Value parameters:
- capabilities
The capabilities the language server provides.
- serverInfo
Information about the server.
- Since:
3.15.0
- Companion:
- object
- Source:
- structures.scala
Inlay hint information.
Inlay hint information.
- Value parameters:
- data
A data entry field that is preserved on an inlay hint between a
textDocument/inlayHint
and ainlayHint/resolve
request.- kind
The kind of this hint. Can be omitted in which case the client should fall back to a reasonable default.
- label
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.
- paddingLeft
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.
- paddingRight
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.
- position
The position of this hint.
- textEdits
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.
- tooltip
The tooltip text when you hover over this item.
- Since:
3.17.0
- Companion:
- object
- Source:
- structures.scala
Inlay hint client capabilities.
Inlay hint client capabilities.
- Value parameters:
- dynamicRegistration
Whether inlay hints support dynamic registration.
- resolveSupport
Indicates which properties a client can resolve lazily on an inlay hint.
- Since:
3.17.0
- Companion:
- object
- Source:
- structures.scala
An inlay hint label part allows for interactive and composite labels of inlay hints.
An inlay hint label part allows for interactive and composite labels of inlay hints.
- Value parameters:
- command
An optional command for this label part. Depending on the client capability
inlayHint.resolveSupport
clients might resolve this property late using the resolve request.- location
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.- tooltip
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.- value
The value of this label part.
- Since:
3.17.0
- Companion:
- object
- Source:
- structures.scala
Inlay hint options used during static registration.
Inlay hint options used during static registration.
- Value parameters:
- resolveProvider
The server provides support to resolve additional information for an inlay hint item.
- Since:
3.17.0
- Companion:
- object
- Source:
- structures.scala
A parameter literal used in inlay hint requests.
A parameter literal used in inlay hint requests.
- Value parameters:
- range
The document range for which inlay hints should be computed.
- textDocument
The text document.
- workDoneToken
An optional token that a server can use to report work done progress.
- Since:
3.17.0
- Companion:
- object
- Source:
- structures.scala
Inlay hint options used during static or dynamic registration.
Inlay hint options used during static or dynamic registration.
- Value parameters:
- documentSelector
A document selector to identify the scope of the registration. If set to null the document selector provided on the client side will be used.
- id
The id used to register the request. The id can be used to deregister the request again. See also Registration#id.
- resolveProvider
The server provides support to resolve additional information for an inlay hint item.
- Since:
3.17.0
- Companion:
- object
- Source:
- structures.scala
Client workspace capabilities specific to inlay hints.
Client workspace capabilities specific to inlay hints.
- Value parameters:
- refreshSupport
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.
- Since:
3.17.0
- Companion:
- object
- Source:
- structures.scala
Client capabilities specific to inline values.
Client capabilities specific to inline values.
- Value parameters:
- dynamicRegistration
Whether implementation supports dynamic registration for inline value providers.
- Since:
3.17.0
- Companion:
- object
- Source:
- structures.scala
- Value parameters:
- frameId
The stack frame (as a DAP Id) where the execution has stopped.
- stoppedLocation
The document range where execution has stopped. Typically the end position of the range denotes the line where the inline values are shown.
- Since:
3.17.0
- Companion:
- object
- Source:
- structures.scala
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.
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.
- Value parameters:
- expression
If specified the expression overrides the extracted expression.
- range
The document range for which the inline value applies. The range is used to extract the evaluatable expression from the underlying document.
- Since:
3.17.0
- Companion:
- object
- Source:
- structures.scala
Inline value options used during static registration.
Inline value options used during static registration.
- Since:
3.17.0
- Companion:
- object
- Source:
- structures.scala
A parameter literal used in inline value requests.
A parameter literal used in inline value requests.
- Value parameters:
- context
Additional information about the context in which inline values were requested.
- range
The document range for which inline values should be computed.
- textDocument
The text document.
- workDoneToken
An optional token that a server can use to report work done progress.
- Since:
3.17.0
- Companion:
- object
- Source:
- structures.scala
Inline value options used during static or dynamic registration.
Inline value options used during static or dynamic registration.
- Value parameters:
- documentSelector
A document selector to identify the scope of the registration. If set to null the document selector provided on the client side will be used.
- id
The id used to register the request. The id can be used to deregister the request again. See also Registration#id.
- Since:
3.17.0
- Companion:
- object
- Source:
- structures.scala
Provide inline value as text.
Provide inline value as text.
- Value parameters:
- range
The document range for which the inline value applies.
- text
The text of the inline value.
- Since:
3.17.0
- Companion:
- object
- Source:
- structures.scala
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.
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.
- Value parameters:
- caseSensitiveLookup
How to perform the lookup.
- range
The document range for which the inline value applies. The range is used to extract the variable name from the underlying document.
- variableName
If specified the name of the variable to look up.
- Since:
3.17.0
- Companion:
- object
- Source:
- structures.scala
Client workspace capabilities specific to inline values.
Client workspace capabilities specific to inline values.
- Value parameters:
- refreshSupport
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.
- Since:
3.17.0
- Companion:
- object
- Source:
- structures.scala
A special text edit to provide an insert and a replace operation.
A special text edit to provide an insert and a replace operation.
- Value parameters:
- insert
The range if the insert is requested
- newText
The string to be inserted.
- replace
The range if the replace is requested.
- Since:
3.16.0
- Companion:
- object
- Source:
- structures.scala
Client capabilities for the linked editing range request.
Client capabilities for the linked editing range request.
- Value parameters:
- dynamicRegistration
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.
- Since:
3.16.0
- Companion:
- object
- Source:
- structures.scala
- Value parameters:
- position
The position inside the text document.
- textDocument
The text document.
- workDoneToken
An optional token that a server can use to report work done progress.
- Companion:
- object
- Source:
- structures.scala
- Value parameters:
- documentSelector
A document selector to identify the scope of the registration. If set to null the document selector provided on the client side will be used.
- id
The id used to register the request. The id can be used to deregister the request again. See also Registration#id.
- Companion:
- object
- Source:
- structures.scala
The result of a linked editing range request.
The result of a linked editing range request.
- Value parameters:
- ranges
A list of ranges that can be edited together. The ranges must have identical length and contain identical text content. The ranges cannot overlap.
- wordPattern
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.
- Since:
3.16.0
- Companion:
- object
- Source:
- structures.scala
Represents a location inside a resource, such as a line inside a text file.
Represents a location inside a resource, such as a line inside a text file.
- Companion:
- object
- Source:
- structures.scala
Represents the connection of two locations. Provides additional metadata over normal locations, including an origin range.
Represents the connection of two locations. Provides additional metadata over normal locations, including an origin range.
- Value parameters:
- originSelectionRange
Span of the origin of this link. Used as the underlined span for mouse interaction. Defaults to the word range at the definition position.
- targetRange
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.
- targetSelectionRange
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 alsoDocumentSymbol#range
- targetUri
The target resource identifier of this link.
- Companion:
- object
- Source:
- structures.scala
The log message parameters.
The log message parameters.
- Value parameters:
- message
The actual message.
- type
The message type. See
[[MessageType]]
- Companion:
- object
- Source:
- structures.scala
Client capabilities specific to the used markdown parser.
Client capabilities specific to the used markdown parser.
- Value parameters:
- allowedTags
A list of HTML tags that the client allows / supports in Markdown.
- parser
The name of the parser.
- version
The version of the parser.
- Since:
3.16.0
- Companion:
- object
- Source:
- structures.scala
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.
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:
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.
'
'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.
- Value parameters:
- kind
The type of the Markup
- value
The content itself
- Companion:
- object
- Source:
- structures.scala
- Value parameters:
- title
A short title like 'Retry', 'Open Log' etc.
- Companion:
- object
- Source:
- structures.scala
Moniker definition to match LSIF 0.5 moniker definition.
Moniker definition to match LSIF 0.5 moniker definition.
- Value parameters:
- identifier
The identifier of the moniker. The value is opaque in LSIF however schema owners are allowed to define the structure if they want.
- kind
The moniker kind if known.
- scheme
The scheme of the moniker. For example tsc or .Net
- unique
The scope in which the moniker is unique
- Since:
3.16.0
- Companion:
- object
- Source:
- structures.scala
Client capabilities specific to the moniker request.
Client capabilities specific to the moniker request.
- Value parameters:
- dynamicRegistration
Whether moniker supports dynamic registration. If this is set to
true
the client supports the newMonikerRegistrationOptions
return value for the corresponding server capability as well.
- Since:
3.16.0
- Companion:
- object
- Source:
- structures.scala
- Value parameters:
- partialResultToken
An optional token that a server can use to report partial results (e.g. streaming) to the client.
- position
The position inside the text document.
- textDocument
The text document.
- workDoneToken
An optional token that a server can use to report work done progress.
- Companion:
- object
- Source:
- structures.scala
- Value parameters:
- documentSelector
A document selector to identify the scope of the registration. If set to null the document selector provided on the client side will be used.
- Companion:
- object
- Source:
- structures.scala
A notebook cell.
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.
- Value parameters:
- document
The URI of the cell's text document content.
- executionSummary
Additional execution summary information if supported by the client.
- kind
The cell's kind
- metadata
Additional metadata stored with the cell. Note: should always be an object literal (e.g. LSPObject)
- Since:
3.17.0
- Companion:
- object
- Source:
- structures.scala
A change describing how to move a NotebookCell
array from state S to S'.
A change describing how to move a NotebookCell
array from state S to S'.
- Value parameters:
- cells
The new cells, if any
- deleteCount
The deleted cells
- start
The start oftest of the cell that changed.
- Since:
3.17.0
- Companion:
- object
- Source:
- structures.scala
A notebook cell text document filter denotes a cell text document by different properties.
A notebook cell text document filter denotes a cell text document by different properties.
- Value parameters:
- language
A language id like
python
. Will be matched against the language id of the notebook cell document. '*' matches every language.- notebook
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.
- Since:
3.17.0
- Companion:
- object
- Source:
- structures.scala
A notebook document.
A notebook document.
- Value parameters:
- cells
The cells of a notebook.
- metadata
Additional metadata stored with the notebook document. Note: should always be an object literal (e.g. LSPObject)
- notebookType
The type of the notebook.
- uri
The notebook document's uri.
- version
The version number of this document (it will increase after each change, including undo/redo).
- Since:
3.17.0
- Companion:
- object
- Source:
- structures.scala
A change event for a notebook document.
A change event for a notebook document.
- Value parameters:
- cells
Changes to cells
- metadata
The changed meta data if any. Note: should always be an object literal (e.g. LSPObject)
- Since:
3.17.0
- Companion:
- object
- Source:
- structures.scala
Capabilities specific to the notebook document support.
Capabilities specific to the notebook document support.
- Value parameters:
- synchronization
Capabilities specific to notebook document synchronization
- Since:
3.17.0
- Companion:
- object
- Source:
- structures.scala
A literal to identify a notebook document in the client.
A literal to identify a notebook document in the client.
- Value parameters:
- uri
The notebook document's uri.
- Since:
3.17.0
- Companion:
- object
- Source:
- structures.scala
Notebook specific client capabilities.
Notebook specific client capabilities.
- Value parameters:
- dynamicRegistration
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.- executionSummarySupport
The client supports sending execution summary data per cell.
- Since:
3.17.0
- Companion:
- object
- Source:
- structures.scala
Options specific to a notebook plus its cells to be synced to the server.
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.
- Value parameters:
- notebookSelector
The notebooks to be synced
- save
Whether save notification should be forwarded to the server. Will only be honored if mode ===
notebook
.
- Since:
3.17.0
- Companion:
- object
- Source:
- structures.scala
Registration options specific to a notebook.
Registration options specific to a notebook.
- Value parameters:
- id
The id used to register the request. The id can be used to deregister the request again. See also Registration#id.
- notebookSelector
The notebooks to be synced
- save
Whether save notification should be forwarded to the server. Will only be honored if mode ===
notebook
.
- Since:
3.17.0
- Companion:
- object
- Source:
- structures.scala
A text document identifier to optionally denote a specific version of a text document.
A text document identifier to optionally denote a specific version of a text document.
- Value parameters:
- uri
The text document's uri.
- version
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).
- Companion:
- object
- Source:
- structures.scala
Represents a parameter of a callable-signature. A parameter can have a label and a doc-comment.
Represents a parameter of a callable-signature. A parameter can have a label and a doc-comment.
- Value parameters:
- documentation
The human-readable doc-comment of this parameter. Will be shown in the UI but can be omitted.
- label
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
andRange
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 theSignatureInformation.label
.
- Companion:
- object
- Source:
- structures.scala
- Value parameters:
- partialResultToken
An optional token that a server can use to report partial results (e.g. streaming) to the client.
- Companion:
- object
- Source:
- structures.scala
Position in a text document expressed as zero-based line and character
offset. Prior to 3.17 the offsets were always based on a UTF-16 string
representation. So a string of the form a𐐀b
the character offset of the
character a
is 0, the character offset of 𐐀
is 1 and the character
offset of b is 3 since 𐐀
is represented using two code units in UTF-16.
Since 3.17 clients and servers can agree on a different string encoding
representation (e.g. UTF-8). The client announces it's supported encoding
via the client capability general.positionEncodings
.
The value is an array of position encodings the client supports, with
decreasing preference (e.g. the encoding at index 0
is the most preferred
one). To stay backwards compatible the only mandatory encoding is UTF-16
represented via the string utf-16
. The server can pick one of the
encodings offered by the client and signals that encoding back to the
client via the initialize result's property
capabilities.positionEncoding
. If the string value
utf-16
is missing from the client's capability general.positionEncodings
servers can safely assume that the client supports UTF-16. If the server
omits the position encoding in its initialize result the encoding defaults
to the string value utf-16
. Implementation considerations: since the
conversion from one encoding into another requires the content of the
file / line the conversion is best done where the file is read which is
usually on the server side.
Position in a text document expressed as zero-based line and character
offset. Prior to 3.17 the offsets were always based on a UTF-16 string
representation. So a string of the form a𐐀b
the character offset of the
character a
is 0, the character offset of 𐐀
is 1 and the character
offset of b is 3 since 𐐀
is represented using two code units in UTF-16.
Since 3.17 clients and servers can agree on a different string encoding
representation (e.g. UTF-8). The client announces it's supported encoding
via the client capability general.positionEncodings
.
The value is an array of position encodings the client supports, with
decreasing preference (e.g. the encoding at index 0
is the most preferred
one). To stay backwards compatible the only mandatory encoding is UTF-16
represented via the string utf-16
. The server can pick one of the
encodings offered by the client and signals that encoding back to the
client via the initialize result's property
capabilities.positionEncoding
. If the string value
utf-16
is missing from the client's capability general.positionEncodings
servers can safely assume that the client supports UTF-16. If the server
omits the position encoding in its initialize result the encoding defaults
to the string value utf-16
. Implementation considerations: since the
conversion from one encoding into another requires the content of the
file / line the conversion is best done where the file is read which is
usually on the server side.
Positions are line end character agnostic. So you can not specify a position
that denotes \r|\n
or \n|
where |
represents the character offset.
- Value parameters:
- character
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.- line
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.
- Since:
3.17.0 - support for negotiated position encoding.
- Companion:
- object
- Source:
- structures.scala
- Value parameters:
- position
The position inside the text document.
- textDocument
The text document.
- workDoneToken
An optional token that a server can use to report work done progress.
- Companion:
- object
- Source:
- structures.scala
A previous result id in a workspace pull request.
A previous result id in a workspace pull request.
- Value parameters:
- uri
The URI for which the client knows a result id.
- value
The value of the previous result id.
- Since:
3.17.0
- Companion:
- object
- Source:
- structures.scala
- Value parameters:
- token
The progress token provided by the client or server.
- value
The progress data.
- Companion:
- object
- Source:
- structures.scala
The publish diagnostic client capabilities.
The publish diagnostic client capabilities.
- Value parameters:
- codeDescriptionSupport
Client supports a codeDescription property
- dataSupport
Whether code action supports the
data
property which is preserved between atextDocument/publishDiagnostics
andtextDocument/codeAction
request.- relatedInformation
Whether the clients accepts diagnostics with related information.
- tagSupport
Client supports the tag property to provide meta data about a diagnostic. Clients supporting tags have to handle unknown tags gracefully.
- versionSupport
Whether the client interprets the version property of the
textDocument/publishDiagnostics
notification's parameter.
- Since:
3.15.0
- Companion:
- object
- Source:
- structures.scala
The publish diagnostic notification's parameters.
The publish diagnostic notification's parameters.
- Value parameters:
- diagnostics
An array of diagnostic information items.
- uri
The URI for which diagnostic information is reported.
- version
Optional the version number of the document the diagnostics are published for.
- Since:
3.15.0
- Companion:
- object
- Source:
- structures.scala
A range in a text document expressed as (zero-based) start and end positions.
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:
{
start: { line: 5, character: 23 }
end : { line 6, character : 0 }
}
- Value parameters:
- end
The range's end position.
- start
The range's start position.
- Companion:
- object
- Source:
- structures.scala
Client Capabilities for a ReferencesRequest.
Client Capabilities for a ReferencesRequest.
- Value parameters:
- dynamicRegistration
Whether references supports dynamic registration.
- Companion:
- object
- Source:
- structures.scala
Value-object that contains additional information when requesting references.
Value-object that contains additional information when requesting references.
- Value parameters:
- includeDeclaration
Include the declaration of the current symbol.
- Companion:
- object
- Source:
- structures.scala
Parameters for a ReferencesRequest.
Parameters for a ReferencesRequest.
- Value parameters:
- partialResultToken
An optional token that a server can use to report partial results (e.g. streaming) to the client.
- position
The position inside the text document.
- textDocument
The text document.
- workDoneToken
An optional token that a server can use to report work done progress.
- Companion:
- object
- Source:
- structures.scala
Registration options for a ReferencesRequest.
Registration options for a ReferencesRequest.
- Value parameters:
- documentSelector
A document selector to identify the scope of the registration. If set to null the document selector provided on the client side will be used.
- Companion:
- object
- Source:
- structures.scala
General parameters to to register for an notification or to register a provider.
General parameters to to register for an notification or to register a provider.
- Value parameters:
- id
The id used to register the request. The id can be used to deregister the request again.
- method
The method / capability to register for.
- registerOptions
Options necessary for the registration.
- Companion:
- object
- Source:
- structures.scala
Client capabilities specific to regular expressions.
Client capabilities specific to regular expressions.
- Value parameters:
- engine
The engine's name.
- version
The engine's version.
- Since:
3.16.0
- Companion:
- object
- Source:
- structures.scala
A full diagnostic report with a set of related documents.
A full diagnostic report with a set of related documents.
- Value parameters:
- items
The actual items.
- kind
A full document diagnostic report.
- relatedDocuments
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.
- resultId
An optional result id. If provided it will be sent on the next diagnostic request for the same document.
- Since:
3.17.0
- Companion:
- object
- Source:
- structures.scala
An unchanged diagnostic report with a set of related documents.
An unchanged diagnostic report with a set of related documents.
- Value parameters:
- kind
A document diagnostic report indicating no changes to the last result. A server can only return
unchanged
if result ids are provided.- relatedDocuments
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.
- resultId
A result id which will be sent on the next diagnostic request for the same document.
- Since:
3.17.0
- Companion:
- object
- Source:
- structures.scala
A relative pattern is a helper to construct glob patterns that are matched
relatively to a base URI. The common value for a baseUri
is a workspace
folder root, but it can be another absolute URI as well.
A relative pattern is a helper to construct glob patterns that are matched
relatively to a base URI. The common value for a baseUri
is a workspace
folder root, but it can be another absolute URI as well.
- Value parameters:
- baseUri
A workspace folder or a base URI to which this pattern will be matched against relatively.
- pattern
The actual glob pattern;
- Since:
3.17.0
- Companion:
- object
- Source:
- structures.scala
- Value parameters:
- dynamicRegistration
Whether rename supports dynamic registration.
- honorsChangeAnnotations
Whether the client honors the change annotations in text edits and resource operations returned via the rename request's workspace edit by for example presenting the workspace edit in the user interface and asking for confirmation.
- prepareSupport
Client supports testing for validity of rename operations before execution.
- prepareSupportDefaultBehavior
Client supports the default behavior result. The value indicates the default behavior used by the client.
- Since:
3.12.0
- Companion:
- object
- Source:
- structures.scala
Rename file operation
Rename file operation
- Value parameters:
- annotationId
An optional annotation identifier describing the operation.
- kind
The resource operation kind.
- newUri
The new location.
- oldUri
The old (existing) location.
- options
Rename options.
- Since:
3.16.0
- Companion:
- object
- Source:
- structures.scala
Rename file options
Rename file options
- Value parameters:
- ignoreIfExists
Ignores if target exists.
- overwrite
Overwrite target if existing. Overwrite wins over
ignoreIfExists
- Companion:
- object
- Source:
- structures.scala
The parameters sent in notifications/requests for user-initiated renames of files.
The parameters sent in notifications/requests for user-initiated renames of files.
- Value parameters:
- files
An array of all files/folders renamed in this operation. When a folder is renamed, only the folder will be included, and not its children.
- Since:
3.16.0
- Companion:
- object
- Source:
- structures.scala
Provider options for a RenameRequest.
Provider options for a RenameRequest.
- Value parameters:
- prepareProvider
Renames should be checked and tested before being executed.
- Since:
version 3.12.0
- Companion:
- object
- Source:
- structures.scala
The parameters of a RenameRequest.
The parameters of a RenameRequest.
- Value parameters:
- newName
The new name of the symbol. If the given name is not valid the request must return a ResponseError with an appropriate message set.
- position
The position at which this request was sent.
- textDocument
The document to rename.
- workDoneToken
An optional token that a server can use to report work done progress.
- Companion:
- object
- Source:
- structures.scala
Registration options for a RenameRequest.
Registration options for a RenameRequest.
- Value parameters:
- documentSelector
A document selector to identify the scope of the registration. If set to null the document selector provided on the client side will be used.
- prepareProvider
Renames should be checked and tested before being executed.
- Since:
version 3.12.0
- Companion:
- object
- Source:
- structures.scala
A generic resource operation.
A generic resource operation.
- Value parameters:
- annotationId
An optional annotation identifier describing the operation.
- kind
The resource operation kind.
- Since:
3.16.0
- Companion:
- object
- Source:
- structures.scala
Save options.
Save options.
- Value parameters:
- includeText
The client is supposed to include the content on save.
- Companion:
- object
- Source:
- structures.scala
A selection range represents a part of a selection hierarchy. A selection range may have a parent selection range that contains it.
A selection range represents a part of a selection hierarchy. A selection range may have a parent selection range that contains it.
- Value parameters:
- parent
The parent selection range containing this range. Therefore
parent.range
must containthis.range
.- range
The range of this selection range.
- Companion:
- object
- Source:
- structures.scala
- Value parameters:
- dynamicRegistration
Whether implementation supports dynamic registration for selection range providers. If this is set to
true
the client supports the newSelectionRangeRegistrationOptions
return value for the corresponding server capability as well.
- Companion:
- object
- Source:
- structures.scala
A parameter literal used in selection range requests.
A parameter literal used in selection range requests.
- Value parameters:
- partialResultToken
An optional token that a server can use to report partial results (e.g. streaming) to the client.
- positions
The positions inside the text document.
- textDocument
The text document.
- workDoneToken
An optional token that a server can use to report work done progress.
- Companion:
- object
- Source:
- structures.scala
- Value parameters:
- documentSelector
A document selector to identify the scope of the registration. If set to null the document selector provided on the client side will be used.
- id
The id used to register the request. The id can be used to deregister the request again. See also Registration#id.
- Companion:
- object
- Source:
- structures.scala
- Value parameters:
- data
The actual tokens.
- resultId
An optional result id. If provided and clients support delta updating the client will include the result id in the next semantic token request. A server can then instead of computing all semantic tokens again simply send a delta.
- Since:
3.16.0
- Companion:
- object
- Source:
- structures.scala
- Value parameters:
- augmentsSyntaxTokens
Whether the client uses semantic tokens to augment existing syntax tokens. If set to
true
client side created syntax tokens and semantic tokens are both used for colorization. If set tofalse
the client only uses the returned semantic tokens for colorization. If the value isundefined
then the client behavior is not specified.- dynamicRegistration
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.- formats
The token formats the clients supports.
- multilineTokenSupport
Whether the client supports tokens that can span multiple lines.
- overlappingTokenSupport
Whether the client supports tokens that can overlap each other.
- requests
Which requests the client supports and might send to the server depending on the server's capability. Please note that clients might not show semantic tokens or degrade some of the user experience if a range or full request is advertised by the client but not provided by the server. If for example the client capability
requests.full
andrequest.range
are both set to true but the server only provides a range provider the client might not render a minimap correctly or might even decide to not show any semantic tokens at all.- serverCancelSupport
Whether the client allows the server to actively cancel a semantic token request, e.g. supports returning LSPErrorCodes.ServerCancelled. If a server does the client needs to retrigger the request.
- tokenModifiers
The token modifiers that the client supports.
- tokenTypes
The token types that the client supports.
- Since:
3.16.0
- Companion:
- object
- Source:
- structures.scala
- Value parameters:
- edits
The semantic token edits to transform a previous result into a new result.
- Since:
3.16.0
- Companion:
- object
- Source:
- structures.scala
- Value parameters:
- partialResultToken
An optional token that a server can use to report partial results (e.g. streaming) to the client.
- previousResultId
The result id of a previous response. The result Id can either point to a full response or a delta response depending on what was received last.
- textDocument
The text document.
- workDoneToken
An optional token that a server can use to report work done progress.
- Since:
3.16.0
- Companion:
- object
- Source:
- structures.scala
- Value parameters:
- data
The elements to insert.
- deleteCount
The count of elements to remove.
- start
The start offset of the edit.
- Since:
3.16.0
- Companion:
- object
- Source:
- structures.scala
- Value parameters:
- tokenModifiers
The token modifiers a server uses.
- tokenTypes
The token types a server uses.
- Since:
3.16.0
- Companion:
- object
- Source:
- structures.scala
- Value parameters:
- full
Server supports providing semantic tokens for a full document.
- legend
The legend used by the server
- range
Server supports providing semantic tokens for a specific range of a document.
- Since:
3.16.0
- Companion:
- object
- Source:
- structures.scala
- Value parameters:
- partialResultToken
An optional token that a server can use to report partial results (e.g. streaming) to the client.
- textDocument
The text document.
- workDoneToken
An optional token that a server can use to report work done progress.
- Since:
3.16.0
- Companion:
- object
- Source:
- structures.scala
- Value parameters:
- partialResultToken
An optional token that a server can use to report partial results (e.g. streaming) to the client.
- range
The range the semantic tokens are requested for.
- textDocument
The text document.
- workDoneToken
An optional token that a server can use to report work done progress.
- Since:
3.16.0
- Companion:
- object
- Source:
- structures.scala
- Value parameters:
- documentSelector
A document selector to identify the scope of the registration. If set to null the document selector provided on the client side will be used.
- full
Server supports providing semantic tokens for a full document.
- id
The id used to register the request. The id can be used to deregister the request again. See also Registration#id.
- legend
The legend used by the server
- range
Server supports providing semantic tokens for a specific range of a document.
- Since:
3.16.0
- Companion:
- object
- Source:
- structures.scala
- Value parameters:
- refreshSupport
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 semantic tokens 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.
- Since:
3.16.0
- Companion:
- object
- Source:
- structures.scala
Defines the capabilities provided by a language server.
Defines the capabilities provided by a language server.
- Value parameters:
- callHierarchyProvider
The server provides call hierarchy support.
- codeActionProvider
The server provides code actions. CodeActionOptions may only be specified if the client states that it supports
codeActionLiteralSupport
in its initialinitialize
request.- codeLensProvider
The server provides code lens.
- colorProvider
The server provides color provider support.
- completionProvider
The server provides completion support.
- declarationProvider
The server provides Goto Declaration support.
- definitionProvider
The server provides goto definition support.
- diagnosticProvider
The server has support for pull model diagnostics.
- documentFormattingProvider
The server provides document formatting.
- documentHighlightProvider
The server provides document highlight support.
- documentLinkProvider
The server provides document link support.
- documentOnTypeFormattingProvider
The server provides document formatting on typing.
- documentRangeFormattingProvider
The server provides document range formatting.
- documentSymbolProvider
The server provides document symbol support.
- executeCommandProvider
The server provides execute command support.
- experimental
Experimental server capabilities.
- foldingRangeProvider
The server provides folding provider support.
- hoverProvider
The server provides hover support.
- implementationProvider
The server provides Goto Implementation support.
- inlayHintProvider
The server provides inlay hints.
- inlineValueProvider
The server provides inline values.
- linkedEditingRangeProvider
The server provides linked editing range support.
- monikerProvider
The server provides moniker support.
- notebookDocumentSync
Defines how notebook documents are synced.
- positionEncoding
The position encoding the server picked from the encodings offered by the client via the client capability
general.positionEncodings
. If the client didn't provide any position encodings the only valid value that a server can return is 'utf-16'. If omitted it defaults to 'utf-16'.- referencesProvider
The server provides find references support.
- renameProvider
The server provides rename support. RenameOptions may only be specified if the client states that it supports
prepareSupport
in its initialinitialize
request.- selectionRangeProvider
The server provides selection range support.
- semanticTokensProvider
The server provides semantic tokens support.
- signatureHelpProvider
The server provides signature help support.
- textDocumentSync
Defines how text documents are synced. Is either a detailed structure defining each notification or for backwards compatibility the TextDocumentSyncKind number.
- typeDefinitionProvider
The server provides Goto Type Definition support.
- typeHierarchyProvider
The server provides type hierarchy support.
- workspace
Workspace specific server capabilities.
- workspaceSymbolProvider
The server provides workspace symbol support.
- Since:
3.17.0
- Companion:
- object
- Source:
- structures.scala
Client capabilities for the showDocument request.
Client capabilities for the showDocument request.
- Value parameters:
- support
The client has support for the showDocument request.
- Since:
3.16.0
- Companion:
- object
- Source:
- structures.scala
Params to show a document.
Params to show a document.
- Value parameters:
- external
Indicates to show the resource in an external program. To show for example
https://code.visualstudio.com/
in the default WEB browser setexternal
totrue
.- selection
An optional selection range if the document is a text document. Clients might ignore the property if an external program is started or the file is not a text file.
- takeFocus
An optional property to indicate whether the editor showing the document should take focus or not. Clients might ignore this property if an external program is started.
- uri
The document uri to show.
- Since:
3.16.0
- Companion:
- object
- Source:
- structures.scala
The result of a showDocument request.
The result of a showDocument request.
- Value parameters:
- success
A boolean indicating if the show was successful.
- Since:
3.16.0
- Companion:
- object
- Source:
- structures.scala
The parameters of a notification message.
The parameters of a notification message.
- Value parameters:
- message
The actual message.
- type
The message type. See
[[MessageType]]
- Companion:
- object
- Source:
- structures.scala
Show message request client capabilities
Show message request client capabilities
- Value parameters:
- messageActionItem
Capabilities specific to the
MessageActionItem
type.
- Companion:
- object
- Source:
- structures.scala
- Value parameters:
- actions
The message action items to present.
- message
The actual message.
- type
The message type. See
[[MessageType]]
- Companion:
- object
- Source:
- structures.scala
Signature help represents the signature of something callable. There can be multiple signature but only one active and only one active parameter.
Signature help represents the signature of something callable. There can be multiple signature but only one active and only one active parameter.
- Value parameters:
- activeParameter
The active parameter of the active signature. If omitted or the value lies outside the range of
signatures[activeSignature].parameters
defaults to 0 if the active signature has parameters. If the active signature has no parameters it is ignored. In future version of the protocol this property might become mandatory to better express the active parameter if the active signature does have any.- activeSignature
The active signature. If omitted or the value lies outside the range of
signatures
the value defaults to zero or is ignored if theSignatureHelp
has no signatures. Whenever possible implementors should make an active decision about the active signature and shouldn't rely on a default value. In future version of the protocol this property might become mandatory to better express this.- signatures
One or more signatures.
- Companion:
- object
- Source:
- structures.scala
Client Capabilities for a SignatureHelpRequest.
Client Capabilities for a SignatureHelpRequest.
- Value parameters:
- contextSupport
The client supports to send additional context information for a
textDocument/signatureHelp
request. A client that opts into contextSupport will also support theretriggerCharacters
onSignatureHelpOptions
.- dynamicRegistration
Whether signature help supports dynamic registration.
- signatureInformation
The client supports the following
SignatureInformation
specific properties.
- Since:
3.15.0
- Companion:
- object
- Source:
- structures.scala
Additional information about the context in which a signature help request was triggered.
Additional information about the context in which a signature help request was triggered.
- Value parameters:
- activeSignatureHelp
The currently active
SignatureHelp
. TheactiveSignatureHelp
has itsSignatureHelp.activeSignature
field updated based on the user navigating through available signatures.- isRetrigger
true
if signature help was already showing when it was triggered. Retriggers occurs when the signature help is already active and can be caused by actions such as typing a trigger character, a cursor move, or document content changes.- triggerCharacter
Character that caused signature help to be triggered. This is undefined when
triggerKind !== SignatureHelpTriggerKind.TriggerCharacter
- triggerKind
Action that caused signature help to be triggered.
- Since:
3.15.0
- Companion:
- object
- Source:
- structures.scala
Server Capabilities for a SignatureHelpRequest.
Server Capabilities for a SignatureHelpRequest.
- Value parameters:
- retriggerCharacters
List of characters that re-trigger signature help. These trigger characters are only active when signature help is already showing. All trigger characters are also counted as re-trigger characters.
- triggerCharacters
List of characters that trigger signature help automatically.
- Since:
3.15.0
- Companion:
- object
- Source:
- structures.scala
Parameters for a SignatureHelpRequest.
Parameters for a SignatureHelpRequest.
- Value parameters:
- context
The signature help context. This is only available if the client specifies to send this using the client capability
textDocument.signatureHelp.contextSupport === true
- position
The position inside the text document.
- textDocument
The text document.
- workDoneToken
An optional token that a server can use to report work done progress.
- Since:
3.15.0
- Companion:
- object
- Source:
- structures.scala
Registration options for a SignatureHelpRequest.
Registration options for a SignatureHelpRequest.
- Value parameters:
- documentSelector
A document selector to identify the scope of the registration. If set to null the document selector provided on the client side will be used.
- retriggerCharacters
List of characters that re-trigger signature help. These trigger characters are only active when signature help is already showing. All trigger characters are also counted as re-trigger characters.
- triggerCharacters
List of characters that trigger signature help automatically.
- Since:
3.15.0
- Companion:
- object
- Source:
- structures.scala
Represents the signature of something callable. A signature can have a label, like a function-name, a doc-comment, and a set of parameters.
Represents the signature of something callable. A signature can have a label, like a function-name, a doc-comment, and a set of parameters.
- Value parameters:
- activeParameter
The index of the active parameter. If provided, this is used in place of
SignatureHelp.activeParameter
.- documentation
The human-readable doc-comment of this signature. Will be shown in the UI but can be omitted.
- label
The label of this signature. Will be shown in the UI.
- parameters
The parameters of this signature.
- Since:
3.16.0
- Companion:
- object
- Source:
- structures.scala
Static registration options to be returned in the initialize request.
Static registration options to be returned in the initialize request.
- Value parameters:
- id
The id used to register the request. The id can be used to deregister the request again. See also Registration#id.
- Companion:
- object
- Source:
- structures.scala
Represents information about programming constructs like variables, classes, interfaces etc.
Represents information about programming constructs like variables, classes, interfaces etc.
- Value parameters:
- containerName
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.
- deprecated
Indicates if this symbol is deprecated.
- kind
The kind of this symbol.
- location
The location of this symbol. The location's range is used by a tool to reveal the location in the editor. If the symbol is selected in the tool the range's start information is used to position the cursor. So the range usually spans more than the actual symbol's name and does normally include things like visibility modifiers. The range doesn't have to denote a node range in the sense of an abstract syntax tree. It can therefore not be used to re-construct a hierarchy of the symbols.
- name
The name of this symbol.
- tags
Tags for this symbol.
- Since:
3.16.0
- Companion:
- object
- Source:
- structures.scala
Describe options to be used when registered for text document change events.
Describe options to be used when registered for text document change events.
- Value parameters:
- documentSelector
A document selector to identify the scope of the registration. If set to null the document selector provided on the client side will be used.
- syncKind
How documents are synced to the server.
- Companion:
- object
- Source:
- structures.scala
Text document specific client capabilities.
Text document specific client capabilities.
- Value parameters:
- callHierarchy
Capabilities specific to the various call hierarchy requests.
- codeAction
Capabilities specific to the
textDocument/codeAction
request.- codeLens
Capabilities specific to the
textDocument/codeLens
request.- colorProvider
Capabilities specific to the
textDocument/documentColor
and thetextDocument/colorPresentation
request.- completion
Capabilities specific to the
textDocument/completion
request.- declaration
Capabilities specific to the
textDocument/declaration
request.- definition
Capabilities specific to the
textDocument/definition
request.- diagnostic
Capabilities specific to the diagnostic pull model.
- documentHighlight
Capabilities specific to the
textDocument/documentHighlight
request.- documentLink
Capabilities specific to the
textDocument/documentLink
request.- documentSymbol
Capabilities specific to the
textDocument/documentSymbol
request.- foldingRange
Capabilities specific to the
textDocument/foldingRange
request.- formatting
Capabilities specific to the
textDocument/formatting
request.- hover
Capabilities specific to the
textDocument/hover
request.- implementation
Capabilities specific to the
textDocument/implementation
request.- inlayHint
Capabilities specific to the
textDocument/inlayHint
request.- inlineValue
Capabilities specific to the
textDocument/inlineValue
request.- linkedEditingRange
Capabilities specific to the
textDocument/linkedEditingRange
request.- moniker
Client capabilities specific to the
textDocument/moniker
request.- onTypeFormatting
Capabilities specific to the
textDocument/onTypeFormatting
request.- publishDiagnostics
Capabilities specific to the
textDocument/publishDiagnostics
notification.- rangeFormatting
Capabilities specific to the
textDocument/rangeFormatting
request.- references
Capabilities specific to the
textDocument/references
request.- rename
Capabilities specific to the
textDocument/rename
request.- selectionRange
Capabilities specific to the
textDocument/selectionRange
request.- semanticTokens
Capabilities specific to the various semantic token request.
- signatureHelp
Capabilities specific to the
textDocument/signatureHelp
request.- synchronization
Defines which synchronization capabilities the client supports.
- typeDefinition
Capabilities specific to the
textDocument/typeDefinition
request.- typeHierarchy
Capabilities specific to the various type hierarchy requests.
- Since:
3.14.0
- Companion:
- object
- Source:
- structures.scala
Describes textual changes on a text document. A TextDocumentEdit describes all changes on a document version Si and after they are applied move the document to version Si+1. So the creator of a TextDocumentEdit doesn't need to sort the array of edits or do any kind of ordering. However the edits must be non overlapping.
Describes textual changes on a text document. A TextDocumentEdit describes all changes on a document version Si and after they are applied move the document to version Si+1. So the creator of a TextDocumentEdit doesn't need to sort the array of edits or do any kind of ordering. However the edits must be non overlapping.
- Value parameters:
- edits
The edits to be applied.
- textDocument
The text document to change.
- Since:
3.16.0 - support for AnnotatedTextEdit. This is guarded using a client capability.
- Companion:
- object
- Source:
- structures.scala
A literal to identify a text document in the client.
A literal to identify a text document in the client.
- Value parameters:
- uri
The text document's uri.
- Companion:
- object
- Source:
- structures.scala
An item to transfer a text document from the client to the server.
An item to transfer a text document from the client to the server.
- Value parameters:
- languageId
The text document's language identifier.
- text
The content of the opened text document.
- uri
The text document's uri.
- version
The version number of this document (it will increase after each change, including undo/redo).
- Companion:
- object
- Source:
- structures.scala
A parameter literal used in requests to pass a text document and a position inside that document.
A parameter literal used in requests to pass a text document and a position inside that document.
- Value parameters:
- position
The position inside the text document.
- textDocument
The text document.
- Companion:
- object
- Source:
- structures.scala
General text document registration options.
General text document registration options.
- Value parameters:
- documentSelector
A document selector to identify the scope of the registration. If set to null the document selector provided on the client side will be used.
- Companion:
- object
- Source:
- structures.scala
Save registration options.
Save registration options.
- Value parameters:
- documentSelector
A document selector to identify the scope of the registration. If set to null the document selector provided on the client side will be used.
- includeText
The client is supposed to include the content on save.
- Companion:
- object
- Source:
- structures.scala
- Value parameters:
- didSave
The client supports did save notifications.
- dynamicRegistration
Whether text document synchronization supports dynamic registration.
- willSave
The client supports sending will save notifications.
- willSaveWaitUntil
The client supports sending a will save request and waits for a response providing text edits which will be applied to the document before it is saved.
- Companion:
- object
- Source:
- structures.scala
- Value parameters:
- change
Change notifications are sent to the server. See TextDocumentSyncKind.None, TextDocumentSyncKind.Full and TextDocumentSyncKind.Incremental. If omitted it defaults to TextDocumentSyncKind.None.
- openClose
Open and close notifications are sent to the server. If omitted open close notifications should not be sent.
- save
If present save notifications are sent to the server. If omitted the notification should not be sent.
- willSave
If present will save notifications are sent to the server. If omitted the notification should not be sent.
- willSaveWaitUntil
If present will save wait until requests are sent to the server. If omitted the request should not be sent.
- Companion:
- object
- Source:
- structures.scala
A text edit applicable to a text document.
A text edit applicable to a text document.
- Value parameters:
- newText
The string to be inserted. For delete operations use an empty string.
- range
The range of the text document to be manipulated. To insert text into a document create a range where start === end.
- Companion:
- object
- Source:
- structures.scala
Since 3.6.0
Since 3.6.0
- Value parameters:
- dynamicRegistration
Whether implementation supports dynamic registration. If this is set to
true
the client supports the newTypeDefinitionRegistrationOptions
return value for the corresponding server capability as well.- linkSupport
The client supports additional metadata in the form of definition links. Since 3.14.0
- Companion:
- object
- Source:
- structures.scala
- Value parameters:
- partialResultToken
An optional token that a server can use to report partial results (e.g. streaming) to the client.
- position
The position inside the text document.
- textDocument
The text document.
- workDoneToken
An optional token that a server can use to report work done progress.
- Companion:
- object
- Source:
- structures.scala
- Value parameters:
- documentSelector
A document selector to identify the scope of the registration. If set to null the document selector provided on the client side will be used.
- id
The id used to register the request. The id can be used to deregister the request again. See also Registration#id.
- Companion:
- object
- Source:
- structures.scala
- Value parameters:
- dynamicRegistration
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.
- Since:
3.17.0
- Companion:
- object
- Source:
- structures.scala
- Value parameters:
- data
A data entry field that is preserved between a type hierarchy prepare and supertypes or subtypes requests. It could also be used to identify the type hierarchy in the server, helping improve the performance on resolving supertypes and subtypes.
- detail
More detail for this item, e.g. the signature of a function.
- kind
The kind of this item.
- name
The name of this item.
- range
The range enclosing this symbol not including leading/trailing whitespace but everything else, e.g. comments and code.
- selectionRange
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
.- tags
Tags for this item.
- uri
The resource identifier of this item.
- Since:
3.17.0
- Companion:
- object
- Source:
- structures.scala
Type hierarchy options used during static registration.
Type hierarchy options used during static registration.
- Since:
3.17.0
- Companion:
- object
- Source:
- structures.scala
The parameter of a textDocument/prepareTypeHierarchy
request.
The parameter of a textDocument/prepareTypeHierarchy
request.
- Value parameters:
- position
The position inside the text document.
- textDocument
The text document.
- workDoneToken
An optional token that a server can use to report work done progress.
- Since:
3.17.0
- Companion:
- object
- Source:
- structures.scala
Type hierarchy options used during static or dynamic registration.
Type hierarchy options used during static or dynamic registration.
- Value parameters:
- documentSelector
A document selector to identify the scope of the registration. If set to null the document selector provided on the client side will be used.
- id
The id used to register the request. The id can be used to deregister the request again. See also Registration#id.
- Since:
3.17.0
- Companion:
- object
- Source:
- structures.scala
The parameter of a typeHierarchy/subtypes
request.
The parameter of a typeHierarchy/subtypes
request.
- Value parameters:
- partialResultToken
An optional token that a server can use to report partial results (e.g. streaming) to the client.
- workDoneToken
An optional token that a server can use to report work done progress.
- Since:
3.17.0
- Companion:
- object
- Source:
- structures.scala
The parameter of a typeHierarchy/supertypes
request.
The parameter of a typeHierarchy/supertypes
request.
- Value parameters:
- partialResultToken
An optional token that a server can use to report partial results (e.g. streaming) to the client.
- workDoneToken
An optional token that a server can use to report work done progress.
- Since:
3.17.0
- Companion:
- object
- Source:
- structures.scala
A diagnostic report indicating that the last returned report is still accurate.
A diagnostic report indicating that the last returned report is still accurate.
- Value parameters:
- kind
A document diagnostic report indicating no changes to the last result. A server can only return
unchanged
if result ids are provided.- resultId
A result id which will be sent on the next diagnostic request for the same document.
- Since:
3.17.0
- Companion:
- object
- Source:
- structures.scala
General parameters to unregister a request or notification.
General parameters to unregister a request or notification.
- Value parameters:
- id
The id used to unregister the request or notification. Usually an id provided during the register request.
- method
The method to unregister for.
- Companion:
- object
- Source:
- structures.scala
A versioned notebook document identifier.
A versioned notebook document identifier.
- Value parameters:
- uri
The notebook document's uri.
- version
The version number of this notebook document.
- Since:
3.17.0
- Companion:
- object
- Source:
- structures.scala
A text document identifier to denote a specific version of a text document.
A text document identifier to denote a specific version of a text document.
- Value parameters:
- uri
The text document's uri.
- version
The version number of this document.
- Companion:
- object
- Source:
- structures.scala
The parameters sent in a will save text document notification.
The parameters sent in a will save text document notification.
- Value parameters:
- reason
The 'TextDocumentSaveReason'.
- textDocument
The document that will be saved.
- Companion:
- object
- Source:
- structures.scala
- Value parameters:
- showDocument
Capabilities specific to the showDocument request.
- showMessage
Capabilities specific to the showMessage request.
- workDoneProgress
It indicates whether the client supports server initiated progress using the
window/workDoneProgress/create
request. The capability also controls Whether client supports handling of progress notifications. If set servers are allowed to report aworkDoneProgress
property in the request specific server capabilities.
- Since:
3.15.0
- Companion:
- object
- Source:
- structures.scala
- Value parameters:
- cancellable
Controls if a cancel button should show to allow the user to cancel the long running operation. Clients that don't support cancellation are allowed to ignore the setting.
- message
Optional, more detailed associated progress message. Contains complementary information to the
title
. Examples: "3/25 files", "project/src/module2", "node_modules/some_dep". If unset, the previous progress message (if any) is still valid.- percentage
Optional progress percentage to display (value 100 is considered 100%). If not provided infinite progress is assumed and clients are allowed to ignore the
percentage
value in subsequent in report notifications. The value should be steadily rising. Clients are free to ignore values that are not following this rule. The value range is [0, 100].- title
Mandatory title of the progress operation. Used to briefly inform about the kind of operation being performed. Examples: "Indexing" or "Linking dependencies".
- Companion:
- object
- Source:
- structures.scala
- Value parameters:
- token
The token to be used to report progress.
- Companion:
- object
- Source:
- structures.scala
- Value parameters:
- token
The token to be used to report progress.
- Companion:
- object
- Source:
- structures.scala
- Value parameters:
- message
Optional, a final message indicating to for example indicate the outcome of the operation.
- Companion:
- object
- Source:
- structures.scala
- Value parameters:
- workDoneToken
An optional token that a server can use to report work done progress.
- Companion:
- object
- Source:
- structures.scala
- Value parameters:
- cancellable
Controls enablement state of a cancel button. Clients that don't support cancellation or don't support controlling the button's enablement state are allowed to ignore the property.
- message
Optional, more detailed associated progress message. Contains complementary information to the
title
. Examples: "3/25 files", "project/src/module2", "node_modules/some_dep". If unset, the previous progress message (if any) is still valid.- percentage
Optional progress percentage to display (value 100 is considered 100%). If not provided infinite progress is assumed and clients are allowed to ignore the
percentage
value in subsequent in report notifications. The value should be steadily rising. Clients are free to ignore values that are not following this rule. The value range is [0, 100]
- Companion:
- object
- Source:
- structures.scala
Workspace specific client capabilities.
Workspace specific client capabilities.
- Value parameters:
- applyEdit
The client supports applying batch edits to the workspace by supporting the request 'workspace/applyEdit'
- codeLens
Capabilities specific to the code lens requests scoped to the workspace.
- configuration
The client supports
workspace/configuration
requests.- diagnostics
Capabilities specific to the diagnostic requests scoped to the workspace.
- didChangeConfiguration
Capabilities specific to the
workspace/didChangeConfiguration
notification.- didChangeWatchedFiles
Capabilities specific to the
workspace/didChangeWatchedFiles
notification.- executeCommand
Capabilities specific to the
workspace/executeCommand
request.- fileOperations
The client has support for file notifications/requests for user operations on files. Since 3.16.0
- inlayHint
Capabilities specific to the inlay hint requests scoped to the workspace.
- inlineValue
Capabilities specific to the inline values requests scoped to the workspace.
- semanticTokens
Capabilities specific to the semantic token requests scoped to the workspace.
- symbol
Capabilities specific to the
workspace/symbol
request.- workspaceEdit
Capabilities specific to
WorkspaceEdit
s.- workspaceFolders
The client has support for workspace folders.
- Since:
3.6.0
- Companion:
- object
- Source:
- structures.scala
Parameters of the workspace diagnostic request.
Parameters of the workspace diagnostic request.
- Value parameters:
- identifier
The additional identifier provided during registration.
- partialResultToken
An optional token that a server can use to report partial results (e.g. streaming) to the client.
- previousResultIds
The currently known diagnostic reports with their previous result ids.
- workDoneToken
An optional token that a server can use to report work done progress.
- Since:
3.17.0
- Companion:
- object
- Source:
- structures.scala
A workspace diagnostic report.
A workspace diagnostic report.
- Since:
3.17.0
- Companion:
- object
- Source:
- structures.scala
A partial result for a workspace diagnostic report.
A partial result for a workspace diagnostic report.
- Since:
3.17.0
- Companion:
- object
- Source:
- structures.scala
A workspace edit represents changes to many resources managed in the workspace. The edit
should either provide changes
or documentChanges
. If documentChanges are present
they are preferred over changes
if the client can handle versioned document edits.
A workspace edit represents changes to many resources managed in the workspace. The edit
should either provide changes
or documentChanges
. If documentChanges are present
they are preferred over changes
if the client can handle versioned document edits.
Since version 3.13.0 a workspace edit can contain resource operations as well. If resource operations are present clients need to execute the operations in the order in which they are provided. So a workspace edit for example can consist of the following two changes: (1) a create file a.txt and (2) a text document edit which insert text into file a.txt.
An invalid sequence (e.g. (1) delete file a.txt and (2) insert text into file a.txt) will
cause failure of the operation. How the client recovers from the failure is described by
the client capability: workspace.workspaceEdit.failureHandling
- Value parameters:
- changeAnnotations
A map of change annotations that can be referenced in
AnnotatedTextEdit
s or create, rename and delete file / folder operations. Whether clients honor this property depends on the client capabilityworkspace.changeAnnotationSupport
.- changes
Holds changes to existing resources.
- documentChanges
Depending on the client capability
workspace.workspaceEdit.resourceOperations
document changes are either an array ofTextDocumentEdit
s to express changes to n different text documents where each text document edit addresses a specific version of a text document. Or it can contain aboveTextDocumentEdit
s mixed with create, rename and delete file / folder operations. Whether a client supports versioned document edits is expressed viaworkspace.workspaceEdit.documentChanges
client capability. If a client neither supportsdocumentChanges
norworkspace.workspaceEdit.resourceOperations
then only plainTextEdit
s using thechanges
property are supported.
- Since:
3.16.0
- Companion:
- object
- Source:
- structures.scala
- Value parameters:
- changeAnnotationSupport
Whether the client in general supports change annotations on text edits, create file, rename file and delete file changes.
- documentChanges
The client supports versioned document changes in
WorkspaceEdit
s- failureHandling
The failure handling strategy of a client if applying the workspace edit fails.
- normalizesLineEndings
Whether the client normalizes line endings to the client specific setting. If set to
true
the client will normalize line ending characters in a workspace edit to the client-specified new line character.- resourceOperations
The resource operations the client supports. Clients should at least support 'create', 'rename' and 'delete' files and folders.
- Since:
3.13.0
- Companion:
- object
- Source:
- structures.scala
A workspace folder inside a client.
A workspace folder inside a client.
- Value parameters:
- name
The name of the workspace folder. Used to refer to this workspace folder in the user interface.
- uri
The associated URI for this workspace folder.
- Companion:
- object
- Source:
- structures.scala
The workspace folder change event.
The workspace folder change event.
- Value parameters:
- added
The array of added workspace folders
- removed
The array of the removed workspace folders
- Companion:
- object
- Source:
- structures.scala
- Value parameters:
- workspaceFolders
The workspace folders configured in the client when the server starts. This property is only available if the client supports workspace folders. It can be
null
if the client supports workspace folders but none are configured.
- Since:
3.6.0
- Companion:
- object
- Source:
- structures.scala
- Value parameters:
- changeNotifications
Whether the server wants to receive workspace folder change notifications. If a string is provided the string is treated as an ID under which the notification is registered on the client side. The ID can be used to unregister for these events using the
client/unregisterCapability
request.- supported
The server has support for workspace folders
- Companion:
- object
- Source:
- structures.scala
A full document diagnostic report for a workspace diagnostic result.
A full document diagnostic report for a workspace diagnostic result.
- Value parameters:
- items
The actual items.
- kind
A full document diagnostic report.
- resultId
An optional result id. If provided it will be sent on the next diagnostic request for the same document.
- uri
The URI for which diagnostic information is reported.
- version
The version number for which the diagnostics are reported. If the document is not marked as open
null
can be provided.
- Since:
3.17.0
- Companion:
- object
- Source:
- structures.scala
A special workspace symbol that supports locations without a range.
A special workspace symbol that supports locations without a range.
See also SymbolInformation.
- Value parameters:
- containerName
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.
- data
A data entry field that is preserved on a workspace symbol between a workspace symbol request and a workspace symbol resolve request.
- kind
The kind of this symbol.
- location
The location of the symbol. Whether a server is allowed to return a location without a range depends on the client capability
workspace.symbol.resolveSupport
. See SymbolInformation#location for more details.- name
The name of this symbol.
- tags
Tags for this symbol.
- Since:
3.17.0
- Companion:
- object
- Source:
- structures.scala
Client capabilities for a WorkspaceSymbolRequest.
Client capabilities for a WorkspaceSymbolRequest.
- Value parameters:
- dynamicRegistration
Symbol request supports dynamic registration.
- resolveSupport
The client support partial workspace symbols. The client will send the request
workspaceSymbol/resolve
to the server to resolve additional properties.- symbolKind
Specific capabilities for the
SymbolKind
in theworkspace/symbol
request.- tagSupport
The client supports tags on
SymbolInformation
. Clients supporting tags have to handle unknown tags gracefully.
- Since:
3.16.0
- Companion:
- object
- Source:
- structures.scala
Server capabilities for a WorkspaceSymbolRequest.
Server capabilities for a WorkspaceSymbolRequest.
- Value parameters:
- resolveProvider
The server provides support to resolve additional information for a workspace symbol.
- Since:
3.17.0
- Companion:
- object
- Source:
- structures.scala
The parameters of a WorkspaceSymbolRequest.
The parameters of a WorkspaceSymbolRequest.
- Value parameters:
- partialResultToken
An optional token that a server can use to report partial results (e.g. streaming) to the client.
- query
A query string to filter symbols by. Clients may send an empty string here to request all symbols.
- workDoneToken
An optional token that a server can use to report work done progress.
- Companion:
- object
- Source:
- structures.scala
Registration options for a WorkspaceSymbolRequest.
Registration options for a WorkspaceSymbolRequest.
- Value parameters:
- resolveProvider
The server provides support to resolve additional information for a workspace symbol.
- Since:
3.17.0
- Companion:
- object
- Source:
- structures.scala
An unchanged document diagnostic report for a workspace diagnostic result.
An unchanged document diagnostic report for a workspace diagnostic result.
- Value parameters:
- kind
A document diagnostic report indicating no changes to the last result. A server can only return
unchanged
if result ids are provided.- resultId
A result id which will be sent on the next diagnostic request for the same document.
- uri
The URI for which diagnostic information is reported.
- version
The version number for which the diagnostics are reported. If the document is not marked as open
null
can be provided.
- Since:
3.17.0
- Companion:
- object
- Source:
- structures.scala
The initialize parameters
The initialize parameters
- Value parameters:
- capabilities
The capabilities provided by the client (editor or tool)
- clientInfo
Information about the client
- initializationOptions
User provided initialization options.
- locale
The locale the client is currently showing the user interface in. This must not necessarily be the locale of the operating system. Uses IETF language tags as the value's syntax (See https://en.wikipedia.org/wiki/IETF_language_tag)
- processId
The process Id of the parent process that started the server. Is
null
if the process has not been started by another process. If the parent process is not alive then the server should exit.- rootPath
The rootPath of the workspace. Is null if no folder is open.
- rootUri
The rootUri of the workspace. Is null if no folder is open. If both
rootPath
androotUri
are setrootUri
wins.- trace
The initial trace setting. If omitted trace is disabled ('off').
- workDoneToken
An optional token that a server can use to report work done progress.
- Since:
3.15.0
- Companion:
- object
- Source:
- structures.scala