ts-jest 项目中的 ESM 预设配置优化指南

在 JavaScript 生态系统中，ES Modules (ESM) 已经成为现代模块系统的标准。对于使用 TypeScript 和 Jest 进行测试的开发者来说，ts-jest 提供了对 ESM 的支持。本文将深入探讨 ts-jest 中 ESM 预设配置的最佳实践。

ESM 预设的核心配置

ts-jest 通过预设(preset)机制简化了 ESM 的配置过程。ts-jest/presets/default-esm 预设实际上等价于以下配置：

{
  extensionsToTreatAsEsm: ['.jsx', '.ts', '.tsx', '.mts'],
  transform: {
    '^.+\\.m?tsx?$': [
      'ts-jest',
      {
        useESM: true,
      },
    ],
  },
}

这个预设自动处理了 .ts、.tsx、.mts 等 TypeScript 文件的 ESM 转换，开发者无需手动配置这些基础项。

常见配置误区

许多开发者在使用预设时，会不必要地重复配置 transform 选项。例如：

{
  preset: 'ts-jest/presets/default-esm',
  transform: {
    '^.+\\.tsx?$': [
      'ts-jest',
      {
        useESM: true,
      },
    ],
  },
  // 其他配置...
}

这种配置不仅冗余，还可能导致潜在的配置冲突。预设已经包含了必要的 transform 配置，重复添加会造成维护困难。

推荐的最佳实践

官方推荐使用 createDefaultEsmPreset 工具函数来创建 ESM 配置：

const { createDefaultEsmPreset } = require('ts-jest');

const defaultEsmPreset = createDefaultEsmPreset({
  // 可选的定制化配置
});

module.exports = {
  ...defaultEsmPreset,
  // 其他项目特定配置
};

这种方法相比直接使用预设字符串更加灵活，允许开发者轻松添加自定义配置，同时避免了配置重复的问题。

完整配置示例

一个完整的 ESM 配置应该简洁明了：

const { createDefaultEsmPreset } = require('ts-jest');

module.exports = {
  ...createDefaultEsmPreset(),
  moduleNameMapper: {
    '^(\\.{1,2}/.*)\\.js$': '$1',
  },
  // 其他项目特定配置...
};

这种配置方式确保了 ESM 支持的正确性，同时保持了配置的简洁性和可维护性。

总结

在使用 ts-jest 的 ESM 功能时，开发者应该：

1. 优先使用 createDefaultEsmPreset 工具函数
2. 避免手动重复预设已包含的配置
3. 保持配置简洁，只添加必要的项目特定选项

遵循这些最佳实践可以确保 TypeScript 项目在 Jest 测试环境中获得正确的 ESM 支持，同时保持配置的清晰和可维护性。