使用Jest进行TypeScript单元测试时遇util.debugGenerator报错问题排查

根据你提供的代码和配置，这个错误通常是模块导入解析或者Jest/ts-jest配置问题导致的，下面是一步步的排查和解决方法：

1. 验证模块导入路径的正确性 #

首先确认相对路径没有错误：

• assets.collect.ts位于src/collect目录，utils.ts位于src/utils目录，所以../utils/utils的相对路径是正确的。
• 如果是Windows系统，注意文件名的大小写一致性（比如实际文件是Utils.ts但导入写的是utils.ts，会导致Node.js无法正确解析模块）。

2. 确保ts-jest使用正确的TypeScript配置 #

你已经在测试目录下创建了继承主配置的tsconfig，需要让ts-jest明确使用这个配置来编译测试文件。修改package.json中的jest配置，添加globals字段：

"jest": {
  "setupFilesAfterEnv": ["<rootDir>/test/config/setup.js"],
  "transform": { "^.+\\.tsx?$": "ts-jest" },
  "testRegex": "/test/.*\\.test\\.ts$",
  "moduleFileExtensions": [ "ts", "js", "json" ],
  "globals": {
    "ts-jest": {
      "tsconfig": "<rootDir>/test/tsconfig.json"
    }
  }
}

这能确保测试代码和源文件都使用正确的TypeScript编译规则，避免模块导出/导入的编译差异。

3. 清除Jest缓存 #

Jest的缓存可能会残留旧的编译结果，导致模块解析异常。运行测试时加上--no-cache参数：

jest --no-cache

4. 检查模块导出/导入的运行时状态 #

在assets.collect.ts中临时添加日志，查看导入的util对象结构：

import * as util from '../utils/utils';
console.log('Imported util object:', util); // 打印util对象
const debug = util.debugGenerator('Collect assets');

运行测试后，如果控制台输出的util是空对象或者没有debugGenerator属性，说明模块没有被正确导入。此时可以尝试：

• 确认utils.ts没有语法错误，能正常编译
• 检查是否存在循环导入（你的代码中暂时没有这种迹象）

5. 可选：配置Jest的模块搜索路径 #

如果相对路径容易出错，可以在package.json的jest配置中添加modulePaths，让Jest直接从src目录搜索模块：

"jest": {
  // ...其他配置
  "modulePaths": ["<rootDir>/src"]
}

同时修改assets.collect.ts的导入语句为：

import * as util from 'utils/utils';

这需要在主tsconfig.json中添加baseUrl配置：

"compilerOptions": {
  // ...其他配置
  "baseUrl": "./src"
}

额外提示 #

别忘了安装debug模块的类型定义，避免TypeScript编译时的类型警告：

npm install --save-dev @types/debug

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