LanguageServerAdapterPluginOptions

LanguageServerAdapterPluginOptions = LanguageServerLaneHostOptions & object

Type Declaration

capabilities?

readonly optional capabilities?: lsp.ClientCapabilities

See LanguageServerPluginOptions.capabilities.

clientInfo?

readonly optional clientInfo?: lsp.InitializeParams["clientInfo"]

See LanguageServerPluginOptions.clientInfo.

commands?

readonly optional commands?: readonly LanguageServerCommandSpec[]

completion?

readonly optional completion?: object

completion.acceptOnCommitCharacter?

readonly optional acceptOnCommitCharacter?: boolean

Accepts the focused suggestion when one of the characters the item declares as committing it is typed, inserting that character too. Off by default: a server whose sets are wrong turns ordinary typing into unwanted completions, which is worse than no shortcut at all.

completion.acceptTimingName?

readonly optional acceptTimingName?: string

completion.editFeature?

readonly optional editFeature?: EditorCapabilityToken<LanguageServerCompletionEditFeature>

completion.widgetClassNamespace?

readonly optional widgetClassNamespace?: string

connectionProvider?

readonly optional connectionProvider?: LspConnectionProvider

Borrows the connection instead of constructing one per view. See LspConnectionProvider.

diagnostics?

readonly optional diagnostics?: object

diagnostics.highlightNameNamespace?

readonly optional highlightNameNamespace?: string

diagnostics.markerTimingNamePrefix?

readonly optional markerTimingNamePrefix?: string

diagnostics.minimapSourceId?

readonly optional minimapSourceId?: string

documentSync?

readonly optional documentSync?: LanguageServerDocumentSyncOptions

formatOnType?

readonly optional formatOnType?: boolean

Corrects the caret’s row as a block-closing delimiter is typed. On by default: without it every closed block is left a level too deep, and the correction is the language’s own indentation rules applied to one row, not a formatter deciding how the file should look.

getDiagnosticActions?

readonly optional getDiagnosticActions?: LanguageServerDiagnosticActions

hoverDefinition?

readonly optional hoverDefinition?: object

hoverDefinition.linkHighlightNameNamespace?

readonly optional linkHighlightNameNamespace?: string

hoverDefinition.navigationTimingNamePrefix?

readonly optional navigationTimingNamePrefix?: string

hoverDefinition.tooltipClassNamespace?

readonly optional tooltipClassNamespace?: string

initializationOptions?

readonly optional initializationOptions?: unknown

name

readonly name: string

notificationHandlers?

readonly optional notificationHandlers?: Readonly<Record<string, LspNotificationHandler<LspClient>>>

See LanguageServerPluginOptions.notificationHandlers. Merged, never replacing.

onDefinitionLinkHover?

readonly optional onDefinitionLinkHover?: (target) => void | (() => void)

Parameters

target

LanguageServerDefinitionTarget

Returns

void | (() => void)

onDiagnostics?

readonly optional onDiagnostics?: (summary) => void

Parameters

summary

LanguageServerDiagnosticSummary

Returns

void

onDidNavigateDiagnostic?

readonly optional onDidNavigateDiagnostic?: (event) => LanguageServerDiagnosticMarkerClaim

Parameters

event

LanguageServerDiagnosticMarkerEvent

Returns

LanguageServerDiagnosticMarkerClaim

onError?

readonly optional onError?: (error) => void

Parameters

error

unknown

Returns

void

onInteractiveReady?

readonly optional onInteractiveReady?: () => void

Returns

void

onOpenDefinition?

readonly optional onOpenDefinition?: (target, options?) => void | boolean

Parameters

target

LanguageServerDefinitionTarget

options?

LanguageServerNavigationOptions

Returns

void | boolean

onOpenReferences?

readonly optional onOpenReferences?: (result) => void | boolean

Parameters

result

LanguageServerReferencesResult

Returns

void | boolean

onRequestError?

readonly optional onRequestError?: (serverId, method, error) => void

Parameters

serverId

string

method

string

error

unknown

Returns

void

onRequestRenameName?

readonly optional onRequestRenameName?: (prompt) => Promise<string | null>

Asks the host for a new symbol name. Supply this to use the application’s own dialog; without it the editor shows its own small input at the symbol.

Parameters

prompt

LanguageServerRenamePrompt

Returns

Promise<string | null>

onStatusChange?

readonly optional onStatusChange?: (status) => void

Parameters

status

LanguageServerStatus

Returns

void

rootUri?

readonly optional rootUri?: lsp.DocumentUri | null

semanticTokens?

readonly optional semanticTokens?: LanguageServerSemanticTokensOptions

Turns on the semantic token layer. Supplying nothing here creates no layer and fires no demand signal, so a host that paints no semantic colour pays nothing for the feature existing.

serverRequestHandlers?

readonly optional serverRequestHandlers?: Readonly<Record<string, LspServerRequestHandler<LspClient>>>

See LanguageServerPluginOptions.serverRequestHandlers.

timeoutMs?

readonly optional timeoutMs?: number

createTransport()

createTransport(): LspManagedTransport | Promise<LspManagedTransport>

Returns

LspManagedTransport | Promise<LspManagedTransport>

onConnected()?

optional onConnected(context): void

Parameters

context

LanguageServerConnectionContext

Returns

void

onConnectionCreated()?

optional onConnectionCreated(context): void | EditorDisposable

Parameters

context

LanguageServerConnectionContext

Returns

void | EditorDisposable