commands

commands二級模塊對象，用於處理和命令相關的邏輯。命令包含2部分：唯一ID和自定義的function，可以通過registerCommand或registerTextEditorCommand註冊。

命令可以通過以下方式觸發：

聲明command

菜單：將命令通過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"
                }
            ]
        }
    }
}

1. 在插件的激活回調(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);