上下文密钥是VSCode中用于控制UI行为的布尔状态标志,如editorTextFocus、resourceLangId等,可在when子句中通过逻辑与比较操作精确控制命令、菜单和快捷键的显示与启用条件,结合Developer: Inspect Context Keys可实时调试,对扩展开发和个性化配置至关重要。

在 Visual Studio Code(VSCode)中,上下文密钥(context keys) 是控制 UI 行为和命令可用性的核心机制之一。它们常用于 when 子句中,决定菜单项、快捷键、按钮等是否显示或启用。理解上下文密钥与条件表达式的使用方式,对自定义编辑器行为或开发扩展非常关键。
什么是上下文密钥?
上下文密钥是布尔值的状态标志,表示当前编辑器或应用所处的某种“上下文”。例如,某个文件是否已聚焦、是否有选中文本、当前语言模式是什么等。这些密钥在运行时动态更新,开发者可在配置中通过 when 条件判断其真假。
常见的上下文密钥包括:
-
editorTextFocus:文本编辑器获得焦点 -
editorHasSelection:编辑器中存在文本选择 -
inQuickOpen:正在使用快速打开面板 -
terminalFocus:终端获得焦点 -
resourceLangId == 'python':当前文件是 Python 类型
when 子句中的条件表达式
when 子句出现在 package.json 的命令、菜单、键绑定等配置中,用于指定某项功能何时生效。它支持逻辑运算和比较操作。
基本语法示例:
-
editorTextFocus && !editorHasSelection:编辑器有焦点且无选中文本 -
terminalFocus || outputFocus:终端或输出面板获得焦点 -
resourceLangId == 'markdown':当前文件是 Markdown 类型 -
config.editor.tabSize == 4:编辑器 tabSize 配置为 4
支持的操作符:
- 逻辑:&&(与)、||(或)、!(非)
- 比较:==、!=、、>=
- 字符串、数字、布尔类型均可参与比较
如何查看当前上下文密钥状态
调试 when 条件时,可通过命令面板执行 Developer: Inspect Context Keys 命令。它会打开一个实时视图,列出所有当前激活的上下文密钥及其值,方便验证条件是否满足。
这个工具对扩展开发者尤其有用,能快速定位为何某个菜单项未显示或快捷键未生效。
在扩展开发中的实际应用
假设你开发一个扩展,希望只在 JavaScript 文件中显示某个命令:
"menus": { "editor/context": [ { "command": "myExtension.formatCustom", "when": "resourceLangId == 'javascript'" } ] }或者你想让快捷键仅在没有选中文本时生效:
{ "key": "ctrl+d", "command": "myExtension.duplicateLine", "when": "editorTextFocus && !editorHasSelection" }合理组合上下文密钥可实现精细的用户交互控制。
基本上就这些。掌握上下文密钥和 when 条件表达式,能让 VSCode 的自定义能力大幅提升,无论是写扩展还是调整个性化设置都很实用。










