如何避免Electron生产环境应用缺失依赖的问题？

问题背景 #

主进程的生产必需依赖被错误归类到devDependencies时，开发环境因已安装所有依赖无法发现问题，但生产打包后启动会触发Error: cannot find module错误，且弹窗会阻塞CI环境的测试流程，无法及时获取有效反馈。当前使用electron-builder打包主进程依赖、vite打包渲染进程依赖。

现有方案的问题 #

通过child_process.spawn启动生产应用并结合puppeteer的方式，存在两个核心问题：

• 模块找不到的错误发生在require调用栈早期，晚于uncaughtException监听器的注册时机，导致无法被捕获
• 错误弹窗在CI环境无法关闭，引发进程阻塞和测试超时

可行解决方案 #

1. 静态分析主进程依赖（打包前检测） #

使用dependency-cruiser工具扫描主进程代码，自动识别所有被引入的模块，并对比package.json的dependencies，提前找出未被正确归类的生产依赖。

步骤：

• 安装工具：

  npm install dependency-cruiser --save-dev
  

• 在项目根目录创建配置文件.dependency-cruiser.js：

  module.exports = {
    forbidden: [
      {
        name: 'prod-dep-in-dev-deps',
        severity: 'error',
        comment: '生产依赖被错误放在devDependencies中',
        from: { path: 'src/main/**/*.js' }, // 替换为你的主进程代码路径
        to: {
          dependencyTypes: ['npm'],
          pathNotIn: Object.keys(require('./package.json').dependencies)
        }
      }
    ]
  };
  

• 在package.json的scripts中添加检测命令：

  "scripts": {
    "check-main-deps": "depcruise --config .dependency-cruiser.js src/main"
  }
  

• 打包前执行该命令，若存在误放的依赖，工具会抛出错误并终止流程。

2. 预打包环境模拟检测 #

通过模拟生产环境的依赖加载逻辑，在打包前验证主进程的依赖是否完整，无需等待打包完成。

步骤：

• 创建检测脚本check-main-deps.js：

  const fs = require('fs');
  const path = require('path');
  
  // 临时复制package.json，移除devDependencies
  const pkgPath = path.join(__dirname, 'package.json');
  const originalPkg = JSON.parse(fs.readFileSync(pkgPath, 'utf8'));
  const tempPkg = { ...originalPkg, devDependencies: {} };
  fs.writeFileSync(pkgPath, JSON.stringify(tempPkg, null, 2));
  
  try {
    // 尝试加载主进程入口文件，捕获模块错误
    require('./src/main/main.js'); // 替换为你的主进程入口路径
    console.log('主进程生产依赖校验通过');
  } catch (err) {
    if (err.code === 'MODULE_NOT_FOUND') {
      console.error('发现缺失的生产依赖:', err.message);
      process.exit(1);
    }
    throw err;
  } finally {
    // 恢复原始package.json
    fs.writeFileSync(pkgPath, JSON.stringify(originalPkg, null, 2));
  }
  

• 在scripts中添加命令：

  "scripts": {
    "prebuild": "node check-main-deps.js"
  }
  

• 执行打包命令时，会自动先运行该脚本，若依赖缺失直接终止打包。

3. 调整主进程错误捕获逻辑+无窗口启动 #

修改主进程代码，确保错误监听器最早注册，同时通过Electron启动参数禁用弹窗，让CI环境能正常捕获错误并退出。

步骤：

• 在主进程入口文件的最顶部添加错误监听器：

  // main.js 第一行
  process.on('uncaughtException', (err) => {
    console.error('[FATAL] 未捕获异常:', err);
    process.exit(1); // 强制退出，避免阻塞
  });
  
  process.on('unhandledRejection', (reason) => {
    console.error('[FATAL] 未处理的Promise拒绝:', reason);
    process.exit(1);
  });
  
  // 之后再引入其他模块
  const { app, BrowserWindow } = require('electron');
  // ...其他依赖引入
  

• 在CI测试脚本中，以无窗口模式启动Electron：

  electron ./dist --no-sandbox --disable-gpu --headless
  

  此时错误会输出到控制台，进程会自动退出，不会出现阻塞的弹窗。

4. 配置electron-builder强制依赖检查 #

在electron-builder.yml或package.json的build字段中，明确指定主进程的核心依赖，避免遗漏：

{
  "build": {
    "extraResources": [
      {
        "from": "node_modules/[你的核心生产依赖]/",
        "to": "node_modules/[你的核心生产依赖]/",
        "filter": ["**/*"]
      }
    ]
  }
}

注：此方式需手动维护依赖列表，适合核心依赖的强制打包，结合静态分析工具使用效果更佳。

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