当子句上下文

Visual Studio Code 根据 VS Code 用户界面中可见和活动的元素设置各种上下文键和特定值。这些上下文可以用于有选择地启用或禁用扩展命令和用户界面元素，例如菜单和视图。

例如，VS Code 使用 when 子句来启用或禁用命令键绑定，这在 Default Keybindings JSON 中可以看到 (偏好设置：打开默认键盘快捷键 (JSON))：

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

上面，内置的开始调试命令有键盘快捷键F5，只有在有合适的调试器可用时才会启用（上下文键调试器可用是真实的) 并且编辑器不是在调试模式下 (上下文键在调试模式是错误的）。

条件运算符

A when 子句可以由上下文键组成（例如，在调试模式) 或者可以使用各种运算符来表达更复杂的编辑状态。

逻辑运算符

逻辑运算符允许组合简单的上下文键或包含其他逻辑、相等、比较、匹配的when子句表达式在输入：/不在操作符或括号内的表达式。

关于逻辑运算符优先级的说明：上表列出了从最高到最低优先级的运算符。示例：

相等运算符

您可以检查上下文键的值是否与指定的值相等。请注意，右侧是一个值，而不是被解释为上下文键，这意味着它不会在上下文中进行查找。

笔记：

• 如果右侧的值是一个包含空白字符的字符串，它必须用单引号括起来 -"resourceFilename == 'My New File.md'"输入：.
• 输入：===具有相同的行为输入：==，和!==具有相同的行为不等于

比较运算符

您可以将上下文键的值与一个数字进行比较。请注意，操作符的左右两侧必须用空格分隔。foo < 1，但不是foo<1输入：.

匹配运算符

（以前的名称：键值对匹配运算符）

有一个匹配运算符 (输入：=~) 用于 when 子句。 表达式键 =~ 正则表达式字面量将右侧视为正则表达式字面量，以匹配左侧。例如，要为所有Docker文件贡献上下文菜单项，可以使用：

   "当"："资源文件名 =~ /docker/"

笔记：

• 右侧输入：=~ 操作符遵循与正则表达式字面量 (参考) 在JavaScript中的相同规则，但字符需要遵循JSON字符串和正则表达式的转义规则。例如，一个匹配子字符串的正则表达式字面量 文件://将会是/文件:\/\//在JavaScript中但是/文件:\\:\\//在 when 子句中，因为JSON字符串中需要转义反斜杠，而在正则表达式模式中需要转义斜杠。
• 不存在一个操作符输入：!=~，但你可以否定匹配表达式 -!(foo =~ /baz/)输入：.

正则表达式标志

可以使用标志与正则表达式字面量。例如，资源文件名 =~ /json/i或myContextKey =~ /baz/si输入：.

支持的标志：我，输入：s，输入：m，输入：u输入：.

被忽略的标志：输入：g，输入： y。

'in' 和 'not in' 条件运算符

该在当子句的运算符允许在另一个上下文键的值中动态查找上下文键的值。例如，如果您希望为包含某种类型文件的文件夹（或无法静态知道的内容）添加上下文菜单命令，现在您可以使用在操作符来实现它。你可以使用不在操作符以检查相反的条件。

首先，确定哪些文件夹应该支持该命令，并将文件夹名称添加到一个数组中。然后，使用设置上下文 命令 将数组转换为上下文键：

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

// or

// 在这种情况下（使用对象），值并不重要，重要的是对象中键的存在
// 值必须是简单类型
vscode.commands.executeCommand('setContext', 'ext.supportedFolders', {
  test: true,
  foo: 'anything',
  bar: false
});

然后，在package.json你可以添加一个菜单贡献用于探索者/上下文菜单:

// 注意，这假定你已经定义了一个名为ext.doSpecial的命令
"menus": {
  "explorer/context": [
    {
      "command": "ext.doSpecial",
      "when": "explorerResourceIsFolder && resourceFilename in ext.supportedFolders"
    }
  ]
}

在那个例子中，我们正在采取的值是资源文件名（这是该文件夹的名称）并检查其在值中的存在ext.supportedFolders如果存在，将显示菜单。这个强大的操作符应该能够允许更丰富的条件和动态贡献，以支持当条目，例如菜单、视图等。

可用上下文键

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

这里的列表并不完整，您可以通过在键盘快捷键编辑器（偏好设置：打开键盘快捷键）中搜索和筛选，或查看默认快捷键JSON文件（偏好设置：打开默认键盘快捷键（JSON））来找到其他when clause上下文。您还可以使用检查上下文键工具来识别您感兴趣的上下文键。

注意：您可以在此使用任何以为前缀的布尔值评估的用户或工作区设置"配置."输入：.

可见/聚焦视图当子句上下文

您可以有一个when子句来检查特定的视图是否可见或聚焦。

查看标识符：

• 工作台.资源管理器.文件视图- 文件资源管理器
• 工作台.资源管理器.打开编辑器视图- 打开编辑器
• 大纲- 大纲视图
• 时间线- 时间线视图
• 工作台.scm- 源代码管理
• workbench.scm.repositories- 源代码控制库
• 工作台.调试.变量视图- 变量
• 工作台调试观察表达式视图- 观看
• 工作台调试调用堆栈视图- 调用栈
• 工作台.调试.已加载脚本视图- 已加载脚本
• 工作台调试断点视图- 停止点
• 工作台.调试.反汇编视图- 拆解
• 工作台.视图.扩展.已安装- 已安装的扩展
• extensions.recommendedList- 推荐的扩展
• 工作台.面板.标记.视图- 问题
• 工作台.面板.输出- 输出
• 工作台.面板.交互式解释器视图- 调试控制台
• 终端- 集成终端
• 工作台.面板.评论- 评论

可见视图容器当子句上下文

您可以有一个when子句来检查特定的视图容器是否可见

查看容器标识符：

• 工作台.视图.资源管理器- 文件资源管理器
• 工作台.视图.搜索- 搜索
• 工作台.视图.源代码管理- 源代码管理
• 工作台.视图.调试- 运行
• 工作台.视图.扩展- 扩展
• 工作台.面板.标记- 问题
• 工作台.面板.输出- 输出
• 工作台.面板.交互式编程语言环境- 调试控制台
• 终端- 集成终端
• 工作台.面板.评论- 评论

如果你想要一个仅在特定视图容器获得焦点时才启用的when子句，请使用侧边栏焦点或面板焦点或辅助栏焦点结合活动视图或活动面板或活跃辅助上下文键。

例如，下面的 when 子句仅在文件资源管理器获得焦点时为真：

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

检查 when 子句中的一个设置

在 when 子句中，您可以通过在其前加上 来引用配置（设置）值配置。例如配置编辑器的自动完成功能或config.breadcrumbs.enabled输入：.

添加自定义when子句上下文

如果你正在编写自己的 VS Code 扩展，并且需要使用 when 子句的上下文来启用/禁用命令、菜单或视图，而现有的键无法满足你的需求，你可以添加自己的上下文键设置上下文命令。

下面的第一个示例将键设置为myExtension显示我的命令to true，您可以在此处用于启用命令或与当属性。第二个示例存储一个值，您可以使用when子句来检查冷却打开事物的数量是否大于2。

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

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

检查上下文密钥实用工具

如果您希望在运行时查看所有当前活动的上下文密钥，您可以使用开发者：检查上下文密钥命令从命令面板（⇧⌘P（Windows, Linux Ctrl+Shift+P））。检查上下文密钥将在VS Code开发者工具控制台标签中显示上下文密钥及其值（帮助 > 切换开发者工具）。

当你运行开发者：检查上下文键时，你的光标将高亮显示 VS Code 用户界面中的元素，当你点击一个元素时，当前的上下文键及其状态将作为一个对象输出到控制台。

活动上下文密钥的列表是广泛的，可能包含自定义上下文密钥，这些密钥来自您已安装的扩展。

注意：一些上下文密钥是VS Code内部使用，可能会在未来更改。