commands

commands二级模块对象，用于处理和命令相关的逻辑。命令包含2部分：唯一ID和自定义的function，可以通过registerCommand或registerTextEditorCommand注册。命令可以通过以下方式触发：

• 菜单：将命令通过menus扩展点关联到某个菜单。

  1. 通过commands扩展点声明一个command，然后关联到menus上

     {
     "contributes":{
      "commands":[
          {
              "command":"extension.firstExtension",
              "title":"My First Extension"
          }
      ],
      "menus":{
          "editor/context":[
              {
                  "command": "extension.firstExtension",
                  "group": "z_commands",
                  "when": "editorTextFocus"
              }
          ]
      }
     }
     }

  2. 在插件的激活回调(activate)中注册该command

     hx.commands.registerCommand('extension.firstExtension',()=>{
      hx.window.showInformationMessage("Hello My First Extension.");
     });

• 用户自定义快捷键：使用插件的用户可以通过得知命令的ID（一般在package.json中有声明），然后通过自定义快捷键配置一个快捷键。

  // Keybindings.json;
  [
    {
        "key":"ctrl+shift+0",
        "command":"extension.firstExtension"
    }
  ]

executeCommand

执行指定id的命令。除了插件扩展的命令外，还可以执行HBuilderX内置的命令，完整的内置命令列表可以通过HBuilderX的顶部菜单工具-自定义快捷键，然后在打开的配置文件左侧部分找到所有列出的command字段，如下图：

参数说明

返回值

示例

//执行插件扩展的命令
hx.commands.executeCommand('extension.firstExtension')
//执行内置的命令（关闭所有打开的编辑器）
hx.commands.executeCommand('workbench.action.closeAllEditors')

registerCommand

注册一个指定id的命令，并关联一个自定义的函数

参数说明

返回值

示例

    let disposable = hx.commands.registerCommand('extension.firstExtension',()=>{
        hx.window.showInformationMessage("Hello My First Extension.");
    });
    context.subscriptions.push(disposable);

registerTextEditorCommand

注册一个指定id的编辑器命令

参数说明

返回值

示例

    let disposable = hx.commands.registerTextEditorCommand('extension.firstExtension',(editor)=>{
        hx.window.showInformationMessage(editor.document.fileName);
    });
    context.subscriptions.push(disposable);