Interface ServerCapabilities<T>

Defines the capabilities provided by a language server.

interface ServerCapabilities<T = LSPAny> {
    callHierarchyProvider?:
        | boolean
        | CallHierarchyOptions
        | CallHierarchyRegistrationOptions;
    codeActionProvider?: boolean
    | CodeActionOptions;
    codeLensProvider?: CodeLensOptions;
    colorProvider?:
        | boolean
        | DocumentColorOptions
        | DocumentColorRegistrationOptions;
    completionProvider?: CompletionOptions;
    declarationProvider?: | boolean
    | DeclarationOptions
    | DeclarationRegistrationOptions;
    definitionProvider?: boolean
    | DefinitionOptions;
    diagnosticProvider?: DiagnosticOptions | DiagnosticRegistrationOptions;
    documentFormattingProvider?: boolean | DocumentFormattingOptions;
    documentHighlightProvider?: boolean | DocumentHighlightOptions;
    documentLinkProvider?: DocumentLinkOptions;
    documentOnTypeFormattingProvider?: DocumentOnTypeFormattingOptions;
    documentRangeFormattingProvider?: boolean | DocumentRangeFormattingOptions;
    documentSymbolProvider?: boolean | DocumentSymbolOptions;
    executeCommandProvider?: ExecuteCommandOptions;
    experimental?: T;
    foldingRangeProvider?:
        | boolean
        | FoldingRangeOptions
        | FoldingRangeRegistrationOptions;
    hoverProvider?: boolean
    | HoverOptions;
    implementationProvider?:
        | boolean
        | ImplementationOptions
        | ImplementationRegistrationOptions;
    inlayHintProvider?: | boolean
    | InlayHintOptions
    | InlayHintRegistrationOptions;
    inlineCompletionProvider?: boolean
    | WorkDoneProgressOptions;
    inlineValueProvider?:
        | boolean
        | WorkDoneProgressOptions
        | InlineValueRegistrationOptions;
    linkedEditingRangeProvider?: | boolean
    | LinkedEditingRangeOptions
    | LinkedEditingRangeRegistrationOptions;
    monikerProvider?: boolean
    | MonikerOptions
    | MonikerRegistrationOptions;
    notebookDocumentSync?:
        | NotebookDocumentSyncOptions
        | NotebookDocumentSyncRegistrationOptions;
    positionEncoding?: string;
    referencesProvider?: boolean
    | ReferenceOptions;
    renameProvider?: boolean | RenameOptions;
    selectionRangeProvider?:
        | boolean
        | SelectionRangeOptions
        | SelectionRangeRegistrationOptions;
    semanticTokensProvider?: | SemanticTokensOptions
    | SemanticTokensRegistrationOptions;
    signatureHelpProvider?: SignatureHelpOptions;
    textDocumentSync?: TextDocumentSyncOptions
    | TextDocumentSyncKind;
    typeDefinitionProvider?:
        | boolean
        | TypeDefinitionOptions
        | TypeDefinitionRegistrationOptions;
    typeHierarchyProvider?: | boolean
    | WorkDoneProgressOptions
    | TypeHierarchyRegistrationOptions;
    workspace?: WorkspaceOptions;
    workspaceSymbolProvider?: boolean
    | WorkspaceSymbolOptions;
}

Type Parameters

Properties

callHierarchyProvider? codeActionProvider? codeLensProvider? colorProvider? completionProvider? declarationProvider? definitionProvider? diagnosticProvider? documentFormattingProvider? documentHighlightProvider? documentLinkProvider? documentOnTypeFormattingProvider? documentRangeFormattingProvider? documentSymbolProvider? executeCommandProvider? experimental? foldingRangeProvider? hoverProvider? implementationProvider? inlayHintProvider? inlineCompletionProvider? inlineValueProvider? linkedEditingRangeProvider? monikerProvider? notebookDocumentSync? positionEncoding? referencesProvider? renameProvider? selectionRangeProvider? semanticTokensProvider? signatureHelpProvider? textDocumentSync? typeDefinitionProvider? typeHierarchyProvider? workspace? workspaceSymbolProvider?

Properties

OptionalcallHierarchyProvider

callHierarchyProvider?:
    | boolean
    | CallHierarchyOptions
    | CallHierarchyRegistrationOptions

The server provides call hierarchy support.

Since

3.16.0

OptionalcodeActionProvider

codeActionProvider?: boolean | CodeActionOptions

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

OptionalcodeLensProvider

codeLensProvider?: CodeLensOptions

The server provides code lens.

OptionalcolorProvider

colorProvider?:
    | boolean
    | DocumentColorOptions
    | DocumentColorRegistrationOptions

The server provides color provider support.

OptionalcompletionProvider

completionProvider?: CompletionOptions

The server provides completion support.

OptionaldeclarationProvider

declarationProvider?:
    | boolean
    | DeclarationOptions
    | DeclarationRegistrationOptions

The server provides Goto Declaration support.

OptionaldefinitionProvider

definitionProvider?: boolean | DefinitionOptions

The server provides goto definition support.

OptionaldiagnosticProvider

diagnosticProvider?: DiagnosticOptions | DiagnosticRegistrationOptions

The server has support for pull model diagnostics.

Since

3.17.0

OptionaldocumentFormattingProvider

documentFormattingProvider?: boolean | DocumentFormattingOptions

The server provides document formatting.

OptionaldocumentHighlightProvider

documentHighlightProvider?: boolean | DocumentHighlightOptions

The server provides document highlight support.

OptionaldocumentLinkProvider

documentLinkProvider?: DocumentLinkOptions

The server provides document link support.

OptionaldocumentOnTypeFormattingProvider

documentOnTypeFormattingProvider?: DocumentOnTypeFormattingOptions

The server provides document formatting on typing.

OptionaldocumentRangeFormattingProvider

documentRangeFormattingProvider?: boolean | DocumentRangeFormattingOptions

The server provides document range formatting.

OptionaldocumentSymbolProvider

documentSymbolProvider?: boolean | DocumentSymbolOptions

The server provides document symbol support.

OptionalexecuteCommandProvider

executeCommandProvider?: ExecuteCommandOptions

The server provides execute command support.

Optionalexperimental

experimental?: T

Experimental server capabilities.

OptionalfoldingRangeProvider

foldingRangeProvider?:
    | boolean
    | FoldingRangeOptions
    | FoldingRangeRegistrationOptions

The server provides folding provider support.

OptionalhoverProvider

hoverProvider?: boolean | HoverOptions

The server provides hover support.

OptionalimplementationProvider

implementationProvider?:
    | boolean
    | ImplementationOptions
    | ImplementationRegistrationOptions

The server provides Goto Implementation support.

OptionalinlayHintProvider

inlayHintProvider?: boolean | InlayHintOptions | InlayHintRegistrationOptions

The server provides inlay hints.

Since

3.17.0

OptionalinlineCompletionProvider

inlineCompletionProvider?: boolean | WorkDoneProgressOptions

Inline completion options used during static registration.

Since

3.18.0

Proposed

OptionalinlineValueProvider

inlineValueProvider?:
    | boolean
    | WorkDoneProgressOptions
    | InlineValueRegistrationOptions

The server provides inline values.

Since

3.17.0

OptionallinkedEditingRangeProvider

linkedEditingRangeProvider?:
    | boolean
    | LinkedEditingRangeOptions
    | LinkedEditingRangeRegistrationOptions

The server provides linked editing range support.

Since

3.16.0

OptionalmonikerProvider

monikerProvider?: boolean | MonikerOptions | MonikerRegistrationOptions

The server provides moniker support.

Since

3.16.0

OptionalnotebookDocumentSync

notebookDocumentSync?:
    | NotebookDocumentSyncOptions
    | NotebookDocumentSyncRegistrationOptions

Defines how notebook documents are synced.

Since

3.17.0

OptionalpositionEncoding

positionEncoding?: string

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

OptionalreferencesProvider

referencesProvider?: boolean | ReferenceOptions

The server provides find references support.

OptionalrenameProvider

renameProvider?: boolean | RenameOptions

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

OptionalselectionRangeProvider

selectionRangeProvider?:
    | boolean
    | SelectionRangeOptions
    | SelectionRangeRegistrationOptions

The server provides selection range support.

OptionalsemanticTokensProvider

semanticTokensProvider?:
    | SemanticTokensOptions
    | SemanticTokensRegistrationOptions

The server provides semantic tokens support.

Since

3.16.0

OptionalsignatureHelpProvider

signatureHelpProvider?: SignatureHelpOptions

The server provides signature help support.

OptionaltextDocumentSync

textDocumentSync?: TextDocumentSyncOptions | TextDocumentSyncKind

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

OptionaltypeDefinitionProvider

typeDefinitionProvider?:
    | boolean
    | TypeDefinitionOptions
    | TypeDefinitionRegistrationOptions

The server provides Goto Type Definition support.

OptionaltypeHierarchyProvider

typeHierarchyProvider?:
    | boolean
    | WorkDoneProgressOptions
    | TypeHierarchyRegistrationOptions

The server provides type hierarchy support.

Since

3.17.0

Optionalworkspace

workspace?: WorkspaceOptions

Workspace specific server capabilities.

OptionalworkspaceSymbolProvider

workspaceSymbolProvider?: boolean | WorkspaceSymbolOptions

The server provides workspace symbol support.

Settings

Member Visibility

On This Page

Properties