Vitest 项目中如何正确配置代码覆盖率排除规则

在 Vitest 测试框架中，当使用工作区(workspace)功能时，开发者可能会遇到代码覆盖率报告包含 node_modules 目录的问题。本文将深入分析这一问题的成因，并提供完整的解决方案。

问题现象分析

在 pnpm 工作区项目中，即使明确配置了 coverage.exclude 规则来排除 node_modules 目录，运行 vitest 覆盖率测试时仍然会包含这些第三方依赖文件。这会导致覆盖率报告变得冗长且不准确。

根本原因

Vitest 的工作区功能有一个重要特性：覆盖率配置是针对整个工作区全局生效的，而不是针对单个项目。这意味着：

1. 在工作区子项目中配置的 coverage 选项实际上会被忽略
2. 必须在根目录的 vitest.config.ts 文件中定义覆盖率相关配置
3. 默认的排除规则可能在某些情况下不会按预期工作

解决方案

基础配置

在项目根目录创建 vitest.config.ts 文件，包含以下内容：

import { defineConfig } from "vitest/config";

export default defineConfig({
  test: {
    coverage: {
      excludeAfterRemap: true,
    },
  },
});

工作区配置

保持 vitest.workspace.ts 文件简洁：

export default ["apps/*", "packages/*"];

完整配置说明

1. excludeAfterRemap: true 是关键配置，确保在源代码映射后应用排除规则
2. 工作区配置只需简单指定包含的目录模式
3. 子项目中的 vitest 配置可以专注于测试相关的设置，如测试匹配规则等

最佳实践

1. 对于工作区项目，始终在根目录配置覆盖率相关选项
2. 子项目配置应专注于测试运行时的特定需求
3. 考虑在根配置中添加更多排除项以提高报告清晰度：

export default defineConfig({
  test: {
    coverage: {
      excludeAfterRemap: true,
      exclude: [
        "**/node_modules/**",
        "**/dist/**",
        "**/*.d.ts",
        "**/test/**"
      ],
    },
  },
});

总结

Vitest 的工作区功能虽然强大，但在覆盖率配置上有其特殊性。理解配置的作用范围和优先级是解决问题的关键。通过正确的根目录配置，可以确保覆盖率报告只包含项目实际代码，排除所有不必要的干扰项。