VSCode中如何在keybindings.json设置快捷键以覆盖默认快捷键？

Question

在VSCode中，如何通过`keybindings.json`文件正确设置自定义快捷键并覆盖默认快捷键？ 问题描述：当你尝试在`keybindings.json`中定义一个新快捷键（如将“格式化代码”从`Shift + Alt + F`改为`Ctrl + K`），却发现旧的快捷键仍然生效，或者出现冲突提示。这是由于VSCode的快捷键优先级机制导致的。如何确保自定义快捷键完全覆盖默认快捷键，同时避免冲突？需要明确`when`条件的使用场景以及`command`和`key`字段的具体配置规则。

Answer 1

1. 了解VSCode快捷键机制

在VSCode中，快捷键的优先级由其定义位置决定。默认快捷键位于系统内部，用户自定义快捷键则存储在keybindings.json文件中。当两者发生冲突时，默认快捷键可能会优先生效。

为确保自定义快捷键覆盖默认快捷键，需要明确以下几点：

• 优先级规则：用户定义的快捷键优先级高于默认快捷键。
• 冲突解决：如果两个快捷键绑定相同的命令，VSCode会提示冲突，并允许手动调整。
• when条件：通过指定上下文条件（如编辑器类型或焦点状态），可以进一步细化快捷键的应用场景。

例如，将“格式化代码”快捷键从Shift + Alt + F改为Ctrl + K，需要正确配置command和key字段。

2. 配置keybindings.json文件

打开keybindings.json文件，可以通过菜单文件 -> 首选项 -> 键盘快捷方式，然后选择“打开键盘快捷方式JSON”。

以下是修改“格式化代码”快捷键的具体步骤：

1. 查找默认快捷键：在快捷键设置界面搜索editor.action.formatDocument，记录其默认绑定。
2. 添加自定义快捷键：在keybindings.json中插入以下代码。

{
        "key": "ctrl+k",
        "command": "editor.action.formatDocument",
        "when": "editorTextFocus"
    }

其中，"when": "editorTextFocus"表示该快捷键仅在编辑器获得焦点时生效。

3. 解决快捷键冲突

如果新快捷键与现有快捷键冲突，VSCode会在状态栏提示冲突信息。此时，可以通过禁用旧快捷键来解决问题。

字段	说明
key	定义快捷键组合，如ctrl+k。
command	指定触发的命令，如editor.action.formatDocument。
when	定义快捷键生效的上下文条件。

禁用默认快捷键的示例：

{
        "key": "shift+alt+f",
        "command": "-editor.action.formatDocument"
    }

4. 使用when条件优化快捷键

when条件用于限制快捷键的适用范围，避免不必要的触发。例如，以下配置仅在JavaScript文件中启用快捷键：

{
        "key": "ctrl+j",
        "command": "editor.action.jumpToDefinition",
        "when": "resourceLangId == javascript"
    }

通过结合不同的上下文条件，可以实现更灵活的快捷键管理。

常见的when条件包括：

• editorTextFocus：编辑器获得焦点时。
• resourceLangId == <language>：特定语言文件中。
• explorerResourceIsFolder：资源管理器选中文件夹时。

5. 快捷键配置流程图

以下是配置自定义快捷键的整体流程：