[I] Server

Language-server handlers and state for an embedding host to connect to LSP. Initialize the server before enabling document-update processing with Server.initialized.

Properties

Property	Modifier	Type	Description
`pendingMessages`	`readonly`	readonly `ServerLog`[]	Messages queued before initialized; the queue is flushed through the host when logging resumes.
`workspaceFolders`	`readonly`	readonly `ServerWorkspaceFolder`[]	Current workspace folders, including normalized paths used for project discovery.

Methods

buildSemanticTokens()

buildSemanticTokens(params): Promise<SemanticTokens>;

Encode classified tokens as LSP semantic-token data using the legend advertised during initialization.

Parameters

Parameter	Type
`params`	`SemanticTokensParams`

Returns

Promise<SemanticTokens>

checkChange()

checkChange(change): void;

Schedule diagnostics for a changed document, ignoring the initial change notification accompanying an open.

Parameters

Parameter	Type
`change`	`TextDocumentChangeEvent`<`TextDocument`>

Returns

void

compile()

compile(
   document,
   additionalOptions,
   serverCompileOptions
): Promise<CompileResult | undefined>;

Compile the inferred project containing a document, falling back to the document itself if it is not included. Additional options override server defaults and resolved configuration. Returns undefined for unsupported documents, unresolved entry points, cancelled or stale requests, or handled compilation failures.

Parameters

Parameter	Type
`document`	`TextDocument` \| `TextDocumentIdentifier`
`additionalOptions`	`CompilerOptions` \| `undefined`
`serverCompileOptions`	`ServerCompileOptions`

Returns

Promise<CompileResult | undefined>

complete()

complete(params): Promise<CompletionList>;

Compute completion items at the requested position, including configuration-file completions.

Parameters

Parameter	Type
`params`	`CompletionParams`

Returns

Promise<CompletionList>

documentClosed()

documentClosed(change): void;

Forget the document’s opening version and clear its published diagnostics.

Parameters

Parameter	Type
`change`	`TextDocumentChangeEvent`<`TextDocument`>

Returns

void

documentOpened()

documentOpened(change): void;

Record a document’s opening version and schedule its initial diagnostics.

Parameters

Parameter	Type
`change`	`TextDocumentChangeEvent`<`TextDocument`>

Returns

void

findDocumentHighlight()

findDocumentHighlight(params): Promise<DocumentHighlight[]>;

Find occurrences of the selected symbol within the requested document, marked as read highlights.

Parameters

Parameter	Type
`params`	`DocumentHighlightParams`

Returns

Promise<DocumentHighlight[]>

findReferences()

findReferences(params): Promise<Location[]>;

Find references to the selected symbol across the compiled program’s source files.

Parameters

Parameter	Type
`params`	`ReferenceParams`

Returns

Promise<Location[]>

formatDocument()

formatDocument(params): Promise<TextEdit[]>;

Format an open TypeSpec document using Prettier configuration, falling back to the client’s indentation options.

Parameters

Parameter	Type
`params`	`DocumentFormattingParams`

Returns

Promise<TextEdit[]>

getCodeActions()

getCodeActions(params): Promise<CodeAction[]>;

Offer unresolved quick fixes for published diagnostics, including file-wide fixes when applicable.

Parameters

Parameter	Type
`params`	`CodeActionParams`

Returns

Promise<CodeAction[]>

getDocumentSymbols()

getDocumentSymbols(params): Promise<DocumentSymbol[]>;

Build the hierarchical symbol outline for a TypeSpec document.

Parameters

Parameter	Type
`params`	`DocumentSymbolParams`

Returns

Promise<DocumentSymbol[]>

getFoldingRanges()

getFoldingRanges(getFoldingRanges): Promise<FoldingRange[]>;

Compute multiline folding regions for comments, consecutive imports, decorators, and syntax nodes.

Parameters

Parameter	Type
`getFoldingRanges`	`FoldingRangeParams`

Returns

Promise<FoldingRange[]>

getHover()

getHover(params): Promise<Hover>;

Describe the symbol at the requested position; return empty contents when no description is available.

Parameters

Parameter	Type
`params`	`HoverParams`

Returns

Promise<Hover>

getInitProjectContext()

getInitProjectContext(): Promise<InitProjectContext>;

Load the built-in project templates used by the editor’s project-creation workflow.

Returns

Promise<InitProjectContext>

getSemanticTokens()

getSemanticTokens(params): Promise<SemanticToken[]>;

Classify TypeSpec source into tokens with absolute source offsets rather than LSP-encoded positions.

Parameters

Parameter	Type
`params`	`SemanticTokensParams`

Returns

Promise<SemanticToken[]>

getSignatureHelp()

getSignatureHelp(params): Promise<SignatureHelp | undefined>;

Return debounced template or decorator signature help, or undefined for superseded requests or unsupported positions.

Parameters

Parameter	Type
`params`	`SignatureHelpParams`

Returns

Promise<SignatureHelp | undefined>

gotoDefinition()

gotoDefinition(params): Promise<Location[]>;

Resolve a symbol’s declarations or an import’s target file. Returns an empty list when document analysis is unavailable or the position has no definition. Import lookup requires a resolvable target and rejects if module resolution fails.

Parameters

Parameter	Type
`params`	`DefinitionParams`

Returns

Promise<Location[]>

initialize()

initialize(params): Promise<InitializeResult<any>>;

Configure workspace roots and update callbacks, and return LSP and TypeSpec-specific capabilities.

Parameters

Parameter	Type
`params`	`InitializeParams`

Returns

Promise<InitializeResult<any>>

initialized()

initialized(params): void;

Enable debounced updates and flush queued log messages after client initialization completes.

Parameters

Parameter	Type
`params`	`InitializedParams`

Returns

void

initProject()

initProject(param): Promise<boolean>;

Scaffold a project using the supplied configuration; log unexpected failures and return false on failure.

Parameters

Parameter	Type	Description
`param`	{ `config`: `ScaffoldingConfig`; }	-
`param.config`	`ScaffoldingConfig`	Resolved project location, template, and user inputs used for scaffolding.

Returns

Promise<boolean>

internalCompile()

internalCompile(param): Promise<InternalCompileResult>;

Run a full compilation without reusing cached compilations or old programs, forwarding captured compiler logs to the host.

Parameters

Parameter	Type	Description
`param`	{ `doc`: `TextDocumentIdentifier`; `options`: `CompilerOptions`; }	-
`param.doc`	`TextDocumentIdentifier`	Document used to infer the project to compile.
`param.options`	`CompilerOptions`	Compiler options overriding the resolved project and server defaults.

Returns

Promise<InternalCompileResult>

log()

log(log): void;

Queue a message before initialized; afterwards flush queued messages and deliver it to the host.

Parameters

Parameter	Type
`log`	`ServerLog`

Returns

void

prepareRename()

prepareRename(params): Promise<Range | undefined>;

Return the selected identifier’s rename range, or undefined when no identifier can be renamed.

Parameters

Parameter	Type
`params`	`PrepareRenameParams`

Returns

Promise<Range | undefined>

rename()

rename(params): Promise<WorkspaceEdit>;

Build edits renaming references to the selected identifier; applying them is the caller’s responsibility.

Parameters

Parameter	Type
`params`	`RenameParams`

Returns

Promise<WorkspaceEdit>

renameFiles()

renameFiles(params): Promise<void>;

Process renamed files or folders, schedule recompilation, and ask the host to apply import-path repairs.

Parameters

Parameter	Type
`params`	`RenameFilesParams`

Returns

Promise<void>

reportDiagnostics()

reportDiagnostics(__namedParameters): void;

Publish diagnostics for the result’s open documents and clear stale diagnostics for files without errors. Does nothing when the result has no open document or that document is tspconfig.yaml.

Parameters

Parameter	Type
`__namedParameters`	`CompileResult`

Returns

void

resolveCodeAction()

resolveCodeAction(codeAction): Promise<CodeAction>;

Populate a previously offered code action’s edit from the current diagnostic index.

Parameters

Parameter	Type
`codeAction`	`CodeAction`

Returns

Promise<CodeAction>

validateInitProjectTemplate()

validateInitProjectTemplate(param): Promise<boolean>;

Validate a project template against the relaxed template schema, logging any validation diagnostics.

Parameters

Parameter	Type	Description
`param`	{ `template`: `InitTemplate`; }	-
`param.template`	`InitTemplate`	Template definition selected or supplied by the client.

Returns

Promise<boolean>

watchedFilesChanged()

watchedFilesChanged(params): void;

Invalidate file and package caches for the client’s watched-file change notifications.

Parameters

Parameter	Type
`params`	`DidChangeWatchedFilesParams`

Returns

void

workspaceFoldersChanged()

workspaceFoldersChanged(e): Promise<void>;

Apply added and removed workspace folders, resolving normalized paths for newly added roots.

Parameters

Parameter	Type
`e`	`WorkspaceFoldersChangeEvent`

Returns

Promise<void>