プログラムによる言語機能

プログラムによる言語機能は、vscode.languages.* API を利用したスマート編集機能のセットです。Visual Studio Code で動的な言語機能を提供する方法は、一般的に2つあります。ホバーを例に見てみましょう。

vscode.languages.registerHoverProvider('javascript', {
  provideHover(document, position, token) {
    return {
      contents: ['Hover Content']
    };
  }
});

上記に示すように、vscode.languages.registerHoverProvider API は、JavaScript ファイルにホバーコンテンツを提供する簡単な方法を提供します。この拡張機能がアクティブ化されると、JavaScript コードにマウスカーソルを合わせるたびに、VS Code は JavaScript のすべてのHoverProvider に問い合わせ、その結果をホバーウィジェットに表示します。言語機能リストと以下の図解付き GIF は、拡張機能に必要な VS Code API / LSP メソッドを簡単に見つける方法を提供します。

別の方法は、Language Server Protocol を話す Language Server を実装することです。その仕組みは次のとおりです。

• 拡張機能が JavaScript 用の Language Client と Language Server を提供します。
• Language Client は他の VS Code 拡張機能と同様に、Node.js 拡張機能ホストのコンテキストで実行されます。アクティブ化されると、別のプロセスで Language Server を起動し、Language Server Protocol を介して通信します。
• VS Code で JavaScript コードにマウスカーソルを合わせる
• VS Code が Language Client にホバーを通知します。
• Language Client が Language Server にホバー結果を問い合わせ、VS Code に返送します。
• VS Code がホバーウィジェットにホバー結果を表示します。

このプロセスはより複雑に見えますが、2つの大きな利点があります。

• Language Server は任意の言語で記述できます。
• Language Server は複数のエディターにスマート編集機能を提供するために再利用できます。

より詳細なガイドについては、Language Server 拡張機能ガイドをご覧ください。

言語機能リスト

このリストには、各言語機能について以下の項目が含まれています。

• VS Code での言語機能のイラスト
• 関連する VS Code API
• 関連する LSP メソッド

診断機能の提供

診断機能は、コードの問題を示す方法です。

Language Server Protocol

Language Server は textDocument/publishDiagnostics メッセージを Language Client に送信します。このメッセージには、リソース URI の診断項目配列が含まれます。

注: クライアントはサーバーに診断を要求しません。サーバーが診断情報をクライアントにプッシュします。

直接実装

let diagnosticCollection: vscode.DiagnosticCollection;

export function activate(ctx: vscode.ExtensionContext): void {
  ...
  ctx.subscriptions.push(getDisposable());
  diagnosticCollection = vscode.languages.createDiagnosticCollection('go');
  ctx.subscriptions.push(diagnosticCollection);
  ...
}

function onChange() {
  let uri = document.uri;
  check(uri.fsPath, goConfig).then(errors => {
    diagnosticCollection.clear();
    let diagnosticMap: Map<string, vscode.Diagnostic[]> = new Map();
    errors.forEach(error => {
      let canonicalFile = vscode.Uri.file(error.file).toString();
      let range = new vscode.Range(error.line-1, error.startColumn, error.line-1, error.endColumn);
      let diagnostics = diagnosticMap.get(canonicalFile);
      if (!diagnostics) { diagnostics = []; }
      diagnostics.push(new vscode.Diagnostic(range, error.msg, error.severity));
      diagnosticMap.set(canonicalFile, diagnostics);
    });
    diagnosticMap.forEach((diags, file) => {
      diagnosticCollection.set(vscode.Uri.parse(file), diags);
    });
  })
}

基本

開いているエディターの診断を報告します。最低限、これは保存ごとに発生する必要があります。より良いのは、エディターの未保存の内容に基づいて診断を計算することです。

高度な設定

開いているエディターだけでなく、開いているフォルダー内のすべてのリソースの診断を報告します。それらがエディターで開かれたことがあるかどうかに関係ありません。

コード補完候補の表示

コード補完は、ユーザーにコンテキストに応じた提案を提供します。

Language Server Protocol

initialize メソッドの応答で、Language Server は補完を提供すること、および計算された補完項目の追加情報を提供するために completionItem\resolve メソッドをサポートするかどうかを宣言する必要があります。

{
    ...
    "capabilities" : {
        "completionProvider" : {
            "resolveProvider": "true",
            "triggerCharacters": [ '.' ]
        }
        ...
    }
}

直接実装

class GoCompletionItemProvider implements vscode.CompletionItemProvider {
    public provideCompletionItems(
        document: vscode.TextDocument, position: vscode.Position, token: vscode.CancellationToken):
        Thenable<vscode.CompletionItem[]> {
    ...
    }
}

export function activate(ctx: vscode.ExtensionContext): void {
    ...
    ctx.subscriptions.push(getDisposable());
    ctx.subscriptions.push(
        vscode.languages.registerCompletionItemProvider(
            GO_MODE, new GoCompletionItemProvider(), '.', '\"'));
    ...
}

基本

リゾルブプロバイダーをサポートしていません。

高度な設定

ユーザーが選択した補完候補の追加情報を計算するリゾルブプロバイダーをサポートしています。この情報は、選択された項目の横に表示されます。

ホバーの表示

ホバーは、マウスカーソル下のシンボル/オブジェクトに関する情報を表示します。これは通常、シンボルの型と説明です。

Language Server Protocol

initialize メソッドの応答で、Language Server はホバーを提供することを宣言する必要があります。

{
    ...
    "capabilities" : {
        "hoverProvider" : "true",
        ...
    }
}

さらに、Language Server は textDocument/hover リクエストに応答する必要があります。

直接実装

class GoHoverProvider implements HoverProvider {
    public provideHover(
        document: TextDocument, position: Position, token: CancellationToken):
        Thenable<Hover> {
    ...
    }
}

export function activate(ctx: vscode.ExtensionContext): void {
    ...
    ctx.subscriptions.push(
        vscode.languages.registerHoverProvider(
            GO_MODE, new GoHoverProvider()));
    ...
}

基本

利用可能な場合は、型情報を表示し、ドキュメントを含めます。

高度な設定

コードを色付けするのと同じスタイルで、メソッドのシグネチャを色付けします。

関数とメソッドのシグネチャのヘルプ

ユーザーが関数またはメソッドを入力すると、呼び出されている関数/メソッドに関する情報を表示します。

Language Server Protocol

initialize メソッドの応答で、Language Server はシグネチャヘルプを提供することを宣言する必要があります。

{
    ...
    "capabilities" : {
        "signatureHelpProvider" : {
            "triggerCharacters": [ '(' ]
        }
        ...
    }
}

さらに、Language Server は textDocument/signatureHelp リクエストに応答する必要があります。

直接実装

class GoSignatureHelpProvider implements SignatureHelpProvider {
    public provideSignatureHelp(
        document: TextDocument, position: Position, token: CancellationToken):
        Promise<SignatureHelp> {
    ...
    }
}

export function activate(ctx: vscode.ExtensionContext): void {
    ...
    ctx.subscriptions.push(
        vscode.languages.registerSignatureHelpProvider(
            GO_MODE, new GoSignatureHelpProvider(), '(', ','));
    ...
}

基本

シグネチャヘルプに、関数またはメソッドのパラメーターのドキュメントが含まれていることを確認します。

高度な設定

その他は特にありません。

シンボルの定義の表示

ユーザーが変数/関数/メソッドが使用されている場所で、その定義を直接確認できるようにします。

Language Server Protocol

initialize メソッドの応答で、Language Server は goto 定義の場所を提供することを宣言する必要があります。

{
    ...
    "capabilities" : {
        "definitionProvider" : "true"
        ...
    }
}

さらに、Language Server は textDocument/definition リクエストに応答する必要があります。

直接実装

class GoDefinitionProvider implements vscode.DefinitionProvider {
    public provideDefinition(
        document: vscode.TextDocument, position: vscode.Position, token: vscode.CancellationToken):
        Thenable<vscode.Location> {
    ...
    }
}

export function activate(ctx: vscode.ExtensionContext): void {
    ...
    ctx.subscriptions.push(
        vscode.languages.registerDefinitionProvider(
            GO_MODE, new GoDefinitionProvider()));
    ...
}

基本

シンボルが曖昧な場合は、複数の定義を表示できます。

高度な設定

その他は特にありません。

シンボルへのすべての参照の検索

ユーザーが特定の変数/関数/メソッド/シンボルが使用されているすべてのソースコードの場所を確認できるようにします。

Language Server Protocol

initialize メソッドの応答で、Language Server はシンボル参照の場所を提供することを宣言する必要があります。

{
    ...
    "capabilities" : {
        "referencesProvider" : "true"
        ...
    }
}

さらに、Language Server は textDocument/references リクエストに応答する必要があります。

直接実装

class GoReferenceProvider implements vscode.ReferenceProvider {
    public provideReferences(
        document: vscode.TextDocument, position: vscode.Position,
        options: { includeDeclaration: boolean }, token: vscode.CancellationToken):
        Thenable<vscode.Location[]> {
    ...
    }
}

export function activate(ctx: vscode.ExtensionContext): void {
    ...
    ctx.subscriptions.push(
        vscode.languages.registerReferenceProvider(
            GO_MODE, new GoReferenceProvider()));
    ...
}

基本

すべての参照の場所（リソース URI と範囲）を返します。

高度な設定

その他は特にありません。

ドキュメント内のシンボルのすべての出現箇所をハイライト表示

ユーザーが開いているエディター内のシンボルのすべての出現箇所を確認できるようにします。

Language Server Protocol

initialize メソッドの応答で、Language Server はシンボルのドキュメントの場所を提供することを宣言する必要があります。

{
    ...
    "capabilities" : {
        "documentHighlightProvider" : "true"
        ...
    }
}

さらに、Language Server は textDocument/documentHighlight リクエストに応答する必要があります。

直接実装

class GoDocumentHighlightProvider implements vscode.DocumentHighlightProvider {
    public provideDocumentHighlights(
        document: vscode.TextDocument, position: vscode.Position, token: vscode.CancellationToken):
        vscode.DocumentHighlight[] | Thenable<vscode.DocumentHighlight[]>;
    ...
    }
}

export function activate(ctx: vscode.ExtensionContext): void {
    ...
    ctx.subscriptions.push(
        vscode.languages.registerDocumentHighlightProvider(
            GO_MODE, new GoDocumentHighlightProvider()));
    ...
}

基本

参照が見つかったエディターのドキュメント内の範囲を返します。

高度な設定

その他は特にありません。

ドキュメント内のすべてのシンボル定義を表示

ユーザーが開いているエディター内の任意のシンボル定義に素早く移動できるようにします。

Language Server Protocol

initialize メソッドの応答で、Language Server はシンボルのドキュメントの場所を提供することを宣言する必要があります。

{
    ...
    "capabilities" : {
        "documentSymbolProvider" : "true"
        ...
    }
}

さらに、Language Server は textDocument/documentSymbol リクエストに応答する必要があります。

直接実装

class GoDocumentSymbolProvider implements vscode.DocumentSymbolProvider {
    public provideDocumentSymbols(
        document: vscode.TextDocument, token: vscode.CancellationToken):
        Thenable<vscode.SymbolInformation[]> {
    ...
    }
}

export function activate(ctx: vscode.ExtensionContext): void {
    ...
    ctx.subscriptions.push(
        vscode.languages.registerDocumentSymbolProvider(
            GO_MODE, new GoDocumentSymbolProvider()));
    ...
}

基本

ドキュメント内のすべてのシンボルを返します。変数、関数、クラス、メソッドなどのシンボルの種類を定義します。

高度な設定

その他は特にありません。

フォルダー内のすべてのシンボル定義を表示

ユーザーが VS Code で開いているフォルダー（ワークスペース）内のどこにあるシンボル定義にも素早く移動できるようにします。

Language Server Protocol

initialize メソッドの応答で、Language Server はグローバルシンボルの場所を提供することを宣言する必要があります。

{
    ...
    "capabilities" : {
        "workspaceSymbolProvider" : "true"
        ...
    }
}

さらに、Language Server は workspace/symbol リクエストに応答する必要があります。

直接実装

class GoWorkspaceSymbolProvider implements vscode.WorkspaceSymbolProvider {
    public provideWorkspaceSymbols(
        query: string, token: vscode.CancellationToken):
        Thenable<vscode.SymbolInformation[]> {
    ...
    }
}

export function activate(ctx: vscode.ExtensionContext): void {
    ...
    ctx.subscriptions.push(
        vscode.languages.registerWorkspaceSymbolProvider(
            new GoWorkspaceSymbolProvider()));
    ...
}

基本

開いているフォルダー内のソースコードによって定義されたすべてのシンボルを返します。変数、関数、クラス、メソッドなどのシンボルの種類を定義します。

高度な設定

その他は特にありません。

エラーまたは警告に対する可能なアクション

エラーまたは警告のすぐ隣に、ユーザーに可能な修正アクションを提供します。アクションが利用可能な場合、エラーまたは警告の隣に電球が表示されます。ユーザーが電球をクリックすると、利用可能なコードアクションのリストが表示されます。

Language Server Protocol

initialize メソッドの応答で、Language Server はコードアクションを提供することを宣言する必要があります。

{
    ...
    "capabilities" : {
        "codeActionProvider" : "true"
        ...
    }
}

さらに、Language Server は textDocument/codeAction リクエストに応答する必要があります。

直接実装

class GoCodeActionProvider implements vscode.CodeActionProvider<vscode.CodeAction> {
    public provideCodeActions(
        document: vscode.TextDocument, range: vscode.Range | vscode.Selection,
        context: vscode.CodeActionContext, token: vscode.CancellationToken):
        Thenable<vscode.CodeAction[]> {
    ...
    }
}

export function activate(ctx: vscode.ExtensionContext): void {
    ...
    ctx.subscriptions.push(
        vscode.languages.registerCodeActionsProvider(
            GO_MODE, new GoCodeActionProvider()));
    ...
}

基本

エラー/警告修正アクションのためのコードアクションを提供します。

高度な設定

さらに、Extract Method などのリファクタリングなど、ソースコード操作アクションを提供します。

CodeLens - ソースコード内の操作可能なコンテキスト情報を表示

ソースコードに散在して表示される、操作可能なコンテキスト情報をユーザーに提供します。

Language Server Protocol

initialize メソッドの応答で、Language Server は CodeLens 結果を提供すること、および CodeLens をコマンドにバインドするために codeLens\resolve メソッドをサポートするかどうかを宣言する必要があります。

{
    ...
    "capabilities" : {
        "codeLensProvider" : {
            "resolveProvider": "true"
        }
        ...
    }
}

さらに、Language Server は textDocument/codeLens リクエストに応答する必要があります。

直接実装

class GoCodeLensProvider implements vscode.CodeLensProvider {
    public provideCodeLenses(document: TextDocument, token: CancellationToken):
        CodeLens[] | Thenable<CodeLens[]> {
    ...
    }

    public resolveCodeLens?(codeLens: CodeLens, token: CancellationToken):
         CodeLens | Thenable<CodeLens> {
    ...
    }
}

export function activate(ctx: vscode.ExtensionContext): void {
    ...
    ctx.subscriptions.push(
        vscode.languages.registerCodeLensProvider(
            GO_MODE, new GoCodeLensProvider()));
    ...
}

基本

ドキュメントで利用可能な CodeLens 結果を定義します。

高度な設定

codeLens/resolve に応答して、CodeLens 結果をコマンドにバインドします。

カラーデコレーターの表示

ユーザーがドキュメント内の色をプレビューおよび変更できるようにします。

Language Server Protocol

initialize メソッドの応答で、Language Server は色情報を提供することを宣言する必要があります。

{
    ...
    "capabilities" : {
        "colorProvider" : "true"
        ...
    }
}

さらに、Language Server は textDocument/documentColor および textDocument/colorPresentation リクエストに応答する必要があります。

直接実装

class GoColorProvider implements vscode.DocumentColorProvider {
    public provideDocumentColors(
        document: vscode.TextDocument, token: vscode.CancellationToken):
        Thenable<vscode.ColorInformation[]> {
    ...
    }
    public provideColorPresentations(
        color: Color, context: { document: TextDocument, range: Range }, token: vscode.CancellationToken):
        Thenable<vscode.ColorPresentation[]> {
    ...
    }
}

export function activate(ctx: vscode.ExtensionContext): void {
    ...
    ctx.subscriptions.push(
        vscode.languages.registerColorProvider(
            GO_MODE, new GoColorProvider()));
    ...
}

基本

ドキュメント内のすべての色の参照を返します。サポートされている色形式（例: rgb(...), hsl(...)）の色表示を提供します。

高度な設定

その他は特にありません。

エディターでソースコードをフォーマット

ドキュメント全体のフォーマットをユーザーにサポートします。

Language Server Protocol

initialize メソッドの応答で、Language Server はドキュメントフォーマットを提供することを宣言する必要があります。

{
    ...
    "capabilities" : {
        "documentFormattingProvider" : "true"
        ...
    }
}

さらに、Language Server は textDocument/formatting リクエストに応答する必要があります。

直接実装

class GoDocumentFormatter implements vscode.DocumentFormattingEditProvider {
    provideDocumentFormattingEdits(
        document: vscode.TextDocument, options: vscode.FormattingOptions, token: vscode.CancellationToken)
        : vscode.ProviderResult<vscode.TextEdit[]> {
    ...
    }
}

export function activate(ctx: vscode.ExtensionContext): void {
    ...
    ctx.subscriptions.push(
        vscode.languages.registerDocumentFormattingEditProvider(
            GO_MODE, new GoDocumentFormatter()));
    ...
}

基本

フォーマットサポートは提供しません。

高度な設定

ソースコードがフォーマットされた結果として、常に可能な限り最小のテキスト編集を返す必要があります。これは、診断結果などのマーカーが正しく調整され、失われないようにするために重要です。

エディターで選択した行をフォーマット

ドキュメントで選択した行範囲のフォーマットをユーザーにサポートします。

Language Server Protocol

initialize メソッドの応答で、Language Server は行範囲のフォーマットサポートを提供することを宣言する必要があります。

{
    ...
    "capabilities" : {
        "documentRangeFormattingProvider" : "true"
        ...
    }
}

さらに、Language Server は textDocument/rangeFormatting リクエストに応答する必要があります。

直接実装

class GoDocumentRangeFormatter implements vscode.DocumentRangeFormattingEditProvider{
    public provideDocumentRangeFormattingEdits(
        document: vscode.TextDocument, range: vscode.Range,
        options: vscode.FormattingOptions, token: vscode.CancellationToken):
        vscode.ProviderResult<vscode.TextEdit[]> {
    ...
    }
}

export function activate(ctx: vscode.ExtensionContext): void {
    ...
    ctx.subscriptions.push(
        vscode.languages.registerDocumentRangeFormattingEditProvider(
            GO_MODE, new GoDocumentRangeFormatter()));
    ...
}

基本

フォーマットサポートは提供しません。

高度な設定

ソースコードがフォーマットされた結果として、常に可能な限り最小のテキスト編集を返す必要があります。これは、診断結果などのマーカーが正しく調整され、失われないようにするために重要です。

ユーザーが入力するたびにコードをインクリメンタルにフォーマット

ユーザーが入力するにつれてテキストをフォーマットするサポートを提供します。

注: ユーザーの設定 editor.formatOnType は、ユーザーが入力する際にソースコードがフォーマットされるかどうかを制御します。

Language Server Protocol

initialize メソッドの応答で、Language Server はユーザーが入力する際にフォーマットを提供することを宣言する必要があります。また、フォーマットをトリガーする文字をクライアントに伝える必要があります。moreTriggerCharacters はオプションです。

{
    ...
    "capabilities" : {
        "documentOnTypeFormattingProvider" : {
            "firstTriggerCharacter": "}",
            "moreTriggerCharacter": [";", ","]
        }
        ...
    }
}

さらに、Language Server は textDocument/onTypeFormatting リクエストに応答する必要があります。

直接実装

class GoOnTypingFormatter implements vscode.OnTypeFormattingEditProvider{
    public provideOnTypeFormattingEdits(
        document: vscode.TextDocument, position: vscode.Position,
        ch: string, options: vscode.FormattingOptions, token: vscode.CancellationToken):
        vscode.ProviderResult<vscode.TextEdit[]> {
    ...
    }
}

export function activate(ctx: vscode.ExtensionContext): void {
    ...
    ctx.subscriptions.push(
        vscode.languages.registerOnTypeFormattingEditProvider(
            GO_MODE, new GoOnTypingFormatter()));
    ...
}

基本

フォーマットサポートは提供しません。

高度な設定

ソースコードがフォーマットされた結果として、常に可能な限り最小のテキスト編集を返す必要があります。これは、診断結果などのマーカーが正しく調整され、失われないようにするために重要です。

シンボルの名前変更

ユーザーがシンボルの名前を変更し、そのシンボルへのすべての参照を更新できるようにします。

Language Server Protocol

initialize メソッドの応答で、Language Server は名前変更を提供することを宣言する必要があります。

{
    ...
    "capabilities" : {
        "renameProvider" : "true"
        ...
    }
}

さらに、Language Server は textDocument/rename リクエストに応答する必要があります。

直接実装

class GoRenameProvider implements vscode.RenameProvider {
    public provideRenameEdits(
        document: vscode.TextDocument, position: vscode.Position,
        newName: string, token: vscode.CancellationToken):
        Thenable<vscode.WorkspaceEdit> {
    ...
    }
}

export function activate(ctx: vscode.ExtensionContext): void {
    ...
    ctx.subscriptions.push(
        vscode.languages.registerRenameProvider(
            GO_MODE, new GoRenameProvider()));
    ...
}

基本

名前変更のサポートは提供しません。

高度な設定

実行する必要があるすべてのワークスペース編集のリストを返します。例えば、シンボルへの参照を含むすべてのファイルにわたるすべての編集です。