如何在Electron Builder中优化node_modules依赖打包

问题背景

在使用Electron Builder构建多工作区项目时，开发者经常会遇到一个常见问题：构建产物中包含了大量不必要的源代码文件。特别是在使用npm工作区(workspaces)架构的项目中，每个子模块可能都有自己的src和dist目录，而实际上运行时只需要dist目录中的编译后文件。

问题分析

Electron Builder默认会复制整个node_modules目录下的所有文件，包括各个子模块的源代码目录。这会导致：

1. 最终应用体积不必要的增大
2. 可能暴露源代码安全风险
3. 增加安装包传输时间

虽然npm的package.json中有files字段可以指定发布时应包含的文件，但Electron Builder并不直接使用这个配置来决定构建时包含哪些文件。

解决方案

方案一：使用Electron Builder的files配置排除文件

Electron Builder提供了files配置项，支持使用minimatch模式来包含或排除特定文件。例如：

export default {
  files: [
    'entry-point.js',
    '!node_modules/@your-scope/**/src', // 排除所有src目录
    '!node_modules/@your-scope/**/*.ts' // 排除所有TypeScript文件
  ]
}

方案二：动态生成排除规则

对于更复杂的项目结构，特别是使用工作区的项目，可以编写脚本动态生成排除规则：

import rootPkg from './package.json' with {type: 'json'};
import mapWorkspaces from '@npmcli/map-workspaces';

const workspaces = await mapWorkspaces({ cwd: process.cwd(), pkg: rootPkg });

const filesToExclude = [];

for (const [name, path] of workspaces) {
  const pkgPath = resolve(path, 'package.json');
  const {default: workspacePkg} = await import(pathToFileURL(pkgPath), {with: {type: 'json'}});
  
  // 获取package.json中定义的files字段
  let patterns = workspacePkg.files || [];
  patterns.push('package.json'); // 确保package.json始终包含
  
  // 将路径转换为绝对路径
  patterns = patterns.map(p => resolve(path, p));
  
  // 获取不符合patterns的文件列表
  let unmatchedFiles = getFilesThatDoesntMathGlobPatterns(path, patterns);
  
  // 转换为Electron Builder的排除格式
  unmatchedFiles = unmatchedFiles.map(f => 
    join('!node_modules', name, f.replace(path + sep, '')));
  
  filesToExclude.push(...unmatchedFiles);
}

export default {
  files: [
    'packages/entry-point.js',
    ...filesToExclude,
  ]
};

实现原理

1. 工作区识别：通过@npmcli/map-workspaces获取所有工作区模块信息
2. 模式匹配：读取每个模块的package.json中的files配置
3. 反向排除：找出不符合files模式的文件，生成排除规则
4. 配置合并：将动态生成的排除规则合并到Electron Builder配置中

最佳实践建议

1. 明确声明files字段：在每个子模块的package.json中明确定义files字段
2. 统一构建输出目录：建议所有子模块使用相同的输出目录名(如dist)
3. 定期检查构建产物：使用asar list命令检查最终打包内容
4. 考虑安全因素：确保不会意外排除运行时必需的文件

总结

通过合理配置Electron Builder的files选项，开发者可以精确控制node_modules中哪些文件应该包含在最终构建产物中。对于复杂的工作区项目，采用动态生成排除规则的方法可以确保构建结果既精简又完整，避免手动维护冗长的排除列表。这种方法特别适合大型Electron应用和模块化架构的项目。