class LSProtocol::SemanticTokensClientCapabilities
- LSProtocol::SemanticTokensClientCapabilities
- Reference
- Object
Overview
@since 3.16.0
Included Modules
- JSON::Serializable
Defined in:
lsprotocol/types.crConstructors
- .new(formats : Array(TokenFormat) | Nil, requests : ClientSemanticTokensRequestOptions | Nil, token_modifiers : Array(String) | Nil, token_types : Array(String) | Nil, augments_syntax_tokens : Bool | Nil = nil, dynamic_registration : Bool | Nil = nil, multiline_token_support : Bool | Nil = nil, overlapping_token_support : Bool | Nil = nil, server_cancel_support : Bool | Nil = nil)
- .new(pull : JSON::PullParser)
Instance Method Summary
-
#augments_syntax_tokens : Bool | Nil
Whether the client uses semantic tokens to augment existing syntax tokens.
-
#dynamic_registration : Bool | Nil
Whether implementation supports dynamic registration.
-
#formats : Array(TokenFormat)
The token formats the clients supports.
-
#multiline_token_support : Bool | Nil
Whether the client supports tokens that can span multiple lines.
-
#overlapping_token_support : Bool | Nil
Whether the client supports tokens that can overlap each other.
-
#requests : ClientSemanticTokensRequestOptions
Which requests the client supports and might send to the server depending on the server's capability.
-
#server_cancel_support : Bool | Nil
Whether the client allows the server to actively cancel a semantic token request, e.g.
-
#token_modifiers : Array(String)
The token modifiers that the client supports.
-
#token_types : Array(String)
The token types that the client supports.
Constructor Detail
Instance Method Detail
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 to false the client only uses the returned semantic tokens
for colorization.
If the value is undefined then the client behavior is not
specified.
@since 3.17.0
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.
Whether the client supports tokens that can span multiple lines.
Whether the client supports tokens that can overlap each other.
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 and
request.range are both set to true but the server only provides a
range provider the client might not render a minimap correctly or might
even decide to not show any semantic tokens at all.
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.
@since 3.17.0