命令

命令在 Visual Studio Code 中触发操作。如果您曾配置过键绑定，那么您就使用过命令。命令还被扩展用于向用户公开功能、绑定到 VS Code UI 中的操作以及实现内部逻辑。

使用命令

VS Code 包含一组庞大的内置命令，您可以使用它们与编辑器交互、控制用户界面或执行后台操作。许多扩展还将其核心功能作为命令公开，供用户和其他扩展利用。

以编程方式执行命令

vscode.commands.executeCommand API 以编程方式执行命令。这使您可以使用 VS Code 的内置功能，并基于 VS Code 的内置 Git 和 Markdown 扩展等扩展进行构建。

例如，editor.action.addCommentLine 命令用于注释活动文本编辑器中当前选定的行。

import * as vscode from 'vscode';

function commentLine() {
  vscode.commands.executeCommand('editor.action.addCommentLine');
}

某些命令接受控制其行为的参数。命令也可能返回结果。例如，类似于 API 的 vscode.executeDefinitionProvider 命令会查询文档中给定位置的定义。它接受文档 URI 和位置作为参数，并返回一个包含定义列表的 Promise。

import * as vscode from 'vscode';

async function printDefinitionsForActiveEditor() {
  const activeEditor = vscode.window.activeTextEditor;
  if (!activeEditor) {
    return;
  }

  const definitions = await vscode.commands.executeCommand<vscode.Location[]>(
    'vscode.executeDefinitionProvider',
    activeEditor.document.uri,
    activeEditor.selection.active
  );

  for (const definition of definitions) {
    console.log(definition);
  }
}

查找可用命令

• 浏览键盘快捷方式
• 查阅 VS Code 的内置高级命令 API

命令 URI

命令 URI 是执行给定命令的链接。它们可用作悬停文本、补全项详细信息或 webview 中的可点击链接。

命令 URI 使用 command 方案，后跟命令名称。例如，editor.action.addCommentLine 命令的命令 URI 是 command:editor.action.addCommentLine。这是一个悬停提供程序，它在活动文本编辑器当前行的注释中显示一个链接。

import * as vscode from 'vscode';

export function activate(context: vscode.ExtensionContext) {
  vscode.languages.registerHoverProvider(
    'javascript',
    new (class implements vscode.HoverProvider {
      provideHover(
        _document: vscode.TextDocument,
        _position: vscode.Position,
        _token: vscode.CancellationToken
      ): vscode.ProviderResult<vscode.Hover> {
        const commentCommandUri = vscode.Uri.parse(`command:editor.action.addCommentLine`);
        const contents = new vscode.MarkdownString(`[Add comment](${commentCommandUri})`);

        // To enable command URIs in Markdown content, you must set the `isTrusted` flag.
        // When creating trusted Markdown string, make sure to properly sanitize all the
        // input content so that only expected command URIs can be executed
        contents.isTrusted = true;

        return new vscode.Hover(contents);
      }
    })()
  );
}

命令的参数列表作为已正确 URI 编码的 JSON 数组传递：以下示例使用 git.stage 命令创建一个悬停链接，用于暂存当前文件。

import * as vscode from 'vscode';

export function activate(context: vscode.ExtensionContext) {
  vscode.languages.registerHoverProvider(
    'javascript',
    new (class implements vscode.HoverProvider {
      provideHover(
        document: vscode.TextDocument,
        _position: vscode.Position,
        _token: vscode.CancellationToken
      ): vscode.ProviderResult<vscode.Hover> {
        const args = [{ resourceUri: document.uri }];
        const stageCommandUri = vscode.Uri.parse(
          `command:git.stage?${encodeURIComponent(JSON.stringify(args))}`
        );
        const contents = new vscode.MarkdownString(`[Stage file](${stageCommandUri})`);
        contents.isTrusted = true;
        return new vscode.Hover(contents);
      }
    })()
  );
}

您可以通过在创建 webview 时在 WebviewOptions 中设置 enableCommandUris 来在webview 中启用命令 URI。

创建新命令

注册命令

vscode.commands.registerCommand 将命令 ID 绑定到扩展中的处理函数。

import * as vscode from 'vscode';

export function activate(context: vscode.ExtensionContext) {
  const command = 'myExtension.sayHello';

  const commandHandler = (name: string = 'world') => {
    console.log(`Hello ${name}!!!`);
  };

  context.subscriptions.push(vscode.commands.registerCommand(command, commandHandler));
}

无论 myExtension.sayHello 命令是使用 executeCommand 以编程方式执行，还是从 VS Code UI 或通过键绑定执行，处理函数都将被调用。

创建面向用户的命令

vscode.commands.registerCommand 仅将命令 ID 绑定到处理函数。为了在命令面板中公开此命令以供用户发现，您还需要在扩展的 package.json 中有一个相应的命令 contribution。

{
  "contributes": {
    "commands": [
      {
        "command": "myExtension.sayHello",
        "title": "Say Hello"
      }
    ]
  }
}

commands 贡献告诉 VS Code 您的扩展提供了给定命令，并且当该命令被调用时应激活，它还允许您控制命令在 UI 中的显示方式。在创建命令时，请务必遵循命令命名约定。

现在，当用户首次从命令面板或通过键绑定调用 myExtension.sayHello 命令时，扩展将被激活，并且 registerCommand 将 myExtension.sayHello 绑定到适当的处理程序。

注意：针对 1.74.0 之前 VS Code 版本的扩展必须明确注册所有面向用户的命令的 onCommand activationEvent，以便扩展激活并执行 registerCommand。

{
  "activationEvents": ["onCommand:myExtension.sayHello"]
}

您不需要为内部命令使用 onCommand 激活事件，但对于以下任何命令，您都必须定义它们：

• 可以使用命令面板调用。
• 可以使用键绑定调用。
• 可以通过 VS Code UI 调用，例如通过编辑器标题栏。
• 旨在作为供其他扩展使用的 API。

控制命令何时显示在命令面板中

默认情况下，通过 package.json 的 commands 部分贡献的所有面向用户的命令都会显示在命令面板中。但是，许多命令仅在特定情况下相关，例如当存在给定语言的活动文本编辑器或当用户设置了某个配置选项时。

menus.commandPalette 贡献点允许您限制命令何时显示在命令面板中。它接受目标命令的 ID 和一个控制命令何时显示的when 子句。

{
  "contributes": {
    "menus": {
      "commandPalette": [
        {
          "command": "myExtension.sayHello",
          "when": "editorLangId == markdown"
        }
      ]
    }
  }
}

现在，只有当用户在 Markdown 文件中时，myExtension.sayHello 命令才会显示在命令面板中。

命令的启用

命令通过 enablement 属性支持启用 - 其值是一个when 子句。启用适用于所有菜单和已注册的键绑定。

注意：enablement 和菜单项的 when 条件之间存在语义重叠。后者用于防止菜单中充满禁用项。例如，一个分析 JavaScript 正则表达式的命令应该在文件是 JavaScript 时才显示，并且只有当光标位于正则表达式上方时才启用。when 子句通过不显示所有其他语言文件的命令来防止混乱。强烈建议避免菜单混乱。

最后，显示命令的菜单（如命令面板或上下文菜单）实现不同的方式来处理启用。编辑器和资源管理器上下文菜单会渲染启用/禁用项，而命令面板会筛选它们。

使用自定义 when 子句上下文

如果您正在编写自己的 VS Code 扩展，并且需要使用 when 子句上下文启用/禁用命令、菜单或视图，而现有键都不符合您的需求，那么您可以添加自己的上下文。

下面的第一个示例将键 myExtension.showMyCommand 设置为 true，您可以在命令启用或与 when 属性一起使用它。第二个示例存储了一个值，您可以与 when 子句一起使用，以检查打开的酷东西数量是否大于 2。

vscode.commands.executeCommand('setContext', 'myExtension.showMyCommand', true);

vscode.commands.executeCommand('setContext', 'myExtension.numberOfCoolOpenThings', 2);

命名约定

创建命令时，您应遵循以下命名约定：

• 命令标题
  • 使用标题样式大小写。不要将少于四个字母的介词（例如 on、to、in、of、with 和 for）大写，除非该介词是第一个或最后一个单词。
  • 以动词开头，描述将要执行的操作。
  • 使用名词描述操作的目标。
  • 避免在标题中使用“命令”。