命令

配置详情

本节介绍了添加到扩展中的新命令，这些命令可以增强开发环境中的交互和自动化。这些命令可以通过 API 以编程方式使用。

package.json 示例

此示例展示了如何在 package.json 中添加新命令，使其可以在扩展中使用。每个命令都定义了唯一的标识符和描述性标题，这些标题会显示在命令面板中。

{
  "contributes": {
    "commands": [
      {
        "command": "extension.exampleCommand",
        "title": "Extension: Example Command"
      },
      {
        "command": "extension.anotherCommand",
        "title": "Extension: Another Command"
      }
    ]
  }
}

在 TypeScript 代码中，你可以像这样使用命令

const exampleCommand = extensionApi.commands.registerCommand('extension.exampleCommand', async () => {
  // Implementation logic here
  console.log('Executing Example Command');
});

const anotherCommand = extensionApi.commands.registerCommand('extension.anotherCommand', () => {
  // Synchronous logic can be used if async processing is not required
  console.log('Another Command Executed');
});

JSON Schema

{
  "contributes": {
    "commands": [
      {
        "command": "string",
        "title": "string",
        "category": "string (optional cateogry for prefix title)",
        "enablement": "myProperty === myValue"
      }
    ]
  }
}

其他资源

添加命令后，它将列在命令面板中。有关更多信息，请参阅 命令面板。

验证

要验证你的命令是否按预期工作

1. 在开发环境中安装扩展。
2. 在 package.json 中添加命令。
3. 执行命令并检查预期输出/日志。