如何创建可同时被ESM和CJS应用引入使用的Node模块?
可行解决方案
方案1:修复双格式打包+条件导出配置(推荐,可同时兼容ESM和CJS项目)
首先排查你之前Rollup和package.json配置的错误,按以下规则调整:
- Rollup需要输出两套独立产物,分别对应ESM和CJS规范,注意配置CJS输出的
exports: 'auto参数自动处理导出规则,避免默认导出识别异常:
// rollup.config.js 参考配置 export default [ // ESM 产物 { input: 'src/index.js', output: { file: 'dist/index.mjs', format: 'esm' } }, // CJS 产物 { input: 'src/index.js', output: { file: 'dist/index.cjs', format: 'cjs', exports: 'auto' } } ]
- 调整模块package.json配置,不需要设置
"type": "module",避免Node默认将所有.js文件识别为ESM,条件导出需要同时配置import和require对应的入口:
{ "name": "你的模块名", "main": "./dist/index.cjs", "module": "./dist/index.mjs", "exports": { ".": { "import": "./dist/index.mjs", "require": "./dist/index.cjs" } } }
配置完成后重新打包即可,CJS项目用require导入、ESM项目用import导入都会自动匹配对应产物。
方案2:CJS项目侧直接用异步import导入(无需修改ESM模块代码)
如果不想调整模块的打包配置,可直接在CJS后端应用中使用Node原生支持的动态import语法导入ESM模块:
// CJS 项目中调用示例 async function loadModule() { const targetModule = await import('你的ESM模块名'); // 按需求调用模块导出的属性、方法即可 const { method1, default: defaultExport } = targetModule; }
注意该方法仅支持Node 13.2.0及以上版本,且导入逻辑必须写在异步函数中。
方案3:使用esbuild简化转换流程
如果觉得Rollup配置过于繁琐,可使用esbuild快速生成CJS产物,执行以下命令即可:esbuild src/index.js --bundle --format=cjs --outfile=dist/index.cjs
转换后将package.json的main字段指向生成的cjs文件即可。
注意事项
如果你的ESM模块中使用了顶层await语法,CJS本身不支持该特性,需要先将顶层await逻辑移入异步函数中,再进行转译操作。
内容的提问来源于stack exchange,提问作者warahi
相关产品推荐
相关产品推荐

