when 句のコンテキスト

Visual Studio Code は、VS Code UI で表示およびアクティブになっている要素に応じて、さまざまなコンテキストキーと特定の値​​を設定します。これらのコンテキストを使用して、メニューやビューなどの拡張機能コマンドと UI 要素を選択的に有効または無効にすることができます。

たとえば、VS Code は when 句を使用してコマンドキーバインドを有効または無効にします。これは、既定のキーバインド JSON ([基本設定: 既定のキーボードショートカットを開く (JSON)]) で確認できます。

{ "key": "f5",  "command": "workbench.action.debug.start",
                   "when": "debuggersAvailable && !inDebugMode" },

上記では、組み込みの [デバッグの開始] コマンドにキーボードショートカット F5 が割り当てられており、これは適切なデバッガーが利用可能な場合 (コンテキストキー debuggersAvailable が true) で、エディターがデバッグモードではない場合 (コンテキストキー inDebugMode が false) のみ有効になります。

条件演算子

when 句は、コンテキストキー (たとえば、inDebugMode) で構成することも、さまざまな演算子を使用して、より微妙なエディターの状態を表現することもできます。

論理演算子

論理演算子を使用すると、単純なコンテキストキー、または他の論理演算子、等価演算子、比較演算子、一致演算子、in/not in 演算子、または括弧で囲まれた式を含む when 句式を組み合わせることができます。

論理演算子の優先順位に関する注記: 上の表は、演算子を優先順位の高い順にリストしています。例

等価演算子

コンテキストキーの値が指定された値と等しいかどうかを確認できます。右辺は値であり、コンテキストキーとして解釈されないことに注意してください。つまり、コンテキスト内で検索されません。

注

• 右辺の値が空白文字を含む文字列の場合、一重引用符で囲む必要があります - "resourceFilename == 'My New File.md'"。
• === は == と同じ動作をし、!== は != と同じ動作をします。

比較演算子

コンテキストキーの値と数値を比較できます。演算子の左辺と右辺は空白文字で区切る必要があります - foo < 1 (foo<1 は不可)。

一致演算子

(旧名: キーと値のペア一致演算子)

when 句には一致演算子 (=~) があります。式 key =~ regularExpressionLiteral は、右辺を左辺と照合する正規表現リテラルとして扱います。たとえば、すべての Docker ファイルのコンテキストメニュー項目を提供するには、次のように使用できます。

   "when": "resourceFilename =~ /docker/"

注

• =~ 演算子の右辺は、JavaScript の正規表現リテラル (リファレンス) と同じルールに従いますが、文字は JSON 文字列と正規表現の両方のエスケープルールに従う必要があります。たとえば、サブ文字列 file:// に一致する正規表現リテラルは、JavaScript では /file:\/\// ですが、when 句では /file:\\/\\// になります。これは、JSON 文字列ではバックスラッシュをエスケープする必要があり、正規表現パターンではスラッシュをエスケープする必要があるためです。
• !=~ 演算子は存在しませんが、一致式を否定することはできます - !(foo =~ /baz/)。

正規表現フラグ

正規表現リテラルでフラグを使用できます。たとえば、resourceFilename =~ /json/i や myContextKey =~ /baz/si などです。

サポートされているフラグ: i、s、m、u。

無視されるフラグ: g、y。

'in' および 'not in' 条件演算子

when 句の in 演算子を使用すると、別のコンテキストキーの値内でコンテキストキーの値を動的に検索できます。たとえば、特定の種類のファイルを含むフォルダー (または静的に認識できないもの) にコンテキストメニューコマンドを追加する場合、in 演算子を使用して実現できます。not in 演算子を使用して、反対の条件を確認できます。

まず、コマンドをサポートするフォルダーを決定し、フォルダー名を配列に追加します。次に、setContext コマンドを使用して、配列をコンテキストキーに変換します。

vscode.commands.executeCommand('setContext', 'ext.supportedFolders', [
  'test',
  'foo',
  'bar'
]);

// or

// Note in this case (using an object), the value doesn't matter, it is based on the existence of the key in the object
// The value must be of a simple type
vscode.commands.executeCommand('setContext', 'ext.supportedFolders', {
  test: true,
  foo: 'anything',
  bar: false
});

次に、package.json で、explorer/context メニューのメニューコントリビューションを追加できます。

// Note, this assumes you have already defined a command called ext.doSpecial
"menus": {
  "explorer/context": [
    {
      "command": "ext.doSpecial",
      "when": "explorerResourceIsFolder && resourceFilename in ext.supportedFolders"
    }
  ]
}

その例では、resourceFilename の値 (この場合はフォルダーの名前) を取得し、ext.supportedFolders の値に存在するかどうかを確認しています。存在する場合、メニューが表示されます。この強力な演算子により、メニュー、ビューなど、when 句をサポートする、より豊富な条件付きおよび動的なコントリビューションが可能になるはずです。

利用可能なコンテキストキー

以下は、Boolean の true/false に評価される、利用可能なコンテキストキーの一部です。

ここに示すリストはすべてを網羅しているわけではありません。他の when 句コンテキストは、キーボードショートカットエディター ([基本設定: キーボードショートカットを開く]) で検索およびフィルタリングするか、既定のキーバインド JSON ファイル ([基本設定: 既定のキーボードショートカットを開く (JSON)]) を確認することで見つけることができます。また、コンテキストキーの検査ユーティリティを使用して、関心のあるコンテキストキーを特定することもできます。

注: ここでは、"config." というプレフィックスを付けて、ブール値に評価されるユーザーまたはワークスペース設定を使用できます。

表示/フォーカスされたビューの when 句コンテキスト

特定の ビューが表示されているか、またはフォーカスされているかを確認する when 句を設定できます。

ビューの識別子

• workbench.explorer.fileView - ファイルエクスプローラー
• workbench.explorer.openEditorsView - 開いているエディター
• outline - アウトラインビュー
• timeline - タイムラインビュー
• workbench.scm - ソース管理
• workbench.scm.repositories - ソース管理リポジトリ
• workbench.debug.variablesView - 変数
• workbench.debug.watchExpressionsView - ウォッチ
• workbench.debug.callStackView - コールスタック
• workbench.debug.loadedScriptsView - ロードされたスクリプト
• workbench.debug.breakPointsView - ブレークポイント
• workbench.debug.disassemblyView - 逆アセンブル
• workbench.views.extensions.installed - インストール済み拡張機能
• extensions.recommendedList - おすすめの拡張機能
• workbench.panel.markers.view - [問題]
• workbench.panel.output - 出力
• workbench.panel.repl.view - デバッグコンソール
• terminal - 統合ターミナル
• workbench.panel.comments - コメント

表示されているビューコンテナの when 句コンテキスト

特定の ビューコンテナが表示されているかどうかを確認する when 句を設定できます。

ビューコンテナの識別子

• workbench.view.explorer - ファイルエクスプローラー
• workbench.view.search - 検索
• workbench.view.scm - ソース管理
• workbench.view.debug - 実行とデバッグ
• workbench.view.extensions - 拡張機能
• workbench.panel.markers - 問題
• workbench.panel.output - 出力
• workbench.panel.repl - デバッグコンソール
• terminal - 統合ターミナル
• workbench.panel.comments - コメント

特定のビューコンテナがフォーカスされている場合にのみ有効になる when 句が必要な場合は、sideBarFocus または panelFocus または auxiliaryBarFocus を activeViewlet または activePanel または activeAuxiliary コンテキストキーと組み合わせて使用します。

たとえば、次の when 句は、ファイルエクスプローラーがフォーカスされている場合にのみ true になります。

"sideBarFocus && activeViewlet == 'workbench.view.explorer'"

when 句で設定を確認する

when 句では、config.editor.tabCompletion や config.breadcrumbs.enabled など、構成 (設定) 値を参照するには、先頭に config. を付けます。

カスタム when 句コンテキストを追加する

独自の VS Code 拡張機能をオーサリングしていて、when 句コンテキストを使用してコマンド、メニュー、またはビューを有効/無効にする必要があり、既存のキーがニーズに合わない場合は、setContext コマンドを使用して独自のコンテキストキーを追加できます。

以下の最初の例では、キー myExtension.showMyCommand を true に設定します。これは、コマンドの有効化または when プロパティで使用できます。2 番目の例では、開いているクールなものの数が 2 より大きいかどうかを確認するために when 句で使用できる値を格納します。

vscode.commands.executeCommand('setContext', 'myExtension.showMyCommand', true);

vscode.commands.executeCommand('setContext', 'myExtension.numberOfCoolOpenThings', 4);

コンテキストキーの検査ユーティリティ

実行時に現在アクティブなすべてのコンテキストキーを確認する場合は、コマンドパレットから [開発者: コンテキストキーの検査] コマンド (⇧⌘P (Windows、Linux Ctrl+Shift+P)) を使用できます。[コンテキストキーの検査] を実行すると、コンテキストキーとその値が VS Code 開発者ツールの [コンソール] タブ ([ヘルプ] > [開発者ツールの切り替え]) に表示されます。

[開発者: コンテキストキーの検査] を実行すると、カーソルが VS Code UI の要素を強調表示し、要素をクリックすると、現在のコンテキストキーとその状態がオブジェクトとしてコンソールに出力されます。

アクティブなコンテキストキーのリストは広範囲にわたっており、インストールした拡張機能からのカスタムコンテキストキーが含まれている場合があります。

注: 一部のコンテキストキーは VS Code 内部で使用するためのものであり、将来変更される可能性があります。