Eleventy项目中CommonJS与ESM模块系统的兼容性指南

在Eleventy v3版本中，项目全面转向了ES Modules (ESM)作为默认模块系统，但依然保留了对CommonJS (CJS)的兼容支持。本文将从技术实现角度，详细解析两种模块系统在Eleventy项目中的交互逻辑及最佳实践。

---

核心差异与背景

• CommonJS (CJS): Node.js传统模块规范，采用require()同步加载，适用于服务端场景。
• ES Modules (ESM): JavaScript官方标准，通过import/export实现静态分析，支持异步加载和Tree Shaking。

Eleventy v3的架构升级中，ESM成为默认选项，但通过Node.js的双模式解析机制，实现了对遗留CJS模块的无缝适配。

---

配置文件适配策略

1. 纯ESM项目

• 推荐配置：直接使用.mjs扩展名或"type": "module"的package.json。
• 示例：

  // .eleventy.mjs
  export default function(eleventyConfig) {
    // ESM语法
  }
  

2. 纯CJS项目

• 保留.cjs扩展名或"type": "commonjs"声明：

  // .eleventy.cjs
  module.exports = function(eleventyConfig) {
    // CJS语法
  }
  

3. 混合模式项目

• 跨模块调用：ESM文件可通过动态import()加载CJS模块，反之CJS需用createRequire解析ESM。
• 典型场景：

  // ESM中调用CJS插件
  import { createRequire } from 'module';
  const require = createRequire(import.meta.url);
  const cjsPlugin = require('cjs-plugin');
  

---

模板文件处理

Eleventy对模板引擎文件（如.11ty.js）的模块类型推断规则：

1. 优先根据项目根目录的package.json的type字段判断
2. 次之通过文件扩展名（.mjs/.cjs）确定
3. 未明确声明时，v3+版本默认按ESM解析

---

插件兼容性矩阵

插件类型	宿主环境	加载方式	注意事项
ESM	ESM	直接import	支持所有ESM特性
CJS	ESM	createRequire	需处理默认导出的default属性
ESM	CJS	动态import()	异步加载需Promise处理
CJS	CJS	require	传统方式无兼容问题

---

调试技巧

1. 模块类型检测：通过console.log(require('module').builtinModules)查看当前环境支持列表
2. 错误处理：捕获ERR_REQUIRE_ESM错误时，应考虑转换为ESM动态导入
3. 性能分析：ESM的静态加载特性可使构建阶段依赖分析效率提升30%+

---

迁移建议

1. 新项目优先采用ESM规范
2. 存量CJS项目可逐步迁移：
   • 先修改配置文件扩展名为.cjs
   • 使用"type": "module"配合--experimental-vm-modules标志测试
3. 复杂插件生态建议封装适配层处理模块差异

通过理解Eleventy的模块解析策略，开发者可以灵活选择最适合项目阶段的模块方案，平衡现代化与兼容性需求。