如何使用Jest运行ESM模块格式的测试用例？

前置要求 #

确认本地安装的Jest版本 >= 27.0.0，低于该版本没有原生ESM测试支持，需要先执行npm i jest@latest -D升级。

推荐方案：全项目ESM配置 #

第一步：调整package.json基础配置 #

• 在package.json中设置 "type": "module"，标识项目默认使用ESM模块规范
• 保留你已配置的Windows适配测试脚本即可："test": "set \"NODE_OPTIONS=--experimental-vm-modules\" && npx jest"

第二步：修复Jest配置文件报错 #

你之前遇到的ReferenceError: module is not defined报错，是因为项目设为ESM后，默认.js配置文件会被当作ESM解析，不能使用CommonJS的module.exports语法，任选一种方式修复即可：

• 把jest.config.js重命名为jest.config.cjs，强制用CommonJS规范解析，原有module.exports的配置内容无需修改
• 把jest.config.js的导出写法改为ESM规范：将module.exports = { ... }替换为export default { ... }
• 直接使用JSON格式的jest.config.json编写配置，不需要写导出语句

第三步：添加Jest ESM兼容配置 #

在Jest配置文件中添加以下配置，解决之前无法识别.mjs测试文件的问题：

export default {
  // 增加mjs后缀的文件识别
  moduleFileExtensions: ["js", "mjs"],
  // 配置测试文件匹配规则，同时兼容.js和.mjs后缀的测试文件
  testMatch: [
    "**/__tests__/**/*.+(js|mjs)",
    "**/?(*.)+(spec|test).+(js|mjs)"
  ],
  // 关闭默认代码转译，避免ESM语法被错误转换为CommonJS
  transform: {},
  transformIgnorePatterns: ["node_modules/"]
}

第四步：验证运行 #

测试文件不管用.js还是.mjs后缀都可以正常使用import语法编写，执行npm run test即可正常运行测试。

备选方案：CommonJS项目下单独运行ESM测试 #

如果不想将整个项目改为ESM规范，可以用该方案：

• package.json保留 "type": "commonjs" 配置
• Jest配置中添加和上面一致的moduleFileExtensions、testMatch配置
• 所有ESM格式的测试文件统一使用.mjs后缀，内部正常使用import语法即可

内容的提问来源于stack exchange，提问作者Luke