VSCode APIで設定画面の特定の設定を表示する方法

この記事は公開から2年以上経過しています。

VSCode拡張開発で、設定画面の特定の設定を表示する方法。

例えば、拡張の設定に不備があったときエラーメッセージを表示するだけではなく、メッセージから直接該当する設定項目にジャンプするといったユーザビリティ向上を図る技に利用できます。

サンプルソースコード

vscode.commands.executeCommand(
    'workbench.action.openSettings',
    '検索設定名'
);

項目概要

vscode.commands.executeCommand() コマンドを実行するVSCode API。

workbench.action.openSettings 設定画面を表示するビルトインコマンドのコマンドID。

検索設定名

項目	概要
vscode.commands.executeCommand()	コマンドを実行するVSCode API。
workbench.action.openSettings	設定画面を表示するビルトインコマンドのコマンドID。
検索設定名	設定画面における設定検索キーワード。例えばVSCode Macros拡張の説明ページの`⚙`→`Extension Settings`をクリックした際に設定画面の検索テキストボックスに表示される`@ext:EXCEEDSYSTEM.vscode-macros`など(下図参照)。 ↓

設定画面における設定検索キーワード。
例えばVSCode Macros拡張の説明ページの⚙→Extension Settingsをクリックした際に設定画面の検索テキストボックスに表示される@ext:EXCEEDSYSTEM.vscode-macrosなど(下図参照)。

↓

以上です。