通过快捷键绑定执行模板生成命令时如何获取URI？

针对快捷键触发模板生成命令的场景，不依赖activeTextEditor的最优方案是优先获取资源管理器选中项，再逐步降级到活动编辑器、用户手动选择，这样能覆盖更多使用场景，避免因焦点不在编辑器导致的失效问题。

实现步骤与代码示例 #

1. 多优先级获取目标URI

在命令处理逻辑中，按以下顺序尝试获取URI：

• 先调用VS Code内置命令获取资源管理器的选中项
• 若失败，再检查活动编辑器的文件URI
• 若仍无结果，弹出选择框让用户指定工作区文件夹

import * as vscode from 'vscode';

export function activate(context: vscode.ExtensionContext) {
  const generateTemplateCmd = vscode.commands.registerCommand('your-extension.generateTemplate', async () => {
    let targetUri: vscode.Uri | undefined;

    // 尝试获取资源管理器选中的资源URI
    try {
      const selections = await vscode.commands.executeCommand<vscode.Uri[]>('filesExplorer.getSelection');
      if (selections?.length > 0) {
        targetUri = selections[0]; // 取第一个选中的文件/文件夹
      }
    } catch (err) {
      // 资源管理器无焦点时会抛出异常，直接跳过
    }

    // 降级到活动编辑器的文件URI
    if (!targetUri && vscode.window.activeTextEditor) {
      targetUri = vscode.window.activeTextEditor.document.uri;
    }

    // 让用户手动选择目标位置
    if (!targetUri) {
      const selectedFolder = await vscode.window.showWorkspaceFolderPick({
        placeHolder: '请选择模板生成的目标文件夹'
      });
      if (!selectedFolder) {
        vscode.window.showErrorMessage('未指定目标位置，命令取消');
        return;
      }
      targetUri = selectedFolder.uri;
    }

    // 此处执行模板生成逻辑，使用targetUri即可
    console.log('模板生成目标URI:', targetUri.fsPath);
  });

  context.subscriptions.push(generateTemplateCmd);
}

2. 结合上下文菜单的参数传递优化

如果你的命令已经在资源管理器上下文菜单中配置了参数传递（比如传入选中资源的URI），可以在命令中区分上下文菜单和快捷键触发的情况，复用参数逻辑：

package.json 配置示例：

"contributes": {
  "commands": [
    {
      "command": "your-extension.generateTemplate",
      "title": "生成模板文件"
    }
  ],
  "menus": {
    "explorer/context": [
      {
        "command": "your-extension.generateTemplate",
        "when": "explorerResourceIsFolder || explorerResourceIsFile",
        "args": { "uri": "%selected%" }
      }
    ]
  },
  "keybindings": [
    {
      "command": "your-extension.generateTemplate",
      "key": "ctrl+shift+t",
      "mac": "cmd+shift+t"
    }
  ]
}

命令处理逻辑优化：

export function activate(context: vscode.ExtensionContext) {
  const generateTemplateCmd = vscode.commands.registerCommand('your-extension.generateTemplate', async (args) => {
    let targetUri: vscode.Uri | undefined;

    // 上下文菜单触发时，直接使用传入的URI参数
    if (args?.uri) {
      targetUri = vscode.Uri.parse(args.uri);
    } else {
      // 快捷键触发时，执行多优先级获取逻辑
      try {
        const selections = await vscode.commands.executeCommand<vscode.Uri[]>('filesExplorer.getSelection');
        if (selections?.length) targetUri = selections[0];
      } catch {}

      if (!targetUri && vscode.window.activeTextEditor) {
        targetUri = vscode.window.activeTextEditor.document.uri;
      }

      if (!targetUri) {
        const selectedFolder = await vscode.window.showWorkspaceFolderPick();
        targetUri = selectedFolder?.uri;
      }
    }

    if (!targetUri) {
      vscode.window.showErrorMessage('无法确定模板生成位置');
      return;
    }

    // 执行模板生成逻辑
  });

  context.subscriptions.push(generateTemplateCmd);
}

为什么不推荐仅依赖activeTextEditor？ #

• 当焦点在资源管理器、终端、设置面板等非编辑器区域时，activeTextEditor会返回undefined，导致命令直接失效
• 用户可能需要在某个文件夹下生成模板，但当前并未打开该文件夹下的任何文件，此时activeTextEditor无法提供正确的目标URI

内容的提问来源于stack exchange，提问作者pengian