Electron Forge 在 macOS 上打包 DMG 时遇到的模块缺失问题分析

问题背景

在使用 Electron Forge 7.5.0 版本进行 macOS 平台打包时，开发者遇到了一个关于 volume.node 模块缺失的错误。这个问题主要出现在使用 pnpm 包管理器的 monorepo 项目中，当执行 electron-forge package 命令并配置了 makerDMG 时，系统会抛出无法找到 ../build/Release/volume.node 模块的错误。

错误现象

错误堆栈显示，问题起源于 macos-alias 模块尝试加载 volume.node 原生模块时失败。这个错误链涉及多个依赖模块，包括 ds-store、appdmg 和 electron-installer-dmg 等。错误表明系统无法在预期的路径中找到编译好的原生模块。

可能的原因分析

1. 原生模块编译问题：volume.node 是一个需要编译的原生模块，可能在安装过程中没有正确编译或放置到预期位置。

2. 包管理器差异：使用 pnpm 而非 npm 或 yarn 时，由于 pnpm 的依赖管理方式不同，可能导致模块路径解析出现问题。

3. ESM 模块系统兼容性：当项目配置为使用 ESM 模块系统（package.json 中设置 "type": "module"）时，某些依赖模块可能不完全兼容。

4. macOS 15.0 兼容性：新操作系统版本可能引入了某些变化，影响了原生模块的加载机制。

解决方案

1. 检查原生模块编译：确保所有依赖的原生模块都已正确编译。可以尝试删除 node_modules 并重新安装依赖。

2. 调整模块系统配置：如果使用 ESM，考虑暂时切换回 CommonJS 模块系统进行测试，或者确保所有依赖都兼容 ESM。

3. 验证 pnpm 配置：在 monorepo 项目中，检查 pnpm 的工作区配置是否正确，确保模块解析路径没有问题。

4. 简化配置：如开发者最终采用的方案，简化 Forge 配置，只保留必要的属性，避免完整配置可能带来的兼容性问题。

经验总结

1. 在 monorepo 项目中使用 Electron Forge 时，需要特别注意包管理器和模块解析的配置。

2. 原生模块在跨平台开发中常常是问题的来源，特别是在使用非标准包管理器或新操作系统版本时。

3. 当遇到类似模块缺失问题时，可以尝试从简化配置入手，逐步排查问题根源。

4. 对于 Electron 项目，保持工具链各组件版本的兼容性非常重要，特别是 Electron Forge、Electron 本身和操作系统版本之间的兼容性。

这个问题最终通过调整项目配置得到解决，但提醒开发者在类似环境下需要特别注意模块系统和包管理器的兼容性问题。