Language Server Protocol Specification - 3.15

以下の文書は Language Server Protocol Specification - 3.15 の日本語訳である。

Base Protocol

ベースプロトコルはヘッダ部とコンテント部で構成される(HTTP と似ている)。ヘッダ部とコンテント部は \r\n で分割される。

Header Part

ヘッダ部はヘッダフィールドで構成される。それぞれのヘッダフィールドは : (コロンとスペース) で分割された名前と値で構成される。それぞれのヘッダフィールドは \r\n で終了する。最後のヘッダフィールドとヘッダ全体はそれぞれ \r\n で終了することと、少なくとも1つのヘッダが必須であることを踏まえると、常にメッセージのコンテント部の直前には2つの \r\n があることになる。

現在次のヘッダフィールドがサポートされている:

ヘッダフィールド名	値の型	備考
Content-Length	number	コンテント部のバイト数。このヘッダは必須。
Content-Type	string	コンテント部の mime type。デフォルトは `application/vscode-jsonrpc; charset=utf-8` である。

ヘッダ部は 'ascii' でエンコードされる。これはヘッダ部とコンテント部を分割する \r\n も含む。

Content Part

実際のメッセージの中身が含まれる。リクエスト、レスポンス、通知を記述するために、コンテント部には JSON-RPC が使われる。コンテント部は Content-Type フィールドで与えられる charset でエンコードされる。デフォルトで utf-8 であり、今は唯一サポートされるエンコード形式である。サーバまたはクライアントが utf-8 以外のエンコード形式のヘッダを受信した場合は、エラーを返すべきである。

(以前のバージョンでは utf8 が使われていたが、これは仕様によると正しいエンコード形式名ではない。) 後方互換性のため、サーバ、クライアント双方は utf8 を utf-8 として扱うことを強く推奨する。

Example:

Content-Length: ...\r\n
\r\n
{
	"jsonrpc": "2.0",
	"id": 1,
	"method": "textDocument/didOpen",
	"params": {
		...
	}
}

Base Protocol JSON structures

次の TypeScript 定義はベースとなる JSON-RPC protocol を記述する。

Abstract Message

一般的な Message は JSON-RPC として定義される。LSP では常に jsonrpc バージョンとして "2.0" を使う。

interface Message {
	jsonrpc: string;
}

Request Message

RequestMessage はクライアントサーバ間のリクエストを記述する。処理されたリクエストは全て、送信元にレスポンスを返さなければならない。

interface RequestMessage extends Message {

	/**
	 * リクエストID。
	 */
	id: number | string;

	/**
	 * 実行されるメソッド。
	 */
	method: string;

	/**
	 * メソッドのパラメータ。
	 */
	params?: array | object;
}

Response Message

ResponseMessage はリクエストの結果として送信される。リクエストが結果となる値を提供しない場合でもリクエスト受信者は JSON RPC 仕様に従うためにレスポンスメッセージを返さなければならない。この場合、ResponseMessage の result プロパティはリクエストの成功を伝えるために null を入れるべきである。

interface ResponseMessage extends Message {
	/**
	 * リクエストID。
	 */
	id: number | string | null;

	/**
	 * リクエストの結果。成功時は必須である。
	 * メソッドがエラーを返した場合はこのプロパティは存在してはならない。
	 */
	result?: string | number | boolean | object | null;

	/**
	 * リクエストが失敗した場合のエラー。
	 */
	error?: ResponseError;
}

interface ResponseError {
	/**
	 * 発生したエラー種別を表す数字。
	 */
	code: number;

	/**
	 * エラーの概要を表す文字列。
	 */
	message: string;

	/**
	 * エラーについての情報を付加するプリミティブまたは構造化された値。
	 * 省略可能。
	 */
	data?: string | number | boolean | array | object | null;
}

export namespace ErrorCodes {
	// JSON RPC で定義されたもの。
	export const ParseError: number = -32700;
	export const InvalidRequest: number = -32600;
	export const MethodNotFound: number = -32601;
	export const InvalidParams: number = -32602;
	export const InternalError: number = -32603;
	export const serverErrorStart: number = -32099;
	export const serverErrorEnd: number = -32000;
	export const ServerNotInitialized: number = -32002;
	export const UnknownErrorCode: number = -32001;

	// このプロトコルで定義されたもの。
	export const RequestCancelled: number = -32800;
	export const ContentModified: number = -32801;
}

Notification Message

NotificationMessage。処理された通知メッセージはレスポンスを返してはならない。これらはイベントのように振る舞う。

interface NotificationMessage extends Message {
	/**
	 * 実行されるメソッド。
	 */
	method: string;

	/**
	 * 通知のパラメータ。
	 */
	params?: array | object;
}

$ Notifications and Requests

$/ で始まるメソッドの通知及びリクエストはプロトコル実装に依存し、全てのクライアントまたはサーバでは実装できない可能性のあるメッセージである。例えばシングルスレッドで同期的なプログラミング言語を用いてサーバを実装する場合、 $/cancelRequest 通知に対してサーバができることはほとんどない。サーバまたはクライアントが $/ から始まる通知を受けた場合、その通知を無視してもよい。サーバまたはクライアントが $/ から始まるリクエストを受けた場合、エラーコード MethodNotFound(-32601) でリクエストをエラーにしなければならない。

Cancellation Support

ベースプロトコルはリクエストのキャンセル機能を提供する。リクエストをキャンセルするには、次のプロパティを通知メッセージとして送信する:

通知:

メソッド: $/cancelRequest
パラメータ: 次で定義される CancelParams:

interface CancelParams {
	/**
	 * キャンセル対象のリクエストID。
	 */
	id: number | string;
}

リクエストはキャンセルされても、サーバから戻ってレスポンスを返す必要がある。開いた/ハング状態のままにはできない。これは全てのリクエストはレスポンスを返すという JSON RPC プロトコルに従っている。加えて、これはキャンセル時に部分的な結果を返すことも許容している。リクエストキャンセル時にエラーを返す場合、エラーコードは ErrorCodes.RequestCancelled を指定することを推奨する。

Progress Support

バージョン 3.15.0 から

ベースプロトコルは一般的な流儀での進行状況の報告もサポートする。この機能は作業の進行状況(大抵 UI 上でプログレスバーを用いて報告するために使用される)や結果のストリーミングをサポートする部分的な結果の進行状況など、さまざまな種類の進行状況を報告するために使われる。

$/progress 通知は次のプロパティを持つ:

通知:

メソッド: $progress
パラメータ: 次で定義される ProgressParams

type ProgressToken = number | string;
interface ProgressParams<T> {
	/**
	 * クライアントまたはサーバから提供されるプログレストークン。
	 */
	token: ProgressToken;

	/**
	 * プログレスデータ。
	 */
	value: T;
}

進行状況はトークンに対して報告される。トークンはリクエスト ID とは異なり、リクエスト外の進行状況を報告したり、通知することができる。

Language Server Protocol

LSP は前述のベースプロトコルでやりとりされる JSON-RPC リクエスト、レスポンス、通知メッセージの集まりとして定義される。このセクションではこのプロトコルで使用される基本的な JSON 構造の記述から始まる。これらの記述には TypeScript interface を用いる。基本的な JSON 構造を基に、実際のリクエストとそれに伴うレスポンス、通知が記述される。

一般的に、LSP は JSON-RPC メッセージをサポートするが、ここで定義されたベースプロトコルはリクエストおよび通知メッセージに渡すパラメータは(渡されるのであれば) object 型であるべきという慣習に従っている。ただし、カスタムメッセージ内で Array パラメータを使うことを禁止してはいない。

現在このプロトコルは一つのサーバが一つのツールを提供することを仮定している。一つのサーバを異なるツールで共有することをサポートしていない。このような共有をするにはプロトコルの追加が必要である。例えば並列編集をサポートするため、ドキュメントのロックを取れるようにする必要がある。

Basic JSON Structures

URI

URI は文字列として送信される。URI フォーマットは https://tools.ietf.org/html/rfc3986 で定義される。

  foo://example.com:8042/over/there?name=ferret#nose
  \_/   \______________/\_________/ \_________/ \__/
   |           |            |            |        |
scheme     authority       path        query   fragment
   |   _____________________|__
  / \ /                        \
  urn:example:animal:ferret:nose

文字列を scheme、authority、path、query、fragment の URI コンポーネントにパースするための node module もメンテナンスしている。GitHub リポジトリは https://github.com/Microsoft/vscode-uri で、npm module は https://www.npmjs.com/package/vscode-uri にある。

多くのインターフェイスはドキュメントの URI に対応するフィールドを持つ。これを明確にするため、このようなフィールドの型を DocumentUri として宣言する。ネットワークを通して URI は文字列として転送されるが、これにより、文字列のコンテンツが有効な URI としてパースされることが保証される。

type DocumentUri = string;

Text Documents

現在のプロトコルは文字列として表現できる中身を持つテキストドキュメントのために調整されている。現在はバイナリドキュメントはサポートされていない。ドキュメント内の位置(後述の Position の定義を参照)は0始まりの行と文字オフセットとして表される。オフセットは UTF-16 文字表現を基にする。そのため文字列 a𐐀b を考えると、 UTF-16 で 𐐀 は2文字単位として表現されるため、文字 a のオフセットは0、𐐀 のオフセットは1、b のオフセットは3となる。クライアントとサーバ双方が文字列を同じ行表現に分割することを保証するために、LSP では \n、\r\n、\r という EOL 文字列を指定する。

位置は行末文字に依存しない。そのため、| が文字オフセットを表すとして、\r|\n や \n| のような位置は指定することができない。

export const EOL: string[] = ['\n', '\r\n', '\r'];

Position

テキストドキュメント内の位置は0始まりの行と0始まりの文字オフセットで表現される。位置はエディタの "insert" カーソルのようにふたつの文字の間にある。-1 で行末を表わす、などの特別な値はサポートされていない。

interface Position {
	/**
	 * ドキュメント内の行位置 (0始まり)。
	 */
	line: number;

	/**
	 * ドキュメント内の行中の文字オフセット (0始まり)。行は文字列として表現される
	 * と仮定し、`character` の値は `character` と `caracter + 1` 間のすき間を表
	 * 現する。
	 *
	 * `character` の値が行の長さを越えた場合はデフォルトでは行の長さに戻る。
	 */
	character: number;
}

Range

テキストドキュメント内の範囲は開始位置(0始まり)と終了位置で表現される。範囲はエディタの選択範囲に相当する。よって終了位置は含まれない。行末文字を含むように行をレンジに指定したい場合は終了位置を次の行の始めに指定する。例えば:

{
    "start": { "line": 5, "character": 23 },
    "end": { "line": 6, "character": 0 }
}

interface Range {
	/**
	 * 範囲の開始位置。
	 */
	start: Position;

	/**
	 * 範囲の終了位置。
	 */
	end: Position;
}

Location

テキストファイル内の行などのリソース内の場所を表わす。

interface Location {
	uri: DocumentUri;
	range: Range;
}

LocationLink

ソースとターゲット間の位置のリンクを表わす。

interface LocationLink {

	/**
	 * このリンクの原点のスパン
	 *
	 * マウス操作の下線付きスパンとして使われる。デフォルトではマウス位置の単語の
	 * 範囲が使われる。
	 */
	originSelectionRange?: Range;

	/**
	 * このリンクのターゲットリソースの識別子。
	 */
	targetUri: DocumentUri;

	/**
	 * このリンクの対象範囲。ターゲットが例えばシンボルの場合、対象範囲はこのシン
	 * ボルを含む範囲で、先頭/末尾の空白は含まれないが、コメントなど他のものは全
	 * て含まれる。これは通常エディタでレンジをハイライトするときに使われる。
	 */
	targetRange: Range;

	/**
	 * このリンクを辿るときに選択し、表示するべき範囲。例えば関数名。
	 * `targetRange` に含まれている必要がある。`DocumentSymbol#range` も参照。
	 */
	targetSelectionRange: Range;
}

Diagnostic

コンパイラのエラーや警告などの診断結果を表わす。Diagnostic はリソース内でのみ有効である。

interface Diagnostic {
	/**
	 * メッセージが適用される範囲。
	 */
	range: Range;

	/**
	 * 診断結果の重大度。省略可能。省略した場合、クライアント次第で診断結果をエ
	 * ラー、警告、情報、ヒントとして解釈する。
	 */
	severity?: number;

	/**
	 * UI に表示されるであろう診断結果コード。
	 */
	code?: number | string;

	/**
	 * 'typescript' や 'super lint' のようなこの診断結果を提供したソースを表わす
	 * 可読な文字列。
	 */
	source?: string;

	/**
	 * 診断結果のメッセージ。
	 */
	message: string;

	/**
	 * 診断結果についての追加のメタデータ。
	 *
	 * @since 3.15.0
	 */
	tags?: DiagnosticTag[];

	/**
	 * 関連する診断情報の配列、例えばスコープ内のシンボル名が衝突した場合このプロ
	 * パティから全ての定義をマークできる。
	 */
	relatedInformation?: DiagnosticRelatedInformation[];
}

LSP は現在次の重大度とタグをサポートしている:

namespace DiagnosticSeverity {
	/**
	 * エラーを報告する。
	 */
	export const Error = 1;
	/**
	 * 警告を報告する。
	 */
	export const Warning = 2;
	/**
	 * 情報を報告する。
	 */
	export const Information = 3;
	/**
	 * ヒントを報告する。
	 */
	export const Hint = 4;
}

export type DiagnosticSeverity = 1 | 2 | 3 | 4;

/**
 * 診断タグ
 *
 * @since 3.15.0
 */
export namespace DiagnosticTag {
	/**
	 * 使われていない、または不要なコード。
	 *
	 * クライアントはエラー下線の代わりに、このタグをフェードアウトすることで診
	 * 断結果を表示できる。
	 */
	export const Unnecessary: 1 = 1;
	/**
	 * 非推奨または廃止されたコード。
	 *
	 * クライアントはこのタグの打ち消し線で診断結果を表示できる。
	 */
	export const Deprecated: 2 = 2;
}

export type DiagnosticTag = 1 | 2;

DiagnosticRelatedInformation は次のように定義される:

/**
 * 診断結果の関連メッセージとソースコードの位置を表わす。これはスコープ内のシン
 * ボルが被っているときなど診断結果の原因やそれに関連するコードの位置を指し示す
 * ために使われるべきである。
 */
export interface DiagnosticRelatedInformation {
	/**
	 * 診断結果に関連する位置。
	 */
	location: Location;

	/**
	 * 診断結果のメッセージ。
	 */
	message: string;
}

Command

コマンドへの参照を表わす。UI でコマンドを表示するためのタイトルを提供する。コマンドは文字列の識別子によって識別される。クライアントとサーバが対応する機能を提供する場合、サーバ側でそれらの実行を実装することがコマンドを処理するために推奨される方法である。代わりにツール拡張コードはコマンドを処理できる。LSP は現状 well-known コマンドを指定しない。

interface Command {
	/**
	 * コマンドのタイトル、`save` など。
	 */
	title: string;
	/**
	 * 実際のコマンドハンドラの識別子。
	 */
	command: string;
	/**
	 * コマンドハンドラに渡すべき引数。
	 */
	arguments?: any[];
}

TextEdit

テキストドキュメントに適用される編集。

interface TextEdit {
	/**
	 * 操作されるテキストドキュメントのレンジ。ドキュメントにテキストを挿入するた
	 * めにはレンジを start === end として指定する。
	 */
	range: Range;

	/**
	 * 挿入される文字列。削除操作をするためには空文字列を使う。
	 */
	newText: string;
}

TextEdit[]

複雑なテキスト操作は、ドキュメントへの1つの変更である TextEdit の配列で記述される。

全てのテキスト編集の範囲は、計算対象のドキュメント内の位置を参照する。よって中間的な状態を記述することなくドキュメントの状態は S1 から S2 に移る。テキスト編集のレンジは重なってはいけない、つまり元のドキュメントのどの部分も1つの編集でしか操作されない。ただし、複数挿入や単一の削除または置換の後の複数挿入など、複数の編集が同一の開始位置を持つことは可能である。複数の挿入が同一の位置を持つ場合、配列の順序が結果のテキストに挿入された文字列が反映される順序を定義する。

TextDocumentEdit

単一のテキストドキュメント上の変更を記述する。テキストドドキュメントはこの編集が適用される前のテキストドキュメントのバージョンを確認できるようにするために VersionedTextDocumentIdentifier として関連付けられる。TextDocumentEdit はバージョン Si の全ての変更を記述し、バージョン Si + 1 に移動する。そのため TextDocumentEdit の作成者は配列のソートやその他の順序付けをする必要はない。ただし編集は重なってはならない。

export interface TextDocumentEdit {
	/**
	 * 変更するテキストドキュメント。
	 */
	textDocument: VersionedTextDocumentIdentifier;

	/**
	 * 適用する変更。
	 */
	edits: TextEdit[];
}

File Resource changes

バージョン 3.13 から:

ファイルリソース変更によりサーバはクライアントを通してファイルおよびフォルダを作成、リネーム、削除できる。この名前(訳注: ファイルリソース変更)はファイルについて述べるが、操作はファイルとフォルダに対して動作することに注意する。これは LSP の他の名付けでも見られる(ファイルとフォルダを監視することができる File watchers などを参照)。対応する変更リテラルは次のようになる:

/**
 * ファイル作成時のオプション。
 */
export interface CreateFileOptions {
	/**
	 * 存在するファイルを上書きする。`ignoreIfExists` より優先される。
	 */
	overwrite?: boolean;
	/**
	 * 存在する場合は何もしない。
	 */
	ignoreIfExists?: boolean;
}

/**
 * ファイル作成操作
 */
export interface CreateFile {
	/**
	 * 作成
	 */
	kind: 'create';
	/**
	 * 作成するリソース。
	 */
	uri: DocumentUri;
	/**
	 * オプション
	 */
	options?: CreateFileOptions;
}

/**
 * ファイルリネームオプション
 */
export interface RenameFileOptions {
	/**
	 * 存在するファイルを上書きする。`ignoreIfExists` より優先される。
	 */
	overwrite?: boolean;
	/**
	 * 存在する場合は何もしない。
	 */
	ignoreIfExists?: boolean;
}

/**
 * リネーム操作
 */
export interface RenameFile {
	/**
	 * リネーム
	 */
	kind: 'rename';
	/**
	 * 古い(存在している)位置。
	 */
	oldUri: DocumentUri;
	/**
	 * 新しい位置。
	 */
	newUri: DocumentUri;
	/**
	 * リネームオプション。
	 */
	options?: RenameFileOptions;
}

/**
 * ファイル削除オプション
 */
export interface DeleteFileOptions {
	/**
	 * フォルダが指定されたとき、コンテントを再帰的に削除する。
	 */
	recursive?: boolean;
	/**
	 * ファイルが存在しない場合は何もしない。
	 */
	ignoreIfNotExists?: boolean;
}

/**
 * ファイル削除操作
 */
export interface DeleteFile {
	/**
	 * 削除
	 */
	kind: 'delete';
	/**
	 * 削除するファイル。
	 */
	uri: DocumentUri;
	/**
	 * 削除オプション。
	 */
	options?: DeleteFileOptions;
}

WorkspaceEdit

ワークスペース編集はワークスペース内で管理される多くのリソースへの変更を表わす。編集操作は changes か documentChanges のどちらかを提供すべきである。クライアントがバージョン管理されたドキュメントへの編集を操作可能で、documentChanges が指定された場合、documentChanges が changes よりも優先される。

export interface WorkspaceEdit {
	/**
	 * 存在するリソースへの変更を保持する。
	 */
	changes?: { [uri: DocumentUri]: TextEdit[]; };

	/**
	 * ドキュメントへの変更は、クライアントが
	 * `workspace.workspaceEdit.resourceOperations` を提供しているかに依存して、
	 * それぞれのテキストドキュメントの編集が扱う指定したバージョンのテキストド
	 * キュメントである n 個の異なるテキストドキュメントへの変更を表現する
	 * `TextDocumentEdit` の配列または `TextDocumentEdit` の配列にファイル/フォル
	 * ダの作成、リネーム、削除操作を混ぜたもののいずれかが含むことができる。
	 *
	 * クライアントがバージョン管理されたドキュメントを操作できるかどうかはクライ
	 * アントが `workspace.workspaceEdit.documentChanges` を提供するかどうかで表
	 * 現される。
	 *
	 * クライアントが `documentChanges` か
	 * `workspace.workspaceEdit.resourceOperations` のいずれかをサポートしている
	 * 場合、`changes` プロパティにただの `TextEdit` の配列を使うことがサポートさ
	 * れる。
	 */
	documentChanges?: (TextDocumentEdit[] | (TextDocumentEdit | CreateFile | RenameFile | DeleteFile)[]);
}

WorkspaceEditClientCapabilities

バージョン 3.13 から追加: ResourceOperationKind、FaulureHandlingKind、クライアントの機能である workspace.workspaceEdit.resourceOperations、 workspace.workspaceEdit.failureHandling

ワークスペース編集機能は時間と共に進歩してきた。クライアントは次のクライアント機能でサポートする機能を記述できる。

プロパティパス(任意): workspace.workspaceEdit
プロパティタイプ: 次で定義される WorkspaceEditClientCapabilities

export interface WorkspaceEditClientCapabilities {
	/**
	 * クライアントは `WorkspaceEdit` でバージョン管理されたドキュメントの変更を
	 * サポートする。
	 */
	documentChanges?: boolean;

	/**
	 * クライアントがサポートするリソース操作。クライアントは少なくともファイルと
	 * フォルダへの 'create'、'rename'、'delete' をサポートすべきである。
	 *
	 * @since 3.13.0
	 */
	resourceOperations?: ResourceOperationKind[];

	/**
	 * ワークスペースへの編集が失敗した場合のクライアントの処理方法。
	 *
	 * @since 3.13.0
	 */
	failureHandling?: FailureHandlingKind;
}

/**
 * クライアントがサポートするリソース操作種別。
 */
export type ResourceOperationKind = 'create' | 'rename' | 'delete';

export namespace ResourceOperationKind {

	/**
	 * 新規ファイルやフォルダを作成することをサポートする。
	 */
	export const Create: ResourceOperationKind = 'create';

	/**
	 * 既存ファイルやフォルダをリネームすることをサポートする。
	 */
	export const Rename: ResourceOperationKind = 'rename';

	/**
	 * 既存ファイルやフォルダを削除することをサポートする。
	 */
	export const Delete: ResourceOperationKind = 'delete';
}

export type FailureHandlingKind = 'abort' | 'transactional' | 'undo' | 'textOnlyTransactional';

export namespace FailureHandlingKind {

	/**
	 * ワークスペースへの変更を適用する際、一つでも変更が失敗した場合単純に破棄さ
	 * れる。失敗した操作の前に実行された操作は実行されたままである。
	 */
	export const Abort: FailureHandlingKind = 'abort';

	/**
	 * 全ての操作はトランザクショナルに実行される。つまり、ワークスペースには全て
	 * 成功するか全て変更しないかのどちらかのみが適用される。
	 */
	export const Transactional: FailureHandlingKind = 'transactional';


	/**
   * テキストファイルへの変更のみからなるワークスペースの編集はランザクショナル
   * に実行される。変更に含まれるリソースへの変更(ファイルの作成、リネーム、削
   * 除)には `abort` が適用される。
	 */
	export const TextOnlyTransactional: FailureHandlingKind = 'textOnlyTransactional';

	/**
	 * クライアントはすでに実行した操作を undo しようとする。しかし、その実行が成
	 *  功することは保証されない。
	 */
	export const Undo: FailureHandlingKind = 'undo';
}

TextDocumentIdentifier

テキストドキュメントは URI で識別される。プロトコルレベルでは URI は文字列として渡される。対応する JSON 構造は次のようになる:

interface TextDocumentIdentifier {
	/**
	 * テキストドキュメントの URI。
	 */
	uri: DocumentUri;
}

TextDocumentItem

クライアントからサーバへ転送されるテキストドキュメントのためのアイテム。

interface TextDocumentItem {
	/**
	 * テキストドキュメントの URI。
	 */
	uri: DocumentUri;

	/**
	 * テキストドキュメントの言語識別子。
	 */
	languageId: string;

	/**
	 * このドキュメントのバージョン番号(undo/redo を含む変更後に増加する)。
	 */
	version: number;

	/**
	 * 開かれたテキストドキュメントの中身。
	 */
	text: string;
}

テキストドキュメントは再解釈したファイル拡張子を回避するための2つ以上の言語を扱うときにサーバ側でドキュメントを識別するため言語識別子を持つ。ドキュメントが以下にリストされるプログラミング言語に関連する場合、これらの ID を使うことを推奨する。

言語	識別子
ABAP	`abap`
Windows Bat	`bat`
BibTeX	`bibtex`
Clojure	`clojure`
Coffeescript	`coffeescript`
C	`c`
C++	`cpp`
C#	`csharp`
CSS	`css`
Diff	`diff`
Dart	`dart`
Dockerfile	`dockerfile`
Elixir	`elixir`
Erlang	`erlang`
F#	`fsharp`
Git	`git-commit` and `git-rebase`
Go	`go`
Groovy	`groovy`
Handlebars	`handlebars`
HTML	`html`
Ini	`ini`
Java	`java`
JavaScript	`javascript`
JavaScript React	`javascriptreact`
JSON	`json`
LaTeX	`latex`
Less	`less`
Lua	`lua`
Makefile	`makefile`
Markdown	`markdown`
Objective-C	`objective-c`
Objective-C++	`objective-cpp`
Perl	`perl`
Perl 6	`perl6`
PHP	`php`
Powershell	`powershell`
Pug	`jade`
Python	`python`
R	`r`
Razor (cshtml)	`razor`
Ruby	`ruby`
Rust	`rust`
SCSS	`scss` (syntax using curly brackets), `sass` (indented syntax)
Scala	`scala`
ShaderLab	`shaderlab`
Shell Script (Bash)	`shellscript`
SQL	`sql`
Swift	`swift`
TypeScript	`typescript`
TypeScript React	`typescriptreact`
TeX	`tex`
Visual Basic	`vb`
XML	`xml`
XSL	`xsl`
YAML	`yaml`

VersionedTextDocumentIdentifier

指定したバージョンのテキストドキュメントを示す識別子。

interface VersionedTextDocumentIdentifier extends TextDocumentIdentifier {
	/**
	 * このドキュメントのバージョン番号。バージョン管理されたテキストドキュメント
	 * の識別子がサーバからクライアントに送信され、エディタに開かれていない(サー
	 * バが open 通知をまだ受けていない)場合、サーバはディスクにある中身が真でバー
	 * ジョンは既知であることを示すため `null` を送信することができる(ドキュメン
	 * トコンテントの所有権で指定されている通り)。
	 * ドキュメントのバージョン番号は undo/redo を含むドキュメントへの変更で増加
	 * する。数字は連続である必要はない。
	 */
	version: number | null;
}

TextDocumentPositionParams

1.0 では TextDocumentPosition はインラインパラメータであった。

テキストドキュメントとその中での位置をリクエストに渡すために使われるパラメータリテラル。

interface TextDocumentPositionParams {
	/**
	 * テキストドキュメント。
	 */
	textDocument: TextDocumentIdentifier;

	/**
	 * テキストドキュメント内の位置。
	 */
	position: Position;
}

DocumentFilter

ドキュメントフィルタは language、scheme、patternを通してドキュメントを記述する。例としてディスク上の TypeScript ファイルを表わす。もう一つの例は package.json という名前の JSON ファイルを示すフィルタである:

{ "language": "typescript", "scheme": "file" }
{ "language": "json", "pattern": "**/package.json" }

export interface DocumentFilter {
	/**
	 * `typescript` のような言語識別子。
	 */
	language?: string;

	/**
	 * `file` や `untitled` のような URI のスキーマ(#Uri.scheme)。
	 */
	scheme?: string;

	/**
	 * `*.{ts,js}` のような glob パターン。
	 *
	 * glob パターンは次の構文を持つ:
	 * - `*` はパス区切りの中の1文字以上にマッチする
	 * - `?` はパス区切りの中の1文字にマッチする
	 * - `**` はパス区切りが無いことも含む任意の数のパス区切りにマッチする
	 * - `{}` は条件のグループ化(例えば、`**/*.{ts,js}` は全ての TypeScript と JavaScript ファイルにマッチする)
	 * - `[]` はパス区切りの中のマッチする文字の範囲を示す(例えば、`example.[0-9]` は `example.0`、`example.1`、… にマッチする)
	 * - `[!...]` はパス区切りの中のマッチしない文字の範囲を示す(例えば、`example.[!0-9]` は`example.a`、`example.b`、にはマッチするが `example.0` にはマッチしない)
	 */
	pattern?: string;
}

ドキュメントセレクタは1つ以上のドキュメントフィルタを組み合わせたものである。

export type DocumentSelector = DocumentFilter[];

StaticRegistrationOptions

静的な登録オプションは、後に機能の登録解除をするために与えられたサーバコントロール ID での初期化時の機能を登録できる。

/**
 * `initialize` リクエストで返される静的な登録オプション。
 */
interface StaticRegistrationOptions {
	/**
	 * リクエストを登録するために使われる ID。この ID はリクエストを解除するため
	 * に使うことができる。Registration#id も参照。
	 */
	id?: string;
}

TextDocumentRegistrationOptions

テキストドキュメントの集まりに対する動的な登録リクエストのオプション。

/**
 * 一般的なテキストドキュメント登録オプション。
 */
export interface TextDocumentRegistrationOptions {
	/**
	 * 登録のスコープを識別するためのドキュメントセレクタ。null の場合クライアン
	 * ト側で提供されるドキュメントセレクタが使用される。
	 */
	documentSelector: DocumentSelector | null;
}

MarkupContent

MarkupContent リテラルは異なるフォーマットで表わすことのできるコンテントの文字列値を表わす。現在は plaintext と markdown がサポートされるフォーマットである。MarkupContent は大抵 CompletionItem か SignatureInformation の結果のプロパティとして使われる。

/**
 * クライアントがサポートする `Hover` や `ParameterInfo` や `CompletionItem` な
 * どのさまざまな結果のコンテントタイプを表わす。
 *
 * `MarkupKinds` は `$` から始まってはいけないことに注意する。これは内部的な用
 * 途のために予約されている。
 */
export namespace MarkupKind {
	/**
	 * plaintext はコンテントフォーマットとしてサポートされている
	 */
	export const PlainText: 'plaintext' = 'plaintext';

	/**
	 * markdown はコンテントフォーマットとしてサポートされている
	 */
	export const Markdown: 'markdown' = 'markdown';
}
export type MarkupKind = 'plaintext' | 'markdown';

/**
 * `MarkupContent` リテラルはその種別フラグで処理される中身の文字列値を表わす。
 * 現在はマークアップ種別として `plaintext` と `markdown` がサポートされている。
 *
 * 種別が `markdown` の場合値には GitHub issue のようなコードブロックを含めるこ
 * とができる。
 * https://help.github.com/articles/creating-and-highlighting-code-blocks/#syntax-highlighting を参照。
 *
 * JavaScript/TypeScript を用いてこのような文字列を構成する方法の例を示す:
 * ```typescript
 * let markdown: MarkdownContent = {
 *  kind: MarkupKind.Markdown,
 *	value: [
 *		'# Header',
 *		'Some text',
 *		'```typescript',
 *		'someCode();',
 *		'```'
 *	].join('\n')
 * };
 * ```
 *
 * *注意* クライアントは返ってきた markdown をサニタイズするかもしれない。クラ
 * イアントはスクリプト実行を避けるために markdown から HTML を削除することを決
 * 定できる。
 */
export interface MarkupContent {
	/**
	 * マークアップ種別
	 */
	kind: MarkupKind;

	/**
	 * コンテンツ
	 */
	value: string;
}

Work Done Progress

バージョン 3.15.0 から

作業進行状況は一般的な $/progress 通知を用いて報告される。作業進行状況通知のペイロードは3つの異なる形式を持つ。

Work Done Progress Begin

進行状況の報告を開始するには、次のペイロードを含む $/progress 通知を送らなければならない。

export interface WorkDoneProgressBegin {

	kind: 'begin';

	/**
   * 進行状況の必須のタイトル。行われた操作種別を簡潔に伝えるために使われる。
	 *
	 * 例えば: "Indexing" または "Linking dependencies"。
	 */
	title: string;

	/**
	 * ユーザが時間のかかる操作をキャンセルできるようにするためにキャンセルボタン
	 * を表示すべきかどうかを制御する。キャンセルをサポートしていないクライアント
	 * はこの設定を無視できる。
	 */
	cancellable?: boolean;

	/**
	 * オプション、進行状況の詳細。`title` の捕捉的な情報を含む。
	 *
	 * 例: "3/25 files", "project/src/module2", "node_modules/some_dep"
	 * セットされてない場合、以前のメッセージ(存在する場合)は有効のままである。
	 */
	message?: string;

	/**
	 * 画面に表示するオプションの進捗率(100は100%と考える)。与えられない場合は無
	 * 限の進捗率が仮定され、クライアントは後続のレポート通知の `percentage` 値を
	 * 無視できる。
	 *
	 * この値は単調に増加すべきである。クライアントはこのルールに従っていない値を
	 * 無視してもよい。
	 */
	percentage?: number;
}

Work Done Progress Report

作業進行状況を報告するには次のペイロードを用いる:

export interface WorkDoneProgressReport {

	kind: 'report';

	/**
	 * キャンセルボタンの有効無効を制御する。このプロパティは `WorkDoneProgressStart` ペイロードでキャンセルボタンが要求された場合のみ有効である。
	 *
	 * キャンセルをサポートしていない、またはボタンの有効無効の制御をサポートして
	 * いないクライアントはこの設定を無視できる。
	 */
	cancellable?: boolean;

	/**
	 * オプション、進行状況の詳細。`title` の捕捉的な情報を含む。
	 *
	 * 例: "3/25 files", "project/src/module2", "node_modules/some_dep"
	 * セットされてない場合、以前のメッセージ(存在する場合)は有効のままである。
	 */
	message?: string;

	/**
	 * 画面に表示するオプションの進捗率(100は100%と考える)。与えられない場合は無
	 * 限の進捗率が仮定され、クライアントは後続のレポート通知の `percentage` 値を
	 * 無視できる。
	 *
	 * この値は単調に増加すべきである。クライアントはこのルールに従っていない値を
	 * 無視してもよい。
	 */
	percentage?: number;
}

Work Done Progress End

作業進行状況の報告を終了するには次のペイロードを用いる:

export interface WorkDoneProgressEnd {

	kind: 'end';

	/**
	 * オプション、操作の結果を示すなどの最後のメッセージを指す。
	 */
	message?: string;
}

Initating Work Done Progress

作業進行状況は二つの異なる方法で始められる:

リクエストパラメータで事前に定義された workDoneToken プロパティを用いてリクエスト送信者(大抵はクライアント)によって開始される。
window/workDoneProgress/create リクエストを用いてサーバによって開始される。

クライアントが textDocument/reference リクエストをサーバニ送信し、クライアントはリクエストで作業進行状況の報告を許可した場合を考える。サーバにそれを伝えるために、クライアントは textDocument/reference リクエストパラメータに workDoneToken プロパティを追加する。このようにである:

{
	"textDocument": {
		"uri": "file:///folder/file.ts"
	},
	"position": {
		"line": 9,
		"character": 5
	},
	"context": {
		"includeDeclaration": true
	},
	// 作業進行状況の報告に使われるトークン。
	"workDoneToken": "1d546990-40a3-4b77-b134-46622995f6ae"
}

サーバは workDoneToken を用いて指定された textDocument/reference の進行状況を報告する。そのための $/progress 通知パラメータはこのようになる:

{
	"token": "1d546990-40a3-4b77-b134-46622995f6ae",
	"value": {
		"kind": "begin",
		"title": "Finding references for A#foo",
		"cancellable": false,
		"message": "Processing file X.ts",
		"percentage": 0
	}
}

サーバが開始した作業の進行状況も同じように機能する。唯一の違いはサーバが window/workDoneProgress/create リクエストを用いて進行状況を示す UI をリクエストし、その後の report で使われるトークンを提供することである。

Signaling Work Done Progress Reporting

プロトコルの後方互換性を担保するために、サーバはクライアントが次で定義される window.workDoneProgress 機能を提供する場合のみ、作業進行状況の報告が許可されている。

	/**
	 * Window specific client capabilities.
	 */
	window?: {
		/**
		 * クライアントが `$/progress` 通知の処理をサポートするかどうか。
		 */
		workDoneProgress?: boolean;
	}

クライアントがリクエストを送信する前にクライアントが進行状況を表示する UI を準備することを避けるために、サーバが実際に進行状況を報告しない場合、サーバは対応するサーバ機能 workDoneProgress を伝えなければならない。上記の textDocument/reference の例ではサーバ機能の referenceProvide プロパティを次のように設定することでサポートすることを通知する。

{
	"referencesProvider": {
		"workDoneProgress": true
	}
}

WorkDoneProgressParams

プログレストークンを渡すために使われるパラメータリテラル。

export interface WorkDoneProgressParams {
	/**
	 * 作業進行状況を報告するために使われるオプションのトークン。
	 */
	workDoneToken?: ProgressToken;
}

WorkDoneProgressOptions

サーバ機能で進行状況報告のサポートを伝えるためのオプション。

export interface WorkDoneProgressOptions {
	workDoneProgress?: boolean;
}

Partial Result Progress

バージョン 3.15.0 から

部分的な結果は一般的な $/progress 通知を用いて報告される。部分的な結果の進行状況通知のペイロードは多くの場合、最終的な結果と同一である。例えば、 workspace/symbol リクエストは結果の型として SymbolInformation[] を持つ。部分的な結果も SymbolInformation[] 型を持つ。クライアントがリクエストの部分的な結果通知を許可するかはリクエストパラメータの partialResultToken を追加することで伝えられる。例えば、作業と部分的結果の進行状況をサポートする textDocument/reference リクエストは次のようになる:

{
	"textDocument": {
		"uri": "file:///folder/file.ts"
	},
	"position": {
		"line": 9,
		"character": 5
	},
	"context": {
		"includeDeclaration": true
	},
	// 作業進行状況の報告に使われるトークン。
	"workDoneToken": "1d546990-40a3-4b77-b134-46622995f6ae",
	// 部分的な結果の報告に使われるトークン。
	"partialResultToken": "5f6f349e-4f81-4a3b-afff-ee04bff96804"
}

partialResultToken は textDocument/reference リクエストの部分的な結果を報告するために使われる。

サーバが $/progress への対応により部分的な結果を報告する場合、結果全体は n 個の $/progress 通知で行わなければならない。最終的なレスポンスは結果の値の項が空でなければならない。これは、他の部分的な結果や結果の置き換えなどの最終的な結果をどの様に処理すべきかという混乱を避けるためである。

レスポンスがエラーを返す場合、与えられた部分的な結果を次のように扱うべきである:

code が RequestCancelled であるとき: クライアントは提供された結果を使うかは自由であるが、リクエストがキャンセルされたか未完了であるかは明確にするべきである。
その他の場合は部分的な結果を使用するべきではない。

PartialResultParams

部分的な結果のトークンを渡すために使われるパラメータリテラル。

export interface PartialResultParams {
	/**
	 * サーバがクライアントへ部分的な結果(例えばストリーミング)を報告するために使
	 * 用できるオプションのトークン。
	 */
	partialResultToken?: ProgressToken;
}

Actual Protocol

このセクションは実際の LSP のドキュメントである。次のフォーマットに従う:

リクエストについて記述するヘッダ
省略可能な クライアント機能 セクションはリクエストのクライアント機能を記述する。クライアント機能へのパスや JSON 構造も記述される。
省略可能な サーバ機能 セクションはリクエストのサーバ機能を記述する。サーバ機能へのパスや JSON 構造も記述される。
リクエスト セクションは送信するリクエストのフォーマットを記述する。メソッドはリクエストを識別する文字列で、パラメータは TypeScript インターフェイスを用いて記述される。
レスポンス セクションはレスポンスのフォーマットを記述する。結果は成功時に返すデータを示す。省略可能な部分結果は部分的な結果通知で返却するデータを記述する。error.data はエラー時に返すデータを記述する。失敗時はレスポンスにはすでに error.code と error.message フィールドがすでに含まれていることを覚えておくこと。これらのフィールドは特定のエラーコードまたはメッセージの使用を強制する場合にのみ指定される。サーバが自由に指定することを決定できる場合、ここには提示されない。
登録オプション セクションはリクエストまたは通知が動的な機能登録をサポートする場合の登録オプションを記述する。

Request, Notification and Response ordering

リクエストへのレスポンスはおおよそリクエストがサーバまたはクライアント側に届いた順番に送信されるべきである。例えばサーバが textDocument/completion リクエストを受けてから textDocument/signatureHelp を受信した場合、大抵まずは textDocument/completion のレスポンスから返され、その後 textDocument/signatureHelp のレスポンスが返される。

ただし、サーバは並列実行する可能性があり、リクエストを受けた順と異なる順でレスポンスを返したい可能性もある。サーバはレスポンスの正確さに影響しない限り、このような順序変更を行うことができる。例えば textDocument と textDocument/signatureHelp は大抵出力順序が影響しないため、順序交換は可能である。一方 textDocument/definition と textDocument/rename は後者の実行が前者に影響するため、恐らくサーバは順序を交換すべきではない。

Server lifetime

現在のプロトコル使用ではサーバのライフサイクルはクライアント(例えば VS Code や Emacs のようなツール)によって管理されるように定義している。クライアント次第でサーバ(プロセス)の起動やシャットダウンが決定される。

Initialize Request

Initialize リクエストはクライアントからサーバへ送られる最初のリクエストである。サーバがリクエストまたは通知を initialize リクエストより前に受けた場合は次のように振る舞うべきである:

リクエストに対し code: -32002 であるエラーをレスポンスとして返すべきである。メッセージはサーバが選択することができる。
通知は exit 通知を除き、無視するべきである。initialize リクエストを受けることなくサーバは終了することができる。

サーバが initialize リクエストに InitializeResult で応答するまで、クライアントはサーバに追加のリクエスト及び通知を送信してはならない。加えて、サーバは InitializeResult を応答するまでリクエストまたは通知をクライアントに送信してはならない、例外として initilize リクエストの処理中、サーバは window/showMessage、window/logMessage、telemetry/event 通知や window/showMessageRequest リクエストをクライアントに送信することができる。

initialize リクエストは一度だけ送信される。

リクエスト:

メソッド: initialize
パラメータ: 次のように定義される InitializedParams:

interface InitializeParams {
	/**
	 * サーバを起動した親プロセスのプロセス ID。プロセスが他のプロセスから起動さ
	 * れていない場合は null となる。
	 * 親プロセスが死んでいる場合は、サーバは自身のプロセスを終了すべきである
	 * (`exit` 通知を参照)。
	 */
	processId: number | null;

	/**
	 * クライアントについての情報
	 *
	 * @since 3.15.0
	 */
	clientInfo?: {
		/**
		 * クライアント自身により定義されたクライアントの名前。
		 */
		name: string;

		/**
		 * クライアント自身により定義されたクライアントのバージョン。
		 */
		version?: string;
	};

	/**
   * ワークスペースの `rootPath`。フォルダを開いていない場合は null となる。
	 *
	 * @deprecated rootUri を用いる
	 */
	rootPath?: string | null;

	/**
	 * ワークスペースの `rootUri`。フォルダを開いていない場合は null となる。
	 * `rootPath` と `rootUri` が指定されている場合は `rootUri` が優先される。
	 */
	rootUri: DocumentUri | null;

	/**
	 * ユーザが提供する初期化オプション。
	 */
	initializationOptions?: any;

	/**
	 * クライアント(エディタまたはツール)から提供される機能
	 */
	capabilities: ClientCapabilities;

	/**
	 * トレースの初期設定。省略した場合、トレースは無効('off')となる。
	 */
	trace?: 'off' | 'messages' | 'verbose';

	/**
	 * サーバ開始時にクライアアントで設定されるワークスペースフォルダ。
	 * このプロパティはクライアントがワークスペースフォルダをサポートするときのみ
	 * 表われる。
	 * クライアントがワークスペースフォルダをサポートしているが設定しない場合は
	 * `null` を指定できる。
	 *
	 * 3.6.0 から
	 */
	workspaceFolders?: WorkspaceFolder[] | null;
}

ClientCapabilities、TextDocumentClientCapabilities は次のように定義される:

`TextDocumentClientCapabilities` define capabilities the editor / tool provides on text documents.

/**
 * テキストドキュメント固有のクライアントの機能。
 */
export interface TextDocumentClientCapabilities {

	synchronization?: TextDocumentSyncClientCapabilities;

	/**
	 * `textDocument/completion` リクエスト固有の機能。
	 */
	completion?: CompletionClientCapabilities;

	/**
	 * `textDocument/hover` リクエスト固有の機能。
	 */
	hover?: HoverClientCapabilities;

	/**
	 * `textDocument/signatureHelp` リクエスト固有の機能。
	 */
	signatureHelp?: SignatureHelpClientCapabilities;

	/**
	 * `textDocument/declaration` リクエスト固有の機能。
	 *
	 * @since 3.14.0
	 */
	declaration?: DeclarationClientCapabilities;

	/**
	 * `textDocument/definition` リクエスト固有の機能。
	 *
	 * Since 3.14.0
	 */
	definition?: DefinitionClientCapabilities;

	/**
	 * `textDocument/typeDefinition` リクエスト固有の機能。
	 *
	 * @since 3.6.0
	 */
	typeDefinition?: TypeDefinitionClientCapabilities;

	/**
	 * `textDocument/implementation` リクエスト固有の機能。
	 *
	 * @since 3.6.0
	 */
	implementation?: ImplementationClientCapabilities;

	/**
	 * `textDocument/references` リクエスト固有の機能。
	 */
	references?: ReferenceClientCapabilities;

	/**
	 * `textDocument/documentHighlight` リクエスト固有の機能。
	 */
	documentHighlight?: DocumentSymbolClientCapabilities;

	/**
	 * `textDocument/documentSymbol` リクエスト固有の機能。
	 */
	documentSymbol?: DocumentSymbolClientCapabilities;

	/**
	 * `textDocument/codeAction` リクエスト固有の機能。
	 */
	codeAction?: CodeActionClientCapabilities;

	/**
	 * `textDocument/codeLens` リクエスト固有の機能。
	 */
	codeLens?: CodeLensClientCapabilities;

	/**
	 * `textDocument/documentLink` リクエスト固有の機能。
	 */
	documentLink?: DocumentLinkClientCapabilities;

	/**
	 * `textDocument/documentColor` と `textDocument/colorPresentation` リクエス
	 * ト固有の機能。
	 *
	 * @since 3.6.0
	 */
	colorProvider?: DocumentColorClientCapabilities;

	/**
	 * `textDocument/formatting` リクエスト固有の機能。
	 */
	formatting?: DocumentFormattingClientCapabilities;

	/**
	 * `textDocument/rangeFormatting` リクエスト固有の機能。
	 */
	rangeFormatting?: DocumentRangeFormattingClientCapabilities;

	/**
	 * `textDocument/onTypeFormatting` リクエスト固有の機能。
	 */
	onTypeFormatting?: DocumentOnTypeFormattingClientCapabilities;

	/**
	 * `textDocument/rename` リクエスト固有の機能。
	 */
	rename?: RenameClientCapabilities;

	/**
	 * `textDocument/publishDiagnostics` 通知固有の機能。
	 */
	publishDiagnostics?: PublishDiagnosticsClientCapabilities;

	/**
	 * `textDocument/foldingRange` リクエスト固有の機能。
	 *
	 * @since 3.10.0
	 */
	foldingRange?: FoldingRangeClientCapabilities;
}

ClientCapabilities はクライアントがサポートする動的な機能登録、ワークスペース、テキストドキュメント機能を定義する。experimental は開発中の実験機能を渡すために使われる。将来の互換性のため ClientCapabilities オブジェクトは現在定義されている以上のプロパティを設定できる。サーバが不明なプロパティを持つ ClientCapabilities オブジェクトを受け取った場合、それらを無視すべきである。見付からないプロパティは提供していない機能であると解釈すべきである。見付からないプロパティがサブプロパティを定義している場合、全てのサブプロパティは対応する機能がないと解釈すべきである。

クライアント機能は LSP バージョン 3.0 から導入された。そのため 3.x 以降で導入された機能のみ記述する。バージョン 2.x から存在した機能は引き続きクライアントで必須である。クライアントはそれらの提供をオプトアウトできない。そのためクライアントが ClientCapabilities.textDocument.synchronization を省略した場合であっても、テキストドキュメント同期は必須である(例えば open、changed、close 通知)。

interface ClientCapabilities {
	/**
	 * ワークスペース固有のクライアント機能。
	 */
	workspace?: {
		/**
		* クライアントは `workspace/applyEdit` リクエストをサポートすることにより、
		* ワークスペースへのバッチ編集をサポートする。
		*/
		applyEdit?: boolean;

		/**
		* `WorkspaceEdit` 固有の機能。
		*/
		workspaceEdit?: WorkspaceEditClientCapabilities;

		/**
		* `workspace/didChangeConfiguration` 通知固有の機能。
		*/
		didChangeConfiguration?: DidChangeConfigurationClientCapabilities;

		/**
		* `workspace/didChangeWatchedFiles` 通知固有の機能。
		*/
		didChangeWatchedFiles?: DidChangeWatchedFilesClientCapabilities;

		/**
		* `workspace/symbol` リクエスト固有の機能。
		*/
		symbol?: WorkspaceSymbolClientCapabilities;

		/**
		* `workspace/executeCommand` リクエスト固有の機能。
		*/
		executeCommand?: ExecuteCommandClientCapabilities;
	};

	/**
	 * テキストドキュメント固有のクライアント機能。
	 */
	textDocument?: TextDocumentClientCapabilities;

	/**
	 * 実験的なクライアント機能。
	 */
	experimental?: any;
}

レスポンス:

結果: 次で定義される InitializeResult:

interface InitializeResult {
	/**
	 * サーバが提供する機能。
	 */
	capabilities: ServerCapabilities;

	/**
	 * サーバについての情報。
	 *
	 * @since 3.15.0
	 */
	serverInfo?: {
		/**
		 * サーバ自身により定義されるサーバの名前。
		 */
		name: string;

		/**
		 * サーバ自身により定義されるサーバのバージョン。
		 */
		version?: string;
	};
}

error.code:

/**
 * `InitializeError` エラーコード。
 */
export namespace InitializeError {
	/**
	 * クライアントが提供するプロトコルバージョンをサーバが処理できない場合。
	 * @deprecated この初期化エラーはクライアント機能によって置き換えられた。バー
	 * ジョン 3.0x ではバージョンハンドシェイクは行われない。
	 */
	export const unknownProtocolVersion: number = 1;
}

error.data:

interface InitializeError {
	/**
	 * 次のようなリトライをクライアントが実行するかどうかを示す:
	 * (1) `ResponseError` で提供されたメッセージをユーザに見せる。
	 * (2) ユーザはリトライするかキャンセルするかを選択する。
	 * (3) ユーザがリトライを選択した場合、`initialize` メソッドをもう一度送信する。
	 */
	retry: boolean;
}

サーバは次の機能を通知できる:

/**
 * コマンド実行オプション。
 */
export interface ExecuteCommandOptions {
	/**
	 * サーバで実行されるコマンド。
	 */
	commands: string[]
}

interface ServerCapabilities {
	/**
	 * どのようにテキストドキュメントが同期されるかを定義する。それぞれの通知を定
	 * 義する詳細な構造または後方互換性のための `TextDocumentSyncKind` のいずれか
	 * である。省略した場合はデフォルトで `TextDocumentSyncKind.None` となる。
	 */
	textDocumentSync?: TextDocumentSyncOptions | number;

	/**
	 * サーバが補完機能を提供するかどうか。
	 */
	completionProvider?: CompletionOptions;

	/**
	 * サーバがホバー機能を提供するかどうか。
	 */
	hoverProvider?: boolean | HoverOptions;

	/**
	 * サーバがシグネチャヘルプ機能を提供するかどうか。
	 */
	signatureHelpProvider?: SignatureHelpOptions;

	/**
	 * サーバが宣言元ジャンプ機能を提供するかどうか。
	 *
	 * @since 3.14.0
	 */
	declarationProvider?: boolean | DeclarationOptions | DeclarationRegistrationOptions;

	/**
	 * サーバが定義ジャンプ機能を提供するかどうか。
	 */
	definitionProvider?: boolean | DefinitionOptions;

	/**
	 * サーバが型定義ジャンプ機能を提供するかどうか。
	 *
	 * @since 3.6.0
	 */
	typeDefinitionProvider?: boolean | TypeDefinitionOptions | TypeDefinitionRegistrationOptions;

	/**
	 * サーバが実装先ジャンプ機能を提供するかどうか。
	 *
	 * @since 3.6.0
	 */
	implementationProvider?: boolean | ImplementationOptions | ImplementationRegistrationOptions;

	/**
	 * サーバがリファレンス機能を提供するかどうか。
	 */
	referencesProvider?: boolean | ReferenceOptions;

	/**
	 * サーバがドキュメントハイライト機能を提供するかどうか。
	 */
	documentHighlightProvider?: boolean | DocumentHighlightOptions;

	/**
	 * サーバがドキュメントシンボル機能を提供するかどうか。
	 */
	documentSymbolProvider?: boolean | DocumentSymbolOptions;

	/**
	 * サーバがコードアクション機能を提供するかどうか。`CodeActionOptions` はクラ
	 * イアントが `textDocument.codeAction.codeActionLiteralSupport` プロパティで
	 * コードアクションリテラルをサポートすることを伝えた場合のみ有効な型である。
	 */
	codeActionProvider?: boolean | CodeActionOptions;

	/**
	 * サーバがコードレンズ機能を提供するかどうか。
	 */
	codeLensProvider?: CodeLensOptions;

	/**
	 * サーバがドキュメントリンク機能を提供するかどうか。
	 */
	documentLinkProvider?: DocumentLinkOptions;

	/**
	 * サーバが色参照機能を提供するかどうか。
	 *
	 * @since 3.6.0
	 */
	colorProvider?: boolean | DocumentColorOptions | DocumentColorRegistrationOptions;

	/**
	 * サーバがドキュメントフォーマット機能を提供するかどうか。
	 */
	documentFormattingProvider?: boolean | DocumentFormattingOptions;

	/**
	 * サーバが範囲ドキュメントフォーマット機能を提供するかどうか。
	 */
	documentRangeFormattingProvider?: boolean | DocumentRangeFormattingOptions;

	/**
	 * サーバが入力中ドキュメントフォーマット機能を提供するかどうか。
	 */
	documentOnTypeFormattingProvider?: DocumentOnTypeFormattingOptions;

	/**
	 * サーバがリネーム機能を提供するかどうか。`RenameOptions` はクライアントが
	 * `initialize` リクエストで `prepareSupport` を提供する場合のみ指定される可
	 * 能性がある。
	 */
	renameProvider?: boolean | RenameOptions;

	/**
	 * サーバが折り畳み機能を提供するかどうか。
	 *
	 * @since 3.10.0
	 */
	foldingRangeProvider?: boolean | FoldingRangeOptions | FoldingRangeRegistrationOptions;

	/**
	 * サーバがコマンド実行機能を提供するかどうか。
	 */
	executeCommandProvider?: ExecuteCommandOptions;

	/**
	 * サーバがワークスペースシンボル機能を提供するかどうか。
	 */
	workspaceSymbolProvider?: boolean;

	/**
	 * ワークスペース固有のサーバ機能。
	 */
	workspace?: {
		/**
		 * サーバがワークスペースフォルダ機能をサポートするかどうか。
		 *
		 * @since 3.6.0
		 */
		workspaceFolders?: WorkspaceFoldersServerCapabilities;
	}

	/**
	 * 実験的なサーバ機能
	 */
	experimental?: any;
}

Initialized notification

Initialized 通知はクライアントが initialize リクエストの結果を受け取ってからその他のリクエストまたは通知をサーバへ送る前にクライアントからサーバへ送信される。サーバは initialized 通知を例えば動的な機能登録に使用できる。 initialized 通知は一度だけ送信される。

通知:

メソッド: initialized
パラメータ: 次で定義される InitializedParams:

interface InitializedParams {
}

Shutdown Request

shutdown リクエストはクライアントからサーバへ送信される。サーバをシャットダウンするよう要求するが、終了はしない(そうしなければレスポンスが正しくクライアントに送信されない可能性がある)。サーバに終了を要求するための exit 通知が別にある。クライアントは exit 以外の通知またはリクエストを shutdown リクエストを送ったサーバへ送信してはならない。サーバが shutdown リクエストの後にリクエストを受信した場合、それらは InvalidRequest エラーとなる。

リクエスト:

メソッド: shutdown
パラメータ: 空

レスポンス:

結果: null
エラー: エラーコードと shutdown リクエスト中に発生した例外がセットされたメッセージ。

Exit notification

サーバ自身のプロセスの終了を要求するための通知。サーバは事前に shutdown リクエストを受信していた場合は success コード0で終了すべきであり、それ以外の場合は error コード1で終了する。

通知:

メソッド: exit
パラメータ: 空

ShowMessage Notification

window/showMessage 通知はクライアントに UI 上に特定のメッセージの表示を要求するためにサーバからクライアントに送信される。

通知:

メソッド: window/showMessage
パラメータ: 次で定義される ShowMessageParams:

interface ShowMessageParams {
	/**
	 * メッセージ種別。{@link MessageType} を参照。
	 */
	type: number;

	/**
	 * 実際のメッセージ。
	 */
	message: string;
}

type は次のように定義される:

export namespace MessageType {
	/**
	 * エラーメッセージ。
	 */
	export const Error = 1;
	/**
	 * 警告メッセージ。
	 */
	export const Warning = 2;
	/**
	 * 情報メッセージ。
	 */
	export const Info = 3;
	/**
	 * ログメッセージ。
	 */
	export const Log = 4;
}

ShowMessage Request

window/showMessageRequest リクエストはクライアントに UI 上に特定のメッセージの表示を要求するためにサーバからクライアントに送信される。window/showMessage 通知に加えてリクエストにアクションを渡すことができ、クライアントからの応答を待つことができる。

リクエスト:

メソッド: window/showMessageRequest
パラメータ: 次で定義される ShowMessageRequestParams:

レスポンス:

結果: 選択された MessageActionItem または選択されていない場合は null
エラー: エラーコードと window/showMessageRequest リクエスト中に発生した例外がセットされたメッセージ。

interface ShowMessageRequestParams {
	/**
	 * メッセージ種別。{@link MessageType} を参照。
	 */
	type: number;

	/**
	 * 実際のメッセージ。
	 */
	message: string;

	/**
	 * 表示するためのメッセージアクション。
	 */
	actions?: MessageActionItem[];
}

MessageActionItem は次のように定義される。

interface MessageActionItem {
	/**
	 * 'Retry'、'Open Log' などのような短いタイトル。
	 */
	title: string;
}

LogMessage Notification

window/logMessage 通知はクライアントに特定のメッセージをログに残す要求をするためにサーバからクライアントに送信される。

通知:

メソッド: window/logMessage
パラメータ: 次で定義される LogMessageParams:

interface LogMessageParams {
	/**
	 * メッセージ種別。{@link MessageType} を参照。
	 */
	type: number;

	/**
	 * 実際のメッセージ。
	 */
	message: string;
}

Creating Work Done Progress

window/workDoneProgress/create リクエストはクライアントに作業進行状況を作成させるためにサーバからクライアントに送信される。

リクエスト:

メソッド: window/workDoneProgress/create
パラメータ: 次で定義される WorkDoneProgresCreateParams:

export interface WorkDoneProgressCreateParams {
	/**
	 * 進行状況報告に使われるトークン。
	 */
	token: ProgressToken;
}

レスポンス:

結果: 空
エラー: エラーコードと window/workDoneProgress/create リクエスト中に発生した例外がセットされたメッセージ。エラーが発生した場合、サーバは WorkDoneProgressCreateParams で受け取ったトークンに対してどのような進行状況通知も送信してはならない。

Telemetry Notification

telemetry/event 通知はクライアントにテレメトリのログ保存を要求するためにサーバからクライアントに送信される。

通知:

メソッド: telemetry/event
パラメータ: any

Register Capability

client/registerCapability リクエストはクライアント上の新たな機能を登録するためにサーバから送信される。全てのクライアントが動的な機能登録をサポートする必要はない。クライアントは特定のクライアント機能の dynamicRegistration プロパティによってオプトインする。クライアントは機能 A については動的な登録を提供するが、機能 B については提供しない、ということも可能である (TextDocumentClientCapabilities を例として参照)。

サーバは同じドキュメントセレクタに対する初期化時の静的に登録される機能と動的に登録される同じ機能を双方登録してはならない。サーバが静的、動的双方の登録をサポートする場合、initialize リクエスト時にクライアント機能を確認し、クライアントがその機能について動的な登録をサポートしていない場合は静的な機能登録のみ行なわなければならない。

リクエスト:

メソッド: client/registerCapability
パラメータ: RegistrationParams

RegistrationParams は次のように定義される:

/**
 * 機能の登録のための一般的なパラメータ。
 */
export interface Registration {
	/**
	 * リクエストを登録するために使われる ID。この ID は登録の解除に再度使用でき
	 *  る。
	 */
	id: string;

	/**
	 * 登録するメソッド/機能。
	 */
	method: string;

	/**
	 * 登録に必要なオプション。
	 */
	registerOptions?: any;
}

export interface RegistrationParams {
	registrations: Registration[];
}

ほとんどの登録オプションはドキュメントセレクタの指定を必要なため、基となるインターフェイスがある。

export interface TextDocumentRegistrationOptions {
	/**
	 * 登録のスコープを識別するためのドキュメントセレクタ。null の場合クライアン
	 * ト側で提供されるドキュメントセレクタが使用される。
	 */
	documentSelector: DocumentSelector | null;
}

クライアント上の textDocument/willSaveWaitUntil 機能を動的に登録するための JSON RPC の例は次のようになる(概要のみ):

{
	"method": "client/registerCapability",
	"params": {
		"registrations": [
			{
				"id": "79eee87c-c409-4664-8102-e03263673f6f",
				"method": "textDocument/willSaveWaitUntil",
				"registerOptions": {
					"documentSelector": [
						{ "language": "javascript" }
					]
				}
			}
		]
	}
}

このメッセージはサーバからクライアントに送信され、クライアントで正常に実行された後、JavaScript テキストドキュメントへの textDocument/willSaveWaitUntil リクエストがクライアントからサーバへ送信される。

レスポンス:

結果: void
エラー: エラーコードとリクエスト中に発生した例外がセットされたメッセージ。

Unregister Capability

client/unregisterCapability リクエストは以前に登録された機能を解除するためにサーバからクライアントに送信される。

リクエスト:

メソッド: client/unregisterCapability
パラメータ: UnregistrationParams

UnregistrationParams は次のように定義される:

/**
 * 機能登録解除の一般的はパラメータ。
 */
export interface Unregistration {
	/**
	 * リクエストまたは通知を登録解除するために使われる ID。ID はたいてい登録リク
	 * エスト中に与えられる。
	 */
	id: string;

	/**
	 * 登録解除するメソッド/機能。
	 */
	method: string;
}

export interface UnregistrationParams {
	unregisterations: Unregistration[];
}

上で登録した textDocument/willServeWaitUntil 機能を解除するための JSON RPC の例はこのようになる:

{
	"method": "client/unregisterCapability",
	"params": {
		"unregisterations": [
			{
				"id": "79eee87c-c409-4664-8102-e03263673f6f",
				"method": "textDocument/willSaveWaitUntil"
			}
		]
	}
}

レスポンス:

結果: void
エラー: エラーコードとリクエスト中に発生した例外がセットされたメッセージ。

Workspace folders request

バージョン 3.6.0 から

多くのツールがワークスペース毎に一つ以上のルートフォルダをサポートする。例えば VS Code のマルチルートや Atom のプロジェクトフォルダ Sublime のプロジェクトがある。クライアントのワークスペースが複数のルートからなる場合、大抵サーバはそれについて知っておく必要がある。ここまでのプロトコルはサーバから通知される InitializeParams の rootUri プロパティがルートフォルダであると仮定する。クライアントがワークスペースフォルダをサポートし、それをクライアントの機能 workspaceFolders で通知している場合、InitializeParams にはサーバ起動時のワークスペースフォルダの設定値である workspaceFolders プロパティが含まれる。

workspace/workspaceFolders リクエストは現在開いているワークスペースフォルダのリストを取得するためにサーバからクライアントへ送信される。ツールが一つのファイルしか開いていない場合 null が返される。ワークスペースは開かれているがフォルダが設定されていない場合は空配列が返される。

クライアント機能:

プロパティパス(省略可能): workdpace.workspaceFolders
プロパティタイプ: boolean

サーバ機能:

プロパティパス(省略可能): workdpace.workspaceFolders
プロパティタイプ: 次で定義される WorkspaceFoldersServerCapabilities:

export interface WorkspaceFoldersServerCapabilities {
	/**
	 * サーバがワークスペースフォルダをサポートするかどうか。
	 */
	supported?: boolean;

	/**
	 * サーバが `workspace/didChangeWorkspaceFolders` 通知を受信するかどうか。
	 *
	 * 文字列が与えられた場合、その文字列はクライアント側で登録された通知の ID と
	 * して扱われる。ID は `client/unregisterCapability` リクエストによる登録解除
	 * に使うことができる。
	 */
	changeNotifications?: string | boolean;
}

リクエスト:

メソッド: workspace/workspaceFolders
パラメータ: なし

レスポンス:

結果: 次で定義される WorkspaceFolder[] | null

export interface WorkspaceFolder {
	/**
	 * このワークスペースフォルダの URI。
	 */
	uri: DocumentUri;

	/**
	 * ワークスペースフォルダ名。UI 上でこのワークスペースフォルダと関連付けるた
	 * めに使われる。
	 */
	name: string;
}

エラー: エラーコードと workspace/workspaceFolders リクエスト中に発生した例外がセットされたメッセージ。

DidChangeWorkspaceFolders Notification

バージョン 3.6.0 から

workspace/didChangeWorkspaceFolders 通知はワークスペース設定が変更されたことをサーバに通知するためにクライアントから送信される。クライアント機能の workspace.workspaceFolders とサーバ機能の workspace.workspaceFolders.supported が双方 true の場合、またはサーバ自身がこの通知の受けることを登録した場合、通知はデフォルトで送信される。 workspace/didChangeWorkspaceFolders を登録するためにサーバからクライアントへ client/registerCapability リクエストを送る。登録パラメータは次の形式の registrations アイテムを持つ必要がある。id は機能の登録解除に使われるユニーク ID である(例では UUID を使用する):

{
	"id": "28c6150c-bd7b-11e7-abc4-cec278b6b50a",
	"method": "workspace/didChangeWorkspaceFolders"
}

通知:

メソッド: workspace/didChangeWorkspaceFolders
パラメータ: 次で定義される DidChangeWorkspaceFoldersParams

export interface DidChangeWorkspaceFoldersParams {
	/**
	 * 実際のワークスペースフォルダ変更イベント。
	 */
	event: WorkspaceFoldersChangeEvent;
}

/**
 * ワークスペースフォルダ変更イベント
 */
export interface WorkspaceFoldersChangeEvent {
	/**
	 * 追加されるワークスペースフォルダの配列
	 */
	added: WorkspaceFolder[];

	/**
	 * 削除されるワークスペースフォルダの配列
	 */
	removed: WorkspaceFolder[];
}

DidChangeConfiguration Notification

設定変更を知らせるためにクライアントからサーバに送信される通知。

クライアント機能:

プロパティパス(省略可能): workspace.didChangeConfiguration
プロパティタイプ: 次で定義される DidChangeConfigurationClientCapabilities:

export interface DidChangeConfigurationClientCapabilities {
	/**
	 * `workspace/didChangeConfiguration` リクエストが動的な登録をサポートするか
	 * どうか。
	 */
	dynamicRegistration?: boolean;
}

通知:

メソッド: workspace/didChangeConfiguration
パラメータ: 次で定義される DidChangeConfigurationParams:

interface DidChangeConfigurationParams {
	/**
	 * 実際に変更された設定。
	 */
	settings: any;
}

Configuration Request

バージョン 3.6.0 から

workspace/configuration リクエストはクライアントから設定を取得するためにサーバからクライアントに送信されるリクエスト。リクエストは一度にいくつかの設定を取得することもできる。返された設定の順序は渡された ConfigurationItems の順序と一致する(例えば、レスポンスの最初の要素はパラメータの最初の設定値となる)。

ConfigurationItem は尋ねたい設定セクション名と追加のスコープ URI から構成される。尋ねたい設定セクション名はサーバ側で定義され、クライアント上の設定値と一致している必要はない。そのため、サーバが設定 cpp.formatterOptions を聞こうとするが、クライアントは異なるレイアウトの XML に設定を保存している。必要な変換をするのはクライアント次第である。スコープ URI が与えられる場合、クライアントは与えられたリソースのスコープ内の設定を返す必要がある。クライアントが例えば EditorConfig で設定を管理していた場合、与えられたリソース URI の設定が返されるべきである。クライアントは与えられたスコープで設定が提供できない場合、返される配列には null を入れる必要がある。

クライアント機能:

プロパティパス(省略可能): workspace.configuration
プロパティタイプ: boolean

リクエスト:

メソッド: workspace/configuration
パラメータ: 次で定義される ConfigurationParams

export interface ConfigurationParams {
	items: ConfigurationItem[];
}

export interface ConfigurationItem {
	/**
	 * 設定セクションを取得するためのスコープ。
	 */
	scopeUri?: DocumentUri;

	/**
	 * 尋ねたい設定セクション。
	 */
	section?: string;
}

レスポンス:

結果: any[]
エラー: エラーコードと workspace/configuration リクエスト中に発生した例外がセットされたメッセージ。

DidChangeWatchedFiles Notification

ファイル監視通知はクライアントにより監視されたファイルへの変更を検出したときにクライアントからサーバへ送信される通知。サーバはそれらのファイルイベントを登録メカニズムを用いて登録することが推奨される。以前の実装ではクライアントはサーバが要求することなくファイルイベントを通知した。

サーバは自身のファイル監視メカニズムを走らせることができ、クライアントが提供するファイルイベントに頼らなくてもよい。ただし、次の理由により推奨はされない:

経験上、複数の OS に渡りサポートが必要な場合は特に、ディスク上のファイル監視を正しく行なうことは挑戦的である。
実装がなんらかのポーリングとタイムスタンプを比較するためにメモリ上にファイルツリーを保持している場合は特に、ファイル監視はリソースを使う。
クライアントは大抵一つ以上のサーバを起動する。全てのサーバが自身のファイル監視をするのであれば、CPU またはメモリの問題が発生する。
一般的に、サーバのほうがクライアントよりも実装することが多い。なのでこの問題はクライアント側で解決するほうがよい。

クライアント機能:

プロパティパス(省略可能): workspace.didChangeWatchedFiles
プロパティタイプ: 次で定義される DidChangeWatchedFilesClientCapabilities:

export interface DidChangeWatchedFilesClientCapabilities {
	/**
	 * `workspace/didChangeWatchedFiles` 通知が動的な機能登録をサポートするかどう
	 * か。現在のプロトコルではサーバ側からの静的な設定はサポートされていないこと
	 * を注意しておく。
	 */
	dynamicRegistration?: boolean;
}

登録オプション: 次で定義される DidChangeWatchedFilesRegistrationOptions:

/**
 * ファイルシステム変更イベントを登録する際に使われるオプションを記述する。
 */
export interface DidChangeWatchedFilesRegistrationOptions {
	/**
	 * 登録する監視。
	 */
	watchers: FileSystemWatcher[];
}

export interface FileSystemWatcher {
	/**
	 * 監視する glob パターン。
	 *
	 * glob パターンは次の構文を持つ:
	 * - `*` はパス区切りの中の1文字以上にマッチする
	 * - `?` はパス区切りの中の1文字にマッチする
	 * - `**` はパス区切りが無いことも含む任意の数のパス区切りにマッチする
	 * - `{}` は条件のグループ化(例えば、`**/*.{ts,js}` は全ての TypeScript と JavaScript ファイルにマッチする)
	 * - `[]` はパス区切りの中のマッチする文字の範囲を示す(例えば、`example.[0-9]` は `example.0`、`example.1`、… にマッチする)
	 * - `[!...]` はパス区切りの中のマッチしない文字の範囲を示す(例えば、`example.[!0-9]` は`example.a`、`example.b`、にはマッチするが `example.0` にはマッチしない)
	 */
	globPattern: string;

	/**
	 * 関心のあるイベント種別。省略した場合はデフォルトで 7 つまり
	 * WatchKind.Create | WatchKind.Change | WatchKind.Delete が指定される。
	 */
	kind?: number;
}

export namespace WatchKind {
	/**
	 * 作成イベントに関心がある。
	 */
	export const Create = 1;

	/**
	 * 変更イベントに関心がある。
	 */
	export const Change = 2;

	/**
	 * 削除イベントに関心がある。
	 */
	export const Delete = 4;
}

通知:

メソッド: workspace/didChangeWatchedFiles
パラメータ: 次で定義される DidChangeWatchedFilesParams:

interface DidChangeWatchedFilesParams {
	/**
	 * 実際のファイルイベント。
	 */
	changes: FileEvent[];
}

FileEvent は次のように記述される:

/**
 * ファイル変更を記述するイベント。
 */
interface FileEvent {
	/**
	 * ファイルの URI。
	 */
	uri: DocumentUri;
	/**
	 * 変更種別。
	 */
	type: number;
}

/**
 * ファイルイベント種別
 */
export namespace FileChangeType {
	/**
	 * ファイルが作成された。
	 */
	export const Created = 1;
	/**
	 * ファイルが変更された。
	 */
	export const Changed = 2;
	/**
	 * ファイルが削除された。
	 */
	export const Deleted = 3;
}

Workspace Symbols Request

ワークスペースシンボルリクエストはクエリ文字列に該当するプロジェクト全体のシンボルを一覧するためにクライアントからサーバへ送信される。

クライアント機能:

プロパティパス(省略可能): workspace.symbol
プロパティタイプ: 次で定義される WorkspaceSymbolClientCapabilities:

interface WorkspaceSymbolClientCapabilities {
	/**
	 * シンボルリクエストの動的な登録をサポートする
	 */
	dynamicRegistration?: boolean;

	/**
	 * `workspace/symbol` リクエスト内の `SymbolKind` 固有の機能。
	 */
	symbolKind?: {
		/**
		 * クライアントがサポートするシンボル種別の値。このプロパティが存在する場
		 * 合、クライアントは範囲外の値を適切に処理し、不明な場合はデフォルト値に
		 * フォールバックすることも保証する。
		 *
		 * このプロパティが与えられていない場合、クライアントは LSP の初期バージョ
		 * ンで定義されていた `File` から `Array` までのみをサポートする。
		 */
		valueSet?: SymbolKind[];
	}
}

サーバ機能:

プロパティパス(省略可能): workspaceSymbolProvider
プロパティタイプ: boolean | WorkspaceSymbolOptions。WorkspaceSymbolOptions は次で定義される:

export interface WorkspaceSymbolOptions extends WorkDoneProgressOptions {
}

登録オプション: 次で定義される WorkspaceSymbolRegistrationOptions:

export interface WorkspaceSymbolRegistrationOptions extends WorkspaceSymbolOptions {
}

リクエスト:

メソッド: workspace/symbol
パラメータ: 次のように定義される WorkspaceSymbolParams:

/**
 * ワークスペースシンボルリクエストのパラメータ。
 */
interface WorkspaceSymbolParams extends WorkDoneProgressParams, PartialResultParams {
	/**
	 * シンボルをフィルタするクエリ文字列。クライアントは全てのシンボルを要求する
	 * ためには空文字列を送信する。
	 */
	query: string;
}

レスポンス:

結果: 上で定義された SymbolInformation[] | null
部分的結果: 上で定義された SymbolInformation[]
エラー: エラーコードと workspace/symbol リクエスト中に発生した例外がセットされたメッセージ。

Execute a command

workspace/executeCommand リクエストはサーバ上でコマンドを実行するためにクライアントからサーバへ送信される。大抵の場合サーバは WorkspaceEdit 構造体を作成し、サーバからクライアントに送られる workspace/applyEdit を用いてワークスペースへの変更を適用する。

クライアント機能:

プロパティパス(省略可能): workspace.executeCommand
プロパティタイプ: 次で定義される ExecuteCommandClientCapabilities:

export interface ExecuteCommandClientCapabilities {
	/**
	 * コマンド実行が動的な機能登録をサポートするかどうか。
	 */
	dynamicRegistration?: boolean;
}

サーバ機能:

プロパティパス(省略可能): executeCommandProvider
プロパティタイプ: 次で定義される ExecuteCommandOptions:

export interface ExecuteCommandOptions extends WorkDoneProgressOptions {
	/**
	 * サーバで実行されるコマンド。
	 */
	commands: string[]
}

登録オプション: 次で定義される ExecuteCommandRegistrationOptions

/**
 * 実行コマンド登録オプション
 */
export interface ExecuteCommandRegistrationOptions extends ExecuteCommandOptions {
}

リクエスト:

メソッド: workspace/executeCommand
パラメータ: 次のように定義される ExecuteCommandParams:

export interface ExecuteCommandParams extends WorkDoneProgressParams {

	/**
	 * コマンドハンドラの識別子。
	 */
	command: string;
	/**
	 * コマンド実行時に渡すべき引数。
	 */
	arguments?: any[];
}

引数は通常、コマンドがサーバからクライアントに戻ってきた際に指定される。コマンドを返すリクエストは例えば textDocument/codeAction や textDocument/codeLens である。

レスポンス:

結果: any | null
エラー: エラーコードとリクエスト中に発生した例外がセットされたメッセージ。

Applies a WorkspaceEdit

workspace/applyEdit リクエストはクライアント側のリソースを変更するためにサーバからクライアントに送信される。

クライアント機能:

プロパティパス(省略可能): workspace.applyEdit
プロパティタイプ: boolean

ワークスペース編集でサポートされる機能は WorkspaceEditClientCapabilities も参照。

リクエスト:

メソッド: workspace/applyEdit
パラメータ: 次で定義される ApplyWorkspaceEditPrams:

export interface ApplyWorkspaceEditParams {
	/**
	 * ワークスペース編集のラベル。このラベルは UI で、ワークスペースへの編集を
	 * undo するための undo スタック上などで表示される。
	 */
	label?: string;

	/**
	 * 適用する編集。
	 */
	edit: WorkspaceEdit;
}

レスポンス:

結果: 次で定義される ApplyWorkspaceEditResponse:

export interface ApplyWorkspaceEditResponse {
	/**
	 * 編集が適用済みかどうかを指す。
	 */
	applied: boolean;

	/**
	 * 編集が適用されなかった理由を示す省略可能な概要。
	 * これはサーバが診断ログや編集を起こしたリクエストに適切なエラーを提供するた
	 * めに使われる場合もある。
	 */
	failureReason?: string;
}

エラー: エラーコードとリクエスト中に発生した例外がセットされたメッセージ。

Text Document Synchronization

LSP において textDocument/open、textDocument/change、textDocument/close 通知をクライアントがサポートすることは必須であり、クライアントはそれらのサポートをオプトアウトできない。加えてサーバはそれら全てを実装するか全く実装しないかのいずれかでなければならない。つまりこれらの機能はクライアントとサーバ機能の組み合わせにより制御される。

クライアント機能:

プロパティパス(省略可能): textDocument.synchronization.dynamicRegistration
プロパティタイプ: boolean

サーバ機能:

プロパティパス(省略可能): textDocumentSync
プロパティタイプ: 次で定義される TextDocumentSyncKind | TextDocumentSyncOptions:

/**
 * ホスト(エディタ)がドキュメント変更の同期をどのようにサーバに行うかを定義す
 * る。
 */
export namespace TextDocumentSyncKind {
	/**
	 * ドキュメントは全て同期されるべきでない。
	 */
	export const None = 0;

	/**
	 * ドキュメントは常にその中身全てを送信する。
	 */
	export const Full = 1;

	/**
	 * ドキュメントは開いた際に中身全てを送信することで同期される。それ以降はド
	 * キュメントへの更新差分のみ送信される。
	 */
	export const Incremental = 2;
}

export interface TextDocumentSyncOptions {
	/**
	 * `textDocument/open` と `textDocument/close` 通知はサーバから送信される。省
	 * 略した場合、それらの通知は送信されるべきではない。
	 */
	openClose?: boolean;
	/**
	 * `textDocument/change` 通知はサーバから送信される。
	 * `TextDocumentSyncKind.None`、`TextDocumentSyncKind.Full`、
	 * `TextDocumentSyncKind.Incremental` を参照。省略した場合、デフォルトで
	 * `TextDocumentSyncKind.None` となる。
	 */
	change?: TextDocumentSyncKind;
}

DidOpenTextDocument Notification

textDocument/didOpen 通知は新しいテキストドキュメントを開いたことを知らせるためにクライアントからサーバへ送信される。ドキュメントの実体はクライアントに管理され、サーバはドキュメントの URI から実体を読もうとしてはならない。この意味でドキュメントを開くことはクライアントによって管理されることを意味する。中身がエディタで表示されることを必ずしも表わさない。textDocument/didOpen 通知は対応する textDocument/didClose 通知を送信する前に再度送信してはならない。これは textDocument/didOpen と textDocument/didClose 通知は同数でなければならず、特定のテキストドキュメントを開いている数は最大で1でなかればならないことを意味する。サーバがリクエストを満たす能力はテキストドキュメントが開いているか閉じているかに依らないことを注意する。

DidOpenTextDocumentParams はドキュメントが関連する言語識別子を含む。ドキュメントの言語識別子が変更された場合、クライアントは textDocument/didClose をサーバに送信し、その後新たな言語識別子をサーバが処理できる場合は新しい言語識別子を textDocument/didOpen で送信する必要がある。

クライアント機能: 一般的な同期クライアント機能

サーバ機能: 一般的な同期サーバ機能

登録オプション: TextDocumentRegisterationOptions

通知:

メソッド: textDocument/didOpen
パラメータ: 次で定義される DidOpenTextDocumentParams:

interface DidOpenTextDocumentParams {
	/**
	 * 開かれたドキュメント。
	 */
	textDocument: TextDocumentItem;
}

DidChangeTextDocument Notification

textDocument/didChange 通知はテキストドキュメントへの変更を伝えるためにクライアントからサーバへ送信される。2.0 でパラメータが適切なバージョン番号と言語識別子を持つように変更された。

クライアント機能: 一般的な同期クライアント機能

サーバ機能: 一般的な同期サーバ機能

登録オプション: 次で定義される TextDocumentChangeRegisterationOptions:

/**
 * テキストドキュメント変更イベントを登録する際使用されるオプションを記述する。
 */
export interface TextDocumentChangeRegistrationOptions extends TextDocumentRegistrationOptions {
	/**
	 * どのようにドキュメントをサーバへ同期するか。TextDocumentSyncKind.Full と
	 * TextDocumentSyncKind.Incremental を参照。
	 */
	syncKind: number;
}

通知:

メソッド: textDocument/didChange
パラメータ: 次で定義される DidChangeTextDocumentParams:

interface DidChangeTextDocumentParams {
	/**
	 * 変更されたドキュメント。バージョン番号は与えられた変更が全て適用された後の
	 * バージョンを指す。
	 */
	textDocument: VersionedTextDocumentIdentifier;

	/**
	 * 実際の中身の変更。中身の変更はドキュメントへの単一の状態変更として記述され
	 * る。つまりドキュメントの状態 S にあるドキュメントの中身の変更 c1(配列のイ
	 * ンデックスは0) と c2(配列のインデックスは1) がある場合、 c1 はドキュメント
	 * を S' にし、c2 は S'' にする。つまり c1 は状態 S で計算され、c2 は状態 S'
	 * で計算される。
	 *
   * ドキュメントの中身を反映するためには次のアプローチで変更イベントを用いる。
	 * - 同一の初期状態から始める。
	 * - 受信した順に `textDocument/didChange` 通知を適用する。
	 * - 受信した順に単一の通知の `TextDocumentContentChangeEvent` の列を適用す
	 *   る。
	 *
	 */
	contentChanges: TextDocumentContentChangeEvent[];
}

/**
 * テキストドキュメントへの変更を記述するイベント。`range` と `rangeLength` が
 * 省略された場合、新しいテキストがドキュメントの中身全体であると解釈される。
 */
interface TextDocumentContentChangeEvent {
	/**
	 * 変更するドキュメントの範囲。
	 */
	range?: Range;

	/**
	 * 置換される範囲の長さ。
	 *
	 * @deprecated 代わりに `range` を用いる。
	 */
	rangeLength?: number;

	/**
	 * 範囲/ドキュメントの新しいテキスト。
	 */
	text: string;
} | {
	/**
	 * ドキュメント全体の新しいテキスト。
	 */
	text: string;
}

WillSaveTextDocument Notification

textDocument/willSave 通知はドキュメントが保存される前にクライアントからサーバへ送信される。

クライアント機能:

プロパティパス(省略可能): textDocument.synchronization.willSave
プロパティタイプ: boolean

この機能はクライアントが textDocument/willSave 通知をサポートすることを示す。

サーバ機能:

プロパティパス(省略可能): textDocumentSync.willSave
プロパティタイプ: boolean

この機能はサーバが textDocument/willSave 通知を受信できることを示す。

登録オプション: TextDocumentRegistionOptions

通知:

メソッド: textDocument/willSave
パラメータ: 次で定義される WillSaveTextDocumentParams

/**
 * `WillSaveTextDocument` 通知で送信されるパラメータ。
 */
export interface WillSaveTextDocumentParams {
	/**
	 * 保存されるドキュメント。
	 */
	textDocument: TextDocumentIdentifier;

	/**
	 * 'TextDocumentSaveReason'。
	 */
	reason: number;
}

/**
 * テキストドキュメントが保存される理由を表わす。
 */
export namespace TextDocumentSaveReason {

	/**
	 * 手動、例えばユーザが保存ボタンを押した、やデバッグを開始した、または API
	 * が叩かれた。
	 */
	export const Manual = 1;

	/**
	 * 遅延後自動で。
	 */
	export const AfterDelay = 2;

	/**
	 * エディタがフォーカスを失なったとき。
	 */
	export const FocusOut = 3;
}

WillSaveWaitUntilTextDocument Request

textDocument/willSaveWaitUntil リクエストはドキュメントが保存される前にクライアントからサーバに送信される。リクエストは保存されるまでにテキストドキュメントに適用された TextEdit の配列を返すことができる。テキスト編集の計算に非常に時間がかかった場合やサーバがこのリクエストで常に失敗する場合、クライアントは結果を落とすかもしれないことに注意する。これは保存を早く、信頼性のあるものにするために行なっている。

クライアント機能:

プロパティパス(省略可能): textDocument.synchronization.willSaveWaitUntil
プロパティタイプ: boolean

この機能はクライアントが textDocument/willSaveWaitUntil 通知をサポートすることを示す。

サーバ機能:

プロパティパス(省略可能): textDocumentSync.willSaveWaitUntil
プロパティタイプ: boolean

この機能はサーバが textDocument/willSaveWaitUntil 通知を受信できることを示す。

登録オプション: TextDocumentRegistrationOptions

リクエスト:

メソッド: textDocument/willSaveWaitUntil
パラメータ: WillSaveTextDocumentParams

レスポンス:

結果: TextEdit[] | null
エラー: エラーコードと textDocument/willSaveWaitUntil リクエスト中に発生した例外がセットされたメッセージ。

DidSaveTextDocument Notification

textDocument/didSave 通知はクライアントでドキュメントを保存したときにクライアントからサーバへ送信される。

クライアント機能:

プロパティパス(省略可能): textDocument.synchronization.didSave
プロパティタイプ: boolean

この機能はクライアントが textDocument/didSave 通知をサポートすることを示す。

サーバ機能:

プロパティパス(省略可能): textDocumentSync.didSave
プロパティタイプ: boolean | SaveOptions SaveOptions は次で定義される:

export interface SaveOptions {
	/**
	 * クライアントが保存時に中身を含むことを仮定する。
	 */
	includeText?: boolean;
}

この機能はサーバが textDocument/didSave 通知を受信できることを示す。

登録オプション: 次で定義される TextDocumentSaveRegistrationOptions:

export interface TextDocumentSaveRegistrationOptions extends TextDocumentRegistrationOptions {
	/**
	 * クライアントが保存時に中身を含むことを仮定する。
	 */
	includeText?: boolean;
}

通知:

メソッド: textDocument/didSave
パラメータ: 次で定義される DidSaveTextDocumentParams:

interface DidSaveTextDocumentParams {
	/**
	 * 保存されたドキュメント。
	 */
	textDocument: TextDocumentIdentifier;

	/**
	 * 保存された省略可能なコンテント。保存通知がリクエストされたとき、
	 * includeText の値に依存する。
	 */
	text?: string;
}

DidCloseTextDocument Notification

textDocument/didClose 通知はクライアントでドキュメントが閉じられたときにクライアントからサーバへ送信される。ドキュメントの実体はドキュメント URI の指す先に存在する(例えばドキュメント URI がファイル URI の場合実体はディスクに存在する)。 textDocument/didOpen 通知と同様に textDocument/didClose 通知はドキュメントの中身の管理についてのものである。textDocument/didClose 通知を受けることはそれまでにドキュメントがエディタで開かれていたことを意味するわけではない。 textDocument/didClose 通知の前に textDocument/didOpen 通知が送信されている必要がある。サーバがリクエストを満たす能力はテキストドキュメントが開いているか閉じているかに依らないことを注意する。

クライアント機能: 一般的な同期クライアント機能

サーバ機能: 一般的な同期サーバ機能

登録オプション: TextDocumentRegisterationOptions

通知:

メソッド: textDocument/didClose
パラメータ: 次で定義される DidCloseTextDocumentParams:

interface DidCloseTextDocumentParams {
	/**
	 * 閉じられたドキュメント。
	 */
	textDocument: TextDocumentIdentifier;
}

TextDocumentSyncClientCapabilities と TextDocumentSyncOptions は最終的に次のようになる。

export interface TextDocumentSyncClientCapabilities {
	/**
	 * テキストドキュメント同期機能の動的な登録をサポートするかどうか。
	 */
	dynamicRegistration?: boolean;

	/**
	 * クライアントは `textDocument/willSave` 通知の送信をサポートする。
	 */
	willSave?: boolean;

	/**
	 * クライアントは `textDocument/willSaveWaitUntil` リクエストの送信をサポート
	 * し、保存前にドキュメントに適用するテキスト編集を提供するレスポンスを待つ。
	 */
	willSaveWaitUntil?: boolean;

	/**
	 * クライアントは `textDocument/didSave` 通知の送信をサポートする。
	 */
	didSave?: boolean;
}

/**
 * ホスト(エディタ)がドキュメント変更の同期をどのようにサーバに行うかを定義す
 */
export namespace TextDocumentSyncKind {
	/**
	 * ドキュメントは全て同期されるべきでない。
	 */
	export const None = 0;

	/**
	 * ドキュメントは常にその中身全てを送信する。
	 */
	export const Full = 1;

	/**
	 * ドキュメントは開いた際に中身全てを送信することで同期される。それ以降はド
	 * キュメントへの更新差分のみ送信される。
	 */
	export const Incremental = 2;
}

export interface TextDocumentSyncOptions {
	/**
	 * `textDocument/open` と `textDocument/close` 通知はサーバから送信される。省
	 * 略した場合、それらの通知は送信されるべきではない。
	 */
	openClose?: boolean;
	/**
	 * `textDocument/change` 通知はサーバから送信される。
	 * `TextDocumentSyncKind.None`、`TextDocumentSyncKind.Full`、
	 * `TextDocumentSyncKind.Incremental` を参照。省略した場合、デフォルトで
	 * `TextDocumentSyncKind.None` となる。
	 */
	change?: number;
	/**
	 * 有効な場合、`textDocument/willSave` 通知はサーバから送信される。省略した場
	 * 合、それらの通知は送信されるべきではない。
	 */
	willSave?: boolean;
	/**
	 * 有効な場合、`textDocument/willSaveWaitUntil` リクエストはサーバから送信さ
	 * れる。省略した場合、それらの通知は送信されるべきではない。
	 */
	willSaveWaitUntil?: boolean;
	/**
	 * 有効な場合、`textDocument/didSave` 通知はサーバから送信される。省略した場
	 * 合、それらの通知は送信されるべきではない。
	 */
	save?: SaveOptions;
}

PublishDiagnostics Notification

textDocument/publishDiabnostics 通知は検証結果を伝えるためにサーバからクライアントに送信される。

診断結果はサーバのものなので、必要であればクリアすることはサーバの責任である。 VS Code では診断結果を生成するサーバは次のルールに従う:

単一ファイルからなる言語 (例えば HTML) の場合、ファイルを閉じた際に診断結果をクリアする。
プロジェクトシステムを持つ言語 (例えば C#) の場合、ファイルを閉じた際には診断結果をクリアしない。プロジェクトが開かれたとき、全てのファイルの全ての診断結果は再計算される(かキャッシュから読まれる)。

ファイルが変更されたとき、診断結果を再計算しクライアントに送信するのはサーバの責任である。計算結果が空の場合、以前の診断結果をクリアするために空配列を送信する必要がある。新たに送信された診断結果は常に以前に送信された診断結果を置き換える。クライアント側でマージされることはない。

Diagnostic セクションも参照。

クライアント機能:

プロパティパス(省略可能): textDocument.publishDiagnostics
プロパティタイプ: 次で定義される PublishDiagnosticsClientCapabilities:

export interface PublishDiagnosticsClientCapabilities {
	/**
	 * クライアントが診断結果に関連する情報を受け入れるかどうか。
	 */
	relatedInformation?: boolean;

	/**
	 * クライアントは診断結果についてのメタデータとしてのタグをサポートする。クラ
	 * イアントは不明なタグを適切に処理する必要がある。
	 *
	 * @since 3.15.0
	 */
	tagSupport?: {
		/**
		 * クライアントにサポートされるタグ。
		 */
		valueSet: DiagnosticTag[];
	};

	/**
	 * クライアントが `textDocument/publishDiagnostics` 通知のパラメータの
	 * `version` プロパティを処理するかどうか。
	 *
	 * @since 3.15.0
	 */
	versionSupport?: boolean;
}

通知:

メソッド: textDocument/publishDiagnostics
パラメータ: 次で定義される PublishDiagnosticsParams:

interface PublishDiagnosticsParams {
	/**
	 * 診断結果を通知する URI。
	 */
	uri: DocumentUri;

	/**
	 * 診断結果の配列。
	 */
	diagnostics: Diagnostic[];
}

Completion Request

Completion リクエストは与えられたカーソル位置の補完候補を計算するためにクライアントからサーバへ送信される。補完候補は IntelliSense UI で表示される。補完候補を全て計算するコストが高い場合、サーバは completionItem/resolve リクエストへのハンドラを提供することができる。このリクエストは UI 上で補完候補が選択されたときに送信される。典型的なユースケースとして: 計算コストが高いため textDocument/completion リクエストは documentation プロパティを埋めずに補完候補を返す。UI 上でその候補が選択されたとき、パラメータに選択された補完候補を入れた completionItem/resolve リクエストが送信される。このとき返される補完候補には documentation プロパティは入っているべきである。リクエストは detail と documentation プロパティの計算を遅延することができる。しかし sortText、filterText、insertText、textEdit のような最初のソートとフィルタに必要なプロパティは textDocument/completion レスポンスに含まれている必要があり、completionItem/resolve 中に変更してはならない。

クライアント機能:

プロパティパス(省略可能): textDocument.completion
プロパティタイプ: 次で定義される CompletionClientCapabilities

export interface CompletionClientCapabilities {
	/**
	 * 補完機能の動的な登録をサポートするかどうか。
	 */
	dynamicRegistration?: boolean;

	/**
	 * クライアントは次の `CompletionItem` 固有の機能をサポートする。
	 */
	completionItem?: {
		/**
		 * クライアントは挿入テキストとしてスニペットをサポートする。
		 *
		 * スニペットはタブ位置とプレースホルダ `$1`、`$2`、`${3:foo}` で定義でき
		 * る。`$0` は最後のタブ位置を定め、デフォルトでスニペットの最後となる。同
		 * じ識別子プレースホルダはリンクしている、つまり一方を入力すると他も更新さ
		 * れる。
		 */
		snippetSupport?: boolean;

		/**
		 * クライアントは補完候補のコミット文字をサポートする。
		 */
		commitCharactersSupport?: boolean

		/**
		 * クライアントは `documentation` プロパティに次のコンテントフォーマットを
		 * サポートする。順序はクライアントで優先されるフォーマットを表わす。
		 */
		documentationFormat?: MarkupKind[];

		/**
		 * クライアントは補完候補の `deprecated` プロパティをサポートする。
		 */
		deprecatedSupport?: boolean;

		/**
		 * クライアントは補完候補の `preselect` プロパティをサポートする。
		 */
		preselectSupport?: boolean;

		/**
		 * クライアントは補完候補についてのメタデータとしてのタグをサポートする。ク
		 * ライアントは不明なタグを適切に処理する必要がある。特に、クライアントは
		 * `completionItem/resolve` 呼び出しで補完候補をサーバに返す際、不明なタグ
		 * を保存することが必要である。
		 *
		 * @since 3.15.0
		 */
		tagSupport?: {
			/**
			 * クライアントによってサポートされるタグ。
			 */
			valueSet: CompletionItemTag[]
		}
	};

	completionItemKind?: {
		/**
		 * クライアントがサポートする補完候補種別。このプロパティが存在する場合、ク
		 * ライアントは範囲外の値を適切に処理し、不明な場合はデフォルト値にフォール
		 * バックすることも保証する。
		 *
		 * このプロパティが与えられていない場合、クライアントは LSP の初期バージョ
		 * ンで定義されていた `Text` から `Reference` までのみをサポートする。
		 */
		valueSet?: CompletionItemKind[];
	};

	/**
	 * クライアントは `textDocument/completion` リクエストに追加のコンテキスト情
	 * 報を送信することをサポートする。
	 */
	contextSupport?: boolean;
}

サーバ機能:

プロパティパス(省略可能): completionProvider
プロパティタイプ: 次で定義される CompletionOptions

/**
 * Completion options.
 */
export interface CompletionOptions extends WorkDoneProgressOptions {
	/**
	 * ほとんどのツールはキーボードショートカット(例えば Ctrl+Space)を用いて明示
	 * 的にリクエストすることなく自動的に補完リクエストを発火する。典型的にはユー
	 * ザが識別子の入力を始めたときに補完は開始される。例えばユーザが `c` を
	 * JavaScript ファイルで入力した場合、コード補完は他の候補と共に `console` を
	 * 候補として自動的にポップアップする。識別子を構成する文字をここにリストする
	 * 必要はない。
	 *
	 * コード補完が識別子内で無効な文字により自動的に発火されるべき場合(例えば
	 * JavaScript での `.`)、`triggerCharacters` に列挙する。
	 */
	triggerCharacters?: string[];

	/**
	 * 補完を確定することのできる全ての文字。クライアントが補完候補毎の確定文字を
	 * サポートしていない場合に使われる。
	 * `ClientCapabilities.textDocument.completion.completionItem.commitCharactesSupport`
	 * を参照。
	 *
	 * サーバが `allCommitCharacters` と各補完候補の確定文字を双方提供している場
	 * 合、補完候補に設定されたものが優先される。
	 *
	 * @since 3.2.0
	 */
	allCommitCharacters?: string[];

	/**
	 * サーバが補完候補の追加情報を解決することをサポートする。
	 */
	resolveProvider?: boolean;
}

登録オプション: 次で定義される CompletionRegistrationOptions:

export interface CompletionRegistrationOptions extends TextDocumentRegistrationOptions, CompletionOptions {
}

リクエスト:

メソッド: textDocument/completion
パラメータ: 次で定義される CompletionParams

export interface CompletionParams extends TextDocumentPositionParams, WorkDoneProgressPrams, PartialResultParams {
	/**
	 * 補完コンテキスト。クライアントが
	 * `ClientCapabilities.textDocument.completion.contextSupport === true` を用
	 * いて送信する場合のみ表われる。
	 */
	context?: CompletionContext;
}

/**
 * 補完がどのように引き起こされたか。
 */
export namespace CompletionTriggerKind {
	/**
	 * 補完は識別子(24x7 コード補完)の入力、手動起動(例えば Ctrl+Space) または
	 * API 経由で起動された。
	 */
	export const Invoked: 1 = 1;

	/**
	 * 補完は `CompletionRegistrationOptions` の `triggerCharacters` プロパティで
	 * 指定された文字のより起動された。
	 */
	export const TriggerCharacter: 2 = 2;

	/**
	 * 補完は現在の補完候補が不完全なので再度起動された。
	 */
	export const TriggerForIncompleteCompletions: 3 = 3;
}
export type CompletionTriggerKind = 1 | 2 | 3;


/**
 * 補完リクエストが起動したコンテキスト情報を追加で含む。
 */
export interface CompletionContext {
	/**
	 * どのように補完が起動したか。
	 */
	triggerKind: CompletionTriggerKind;

	/**
	 * コード補完を起動した文字(単一の文字)。`triggerKind !==
	 * CompletionTriggerKind.TriggerCharacter` のとき未定義となる。
	 */
	triggerCharacter?: string;
}

レスポンス:

結果: CompletionItem[] | CompletionList | null。もし CompletionItem[] が与えられた場合、補完が完了したことを表わす。つまり { isIncomplete: false, items } と同一である。

/**
 * エディタ上で表示するための [completion items](#CompletionItem) の集まりを表
 * わす。
 */
interface CompletionList {
	/**
	 * リストは完成していない。さらに入力するとリストが再計算されるべきである。
	 */
	isIncomplete: boolean;

	/**
	 * 補完候補。
	 */
	items: CompletionItem[];
}

/**
 * 補完候補から入力されるテキストがプレインテキスト、スニペットどちらとして処理
 * されるかを定める。
 */
namespace InsertTextFormat {
	/**
	 * 挿入されるテキストはただの文字列として扱われる。
	 */
	export const PlainText = 1;

	/**
	 * 挿入されるテキストはスニペットとして扱われる。
	 *
	 * スニペットはタブ位置とプレースホルダ `$1`、`$2`、`${3:foo}` で定義できる。
	 * `$0` は最後のタブ位置を定め、デフォルトでスニペットの最後となる。同じ識別
	 * 子プレースホルダはリンクしている、つまり一方を入力すると他も更新される。
	 */
	export const Snippet = 2;
}

type InsertTextFormat = 1 | 2;

/**
 * 補完候補タグは補完候補の表示を微調整する追加情報である。
 *
 * @since 3.15.0
 */
export namespace CompletionItemTag {
	/**
	 * 補完候補は廃止として表示される。大抵打ち消し線を用いる。
	 */
	export const Deprecated = 1;
}

export type CompletionItemTag = 1;

interface CompletionItem {
	/**
	 * 補完候補のラベル。デフォルトでこの候補を選択したときに挿入されるテキスト。
	 */
	label: string;

	/**
	 * 補完候補の種別。種別に基づき、エディタがアイコンを選択する。標準的に利用で
	 * きる値は `CompletionItemKind` で定義される。
	 */
	kind?: number;

	/**
	 * この補完候補のタグ。
	 *
	 * @since 3.15.0
	 */
	tags?: CompletionItemTag[];

	/**
	 * 型やシンボル情報のような、この候補の追加情報を与える可読な文字列。
	 */
	detail?: string;

	/**
	 * コメントを表す可読な文字列。
	 */
	documentation?: string | MarkupContent;

	/**
	 * この候補が非推奨かどうかを指す。
	 *
	 * @deprecated サポートされている場合は `tags` を代わりに用いる。
	 */
	deprecated?: boolean;

	/**
	 * 表示するときにこの候補を選択する。
	 *
	 * *注意* 選択できる補完候補は唯一つであり、候補はツール/クライアントが決定す
	 * る。ルールは最適な *最初の* 候補が選択されることである。
	 */
	preselect?: boolean;

	/**
	 * 他の候補と比較するときに使われるべき文字列。`falsy` な場合は `label` が用
	 * いられる。
	 */
	sortText?: string;

	/**
	 * 補完候補をフィルタするときに使われるべき文字列。`falsy` な場合は `label`
	 * が用いられる。
	 */
	filterText?: string;

	/**
	 * この補完候補が選択されたときに挿入されるべき文字列。`falsy` な場合は
	 * `label` が用いられる。
	 *
	 * `insertText` はクライアント側で解釈される対象である。一部のツールは文字列
	 * をそのまま使わないかもしれない。例えば VS Code は `con<カーソル位置>` で
	 * コード補完がリクエストされ、補完候補の `insertText` が `console` で与えら
	 * れた場合、`sole` のみを挿入する。よってクライアント側での解釈を避けるには
	 * `textEdit` を用いることが推奨される。
	 */
	insertText?: string;

	/**
	 * 挿入するテキストのフォーマット。このフォーマットは `textEdit` プロパティで
	 * 与えられる `insertText` プロパティと `newText` プロパティ双方に適用される。
	 * 省略した場合はデフォルトで `InsertTextFormat.PlainText` が使われる。
	 */
	insertTextFormat?: InsertTextFormat;

	/**
	 * この補完候補が選択されたときにドキュメントに適用される編集。`textEdit` が
	 * 与えられたとき、`insertText` の値は無視される。
	 *
	 * *注意:* 編集範囲は1行で、補完リクエストが発生した位置を含んでいる必要があ
	 * る。
	 */
	textEdit?: TextEdit;

	/**
	 * この補完候補が選択されたときに適用される追加編集の列。編集は `textEdit` と
	 * も配列の他の要素とも被ってはならない(同一位置への挿入を含む)。
	 *
	 * `additionalTextEdits` は現在のカーソル位置とは関係の無いテキスト編集に使用
	 * されるべきである(例えば補完候補が未宣言の型を挿入するときに、ファイル上部
	 * の import 文に追加する)。
	 */
	additionalTextEdits?: TextEdit[];

	/**
	 * この補完候補が有効なときに押されると、許容され、入力される文字の集まり。
	 * *注意* `commitCharacters` の各要素は `length=1` であるべきである、余計な文
	 * 字は無視される。
	 */
	commitCharacters?: string[];

	/**
	 * この補完候補が挿入された *後に* 実行されるコマンド。*注意* この現在のドキュ
	 * メントへの追加の編集は `additionalTextEdits` プロパティに記述されるべきで
	 * ある。
	 */
	command?: Command;

	/**
	 * `textDocument/completion` リクエストと `completionItem/resolve` リクエスト
	 * の間で補完候補に保存されるデータ。
	 */
	data?: any
}

/**
 * 補完候補の種別。
 */
namespace CompletionItemKind {
	export const Text = 1;
	export const Method = 2;
	export const Function = 3;
	export const Constructor = 4;
	export const Field = 5;
	export const Variable = 6;
	export const Class = 7;
	export const Interface = 8;
	export const Module = 9;
	export const Property = 10;
	export const Unit = 11;
	export const Value = 12;
	export const Enum = 13;
	export const Keyword = 14;
	export const Snippet = 15;
	export const Color = 16;
	export const File = 17;
	export const Reference = 18;
	export const Folder = 19;
	export const EnumMember = 20;
	export const Constant = 21;
	export const Struct = 22;
	export const Event = 23;
	export const Operator = 24;
	export const TypeParameter = 25;
}

部分的結果: CompletionItem[] または CompletionList の後に CompletionItem[]。最初に与えられた結果が CompletionList 型の場合、後に続く CompletionItem[] は CompletionList の items プロパティに追加していく。
エラー: エラーコードとリクエスト中に発生した例外がセットされたメッセージ。

補完候補はスニペットをサポートする(InsertTextFormat.Snippet を参照)。スニペットのフォーマットは次のように定義される。

Snippet Syntax

スニペットの body はカーソルの操作とテキスト入力のための特別な構成要素を使うことができる。次はそれらの構文と機能である:

Tab stops

タブ位置により、エディタのカーソルをスニペット内で移動させることができる。$1、 $2 でカーソル位置を指定する。数字はタブ位置に移動する順序であり、$0 は最後のカーソル位置を記述する。複数のタブ位置はリンクしており、更新は同期される。

Placeholders

プレースホルダは ${1:foo} のような、値付きのタブ位置である。プレースホルダのテキストは挿入され、簡単に変更できるように選択される。プレースホルダは ${1:another ${2:placeholder}} のように、ネストすることができる。

Choice

プレースホルダは値として選択肢を持つ。構文は、例えば `${1|one,two,three|} のように、カンマ区切りで列挙された、パイプで囲まれた値である。スニペットが挿入され、プレースホルダが選択されたとき、選択肢はユーザに値を選択するよう促す。

Variables

$name または ${name:default} で変数の値を挿入することができる。変数の中身がセットされていない場合、default または空文字列が挿入される。不明な変数(つまり名前が宣言されていない)の場合、変数名が挿入され、プレースホルダに変換される。

次の変数が使用できる:

TM_SELECTED_TEXT 現在選択中のテキストまたは空文字列
TM_CURRENT_LINE 現在行の中身
TM_CURRENT_WORD カーソル上の単語の中身または空文字列
TM_LINE_INDEX 0始まりの行番号
TM_LINE_NUMBER 1始まりの行番号
TM_FILENAME 現在のドキュメントのファイル名
TM_FILENAME_BASE 現在のドキュメントの拡張子を除くファイル名
TM_DIRECTORY 現在のドキュメントのディレクトリ
TM_FILEPATH 現在のドキュメントの絶対パス

Variable Transforms

変換により入力前の変数の値を編集することができる。変換の定義は3つの部分からなる。

変数の値と照合される正規表現、または変数を解決できない場合は空文字列。
正規表現のマッチグループへの参照を持つフォーマット文字列。フォーマット文字列により条件付きの挿入や単純な編集ができる。
正規表現に渡されるオプション。

次の例は現在のファイル名から最後を除いて挿入する例である、つまり foo.txt から foo を作る。

${TM_FILENAME/(.*)\..+$/$1/}
  |           |         | |
  |           |         | |-> オプションなし
  |           |         |
  |           |         |-> 最初のキャプチャグループへの参照
  |           |
  |           |-> 最後の `.suffix` の前全てを捕えるための正規表現
  |
  |-> ファイル名の解決

Grammar

スニペットの EBNF(extended Backus-Naur form) を以下に示す。\(バックスラッシュ) により、$、}、\ をエスケープできる。選択肢ではバックスラッシュで更にカンマとパイプ文字をエスケープできる。

any         ::= tabstop | placeholder | choice | variable | text
tabstop     ::= '$' int | '${' int '}'
placeholder ::= '${' int ':' any '}'
choice      ::= '${' int '|' text (',' text)* '|}'
variable    ::= '$' var | '${' var }'
                | '${' var ':' any '}'
                | '${' var '/' regex '/' (format | text)+ '/' options '}'
format      ::= '$' int | '${' int '}'
                | '${' int ':' '/upcase' | '/downcase' | '/capitalize' '}'
                | '${' int ':+' if '}'
                | '${' int ':?' if ':' else '}'
                | '${' int ':-' else '}' | '${' int ':' else '}'
regex       ::= JavaScript Regular Expression value (ctor-string)
options     ::= JavaScript Regular Expression option (ctor-options)
var         ::= [_a-zA-Z] [_a-zA-Z0-9]*
int         ::= [0-9]+
text        ::= .*

Completion Item Resolve Request

このリクエストは与えられた補完候補の追加情報を解決するためにクライアントからサーバへ送信される。

リクエスト:

メソッド: completionItem/resolve
パラメータ: CompletionItem

レスポンス:

結果: CompletionItem
エラー: エラーコードと completionItem/resolve リクエスト中に発生した例外がセットされたメッセージ。

Hover Request

document/hover リクエストは与えられたテキスト位置でのホバー情報を要求するためにクライアントからサーバへ送信される。

クライアント機能:

プロパティパス(省略可能): textDocument.hover
プロパティタイプ: 次で定義される HoverClientCapabilities:

export interface HoverClientCapabilities {
	/**
	 * ホバー機能の動的な登録をサポートするかどうか。
	 */
	dynamicRegistration?: boolean;

	/**
	 * クライアントは `content` プロパティに次のコンテントフォーマットをサポート
	 * する。順序はクライアントでのフォーマットの優先度を表わす。
	 */
	contentFormat?: MarkupKind[];
}

サーバ機能:

プロパティパス(省略可能): hoverProvider
プロパティタイプ: boolean または次で定義される HoverOptions:

export interface HoverOptions extends WorkDoneProgressOptions {
}

登録オプション: 次で定義される HoverRegistrationOptions

export interface HoverRegistrationOptions extends TextDocumentRegistrationOptions, HoverOptions {
}

リクエスト:

メソッド: textDocument/hover
パラメータ: 次で定義される HoverParams:

export interface HoverParams extends TextDocumentPositionParams, WorkDoneProgressParams {
}

レスポンス:

結果: 次で定義される Hover | null:

/**
 * ホバーリクエストの結果
 */
interface Hover {
	/**
	 * ホバーの中身
	 */
	contents: MarkedString | MarkedString[] | MarkupContent;

	/**
	 * 省略可能な `range` は、例えば背景色を変更するような、ホバーを表示するため
	 * に使われるテキストドキュメント内の範囲。
	 */
	range?: Range;
}

MarkedString は次のように定義される:

/**
 * MarkedString は人間の読めるテキストを表示するために使うことができる。これは
 * markdown 文字列または言語とコードスニペットが与えられたコードブロックである。
 * 言語識別子は GitHub issue の fenced code block の言語識別子と意味的に同じで
 * ある。
 * https://help.github.com/articles/creating-and-highlighting-code-blocks/#syntax-highlighting
 * を参照。
 *
 * 言語と値のペアは markdown と同一である:
 * ```${language}
 * ${value}
 * ```
 *
 * マークダウン文字列はサニタイズされる。- つまり、HTML はエスケープされる。
 * @deprecated MarkupContent を代わりに用いる。
 */
type MarkedString = string | { language: string; value: string };

エラー: エラーコードと textDocument/hover リクエスト中に発生した例外がセットされたメッセージ。

Signature Help Request

textDocument/signatureHelp リクエストは与えられたカーソル位置でのシグネチャ情報を要求するためにクライアントからサーバへ送信される。

クライアント機能:

プロパティパス(省略可能): textDocument.signatureHelp
プロパティタイプ: 次で定義される SignatureHelpClientCapabilities

export interface SignatureHelpClientCapabilities {
	/**
	 * シグネチャヘルプ機能の動的な登録をサポートするかどうか。
	 */
	dynamicRegistration?: boolean;

	/**
	 * クライアントは次の `SignatureInformation` 固有のプロパティをサポートする。
	 */
	signatureInformation?: {
		/**
		 * クライアントは `documentation` プロパティに次のフォーマットをサポートす
		 * る。順序はクライアントでのフォーマットの優先度を表わす。
		 */
		documentationFormat?: MarkupKind[];

		/**
		 * パラメータ情報固有のクライアントの機能。
		 */
		parameterInformation?: {
			/**
			 * クライアントは単純なラベル文字の代わりにラベルオフセットの処理をサポー
			 * トする。
			 *
			 * @since 3.14.0
			 */
			labelOffsetSupport?: boolean;
		};
	};

	/**
	 * クライアントは `textDocument/signatureHelp` リクエストに追加のコンテキスト
	 * 情報を送信することをサポートする。`contextSupport` が有効なクライアントは
	 * `SignatureHelpOptions` の `retriggerCharacters` もサポートする。
	 *
	 * @since 3.15.0
	 */
	contextSupport?: boolean;
}

サーバ機能:

プロパティパス(省略可能): signatureHelpProvider
プロパティタイプ: 次で定義される SignatureHelpOptions:

export interface SignatureHelpOptions extends WorkDoneProgressOptions {
	/**
	 * シグネチャヘルプを自動で起動する文字の列。
	 */
	triggerCharacters?: string[];

	/**
	 * シグネチャヘルプを再起動する文字の列。
	 *
	 * これらのトリガ文字列はスグネチャヘルプがすでに表示されている場合にのみ有効
	 * である。全てのトリガ文字列は再起動文字列にもカウントされる。
	 *
	 * @since 3.15.0
	 */
	retriggerCharacters?: string[];
}

登録オプション: 次で定義される SignatureHelpRegistrationOptions:

export interface SignatureHelpRegistrationOptions extends TextDocumentRegistrationOptions, SignatureHelpOptions {
}

リクエスト:

メソッド: textDocument/signatureHelp
パラメータ: 次で定義される SignatureHelpParams:

export interface SignatureHelpParams extends TextDocumentPositionParams, WorkDoneProgressParams {
	/**
	 * シグネチャヘルプコンテキスト。クライアントが
	 * `textDocument.signatureHelp.contextSupport === true` を用いて送信する場合
	 * のみ表われる。
	 *
	 * @since 3.15.0
	 */
	context?: SignatureHelpContext;
}

/**
 * シグネチャヘルプがどのように起動されたか。
 *
 * @since 3.15.0
 */
export namespace SignatureHelpTriggerKind {
	/**
	 * シグネチャヘルプはユーザが手動で、またはコマンドにより実行された。
	 */
	export const Invoked: 1 = 1;
	/**
	 * シグネチャヘルプはトリガ文字により起動された。
	 */
	export const TriggerCharacter: 2 = 2;
	/**
	 * シグネチャヘルプはカーソル移動またはドキュメントの中身の変更によって起動さ
	 * れた。
	 */
	export const ContentChange: 3 = 3;
}
export type SignatureHelpTriggerKind = 1 | 2 | 3;

/**
 * textDocument/signatureHelp` リクエストが起動されたコンテキストについての追加
 * 情報。
 *
 * @since 3.15.0
 */
export interface SignatureHelpContext {
	/**
	 * シグネチャヘルプが起動された原因。
	 */
	triggerKind: SignatureHelpTriggerKind;

	/**
	 * シグネチャヘルプが起動された原因。
	 *
	 * `triggerKind !== SignatureHelpTriggerKind.TriggerCharacter` のとき未定義と
	 * なる。
	 */
	triggerCharacter?: string;

	/**
	 * 起動された時点ですでにシグネチャヘルプが表示されていた場合 `true` となる。
	 *
	 * 再起動はシグネチャヘルプがすでに有効である場合に発生し、トリガ文字の入力、
	 * カーソル移動、ドキュメントの内容の変更などで引き起される場合がある。
	 */
	isRetrigger: boolean;

	/**
	 * 現在有効な `SignatureHelp`。
	 *
	 * `activeSignatureHelp` はユーザ操作によって有効なシグネチャとして更新された
	 * `SignatureHelp.activeSignature` フィールドを持つ
	 */
	activeSignatureHelp?: SignatureHelp;
}

レスポンス:

結果: 次で定義される SignatureHelp | null:

/**
 * シグネチャヘルプは呼び出し可能な何かのシグネチャを表示する。複数のシグネチャ
 * が存在できるが、有効であり、有効なパラメータを持つのはただ一つである。
 */
interface SignatureHelp {
	/**
	 * 一つ以上のシグネチャ。
	 */
	signatures: SignatureInformation[];

	/**
	 * 有効なシグネチャ。省略、または `signatures` の範囲外の値を指定した場合はデ
	 * フォルトで 0 または `signatures.length === 0` の場合は無視される。可能な場
	 * 合はいつでも、実装者は有効なシグネチャを決定するべきで、デフォルト値に頼る
	 * べきではない。
	 * 将来のプロトコルバージョンでこのことをより表現するためにこのプロパティは必
	 * 須となるだろう。
	 */
	activeSignature?: number;

	/**
	 * 有効なシグネチャの有効なパラメータ。省略、または
	 * `signatures[activeSignature].parameters` の範囲外の値を指定した場合はデフォ
	 * ルトで有効なシグネチャが `parameters` を持つ場合は0となる。有効なシグネチャ
	 * が `parameters` を持たない場合は無視される。
	 * 将来のプロトコルバージョンで有効なシグネチャが何かを持っている場合、有効な
	 * パラメータをより表現するためにこのプロパティは必須となるだろう。
	 */
	activeParameter?: number;
}

/**
 * 呼び出し可能なシグネチャを表現する。シグネチャは関数名のようなラベルやコメン
 * ト、パラメータを持つことができる。
 */
interface SignatureInformation {
	/**
	 * このシグネチャのラベル。UI 上で表示される。
	 */
	label: string;

	/**
	 * このシグネチャの可読なコメント。UI 上で表示されるが省略可能である。
	 */
	documentation?: string | MarkupContent;

	/**
	 * このシグネチャのパラメータ。
	 */
	parameters?: ParameterInformation[];
}

/**
 * 呼び出し可能なシグネチャのパラメータを表現する。パラメータはラベルとコメント
 * を持つことができる。
 */
interface ParameterInformation {

	/**
	 * このパラメータ情報のラベル。
	 *
	 * 文字列はたは開始を含み終了を含まないラベル内のオフセットのどちらかである。
	 * (`SignatureInformation.label` を参照。オフセットは `Position` や `Range`
	 * と同様に `UTF-16` 文字表現を基にする。
	 *
	 * *注意*: string 型のラベルはシグネチャラベルに含まれる部分文字列であるべき
	 * である。これは`SignatureInformation.label` の `ParameterInformation.label`
	 * 部分でハイライトするユースケースを意図している。
	 */
	label: string | [number, number];

	/**
	 * このパラメータの可読なコメント。UI 上で表示されるが省略可能である。
	 */
	documentation?: string | MarkupContent;
}

エラー: エラーコードと textDocument/hover リクエスト中に発生した例外がセットされたメッセージ。

Goto Declaration Request

バージョン 3.14.0 から

textDocument/declaration リクエストは与えられたテキストドキュメント位置のシンボルの宣言位置を解決するためにクライアントからサーバへ送信される。

結果の LocationLink[] 型はバージョン 3.14.0 で導入され、一致するクライアント機能 textDocument.declaration.linkSupport に依存する。

クライアント機能:

プロパティパス(省略可能): textDocument.declaration
プロパティタイプ: 次で定義される DeclarationClientCapabilities

export interface DeclarationClientCapabilities {
	/**
	 * 宣言元参照機能の動的な登録をサポートするかどうか。`true` がセットされた場
	 * 合、クライアントは対応するサーバ機能の新しい返り値
	 * `DeclarationRegistrationOptions` もサポートする。
	 */
	dynamicRegistration?: boolean;

	/**
	 * クライアントはリンク形式の追加メタデータをサポートする。
	 */
	linkSupport?: boolean;
}

サーバ機能:

プロパティパス(省略可能): declarationProvider
プロパティタイプ: boolean | DeclarationOptions | DeclarationRegistrationOptions。DeclarationOptions は次で定義される:

export interface DeclarationOptions extends WorkDoneProgressOptions {
}

登録オプション: 次で定義される DeclarationRegistrationOptions:

export interface DeclarationRegistrationOptions extends DeclarationOptions, TextDocumentRegistrationOptions, StaticRegistrationOptions  {
}

リクエスト:

メソッド: textDocument/declaration
パラメータ: 次で定義される DeclarationParams

export interface DeclarationParams extends TextDocumentPositionParams, WorkDoneProgressParams, PartialResultParams {
}

レスポンス:

結果: Location | Location[] | LocationLink[] | null
部分的結果: Location[] | LocationLink[]
エラー: エラーコードと textDocument/declaration リクエスト中に発生した例外がセットされたメッセージ。

Goto Definition Request

textDocument/definition リクエストは与えられたテキストドキュメント位置のシンボルの定義位置を解決するためにクライアントからサーバへ送信される。

結果の LocationLink[] 型はバージョン 3.14.0 で導入され、一致するクライアント機能 textDocument.definition.linkSupport に依存する。

クライアント機能:

プロパティパス(省略可能): textDocument.definition
プロパティタイプ: 次で定義される DefinitionClientCapabilities

export interface DefinitionClientCapabilities {
	/**
	 * 定義元参照機能が動的な機能登録をサポートするかどうか。
	 */
	dynamicRegistration?: boolean;

	/**
	 * クライアントはリンク形式の追加メタデータをサポートする。
	 *
	 * @since 3.14.0
	 */
	linkSupport?: boolean;
}

サーバ機能:

プロパティパス(省略可能): definitionProvider
プロパティタイプ: boolean | DefinitionOptions 。DefinitionOptions は次で定義される:

export interface DefinitionOptions extends WorkDoneProgressOptions {
}

登録オプション: 次で定義される DefinitionRegistrationOptions:

export interface DefinitionRegistrationOptions extends TextDocumentRegistrationOptions, DefinitionOptions {
}

リクエスト:

メソッド: textDocument/definition
パラメータ: 次で定義される DefinitionParams:

export interface DefinitionParams extends TextDocumentPositionParams, WorkDoneProgressParams, PartialResultParams {
}

レスポンス:

結果: Location | Location[] | LocationLink[] | null
部分的結果: Location[] | LocationLink[]
エラー: エラーコードと textDocument/definition リクエスト中に発生した例外がセットされたメッセージ。

Goto Type Definition Request

バージョン 3.6.0 から

textDocument/typeDefinition リクエストは与えられたテキストドキュメント位置のシンボルの型定義位置を解決するためにクライアントからサーバへ送信される。

結果の LocationLink[] 型はバージョン 3.14.0 で導入され、一致するクライアント機能 textDocument.typeDefinition.linkSupport に依存する。

クライアント機能:

プロパティパス(省略可能): textDocument.typeDefinition
プロパティタイプ: 次で定義される TypeDefinitionClientCapabilities

export interface TypeDefinitionClientCapabilities {
	/**
	 * 型定義元参照機能の動的な登録をサポートするかどうか。`true` がセットされた
	 * 場合、クライアントは対応するサーバ機能の新しい返り値
	 * `TypeDefinitionRegistrationOptions` もサポートする。
	 */
	dynamicRegistration?: boolean;

	/**
	 * クライアントはリンク形式の追加メタデータをサポートする。
	 *
	 * @since 3.14.0
	 */
	linkSupport?: boolean;
}

サーバ機能:

プロパティパス(省略可能): typeDefinitionProvider
プロパティタイプ: boolean | TypeDefinitionOptions | TypeDefinitionRegistrationOptions。TypeDefinitionOptions は次で定義される:

export interface TypeDefinitionOptions extends WorkDoneProgressOptions {
}

登録オプション: 次で定義される TypeDefinitionRegistrationOptions:

export interface TypeDefinitionRegistrationOptions extends TextDocumentRegistrationOptions, TypeDefinitionOptions, StaticRegistrationOptions {
}

リクエスト:

メソッド: textDocument/typeDefinition
パラメータ: 次で定義される TypeDefinitionParams:

export interface TypeDefinitionParams extends TextDocumentPositionParams, WorkDoneProgressParams, PartialResultParams {
}

レスポンス:

結果: Location | Location[] | LocationLink[] | null
部分的結果: Location[] | LocationLink[]
エラー: エラーコードと textDocument/typeDefinition リクエスト中に発生した例外がセットされたメッセージ。

Goto Implementation Request

バージョン 3.6.0 から

textDocument/implementation リクエストは与えられたテキストドキュメント位置のシンボルの実装位置を解決するためにクライアントからサーバへ送信される。

結果の LocationLink[] 型はバージョン 3.14.0 で導入され、一致するクライアント機能 textDocument.implementation.linkSupport に依存する。

クライアント機能:

プロパティパス(省略可能): textDocument.implementation
プロパティタイプ: 次で定義される ImplementationClientCapabilities

export interface ImplementationClientCapabilities {
	/**
	 * 実装先参照機能が動的な機能登録をサポートするかどうか。`true` がセットされ
	 * た場合、クライアントは対応するサーバ機能の新しい返り値
	 * `ImplementationRegistrationOptions` もサポートする。
	 */
	dynamicRegistration?: boolean;

	/**
	 * クライアントはリンク形式の追加メタデータをサポートする。
	 *
	 * @since 3.14.0
	 */
	linkSupport?: boolean;
}

サーバ機能:

プロパティパス(省略可能): implementationProvider
プロパティタイプ: boolean | ImplementationOptions | ImplementationRegistrationOptions。ImplementationOptions は次で定義される:

export interface ImplementationOptions extends WorkDoneProgressOptions {
}

登録オプション: 次で定義される ImplementationRegistrationOptions:

export interface ImplementationRegistrationOptions extends TextDocumentRegistrationOptions, ImplementationOptions, StaticRegistrationOptions {
}

リクエスト:

メソッド: textDocument/implementation
パラメータ: ImplementationParams

export interface ImplementationParams extends TextDocumentPositionParams, WorkDoneProgressParams, PartialResultParams {
}

レスポンス:

結果: Location | Location[] | LocationLink[] | null
部分的結果: Location[] | LocationLink[]
エラー: エラーコードと textDocument/implementation リクエスト中に発生した例外がセットされたメッセージ。

Find References Request

textDocument.references リクエストは与えられたテキスト位置で記述されているシンボルのプロジェクト全体での参照を解決するためにクライアントからサーバへ送信される。

クライアント機能:

プロパティパス(省略可能): textDocument.references
プロパティタイプ: 次で定義される ReferenceClientCapabilities

export interface ReferenceClientCapabilities {
	/**
	 * 参照解決機能が動的な機能登録をサポートするかどうか。
	 */
	dynamicRegistration?: boolean;
}

サーバ機能:

プロパティパス(省略可能): referencesProvider
プロパティタイプ: boolean | ReferenceOptions。ReferenceOptions は次で定義される:

export interface ReferenceOptions extends WorkDoneProgressOptions {
}

登録オプション: 次で定義される ReferenceRegistrationOptions:

export interface ReferenceRegistrationOptions extends TextDocumentRegistrationOptions, ReferenceOptions {
}

リクエスト:

メソッド: textDocument/references
パラメータ: 次で定義される ReferenceParams:

export interface ReferenceParams extends TextDocumentPositionParams, WorkDoneProgressParams, PartialResultParams {
	context: ReferenceContext
}

interface ReferenceContext {
	/**
	 * 現在のシンボルの宣言を含む。
	 */
	includeDeclaration: boolean;
}

レスポンス:

結果: Location[] | null
部分的結果: Location[]
エラー: エラーコードと textDocument/references リクエスト中に発生した例外がセットされたメッセージ。

Document Highlights Request

textDocument/documentHighlight リクエストは与えられたテキスト位置のドキュメントハイライトを解決するためにクライアントからサーバへ送信される。プログラミング言語の場合、通常、このファイルをスコープとするシンボルへの全ての参照をハイライトする。しかし、 textDocument/documentHighlight と textDocument/references を別のリクエストとしたのは最初のリクエストをより曖昧にできるようにするためである。シンボルはたいてい DocumentHighlightKind の Read または Write にマッチする、一方曖昧または文字的な一致には Text が用いられる。

クライアント機能:

プロパティパス(省略可能): textDocument.documentHighlight
プロパティタイプ: 次で定義される DocumentHighlightClientCapabilities:

export interface DocumentHighlightClientCapabilities {
	/**
	 * ドキュメントハイライト機能が動的な機能登録をサポートするかどうか。
	 */
	dynamicRegistration?: boolean;
}

サーバ機能:

プロパティパス(省略可能): documentHighlightProvider
プロパティタイプ: boolean | DocumentHighlightOptions。DocumentHighlightOptions は次で定義される:

export interface DocumentHighlightOptions extends WorkDoneProgressOptions {
}

登録オプション: 次で定義される DocumentHighlightRegistrationOptions:

export interface DocumentHighlightRegistrationOptions extends TextDocumentRegistrationOptions, DocumentHighlightOptions {
}

リクエスト:

メソッド: textDocument/documentHighlight
パラメータ: 次で定義される DocumentHighlightParams:

export interface DocumentHighlightParams extends TextDocumentPositionParams, WorkDoneProgressParams, PartialResultParams {
}

レスポンス:

結果: 次で定義される DocumentHighlight[] | null

/**
 * ドキュメントハイライトは特別に注意するテキストドキュメント内の範囲である。大
 * 抵、ドキュメントハイライトはその範囲の背景色を変更することによって可視化され
 * る。
 *
 */
interface DocumentHighlight {
	/**
	 * このハイライトが適用される範囲。
	 */
	range: Range;

	/**
	 * ハイライト種別、デフォルトでは `DocumentHighlightKind.Text`。
	 */
	kind?: number;
}

/**
 * ドキュメントハイライト種別。
 */
export namespace DocumentHighlightKind {
	/**
	 * テキストの出現。
	 */
	export const Text = 1;

	/**
	 * 変数の読み込みのような、シンボルの読み込み権限。
	 */
	export const Read = 2;

	/**
	 * 変数への書き込みのような、シンボルの書き込み権限。
	 */
	export const Write = 3;
}

部分的結果: DocumentHighlight[]
エラー: エラーコードと textDocument/documentHighlight リクエスト中に発生した例外がセットされたメッセージ。

Document Symbols Request

textDocument/documentSymbol リクエストはクライアントからサーバへ送信される。結果は以下のいずれかである。

SymbolInformation[] 与えられたテキストドキュメント内で見付かった全てのシンボルのリスト。シンボルの場所の範囲もシンボルのコンテナ名も階層構造の推測に用いるべきではない。
DocumentSymbol[] 与えられたテキストドキュメント内で見付かったシンボルの階層構造。

クライアント機能:

プロパティパス(省略可能): textDocument.documentSymbol
プロパティタイプ: 次で定義される DocumentSymbolClientCapabilities:

export interface DocumentSymbolClientCapabilities {
	/**
	 * ドキュメントシンボル機能が動的な機能登録をサポートするかどうか。
	 */
	dynamicRegistration?: boolean;

	/**
	 * `textDocument/documentSymbol` リクエストの `SymbolKind` 固有の機能
	 */
	symbolKind?: {
		/**
		 * クライアントがサポートするシンボル種別の値。このプロパティが存在する場
		 * 合、クライアントは範囲外の値を適切に処理し、不明な場合はデフォルト値に
		 * フォールバックすることも保証する。
		 *
		 * このプロパティが与えられていない場合、クライアントは LSP の初期バージョ
		 * ンで定義されていた `File` から `Array` までのみをサポートする。
		 */
		valueSet?: SymbolKind[];
	}

	/**
	 * クライアントは階層的なドキュメントシンボルをサポートする。
	 */
	hierarchicalDocumentSymbolSupport?: boolean;
}

サーバ機能:

プロパティパス(省略可能): documentSymbolProvider
プロパティタイプ: boolean | DocumentSymbolOptions。DocumentSymbolOptions は次で定義される:

export interface DocumentSymbolOptions extends WorkDoneProgressOptions {
}

登録オプション: 次で定義される DocumentSymbolRegistrationOptions

export interface DocumentSymbolRegistrationOptions extends TextDocumentRegistrationOptions, DocumentSymbolOptions {
}

リクエスト:

メソッド: textDocument/documentSymbol
パラメータ: 次で定義される DocumentSymbolParams:

interface DocumentSymbolParams {
	/**
	 * テキストドキュメント。
	 */
	textDocument: TextDocumentIdentifier;
}

レスポンス:

結果: 次で定義される DocumentSymbol[] | SymbolInformation[] | null:

/**
 * シンボル種別。
 */
export namespace SymbolKind {
	export const File = 1;
	export const Module = 2;
	export const Namespace = 3;
	export const Package = 4;
	export const Class = 5;
	export const Method = 6;
	export const Property = 7;
	export const Field = 8;
	export const Constructor = 9;
	export const Enum = 10;
	export const Interface = 11;
	export const Function = 12;
	export const Variable = 13;
	export const Constant = 14;
	export const String = 15;
	export const Number = 16;
	export const Boolean = 17;
	export const Array = 18;
	export const Object = 19;
	export const Key = 20;
	export const Null = 21;
	export const EnumMember = 22;
	export const Struct = 23;
	export const Event = 24;
	export const Operator = 25;
	export const TypeParameter = 26;
}

/**
 * 変数、クラス、インターフェイスなどのプログラミングの構成物を表現する。これは
 * ドキュメント上に表れる。ドキュメントシンボルは階層的で、二つの範囲を持つこと
 * ができる: 一つはその定義を囲む範囲、もう一つはそれ自身が最も関心のある点につ
 * いての範囲。例えば、識別子の範囲。
 */
export class DocumentSymbol {

	/**
	 * シンボル名。UI 上で表示されるため、空文字列や空白のみからなる文字列であっ
	 * てはならない。
	 */
	name: string;

	/**
	 * このシンボルの更なる詳細、例えば関数のシグネチャ。
	 */
	detail?: string;

	/**
	 * このシンボルの種別。
	 */
	kind: SymbolKind;

	/**
	 * このシンボルが非推奨かどうかを指す。
	 */
	deprecated?: boolean;

	/**
	 * シンボルを囲み前後の空白を含まず、コメントなどのその他は含む範囲。この情報
	 * は通常クライアントのカーソルが UI のシンボルで表示するためのシンボルに含ま
	 * れるかどうかを判断するために使われる。
	 */
	range: Range;

	/**
	 * The range that should be selected and revealed when this symbol is being picked, e.g the name of a function.
	 * Must be contained by the `range`.
	 */
	selectionRange: Range;

	/**
	 * Children of this symbol, e.g. properties of a class.
	 */
	children?: DocumentSymbol[];
}

/**
 * Represents information about programming constructs like variables, classes,
 * interfaces etc.
 */
interface SymbolInformation {
	/**
	 * The name of this symbol.
	 */
	name: string;

	/**
	 * The kind of this symbol.
	 */
	kind: number;

	/**
	 * Indicates if this symbol is deprecated.
	 */
	deprecated?: boolean;

	/**
	 * The location of this symbol. The location's range is used by a tool
	 * to reveal the location in the editor. If the symbol is selected in the
	 * tool the range's start information is used to position the cursor. So
	 * the range usually spans more then the actual symbol's name and does
	 * normally include things like visibility modifiers.
	 *
	 * The range doesn't have to denote a node range in the sense of a abstract
	 * syntax tree. It can therefore not be used to re-construct a hierarchy of
	 * the symbols.
	 */
	location: Location;

	/**
	 * The name of the symbol containing this symbol. This information is for
	 * user interface purposes (e.g. to render a qualifier in the user interface
	 * if necessary). It can't be used to re-infer a hierarchy for the document
	 * symbols.
	 */
	containerName?: string;
}

エラー: エラーコードと textDocument/documentSymbol リクエスト中に発生した例外がセットされたメッセージ。

Code Action Request

textDocument/codeAction リクエストは与えられたテキストドキュメントと範囲上でコマンドを実行するためにクライアントからサーバへ送信される。コマンドは典型的には問題を修正するかコードを綺麗/リファクタリングするものである。 textDocument/codeAction リクエストの結果は、通常 UI 上で表示される Command リテラルの配列である。サーバを多くのクライアントから使いやすくするために、指定されたコマンドはクライアント側ではなくサーバ側で処理すべきである (workspace/executeCommand と ServerCapabilities.executeCommandPrivider を参照)。クライアントがコードアクションによる編集を提供する場合、モードを使用するべきである。

コマンドがサーバにより選択された場合、コマンドを実行するために再度 (workspace/executeCommand により)リクエストを送信するべきである。

バージョン 3.8.0 から: CodeAction リテラルがサポートされることで、次のようなシナリオが可能になる:

コードアクションリクエストから直接ワークスペース編集に戻る機能。これにより実際のコードアクション実行のための別のサーバへの往復を避けることができる。しかし、サーバの提供者はコードアクションの計算が重かったり、編集が膨大な場合、結果がシンプルなコマンドであり必要な場合のみ実際の編集が実行されることが有用なサーバ実装であることを知っておくべきである。
種別を用いたコードアクションのグループ化機能。クライアントはこの情報を無視できる。しかし、これにより例えば対応するメニューにコードアクションをグループ化できる(例えばリファクタリングメニュー内に全てのリファクタリング用コードアクションを表示する)。

クライアントは対応するクライアント機能 codeAction.codeActionLiteralSupport により CodeAction リテラルとコードアクション種別をサポートすることを知らせる必要がある。

クライアント機能:

プロパティパス(省略可能): textDocument.codeAction
プロパティタイプ: 次で定義される CodeActionClientCapabilities:

export interface CodeActionClientCapabilities {
	/**
	 * Whether code action supports dynamic registration.
	 */
	dynamicRegistration?: boolean;

	/**
	 * The client supports code action literals as a valid
	 * response of the `textDocument/codeAction` request.
	 *
	 * @since 3.8.0
	 */
	codeActionLiteralSupport?: {
		/**
		 * The code action kind is supported with the following value
		 * set.
		 */
		codeActionKind: {

			/**
			 * The code action kind values the client supports. When this
			 * property exists the client also guarantees that it will
			 * handle values outside its set gracefully and falls back
			 * to a default value when unknown.
			 */
			valueSet: CodeActionKind[];
		};
	};

	/**
	 * Whether code action supports the `isPreferred` property.
	 * @since 3.15.0
	 */
	isPreferredSupport?: boolean;
}

サーバ機能:

プロパティパス(省略可能): codeActionProvider
プロパティタイプ: boolean | CodeActionOptions。CodeActionOptions は次で定義される:

export interface CodeActionOptions extends WorkDoneProgressOptions {
	/**
	 * CodeActionKinds that this server may return.
	 *
	 * The list of kinds may be generic, such as `CodeActionKind.Refactor`, or the server
	 * may list out every specific kind they provide.
	 */
	codeActionKinds?: CodeActionKind[];
}

登録オプション: 次で定義される CodeActionRegisterationOptions:

export interface CodeActionRegistrationOptions extends TextDocumentRegistrationOptions, CodeActionOptions {
}

リクエスト:

メソッド: textDocument/codeAction
パラメータ: 次で定義される CodeActionParams:

/**
 * Params for the CodeActionRequest
 */
export interface CodeActionParams extends WorkDoneProgressParams, PartialResultParams {
	/**
	 * The document in which the command was invoked.
	 */
	textDocument: TextDocumentIdentifier;

	/**
	 * The range for which the command was invoked.
	 */
	range: Range;

	/**
	 * Context carrying additional information.
	 */
	context: CodeActionContext;
}

/**
 * The kind of a code action.
 *
 * Kinds are a hierarchical list of identifiers separated by `.`, e.g. `"refactor.extract.function"`.
 *
 * The set of kinds is open and client needs to announce the kinds it supports to the server during
 * initialization.
 */
export type CodeActionKind = string;

/**
 * A set of predefined code action kinds.
 */
export namespace CodeActionKind {

	/**
	 * Empty kind.
	 */
	export const Empty: CodeActionKind = '';

	/**
	 * Base kind for quickfix actions: 'quickfix'.
	 */
	export const QuickFix: CodeActionKind = 'quickfix';

	/**
	 * Base kind for refactoring actions: 'refactor'.
	 */
	export const Refactor: CodeActionKind = 'refactor';

	/**
	 * Base kind for refactoring extraction actions: 'refactor.extract'.
	 *
	 * Example extract actions:
	 *
	 * - Extract method
	 * - Extract function
	 * - Extract variable
	 * - Extract interface from class
	 * - ...
	 */
	export const RefactorExtract: CodeActionKind = 'refactor.extract';

	/**
	 * Base kind for refactoring inline actions: 'refactor.inline'.
	 *
	 * Example inline actions:
	 *
	 * - Inline function
	 * - Inline variable
	 * - Inline constant
	 * - ...
	 */
	export const RefactorInline: CodeActionKind = 'refactor.inline';

	/**
	 * Base kind for refactoring rewrite actions: 'refactor.rewrite'.
	 *
	 * Example rewrite actions:
	 *
	 * - Convert JavaScript function to class
	 * - Add or remove parameter
	 * - Encapsulate field
	 * - Make method static
	 * - Move method to base class
	 * - ...
	 */
	export const RefactorRewrite: CodeActionKind = 'refactor.rewrite';

	/**
	 * Base kind for source actions: `source`.
	 *
	 * Source code actions apply to the entire file.
	 */
	export const Source: CodeActionKind = 'source';

	/**
	 * Base kind for an organize imports source action: `source.organizeImports`.
	 */
	export const SourceOrganizeImports: CodeActionKind = 'source.organizeImports';
}

/**
 * Contains additional diagnostic information about the context in which
 * a code action is run.
 */
export interface CodeActionContext {
	/**
	 * An array of diagnostics known on the client side overlapping the range provided to the
	 * `textDocument/codeAction` request. They are provided so that the server knows which
	 * errors are currently presented to the user for the given range. There is no guarantee
	 * that these accurately reflect the error state of the resource. The primary parameter
	 * to compute code actions is the provided range.
	 */
	diagnostics: Diagnostic[];

	/**
	 * Requested kind of actions to return.
	 *
	 * Actions not of this kind are filtered out by the client before being shown. So servers
	 * can omit computing them.
	 */
	only?: CodeActionKind[];
}

レスポンス:

結果: (Command | CodeAction)[] | null、CodeAction は次のように定義される。

/**
 * A code action represents a change that can be performed in code, e.g. to fix a problem or
 * to refactor code.
 *
 * A CodeAction must set either `edit` and/or a `command`. If both are supplied, the `edit` is applied first, then the `command` is executed.
 */
export interface CodeAction {

	/**
	 * A short, human-readable, title for this code action.
	 */
	title: string;

	/**
	 * The kind of the code action.
	 *
	 * Used to filter code actions.
	 */
	kind?: CodeActionKind;

	/**
	 * The diagnostics that this code action resolves.
	 */
	diagnostics?: Diagnostic[];

	/**
	 * Marks this as a preferred action. Preferred actions are used by the `auto fix` command and can be targeted
	 * by keybindings.
	 *
	 * A quick fix should be marked preferred if it properly addresses the underlying error.
	 * A refactoring should be marked preferred if it is the most reasonable choice of actions to take.
	 *
	 * @since 3.15.0
	 */
	isPreferred?: boolean;

	/**
	 * The workspace edit this code action performs.
	 */
	edit?: WorkspaceEdit;

	/**
	 * A command this code action executes. If a code action
	 * provides an edit and a command, first the edit is
	 * executed and then the command.
	 */
	command?: Command;
}

部分的結果: (Command | CodeAction)[]
エラー: エラーコードと textDocument/codeAction リクエスト中に発生した例外がセットされたメッセージ。

Code Lens Request

textDocument/codeLens リクエストは与えられたテキストドキュメントのコードレンズを計算するためにクライアントからサーバへ送信される。

クライアント機能:

プロパティパス(省略可能): textDocument.codeLens
プロパティタイプ: 次で定義される CodeLensClientCapabilities

export interface CodeLensClientCapabilities {
	/**
	 * Whether code lens supports dynamic registration.
	 */
	dynamicRegistration?: boolean;
}

サーバ機能:

プロパティパス(省略可能): codeLensProvider
プロパティタイプ: 次で定義される CodeLensOptions

export interface CodeLensOptions extends WorkDoneProgressOptions {
	/**
	 * Code lens has a resolve provider as well.
	 */
	resolveProvider?: boolean;
}

登録オプション: 次で定義される CodeLensRegistrationOptions:

export interface CodeLensRegistrationOptions extends TextDocumentRegistrationOptions, CodeLensOptions {
}

リクエスト:

メソッド: textDocument/codeLens
パラメータ: 次で定義される CodeLensParams:

interface CodeLensParams extends WorkDoneProgressParams, PartialResultParams {
	/**
	 * The document to request code lens for.
	 */
	textDocument: TextDocumentIdentifier;
}

レスポンス:

結果: 次で定義される CodeLens[] | null:

/**
 * A code lens represents a command that should be shown along with
 * source text, like the number of references, a way to run tests, etc.
 *
 * A code lens is _unresolved_ when no command is associated to it. For performance
 * reasons the creation of a code lens and resolving should be done in two stages.
 */
interface CodeLens {
	/**
	 * The range in which this code lens is valid. Should only span a single line.
	 */
	range: Range;

	/**
	 * The command this code lens represents.
	 */
	command?: Command;

	/**
	 * A data entry field that is preserved on a code lens item between
	 * a code lens and a code lens resolve request.
	 */
	data?: any
}

部分的結果: CodeLens[]
エラー: エラーコードとリクエスト中に発生した例外がセットされたメッセージ。

Code Lens Resolve Request

codeLens/resolve リクエストは与えられたコードレンズアイテムのコマンドを解決するためにクライアントからサーバへ送信される。

リクエスト:

メソッド: codeLens/resolve
パラメータ: CodeLens

レスポンス:

結果: CodeLens
エラー: エラーコードと codeLens/resolve リクエスト中に発生した例外がセットされたメッセージ。

Document Link Request

textDocument/documentLink リクエストはドキュメントへのリンクを要求するためにクライアントからサーバへ送信される。

クライアント機能:

プロパティパス(省略可能): textDocument.documentLink
プロパティタイプ: 次で定義される DocumentLinkClientCapabilities:

export interface DocumentLinkClientCapabilities {
	/**
	 * Whether document link supports dynamic registration.
	 */
	dynamicRegistration?: boolean;

	/**
	 * Whether the client supports the `tooltip` property on `DocumentLink`.
	 *
	 * @since 3.15.0
	 */
	tooltipSupport?: boolean;
}

サーバ機能:

プロパティパス(省略可能): documentLinkProvider
プロパティタイプ: 次で定義される DocumentLinkOptions:

export interface DocumentLinkOptions extends WorkDoneProgressOptions {
	/**
	 * Document links have a resolve provider as well.
	 */
	resolveProvider?: boolean;
}

登録オプション: 次で定義される DocumentLinkRegistrationOptions:

export interface DocumentLinkRegistrationOptions extends TextDocumentRegistrationOptions, DocumentLinkOptions {
}

リクエスト:

メソッド: textDocument/documentLink
パラメータ: 次で定義される DocumentLinkParams:

interface DocumentLinkParams extends WorkDoneProgressParams, PartialResultParams {
	/**
	 * The document to provide document links for.
	 */
	textDocument: TextDocumentIdentifier;
}

レスポンス:

結果: DocumentLink[] | null

/**
 * A document link is a range in a text document that links to an internal or external resource, like another
 * text document or a web site.
 */
interface DocumentLink {
	/**
	 * The range this link applies to.
	 */
	range: Range;

	/**
	 * The uri this link points to. If missing a resolve request is sent later.
	 */
	target?: DocumentUri;

	/**
	 * The tooltip text when you hover over this link.
	 *
	 * If a tooltip is provided, is will be displayed in a string that includes instructions on how to
	 * trigger the link, such as `{0} (ctrl + click)`. The specific instructions vary depending on OS,
	 * user settings, and localization.
	 *
	 * @since 3.15.0
	 */
	tooltip?: string;

	/**
	 * A data entry field that is preserved on a document link between a
	 * DocumentLinkRequest and a DocumentLinkResolveRequest.
	 */
	data?: any;
}

部分的結果: DocumentLink[]
エラー: エラーコードと textDocument/documentLink リクエスト中に発生した例外がセットされたメッセージ。

Document Link Resolve Request

documentLink/resolve リクエストは与えられた DocumentLink を解決するためにクライアントからサーバへ送信される。

リクエスト:

メソッド: documentLink/resolve
パラメータ: DocumentLink

レスポンス:

結果: DocumentLink
エラー: エラーコードと documentLink/resolve リクエスト中に発生した例外がセットされたメッセージ。

Document Color Request

バージョン 3.6.0 から

Document Color リクエストは与えられたテキストドキュメントで見付かった全ての色参照を列挙するためにクライアントからサーバへ送信される。範囲に加えて、色の RGB 値が返される。

クライアントはエディタで色参照を装飾するために結果を使うことができる。例えば:

参照の横に実際の色のカラーボックスを表示する
色参照の編集時にカラーピッカーを表示する

クライアント機能:

プロパティパス(省略可能): textDocument.colorProvider
プロパティタイプ: 次で定義される DocumentColorClientCapabilties

export interface DocumentColorClientCapabilities {
	/**
	 * Whether document color supports dynamic registration.
	 */
	dynamicRegistration?: boolean;
}

サーバ機能:

プロパティパス(省略可能): colorProvider
プロパティタイプ: boolean | DocumentColorOptions | DocumentColorRegistrationOptions。DocumentColorOptions は次で定義される:

export interface DocumentColorOptions extends WorkDoneProgressOptions {
}

登録オプション: 次で定義される DocumentColorRegistrationOptions:

export interface DocumentColorRegistrationOptions extends TextDocumentRegistrationOptions, StaticRegistrationOptions, DocumentColorOptions {
}

リクエスト:

メソッド: textDocument/documentColor
パラメータ: 次で定義される DocumentColorParams

interface DocumentColorParams extends WorkDoneProgressParams, PartialResultParams {
	/**
	 * The text document.
	 */
	textDocument: TextDocumentIdentifier;
}

レスポンス:

結果: 次で定義される ColorInformation[]

interface ColorInformation {
	/**
	 * The range in the document where this color appears.
	 */
	range: Range;

	/**
	 * The actual color value for this color range.
	 */
	color: Color;
}

/**
 * Represents a color in RGBA space.
 */
interface Color {

	/**
	 * The red component of this color in the range [0-1].
	 */
	readonly red: number;

	/**
	 * The green component of this color in the range [0-1].
	 */
	readonly green: number;

	/**
	 * The blue component of this color in the range [0-1].
	 */
	readonly blue: number;

	/**
	 * The alpha component of this color in the range [0-1].
	 */
	readonly alpha: number;
}

部分的結果: ColorInformation[]
エラー: エラーコードと textDocument/documentColor リクエスト中に発生した例外がセットされたメッセージ。

Color Presentation Request

バージョン 3.6.0 から

Color Presentation リクエストは与えられた位置の色値の表現一覧を取得するためにクライアントからサーバへ送信される。クライアントはこの結果を以下の用途に使用できる。

色参照を編集する
カラーピッカーの中で表示し、表現をユーザに選択させる

このリクエストは textDocument/documentColor リクエストの解決のために送信されるため、特別な機能や登録オプションを持たない。

リクエスト:

メソッド: textDocument/colorPresentation
パラメータ: 次で定義される ColorPresentationParams

interface ColorPresentationParams extends WorkDoneProgressParams, PartialResultParams {
	/**
	 * The text document.
	 */
	textDocument: TextDocumentIdentifier;

	/**
	 * The color information to request presentations for.
	 */
	color: Color;

	/**
	 * The range where the color would be inserted. Serves as a context.
	 */
	range: Range;
}

レスポンス:

結果: 次で定義される ColorPresentation[]

interface ColorPresentation {
	/**
	 * The label of this color presentation. It will be shown on the color
	 * picker header. By default this is also the text that is inserted when selecting
	 * this color presentation.
	 */
	label: string;
	/**
	 * An [edit](#TextEdit) which is applied to a document when selecting
	 * this presentation for the color.  When `falsy` the [label](#ColorPresentation.label)
	 * is used.
	 */
	textEdit?: TextEdit;
	/**
	 * An optional array of additional [text edits](#TextEdit) that are applied when
	 * selecting this color presentation. Edits must not overlap with the main [edit](#ColorPresentation.textEdit) nor with themselves.
	 */
	additionalTextEdits?: TextEdit[];
}

部分的結果: ColorPresentation[]
エラー: エラーコードと textDocument/colorPresentation リクエスト中に発生した例外がセットされたメッセージ。

Document Formatting Request

textDoucment/formatting リクエストはドキュメント全体をフォーマットするためにクライアントからサーバへ送信される。

クライアント機能:

プロパティパス(省略可能): textDocument.formatting
プロパティタイプ: 次で定義される DocumentFormattingClientCapabilities:

export interface DocumentFormattingClientCapabilities {
	/**
	 * Whether formatting supports dynamic registration.
	 */
	dynamicRegistration?: boolean;
}

サーバ機能:

プロパティパス(省略可能): documentFormattingProvider
プロパティタイプ: boolean | DocumentFormattingOptions。DocumentFormattingOptons は次で定義される:

export interface DocumentFormattingOptions extends WorkDoneProgressOptions {
}

登録オプション: 次で定義される DocumentFormattingRegistrationOptions:

export interface DocumentFormattingRegistrationOptions extends TextDocumentRegistrationOptions, DocumentFormattingOptions {
}

リクエスト:

メソッド: textDocument/formatting
パラメータ: 次で定義される DocumentFormattingParams

interface DocumentFormattingParams extends WorkDoneProgressParams {
	/**
	 * The document to format.
	 */
	textDocument: TextDocumentIdentifier;

	/**
	 * The format options.
	 */
	options: FormattingOptions;
}

/**
 * Value-object describing what options formatting should use.
 */
interface FormattingOptions {
	/**
	 * Size of a tab in spaces.
	 */
	tabSize: number;

	/**
	 * Prefer spaces over tabs.
	 */
	insertSpaces: boolean;

	/**
	 * Trim trailing whitespace on a line.
	 *
	 * @since 3.15.0
	 */
	trimTrailingWhitespace?: boolean;

	/**
	 * Insert a newline character at the end of the file if one does not exist.
	 *
	 * @since 3.15.0
	 */
	insertFinalNewline?: boolean;

	/**
	 * Trim all newlines after the final newline at the end of the file.
	 *
	 * @since 3.15.0
	 */
	trimFinalNewlines?: boolean;

	/**
	 * Signature for further properties.
	 */
	[key: string]: boolean | number | string;
}

レスポンス:

結果: TextEdit[] | null。フォーマットされたドキュメントへの編集が記述される。
エラー: エラーコードと textDocument/formatting リクエスト中に発生した例外がセットされたメッセージ。

Document Range Formatting Request

textDocument/rangeFormatting リクエストは与えられたドキュメントの範囲をフォーマットするためにクライアントからサーバへ送信される。

クライアント機能:

プロパティパス(省略可能): textDocument.rangeFormatting
プロパティタイプ: 次で定義される DocumentRangeFormattingClientCapabilities:

export interface DocumentRangeFormattingClientCapabilities {
	/**
	 * Whether formatting supports dynamic registration.
	 */
	dynamicRegistration?: boolean;
}

サーバ機能:

プロパティパス(省略可能): documentRangeFormattingProvider
プロパティタイプ: boolean | DocumentRangeFormattingOptions。DocumentRangeFormattingOptons は次で定義される:

export interface DocumentRangeFormattingOptions extends WorkDoneProgressOptions {
}

登録オプション: 次で定義される DocumentRangeFormattingRegistrationOptions:

export interface DocumentRangeFormattingRegistrationOptions extends TextDocumentRegistrationOptions, DocumentRangeFormattingOptions {
}

リクエスト:

メソッド: textDocument/rangeFormatting
パラメータ: 次で定義される DocumentRangeFormattingParams

interface DocumentRangeFormattingParams extends WorkDoneProgressParams {
	/**
	 * The document to format.
	 */
	textDocument: TextDocumentIdentifier;

	/**
	 * The range to format
	 */
	range: Range;

	/**
	 * The format options
	 */
	options: FormattingOptions;
}

レスポンス:

結果: TextEdit[] | null。フォーマットされたドキュメントへの編集が記述される。
エラー: エラーコードと textDocument/rangeFormatting リクエスト中に発生した例外がセットされたメッセージ。

Document on Type Formatting Request

Document on Type Formatting リクエストは入力中のドキュメントをフォーマットするためにクライアントからサーバへ送信される。

クライアント機能:

プロパティパス(省略可能): textDocument.onTypeFormatting
プロパティタイプ: 次で定義される DocumentOnTypeFormattingClientCapabilities:

export interface DocumentOnTypeFormattingClientCapabilities {
	/**
	 * Whether on type formatting supports dynamic registration.
	 */
	dynamicRegistration?: boolean;
}

サーバ機能:

プロパティパス(省略可能): documentOnTypeFormattingProvider
プロパティタイプ: boolean | DocumentOnTypeFormattingOptions。DocumentOnTypeFormattingOptons は次で定義される:

export interface DocumentOnTypeFormattingOptions {
	/**
	 * A character on which formatting should be triggered, like `}`.
	 */
	firstTriggerCharacter: string;

	/**
	 * More trigger characters.
	 */
	moreTriggerCharacter?: string[];
}

登録オプション: 次で定義される DocumentOnTypeFormattingRegistrationOptions:

export interface DocumentOnTypeFormattingRegistrationOptions extends TextDocumentRegistrationOptions, DocumentOnTypeFormattingOptions {
}

リクエスト:

メソッド: textDocument/onTypeFormatting
パラメータ: 次で定義される DocumentOnTypeFormattingParams:

interface DocumentOnTypeFormattingParams {
	/**
	 * The document to format.
	 */
	textDocument: TextDocumentIdentifier;

	/**
	 * The position at which this request was sent.
	 */
	position: Position;

	/**
	 * The character that has been typed.
	 */
	ch: string;

	/**
	 * The format options.
	 */
	options: FormattingOptions;
}

レスポンス:

結果: TextEdit[] | null フォーマットされたドキュメントへの編集が記述される。
エラー: エラーコードと textDocument/onTypeFormatting リクエスト中に発生した例外がセットされたメッセージ。

Rename Request

textDocument/rename リクエストは、クライアントがシンボルのワークスペース全体でのリネームを行なうために、サーバがワークスペースへの変更を計算するために、クライアントからサーバへ送信される。

クライアント機能:

プロパティパス(省略可能): textDocument.rename
プロパティタイプ: 次で定義される RenameClientCapabilities:

export interface RenameClientCapabilities {
	/**
	 * Whether rename supports dynamic registration.
	 */
	dynamicRegistration?: boolean;

	/**
	 * Client supports testing for validity of rename operations
	 * before execution.
	 *
	 * @since version 3.12.0
	 */
	prepareSupport?: boolean;
}

サーバ機能:

プロパティパス(省略可能): renameProvider
プロパティタイプ: boolean | RenameOptions。RenameOptions は次で定義される。

RenameOptions は最初の initialize リクエストで prepareSupport をサポートする状態のクライアントのときのみだけ指定される。

export interface RenameOptions extends WorkDoneProgressOptions {
	/**
	 * Renames should be checked and tested before being executed.
	 */
	prepareProvider?: boolean;
}

登録オプション: 次で定義される RenameRegistrationOptions:

export interface RenameRegistrationOptions extends TextDocumentRegistrationOptions, RenameOptions {
}

リクエスト:

メソッド: textDocument/rename
パラメータ: 次で定義される RenameParams

interface RenameParams extends WorkDoneProgressParams {
	/**
	 * The document to rename.
	 */
	textDocument: TextDocumentIdentifier;

	/**
	 * The position at which this request was sent.
	 */
	position: Position;

	/**
	 * The new name of the symbol. If the given name is not valid the
	 * request must return a [ResponseError](#ResponseError) with an
	 * appropriate message set.
	 */
	newName: string;
}

レスポンス:

結果: WorkspaceEdit | null。ワークスペースへの変更を記述する
エラー: エラーコードと textDocument/rename リクエスト中に発生した例外がセットされたメッセージ。

Prepare Rename Request

バージョン 3.12.0 から

textDocument/prepareRename リクエストは与えられた場所でのリネーム処理の妥当性をテストするためにクライアントからサーバへ送信される。

リクエスト:

メソッド: textDocument/prepareRename
パラメータ: TextDocumentPositionParams

レスポンス:

結果: Range | { range: Range, placeholder: string } | null リネームする文字列の範囲とオプションでリネームする文字列のプレースホルダを記述する。null が返された場合、与えられた位置での textDocument/rename リクエストは無効であるとみなす。
エラー: エラーコードと textDocument/prepareRename リクエスト中に発生した例外がセットされたメッセージ。

Folding Range Request

バージョン 3.10.0 から

textDocument/foldingRange リクエストは与えられたテキストドキュメントの折り畳む全て範囲を返すためにクライアントからサーバへ送信される。

クライアント機能:

プロパティパス(省略可能): textDocument.foldingRange
プロパティタイプ: 次で定義される FoldingRangeClientCapabilities

export interface FoldingRangeClientCapabilities {
	/**
	 * Whether implementation supports dynamic registration for folding range providers. If this is set to `true`
	 * the client supports the new `FoldingRangeRegistrationOptions` return value for the corresponding server
	 * capability as well.
	 */
	dynamicRegistration?: boolean;
	/**
	 * The maximum number of folding ranges that the client prefers to receive per document. The value serves as a
	 * hint, servers are free to follow the limit.
	 */
	rangeLimit?: number;
	/**
	 * If set, the client signals that it only supports folding complete lines. If set, client will
	 * ignore specified `startCharacter` and `endCharacter` properties in a FoldingRange.
	 */
	lineFoldingOnly?: boolean;
}

サーバ機能:

プロパティパス(省略可能): foldingRangeProvider
プロパティタイプ: boolean | FoldingRangeOptions | FoldingRangeRegistrationOptions。FoldingRangeOptions は次のように定義される。

export interface FoldingRangeOptions extends WorkDoneProgressOptions {
}

登録オプション: 次で定義される FoldingRangeRegistrationOptions:

export interface FoldingRangeRegistrationOptions extends TextDocumentRegistrationOptions, FoldingRangeOptions, StaticRegistrationOptions {
}

リクエスト:

メソッド: textDocument/foldingRange
パラメータ: 次で定義される FoldingRangeParams

export interface FoldingRangeParams extends WorkDoneProgressParams, PartialResultParams {
	/**
	 * The text document.
	 */
	textDocument: TextDocumentIdentifier;
}

レスポンス:

結果: 次で定義される FoldingRange[] | null

/**
 * Enum of known range kinds
 */
export enum FoldingRangeKind {
	/**
	 * Folding range for a comment
	 */
	Comment = 'comment',
	/**
	 * Folding range for a imports or includes
	 */
	Imports = 'imports',
	/**
	 * Folding range for a region (e.g. `#region`)
	 */
	Region = 'region'
}

/**
 * Represents a folding range.
 */
export interface FoldingRange {

	/**
	 * The zero-based line number from where the folded range starts.
	 */
	startLine: number;

	/**
	 * The zero-based character offset from where the folded range starts. If not defined, defaults to the length of the start line.
	 */
	startCharacter?: number;

	/**
	 * The zero-based line number where the folded range ends.
	 */
	endLine: number;

	/**
	 * The zero-based character offset before the folded range ends. If not defined, defaults to the length of the end line.
	 */
	endCharacter?: number;

	/**
	 * Describes the kind of the folding range such as `comment` or `region`. The kind
	 * is used to categorize folding ranges and used by commands like 'Fold all comments'. See
	 * [FoldingRangeKind](#FoldingRangeKind) for an enumeration of standardized kinds.
	 */
	kind?: string;
}

部分的結果: FoldingRange[]
エラー: エラーコードと textDocument/foldingRange リクエスト中に発生した例外がセットされたメッセージ。

Selection Range Request

バージョン 3.15.0 から

textDocument/selectionRange リクエストは与えられた複数の位置で推奨される選択範囲を返すためにクライアントからサーバへ送信される。選択範囲はユーザが関心のある選択位置の周囲である。

返却された配列の選択範囲は与えられた同じインデックスのパラメータ内の位置である。よって、positions[i] は result[i].range に含まれていなければならない。

典型的には、必須ではないが、選択範囲は構文木のノードに対応する。

*クライアント機能:

プロパティパス(省略可能): textDocument.selectionRange
プロパティタイプ: 次で定義される SelectionRangeClientCapabilities:

export interface SelectionRangeClientCapabilities {
	/**
	 * 実装が選択範囲機能の動的な登録をサポートするかどうか。`true` である場合は
	 * クライアントは対応するサーバ機能の新しい
	 * `SelectionRangeRegistrationOptions` をサポートする。
	 */
	dynamicRegistration?: boolean;
}

サーバ機能:

プロパティパス(省略可能): selectionRangeProvider
プロパティタイプ: boolean | SelectionRangeOptions | SelectionRangeRegistrationOptions。SelectionRangeOptions は次で定義される:

export interface SelectionRangeOptions extends WorkDoneProgressOptions {
}

登録オプション: 次で定義される SelectionRangeRegistrationOptions:

export interface SelectionRangeRegistrationOptions extends SelectionRangeOptions, TextDocumentRegistrationOptions, StaticRegistrationOptions {
}

リクエスト:

メソッド: textDocument/selectionRange
パラメータ: 次で定義される SelectionRangeParams

export interface SelectionRangeParams extends WorkDoneProgressParams, PartialResultParams {
	/**
	 * The text document.
	 */
	textDocument: TextDocumentIdentifier;

	/**
	 * The positions inside the text document.
	 */
	positions: Position[];
}

レスポンス:

結果: 次で定義される SelectionRange[] | null

export interface SelectionRange {
	/**
	 * この選択範囲の `Range`
	 */
	range: Range;
	/**
	 * この範囲を含む親の選択範囲。よって `parent.range` は `this.range` を含ま
	 * なければならない。
	 */
	parent?: SelectionRange;
}

部分的結果: SelectionRange[]
エラー: エラーコードと textDocument/selectionRange リクエスト中に発生した例外がセットされたメッセージ。

Implementation considerations

言語サーバは大抵別のプロセスとして動作し、クライアントとは非同期に通信する。加えてクライアントは大抵リクエストがペンディング状態であってもソースコードへの変更が許容される。クライアントに古いレスポンスを適用させないために次の実装パターンを推奨する。

クライアントがサーバにリクエストを送信し、結果が無効になるようにクライアントの状態が変更する場合、サーバリクエストをキャンセルし、結果を無視すべきである。必要であれば、最新の結果を受信するためにリクエストを再送できる。
サーバが実行中のリクエストの結果を無効にする状態変更を検知した場合、そのリクエストに ContentModified エラーを返すことができる。クライアントが ContentModified エラーを受信した場合、一般的に UI 上でエンドユーザに見せるべきではない。クライアントは適切であればリクエストを再送できる。
サーバが矛盾した状態に陥った場合、window/logMessage リクエストでクライアントにそのことをログに残させるべきである。その状態から回復できない場合、最善は自身を終了されることである。現在クライアントからサーバを再起動させるためのプロトコル拡張を考えているところである。
クライアントが予期しないサーバの存在を検知した場合、サーバの再起動を試みるべきである。ただし、クライアントはクラッシュしたサーバを無限に再起動しないように注意すべきである。VS Code では例えば、180秒で5回クラッシュした場合はサーバを再起動しない。

Language Server Protocol Specification - 3.15

Base Protocol

Header Part

Content Part

Example:

Base Protocol JSON structures

Abstract Message

Request Message

Response Message

Notification Message

$ Notifications and Requests

Cancellation Support

Progress Support

Language Server Protocol

Basic JSON Structures

URI

Text Documents

Position

Range

Location

LocationLink

Diagnostic

Command

TextEdit

TextEdit[]

TextDocumentEdit

File Resource changes

WorkspaceEdit

WorkspaceEditClientCapabilities

TextDocumentIdentifier

TextDocumentItem

VersionedTextDocumentIdentifier

TextDocumentPositionParams

DocumentFilter

StaticRegistrationOptions

TextDocumentRegistrationOptions

MarkupContent

Work Done Progress

Work Done Progress Begin

Work Done Progress Report

Work Done Progress End

Initating Work Done Progress

Signaling Work Done Progress Reporting

WorkDoneProgressParams

WorkDoneProgressOptions

Partial Result Progress

PartialResultParams

Actual Protocol

Request, Notification and Response ordering

Server lifetime

Initialize Request

TextDocumentClientCapabilities define capabilities the editor / tool provides on text documents.

Initialized notification

Shutdown Request

Exit notification

ShowMessage Notification

ShowMessage Request

LogMessage Notification

Creating Work Done Progress

Telemetry Notification

Register Capability

Unregister Capability

Workspace folders request

DidChangeWorkspaceFolders Notification

DidChangeConfiguration Notification

Configuration Request

DidChangeWatchedFiles Notification

Workspace Symbols Request

Execute a command

Applies a WorkspaceEdit

Text Document Synchronization

DidOpenTextDocument Notification

DidChangeTextDocument Notification

WillSaveTextDocument Notification

WillSaveWaitUntilTextDocument Request

DidSaveTextDocument Notification

DidCloseTextDocument Notification

PublishDiagnostics Notification

Completion Request

Snippet Syntax

`TextDocumentClientCapabilities` define capabilities the editor / tool provides on text documents.