class LSProtocol::ServerCapabilities

Overview

Defines the capabilities provided by a language server.

Included Modules

Defined in:

lsprotocol/types.cr

Constructors

Instance Method Summary

Constructor Detail

def self.new(pull : JSON::PullParser) #

[View source]
def self.new(call_hierarchy_provider : Bool | CallHierarchyOptions | CallHierarchyRegistrationOptions | Nil = nil, code_action_provider : Bool | CodeActionOptions | Nil = nil, code_lens_provider : CodeLensOptions | Nil = nil, color_provider : Bool | DocumentColorOptions | DocumentColorRegistrationOptions | Nil = nil, completion_provider : CompletionOptions | Nil = nil, declaration_provider : Bool | DeclarationOptions | DeclarationRegistrationOptions | Nil = nil, definition_provider : Bool | DefinitionOptions | Nil = nil, diagnostic_provider : DiagnosticOptions | DiagnosticRegistrationOptions | Nil = nil, document_formatting_provider : Bool | DocumentFormattingOptions | Nil = nil, document_highlight_provider : Bool | DocumentHighlightOptions | Nil = nil, document_link_provider : DocumentLinkOptions | Nil = nil, document_on_type_formatting_provider : DocumentOnTypeFormattingOptions | Nil = nil, document_range_formatting_provider : Bool | DocumentRangeFormattingOptions | Nil = nil, document_symbol_provider : Bool | DocumentSymbolOptions | Nil = nil, execute_command_provider : ExecuteCommandOptions | Nil = nil, experimental : LSPAny | Nil = nil, folding_range_provider : Bool | FoldingRangeOptions | FoldingRangeRegistrationOptions | Nil = nil, hover_provider : Bool | HoverOptions | Nil = nil, implementation_provider : Bool | ImplementationOptions | ImplementationRegistrationOptions | Nil = nil, inlay_hint_provider : Bool | InlayHintOptions | InlayHintRegistrationOptions | Nil = nil, inline_completion_provider : Bool | InlineCompletionOptions | Nil = nil, inline_value_provider : Bool | InlineValueOptions | InlineValueRegistrationOptions | Nil = nil, linked_editing_range_provider : Bool | LinkedEditingRangeOptions | LinkedEditingRangeRegistrationOptions | Nil = nil, moniker_provider : Bool | MonikerOptions | MonikerRegistrationOptions | Nil = nil, notebook_document_sync : NotebookDocumentSyncOptions | NotebookDocumentSyncRegistrationOptions | Nil = nil, position_encoding : PositionEncodingKind | String | Nil = nil, references_provider : Bool | ReferenceOptions | Nil = nil, rename_provider : Bool | RenameOptions | Nil = nil, selection_range_provider : Bool | SelectionRangeOptions | SelectionRangeRegistrationOptions | Nil = nil, semantic_tokens_provider : SemanticTokensOptions | SemanticTokensRegistrationOptions | Nil = nil, signature_help_provider : SignatureHelpOptions | Nil = nil, text_document_sync : TextDocumentSyncKind | TextDocumentSyncOptions | Nil = nil, type_definition_provider : Bool | TypeDefinitionOptions | TypeDefinitionRegistrationOptions | Nil = nil, type_hierarchy_provider : Bool | TypeHierarchyOptions | TypeHierarchyRegistrationOptions | Nil = nil, workspace : WorkspaceOptions | Nil = nil, workspace_symbol_provider : Bool | WorkspaceSymbolOptions | Nil = nil) #

[View source]

Instance Method Detail

def call_hierarchy_provider : Bool | CallHierarchyOptions | CallHierarchyRegistrationOptions | Nil #

The server provides call hierarchy support.

@since 3.16.0


[View source]
def code_action_provider : Bool | CodeActionOptions | Nil #

The server provides code actions. CodeActionOptions may only be specified if the client states that it supports codeActionLiteralSupport in its initial initialize request.


[View source]
def code_lens_provider : CodeLensOptions | Nil #

The server provides code lens.


[View source]
def color_provider : Bool | DocumentColorOptions | DocumentColorRegistrationOptions | Nil #

The server provides color provider support.


[View source]
def completion_provider : CompletionOptions | Nil #

The server provides completion support.


[View source]
def declaration_provider : Bool | DeclarationOptions | DeclarationRegistrationOptions | Nil #

The server provides Goto Declaration support.


[View source]
def definition_provider : Bool | DefinitionOptions | Nil #

The server provides goto definition support.


[View source]
def diagnostic_provider : DiagnosticOptions | DiagnosticRegistrationOptions | Nil #

The server has support for pull model diagnostics.

@since 3.17.0


[View source]
def document_formatting_provider : Bool | DocumentFormattingOptions | Nil #

The server provides document formatting.


[View source]
def document_highlight_provider : Bool | DocumentHighlightOptions | Nil #

The server provides document highlight support.


[View source]
def document_link_provider : DocumentLinkOptions | Nil #

The server provides document link support.


[View source]
def document_on_type_formatting_provider : DocumentOnTypeFormattingOptions | Nil #

The server provides document formatting on typing.


[View source]
def document_range_formatting_provider : Bool | DocumentRangeFormattingOptions | Nil #

The server provides document range formatting.


[View source]
def document_symbol_provider : Bool | DocumentSymbolOptions | Nil #

The server provides document symbol support.


[View source]
def execute_command_provider : ExecuteCommandOptions | Nil #

The server provides execute command support.


[View source]
def experimental : LSPAny | Nil #

Experimental server capabilities.


[View source]
def folding_range_provider : Bool | FoldingRangeOptions | FoldingRangeRegistrationOptions | Nil #

The server provides folding provider support.


[View source]
def hover_provider : Bool | HoverOptions | Nil #

The server provides hover support.


[View source]
def implementation_provider : Bool | ImplementationOptions | ImplementationRegistrationOptions | Nil #

The server provides Goto Implementation support.


[View source]
def inlay_hint_provider : Bool | InlayHintOptions | InlayHintRegistrationOptions | Nil #

The server provides inlay hints.

@since 3.17.0


[View source]
def inline_completion_provider : Bool | InlineCompletionOptions | Nil #

Inline completion options used during static registration.

@since 3.18.0 @proposed


[View source]
def inline_value_provider : Bool | InlineValueOptions | InlineValueRegistrationOptions | Nil #

The server provides inline values.

@since 3.17.0


[View source]
def linked_editing_range_provider : Bool | LinkedEditingRangeOptions | LinkedEditingRangeRegistrationOptions | Nil #

The server provides linked editing range support.

@since 3.16.0


[View source]
def moniker_provider : Bool | MonikerOptions | MonikerRegistrationOptions | Nil #

The server provides moniker support.

@since 3.16.0


[View source]

Defines how notebook documents are synced.

@since 3.17.0


[View source]
def position_encoding : PositionEncodingKind | String | Nil #

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'.

@since 3.17.0


[View source]
def references_provider : Bool | ReferenceOptions | Nil #

The server provides find references support.


[View source]
def rename_provider : Bool | RenameOptions | Nil #

The server provides rename support. RenameOptions may only be specified if the client states that it supports prepareSupport in its initial initialize request.


[View source]
def selection_range_provider : Bool | SelectionRangeOptions | SelectionRangeRegistrationOptions | Nil #

The server provides selection range support.


[View source]
def semantic_tokens_provider : SemanticTokensOptions | SemanticTokensRegistrationOptions | Nil #

The server provides semantic tokens support.

@since 3.16.0


[View source]
def signature_help_provider : SignatureHelpOptions | Nil #

The server provides signature help support.


[View source]
def text_document_sync : TextDocumentSyncKind | TextDocumentSyncOptions | Nil #

Defines how text documents are synced. Is either a detailed structure defining each notification or for backwards compatibility the TextDocumentSyncKind number.


[View source]
def type_definition_provider : Bool | TypeDefinitionOptions | TypeDefinitionRegistrationOptions | Nil #

The server provides Goto Type Definition support.


[View source]
def type_hierarchy_provider : Bool | TypeHierarchyOptions | TypeHierarchyRegistrationOptions | Nil #

The server provides type hierarchy support.

@since 3.17.0


[View source]
def workspace : WorkspaceOptions | Nil #

Workspace specific server capabilities.


[View source]
def workspace_symbol_provider : Bool | WorkspaceSymbolOptions | Nil #

The server provides workspace symbol support.


[View source]