文档首页/ CodeArts IDE/ 用户指南/ 基本操作/ 重构/ 代码操作的键绑定
更新时间:2023-09-27 GMT+08:00
分享

代码操作的键绑定

editor.action.codeAction命令允许您为特定代码操作配置键绑定。例如,此键绑定触发提取函数重构代码操作:

{
  "key": "ctrl+shift+r ctrl+e",
  "command": "editor.action.codeAction",
  "args": {
    "kind": "refactor.extract.function"
  }
}

代码操作类型由扩展使用增强的CodeActionProvided API指定。种类是分层的,因此"kind": "refactor" 将显示所有重构代码操作,而“ "kind": "refactor.extract.function"”将仅显示提取函数重构。

使用上述键绑定,如果只有单个“refactor.extract.function”代码操作可用,则将自动应用该代码操作。如果有多个提取函数代码操作可用,您可以从上下文菜单中选择所需的代码操作。

您还可以使用应用参数控制自动应用代码操作的方式和时间:

{
  "key": "ctrl+shift+r ctrl+e",
  "command": "editor.action.codeAction",
  "args": {
    "kind": "refactor.extract.function",
    "apply": "first"
  }
}

“apply”的有效值:

  • first - 始终自动应用第一个可用的代码操作。
  • ifSingle - 默认情况下。如果只有一个代码操作可用,则自动应用代码操作。否则,显示上下文菜单。
  • never - 始终显示代码操作上下文菜单,即使只有一个代码操作可用。

当代码操作键绑定配置为"preferred": true时,仅显示首选的快速修复和重构。首选的快速修复解决了基础错误,而首选的重构是最常见的重构选择。例如,虽然可能存在多个refactor.extract.const重构,但每个重构都提取到文件中的不同作用域,但首选的refactor.extract.constant重构项是提取到局部变量的重构。

此键绑定使用"preferred": true创建始终尝试将选定源代码提取到本地作用域中的常量的重构:

{
  "key": "shift+ctrl+e",
  "command": "editor.action.codeAction",
  "args": {
    "kind": "refactor.extract.constant",
    "preferred": true,
    "apply": "ifSingle"
  }
}

相关文档