使用nyc时TypeScript装饰器导致代码覆盖率分支未覆盖问题求助

问题分析 #

你遇到的分支未覆盖问题，本质是experimentalDecorators和emitDecoratorMetadata开启后，TypeScript编译器会在编译后的JS代码中生成额外的装饰器逻辑（比如元数据注入、装饰器执行的分支判断），而nyc默认会统计这些编译生成的代码分支，但单元测试不会专门覆盖这些自动生成的逻辑，映射回TS文件时，就显示在@Inject、@Response等装饰器所在行。

解决方案 #

1. 使用官方TypeScript nyc配置 #

安装适配TypeScript的nyc预设配置，它已经处理了装饰器相关的覆盖率统计问题：

npm install --save-dev @istanbuljs/nyc-config-typescript

在项目根目录创建.nycrc文件，引入该配置：

{
  "extends": "@istanbuljs/nyc-config-typescript",
  "include": ["src/**/*.ts"],
  "exclude": ["src/**/*.d.ts", "migrations/**/*.ts"]
}

2. 调整测试命令，优化TypeScript处理 #

改用ts-mocha替代原生mocha+ts-node，让nyc更准确地追踪TypeScript代码执行路径：

npm install --save-dev ts-mocha

更新package.json中的脚本：

"test": "ts-mocha ./tests/unit/**/*.ts --exit",
"test:cov": "rimraf reports .nyc_output && nyc ts-mocha ./tests/unit/**/*.ts --exit"

3. 手动忽略特定装饰器分支（可选） #

如果仍有个别装饰器行的未覆盖提示，可以在代码中添加注释忽略该分支：

/* istanbul ignore next */
@Inject(TYPES.UserRepository)
constructor(private userRepo: UserRepository) {}

4. 验证配置 #

执行测试覆盖率命令，检查报告是否恢复正常：

npm run test:cov

关键原理说明 #

• @istanbuljs/nyc-config-typescript会自动处理TypeScript源映射，将覆盖率统计正确映射到TS文件，同时过滤掉装饰器编译生成的无关分支。
• ts-mocha整合了TypeScript编译与测试流程，避免了原生mocha+ts-node组合可能导致的覆盖率追踪偏差。

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