t3-env 项目在 Jest 测试中的 ESM 模块兼容性问题解析

在大型 Turborepo 项目中集成 t3-env 时，开发团队遇到了一个棘手的 ESM 模块兼容性问题。这个问题特别出现在 Jest 测试环境中，表现为经典的 "Cannot use import statement outside a module" 错误。本文将深入分析问题本质，并提供多种解决方案。

问题现象

当开发者在 ESM 项目中引入 t3-env 并运行 Jest 测试时，会遇到以下错误提示：

SyntaxError: Cannot use import statement outside a module
> 1 | import { createEnv } from '@t3-oss/env-core'

这个问题特别值得关注，因为：

1. 它只出现在测试阶段，不影响开发和构建过程
2. 整个项目已经全面采用 ESM 规范
3. 在所有依赖中，只有 t3-env 出现了这个问题

问题根源

经过深入分析，这个问题本质上是 Jest 对 ESM 模块支持不完善导致的。虽然现代 JavaScript 生态已经普遍转向 ESM，但 Jest 的默认配置仍然主要面向 CommonJS 模块系统。

特别值得注意的是，t3-env 是一个纯 ESM 包，没有提供 CommonJS 版本的构建产物。这在 Node.js 生态中越来越常见，但也带来了与部分工具链的兼容性问题。

解决方案比较

方案一：启用 Node.js 实验性 ESM 支持

通过在运行 Jest 时添加 Node.js 的实验性标志来解决问题：

node --experimental-vm-modules node_modules/jest/bin/jest.js

优点：

• 简单直接
• 不需要修改项目配置

缺点：

• 依赖实验性功能，可能不稳定
• 需要在所有测试命令中添加标志

方案二：配置 Jest 转换规则

通过修改 Jest 配置，显式指定对 t3-env 的转换规则：

// jest.config.js
module.exports = {
  transform: {
    'node_modules/@t3-oss/.+\\.js$': ['ts-jest'],
  },
  transformIgnorePatterns: ['/node_modules/(?!@t3-oss)'],
}

优点：

• 配置一次即可全局生效
• 不依赖实验性功能

缺点：

• 在复杂项目结构中可能不够灵活
• 需要确保 ts-jest 正确配置

方案三：模拟 t3-env 模块

对于 Next.js 项目或复杂依赖结构，可以采用模块模拟的方式：

// test-setup.ts
jest.mock("@t3-oss/env-nextjs", () => ({
  createEnv: jest.fn(() => ({
    NODE_ENV: "test",
    OTHER_VAR: "value",
  })),
}));

优点：

• 完全避免 ESM 兼容性问题
• 可以自定义测试环境变量

缺点：

• 需要手动维护模拟实现
• 可能错过实际包的行为变化

最佳实践建议

1. 评估项目需求：如果项目不强制要求纯 ESM 环境，考虑使用同时提供 ESM 和 CommonJS 构建的替代方案

2. 分层解决方案：

   • 对于简单项目：采用方案一或方案二
   • 对于复杂项目或 Next.js 项目：考虑方案三

3. 长期规划：

   • 关注 Jest 对 ESM 支持的发展
   • 考虑逐步迁移到 Vitest 等对 ESM 支持更好的测试框架

结论

ESM 与测试工具的兼容性问题在现代 JavaScript 开发中并不罕见。通过理解问题本质和掌握多种解决方案，开发者可以灵活应对不同场景下的挑战。t3-env 作为一个纯 ESM 包，在带来现代化特性的同时，也需要开发者对测试环境进行适当配置。希望本文提供的解决方案能帮助开发者顺利集成 t3-env 并保持测试流程的稳定性。