VSCode扩展中调用dir-compare的compare()方法无报错却执行失败怎么办？

问题描述 #

在常规Node脚本中可正常运行的dir-compare包compare()方法，在VSCode扩展中执行时失败，仅输出err {}，无有效错误信息。执行代码如下：

const path1 = 'C:/a';
const path2 = 'C:/b';

try
{
    dircompare.compare(path1, path2)
        .then(res => terminal.sendText( 'echo "res ' + JSON.stringify( res ) + '"' ))
        .catch(error => terminal.sendText( 'echo "E2 ' + JSON.stringify( error ) + '"' ));
}
catch(e)
{
    terminal.sendText( 'echo "err ' + JSON.stringify( e ) + '"' );
}

原因分析 #

1. 异步错误未被外层try/catch捕获：dircompare.compare()是异步Promise操作，外层try/catch只能捕获同步代码的错误，异步错误会进入.catch()分支，但当前代码的错误输出逻辑存在问题。
2. JSON.stringify无法序列化Error对象：Error对象的核心属性（如message、stack）属于非枚举属性，直接用JSON.stringify()序列化会得到空对象{}，导致看不到实际错误信息。
3. VSCode扩展环境的权限/路径限制：VSCode扩展运行在Electron环境中，文件系统访问权限、路径解析逻辑和普通Node脚本不同，硬编码的盘符路径可能因权限不足或路径解析失败导致执行出错。

排查步骤 #

• 优化错误输出格式：修改.catch()和try/catch的输出逻辑，直接打印Error对象的message和stack属性，替代JSON.stringify()：

  .catch(error => terminal.sendText(`echo "E2: ${error.message}\nStack: ${error.stack}"`))
  // 外层try/catch同理修改
  

• 验证路径合法性：使用Node的path模块或VSCode提供的路径API处理路径，避免硬编码问题：

  const path = require('path');
  // 基于扩展目录的相对路径
  const path1 = path.resolve(__dirname, 'a');
  // 或基于当前工作区路径
  const workspaceFolder = vscode.workspace.workspaceFolders?.[0].uri.fsPath;
  const path2 = path.resolve(workspaceFolder, 'b');
  

• 检查扩展权限配置：若访问工作区外的路径，需在package.json中声明文件系统权限：

  "contributes": {
    "permissions": {
      "fileSystem": "read"
    }
  }
  

• 切换同步方法测试：使用dircompare.compareSync()同步方法，让外层try/catch直接捕获错误，快速定位问题：

  try {
    const res = dircompare.compareSync(path1, path2);
    terminal.sendText(`echo "res: ${JSON.stringify(res)}"`);
  } catch(e) {
    terminal.sendText(`echo "err: ${e.message}\nStack: ${e.stack}"`);
  }
  

解决方案 #

1. 修复错误输出逻辑：放弃用JSON.stringify()处理Error对象，直接输出error.message和error.stack，确保能看到实际错误详情。
2. 适配VSCode路径规则：使用path模块或VSCode工作区API生成合法路径，避免硬编码盘符路径带来的权限或解析问题。
3. 正确处理异步错误：确保Promise的.catch()分支能正确捕获并输出异步错误，外层try/catch仅处理同步初始化阶段的错误。
4. 配置必要权限：若需访问工作区外的文件，在扩展的package.json中添加对应的文件系统权限声明。

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