ts-jest项目中ESM模块支持的关键配置解析

问题背景

在使用ts-jest 29.2版本进行TypeScript项目测试时，开发者可能会遇到"ReferenceError: exports is not defined"的错误。这个错误通常发生在尝试使用ECMAScript模块(ESM)语法进行测试时，而项目配置却未正确支持ESM模块系统。

核心问题分析

该错误的根本原因在于模块系统配置的不一致。当开发者选择使用ESM模式运行测试时(NODE_OPTIONS=--experimental-vm-modules)，但TypeScript配置(tsconfig.json)中仍然使用CommonJS作为模块系统，就会导致这种运行时错误。

解决方案

要解决这个问题，需要确保TypeScript配置与Node.js运行时模块系统一致：

1. 修改tsconfig.json文件中的"module"选项
2. 将原本的"CommonJS"改为ES模块兼容的版本，如：
   • ES2020
   • ES2022
   • ESNext

配置示例

正确的tsconfig.json配置应该包含类似以下内容：

{
  "compilerOptions": {
    "module": "ES2020",
    // 其他配置...
  }
}

深入理解

这种配置不一致会导致问题的原因是：

1. 当使用--experimental-vm-modules标志时，Node.js期望代码使用ES模块语法
2. 但如果TypeScript配置为CommonJS，编译器会生成CommonJS风格的模块代码(使用require和module.exports)
3. 在ESM环境下，这些CommonJS特定的变量(exports, require等)不存在，因此抛出"exports is not defined"错误

最佳实践建议

1. 对于新项目，建议直接使用ES模块作为默认模块系统
2. 如果项目需要同时支持CommonJS和ESM，可以考虑使用双模块发布策略
3. 确保开发环境、构建工具和测试工具的模块系统配置保持一致
4. 在升级jest/ts-jest版本时，注意检查模块系统相关的配置变更

总结

正确配置模块系统是TypeScript项目使用现代JavaScript特性的基础。通过理解模块系统的工作原理和配置要求，开发者可以避免这类运行时错误，确保测试和开发流程的顺畅。当遇到"exports is not defined"这类错误时，首先应该检查项目中的模块系统配置是否一致，特别是TypeScript配置与运行时环境的匹配情况。