reporters.md

扩展默认报告器 advanced {#extending-reporters}

::: warning 这是一个高级 API。如果我们只是想配置内置报告器，请阅读 报告器 指南。 :::

我们可以从 vitest/node 导入报告器并扩展它们来创建自定义报告器。

扩展内置报告器 {#extending-built-in-reporters}

一般来说，我们不需要从头开始创建报告器。vitest 附带了几个可以扩展的默认报告程序。

import { DefaultReporter } from 'vitest/node'

export default class MyDefaultReporter extends DefaultReporter {
  // 在此实现自定义功能
}

::: warning 请注意，导出的报告器接口尚未稳定，在次要版本更新中可能会调整其 API 结构。 :::

当然，你也可以从头开始创建自定义报告器，只需实现 Reporter 接口即可：

这是自定义报告器的示例：

import type { Reporter } from 'vitest/node'

export default class CustomReporter implements Reporter {
  onTestModuleCollected(testModule) {
    console.log(testModule.moduleId, 'is finished')

    for (const test of testModule.children.allTests()) {
      console.log(test.name, test.result().state)
    }
  }
}

然后我们可以在 vitest.config.ts 文件中使用自定义报告器：

import { defineConfig } from 'vitest/config'
import CustomReporter from './custom-reporter.js'

export default defineConfig({
  test: {
    reporters: [new CustomReporter()],
  },
})

报告任务 {#reported-tasks}

报告器接收的 事件 包含 测试用例、测试套件 和 测试模块 任务：

import type { Reporter, TestModule } from 'vitest/node'

class MyReporter implements Reporter {
  onTestRunEnd(testModules: ReadonlyArray<TestModule>) {
    for (const testModule of testModules) {
      for (const task of testModule.children) {
        //                          ^?
        console.log('test run end', task.type, task.fullName)
      }
    }
  }
}

在文件系统上存储附件 {#storing-artifacts-on-file-system}

::: tip Vitest 提供了 vitest.createReport，它公开了一组工具函数，用于在文件系统上写入附件。 :::

如果你的自定义报告器需要在文件系统上存储任何附件，应该将它们放在 .vitest 目录中。这个目录是一个约定，Vitest 报告器和第三方集成可以使用它将结果放在同一个目录中。这样，你的自定义报告器的用户就不需要在他们的 .gitignore 中添加多个排除项。只需要排除 .vitest 即可。

报告器和其他集成应遵守以下关于 .vitest 目录的规则：

• .vitest 目录位于项目的 根目录
• 如果 .vitest 目录不存在，报告器将自行创建
• 报告器绝不会删除 .vitest 目录
• 报告器会在 .vitest 内创建自己的目录，例如 .vitest/yaml-reporter/
• 报告器会删除其在 .vitest 内的特定目录，例如 .vitest/yaml-reporter/

.vitest
│
├── yaml-reporter
│   ├── results.yaml
│   └── summary.yaml
│
└── junit-reporter
    └── report.xml

导出报告器 {#exported-reporters}

vitest 附带了一些 内置报告器，我们可以开箱即用。

内置报告器: {#built-in-reporters}

1. DefaultReporter
2. DotReporter
3. JsonReporter
4. VerboseReporter
5. TapReporter
6. JUnitReporter
7. TapFlatReporter
8. HangingProcessReporter
9. TreeReporter

接口报告器: {#interface-reporters}

1. Reporter