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 字符串和正则表达式的转义规则。例如，在 JavaScript 中匹配子字符串 file:// 的正则表达式字面量将是 /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 语句，例如菜单、视图等。

可用的上下文键

以下是一些可用的上下文键，它们评估为布尔值 true/false。

此处列表并非详尽无遗，您可以通过在键盘快捷方式编辑器（首选项：打开键盘快捷方式）中搜索和过滤，或查看默认键盘绑定 JSON 文件（首选项：打开默认键盘绑定 JSON）来查找其他 when 语句上下文。您还可以使用“检查上下文键实用程序”来识别您感兴趣的上下文键。

注意：您可以在此处使用任何评估为布尔值的用户或工作区设置，前缀为 "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. 前缀来引用配置（设置）值，例如 config.editor.tabCompletion 或 config.breadcrumbs.enabled。

添加自定义 when 语句上下文

如果您正在编写自己的 VS Code 扩展，并且需要使用 when 语句上下文来启用/禁用命令、菜单或视图，而现有键都不适合您，您可以使用 setContext 命令添加自己的上下文键。

下面的第一个示例将键 myExtension.showMyCommand 设置为 true，您可以在命令的启用条件中使用它，或与 when 属性一起使用。第二个示例存储了一个值，您可以使用它与 when 语句来检查酷炫的开放事物数量是否大于 2。

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

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

检查上下文键实用程序

如果您想在运行时查看所有当前活动的上下文键，可以从命令面板（⇧⌘P（Windows、Linux Ctrl+Shift+P））中使用 **Developer: Inspect Context Keys** 命令。**Inspect Context Keys** 将在 VS Code Developer Tools 的 **Console** 选项卡（**Help** > **Toggle Developer Tools**）中显示上下文键及其值。

运行 **Developer: Inspect Context Keys** 时，您的光标将突出显示 VS Code UI 中的元素，当您单击一个元素时，当前上下文键及其状态将作为对象输出到控制台。

活动上下文键列表非常广泛，可能包含您安装的扩展的 自定义上下文键。

注意：某些上下文键是供 VS Code 内部使用的，并且将来可能会发生更改。