View source

typedef ServerCapabilities

package languageServerProtocol.protocol

import languageServerProtocol.protocol.Protocol

Defines the capabilities provided by a language server.

Fields

@:optionaloptionalworkspaceSymbolProvider:Null<EitherType<Bool, WorkspaceSymbolOptions>>

The server provides workspace symbol support.

@:optionaloptionalworkspace:Null<{workspaceFolders:Null<WorkspaceFoldersServerCapabilities>, fileOperations:Null<FileOperationOptions>}>

Workspace specific server capabilities.

@:optionaloptionaltypeHierarchyProvider:Null<EitherType<Bool, EitherType<TypeHierarchyOptions, TypeHierarchyRegistrationOptions>>>

The server provides type hierarchy support.

Available since

3.17.0

.

@:optionaloptionaltypeDefinitionProvider:Null<EitherType<Bool, EitherType<TypeDefinitionOptions, TypeDefinitionRegistrationOptions>>>

The server provides Goto Type Definition support.

@:optionaloptionaltextDocumentSync:Null<EitherType<TextDocumentSyncOptions, TextDocumentSyncKind>>

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

@:optionaloptionalsupported:Null<Bool>

The Server has support for workspace folders

@:optionaloptionalsignatureHelpProvider:Null<SignatureHelpOptions>

The server provides signature help support.

@:optionaloptionalsemanticTokensProvider:Null<EitherType<SemanticTokensOptions, SemanticTokensRegistrationOptions>>

The server provides semantic tokens support.

Available since

3.16.0

.

@:optionaloptionalselectionRangeProvider:Null<EitherType<Bool, EitherType<SelectionRangeOptions, SelectionRangeRegistrationOptions>>>

The server provides selection range support.

@:optionaloptionalrenameProvider:Null<EitherType<Bool, RenameOptions>>

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

@:optionaloptionalreferencesProvider:Null<EitherType<Bool, ReferenceOptions>>

The server provides find references support.

@:optionaloptionalpositionEncoding:Null<PositionEncodingKind>

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

If for some reason

Available since

3.17.0

.

@:optionaloptionalnotebookDocumentSync:Null<EitherType<NotebookDocumentSyncOptions, NotebookDocumentSyncRegistrationOptions>>

Defines how notebook documents are synced.

Available since

3.17.0

.

@:optionaloptionalmonikerProvider:Null<EitherType<Bool, EitherType<MonikerOptions, MonikerRegistrationOptions>>>

The server provides moniker support.

Available since

3.16.0

.

@:optionaloptionallinkedEditingRangeProvider:Null<EitherType<Bool, EitherType<LinkedEditingRangeOptions, LinkedEditingRangeRegistrationOptions>>>

The server provides linked editing range support.

Available since

3.16.0

.

@:optionaloptionalinlineValueProvider:Null<EitherType<Bool, EitherType<InlineValueOptions, InlineValueRegistrationOptions>>>

The server provides inline values.

Available since

3.17.0

.

@:optionaloptionalinlayHintProvider:Null<EitherType<Bool, EitherType<InlayHintOptions, InlayHintRegistrationOptions>>>

The server provides inlay hints.

Available since

3.17.0

.

@:optionaloptionalimplementationProvider:Null<EitherType<Bool, EitherType<ImplementationOptions, ImplementationRegistrationOptions>>>

The server provides Goto Implementation support.

@:optionaloptionalhoverProvider:Null<EitherType<Bool, HoverOptions>>

The server provides hover support.

@:optionaloptionalfoldingRangeProvider:Null<EitherType<Bool, EitherType<FoldingRangeOptions, FoldingRangeRegistrationOptions>>>

The server provides folding provider support.

@:optionaloptionalexperimental:Null<Dynamic>

Experimental server capabilities.

@:optionaloptionalexecuteCommandProvider:Null<ExecuteCommandOptions>

The server provides execute command support.

@:optionaloptionaldocumentSymbolProvider:Null<EitherType<Bool, DocumentSymbolOptions>>

The server provides document symbol support.

@:optionaloptionaldocumentRangeFormattingProvider:Null<EitherType<Bool, DocumentRangeFormattingOptions>>

The server provides document range formatting.

@:optionaloptionaldocumentOnTypeFormattingProvider:Null<DocumentOnTypeFormattingOptions>

The server provides document formatting on typing.

@:optionaloptionaldocumentLinkProvider:Null<DocumentLinkOptions>

The server provides document link support.

@:optionaloptionaldocumentHighlightProvider:Null<EitherType<Bool, DocumentHighlightOptions>>

The server provides document highlight support.

@:optionaloptionaldocumentFormattingProvider:Null<EitherType<Bool, DocumentFormattingOptions>>

The server provides document formatting.

@:optionaloptionaldiagnosticProvider:Null<EitherType<DiagnosticOptions, DiagnosticRegistrationOptions>>

The server has support for pull model diagnostics.

Available since

3.17.0

.

@:optionaloptionaldefinitionProvider:Null<EitherType<Bool, DefinitionOptions>>

The server provides goto definition support.

@:optionaloptionaldeclarationProvider:Null<EitherType<Bool, EitherType<DeclarationOptions, DeclarationRegistrationOptions>>>

The server provides Goto Declaration support.

@:optionaloptionalcompletionProvider:Null<CompletionOptions>

The server provides completion support.

@:optionaloptionalcolorProvider:Null<EitherType<Bool, EitherType<DocumentColorOptions, DocumentColorRegistrationOptions>>>

The server provides color provider support.

@:optionaloptionalcodeLensProvider:Null<CodeLensOptions>

The server provides code lens.

@:optionaloptionalcodeActionProvider:Null<EitherType<Bool, CodeActionOptions>>

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

@:optionaloptionalchangeNotifications:Null<EitherType<String, Bool>>

Whether the server wants to receive workspace folder change notifications.

If a strings is provided the string is treated as a ID under which the notification is registed on the client side. The ID can be used to unregister for these events using the client/unregisterCapability request.

@:optionaloptionalcallHierarchyProvider:Null<EitherType<Bool, EitherType<CallHierarchyOptions, CallHierarchyRegistrationOptions>>>

The server provides call hierarchy support.

Available since

3.16.0

.