reporters

• 类型:

interface UserConfig {
  reporters?: ConfigReporter | Array<ConfigReporter>
}

type ConfigReporter = string | Reporter | [string, object?]

• 默认值: 'default'（当 process.env.GITHUB_ACTIONS === 'true' 时为 ['default', 'github-actions']）
• 命令行终端:
  • --reporter=tap 用于单个报告器
  • --reporter=verbose --reporter=github-actions 用于多个报告器

此选项定义在 Vitest 测试运行期间可用的单个报告器或报告器列表。

除了内置报告器，你也可以传入 Reporter 接口 的自定义实现，或指向导出该接口默认导出的模块路径（例如：'./path/to/reporter.ts', '@scope/reporter'）。

你可以通过提供一个元组来配置报告器：[string, object]，其中字符串是报告器名称，对象是报告器配置选项。

WARNING

注意 coverage 功能使用了不同的 coverage.reporter 选项。

内置报告器

• default
• verbose
• tree
• dot
• junit
• json
• html
• tap
• tap-flat
• hanging-process
• github-actions
• agent
• blob

示例

vitest.config.js

import { defineConfig } from 'vitest/config'

export default defineConfig({
  test: {
    reporters: [
      'default',
      // 条件报告器
      process.env.CI ? 'github-actions' : {},
      // 来自 npm 包的自定义报告器
      // 选项将以元组形式向下传递
      [
        'vitest-sonar-reporter',
        { outputFile: 'sonar-report.xml' }
      ],
    ]
  }
})

CLI

vitest --reporter=github-actions --reporter=junit