VSCode扩展开发如何读取自身源码文件内容填充未保存无标题文件

错误原因 #

相对路径默认相对于用户当前打开的工作区解析，不会指向扩展自身的安装目录，因此无法找到你扩展内的my-file.json文件。

实现步骤 #

• 调用扩展激活时传入的ExtensionContext对象的extensionUri属性，该属性指向扩展的根目录URI
• 使用VSCode官方提供的vscode.workspace.fsAPI读取扩展目录下的目标文件，跨平台兼容性更好
• 将读取到的内容传入无标题文档的配置项，调用showTextDocument显示新建的编辑器

完整代码示例 #

const vscode = require('vscode');

// 扩展激活入口，context参数由VSCode自动传入
function activate(context) {
  const openCustomFileCommand = vscode.commands.registerCommand('你的扩展ID.自定义命令名', async () => {
    try {
      // 拼接扩展内目标文件的完整URI
      const fileUri = vscode.Uri.joinPath(context.extensionUri, 'src', 'my-file.json');
      // 读取文件内容并转成UTF-8字符串
      const fileContent = await vscode.workspace.fs.readFile(fileUri);
      const content = Buffer.from(fileContent).toString('utf-8');

      // 新建无标题编辑器并填充内容
      const untitledDoc = await vscode.workspace.openTextDocument({
        language: 'json',
        content: content
      });
      // 显示新建的编辑器
      await vscode.window.showTextDocument(untitledDoc);
    } catch (error) {
      vscode.window.showErrorMessage(`打开文件失败：${error.message}`);
    }
  });

  context.subscriptions.push(openCustomFileCommand);
}

注意事项 #

• 打包扩展时需要在package.json的files字段中添加src/my-file.json路径，避免该文件被打包工具过滤
• 如果你偏好使用Node.js原生FS接口，可以用context.asAbsolutePath(path.join('src', 'my-file.json'))拼接出文件的绝对路径后再读取，不会出现路径解析错误
• 1.61.2版本VSCode完全支持上述所有API，无需做兼容性适配

内容的提问来源于stack exchange，提问作者Itération 122442