Electron-Builder 配置文件的ESM模块支持问题解析

问题背景

在Electron应用开发中，electron-builder是一个广泛使用的打包工具。随着Node.js生态逐渐向ES Modules（ESM）迁移，许多开发者开始将项目中的package.json设置为"type": "module"，这导致传统的CommonJS模块系统与ESM之间的兼容性问题。

问题现象

当项目使用ESM模块系统时，electron-builder在加载外部配置文件时会遇到以下典型错误：

require() of ES Module /path/to/electron-builder.config.js not supported.
electron-builder.config.js is treated as an ES module file...

这个错误的核心原因是electron-builder内部依赖的read-config-file包没有正确处理ESM模块的加载逻辑。

技术原理分析

在Node.js中，当package.json中设置了"type": "module"时，所有.js文件默认会被视为ESM模块。而传统的require()函数无法直接加载ESM模块，必须使用动态import()语法。

electron-builder原本通过read-config-file包来加载配置文件，该包内部使用require()来加载文件，导致无法正确处理ESM格式的配置文件。

解决方案演进

electron-builder团队采取了以下改进措施：

1. 内部化配置加载逻辑：不再依赖外部的read-config-file包，而是将配置加载功能集成到electron-builder核心代码中。

2. 智能模块加载机制：实现了新的模块解析逻辑，能够根据文件扩展名和项目类型自动选择正确的加载方式：

   • 对于.mjs文件或"type": "module"项目中的.js文件，使用动态import()
   • 对于其他情况，回退到传统的require()

3. 扩展名支持增强：现在支持更多配置文件格式，包括：

   • .js/.cjs/.mjs (JavaScript)
   • .ts (TypeScript)
   • .json/.json5
   • .yml/.yaml
   • .toml

最佳实践建议

1. 配置文件命名：

   • 对于CommonJS项目：使用.js或.cjs扩展名
   • 对于ESM项目：使用.js或.mjs扩展名

2. 导出方式：

   • CommonJS: module.exports = { /* 配置 */ }
   • ESM: export default { /* 配置 */ }

3. TypeScript支持：可以直接使用.ts配置文件，electron-builder会通过ts-node自动编译

4. 调试技巧：设置DEBUG=electron-builder环境变量可以获取更详细的加载过程信息

兼容性考虑

该解决方案保持了向后兼容性，能够正确处理以下场景：

1. 传统CommonJS项目中的.js配置文件
2. ESM项目中的.js/.mjs配置文件
3. 显式使用.cjs扩展名的CommonJS模块
4. 各种非JavaScript配置文件格式

总结

electron-builder 25.0.6及以上版本已经完善了对ESM模块系统的支持，开发者现在可以自由选择使用CommonJS或ESM格式的配置文件。这一改进使得electron-builder能够更好地适应现代JavaScript生态系统的发展趋势，同时保持对传统项目的兼容性。

对于正在迁移到ESM的项目，建议更新到最新版本的electron-builder，并根据项目类型选择合适的配置文件和导出方式。如果在使用过程中遇到问题，可以通过调试模式获取详细的加载信息来帮助诊断问题。