Vitest 测试覆盖率报告中包含测试文件的问题解析

问题背景

在使用 Vitest 进行前端项目测试时，开发者可能会遇到一个常见问题：生成的测试覆盖率报告不仅包含了被测试的源代码文件，还包含了测试文件本身。这种情况会导致覆盖率数据失真，因为测试文件本身通常不会被测试覆盖。

问题表现

当运行 Vitest 的覆盖率报告时，开发者会发现测试文件（如 .spec.ts 或 .test.ts 文件）也被计算在覆盖率统计中。这显然不符合预期，因为测试文件本身不需要被"测试覆盖"。

根本原因

Vitest 默认会收集所有被加载文件的覆盖率数据，包括测试文件。虽然 Vitest 内部确实有默认的排除规则，但这些规则需要开发者显式地在配置中引用才能生效。

解决方案

要正确排除测试文件，开发者需要在 Vitest 配置中做以下调整：

1. 首先确保测试文件匹配模式正确设置
2. 然后在覆盖率配置中显式引用默认排除规则

具体配置示例如下：

import { defineConfig } from 'vitest/config'
import { coverageConfigDefaults } from 'vitest/config'

export default defineConfig({
  test: {
    include: ['src/**/*.{test,spec}.?(c|m)[jt]s?(x)'],
    coverage: {
      provider: 'v8',
      exclude: [
        'vite.config.ts',
        ...coverageConfigDefaults.exclude // 关键：引用默认排除规则
      ],
    },
  },
})

技术细节

Vitest 内部维护了一个默认的排除列表 coverageConfigDefaults.exclude，其中已经包含了常见的测试文件模式（如 **/*.spec.ts 等）。但为了保持配置的灵活性，Vitest 不会自动应用这些排除规则，需要开发者显式引用。

最佳实践

1. 始终在覆盖率配置中引用 coverageConfigDefaults.exclude
2. 可以根据项目需要添加额外的排除项
3. 定期检查覆盖率报告，确保没有意外包含的文件
4. 对于大型项目，可以考虑将覆盖率配置提取到单独的文件中维护

总结

Vitest 提供了灵活的测试覆盖率配置选项，但需要开发者正确理解和使用其默认排除机制。通过合理配置，可以确保覆盖率报告只包含真正需要统计的源代码文件，从而获得准确的项目测试覆盖率数据。