扩展默认报告器 advanced

WARNING

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

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

扩展内置报告器

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

import { DefaultReporter } from 'vitest/node'

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

WARNING

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

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

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

custom-reporter.js

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 文件中使用自定义报告器：

vitest.config.ts

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

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

报告任务

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

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 provides vitest.createReport that exposes collection of utilities for writing artifacts on file system conveniently.

If your custom reporter needs to store any artifacts on file system it should place them inside .vitest directory. This directory is a convention that Vitest reporters and third party integrations can use to co-locate their results in a single directory. This way users of your custom reporter do not need to add multiple exclusion in their .gitignore. Only the .vitest is needed.

Reporters and other integrations should respect following rules around .vitest directory:

• .vitest directory is placed in the root of the project
• Reporter can create .vitest directory if it does not already exist
• Reporter should never remove .vitest directory
• Reporter should create their own directory inside .vitest, for example .vitest/yaml-reporter/
• Reporter can remove their own specific directory inside .vitest, for example .vitest/yaml-reporter/

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

导出报告器

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

内置报告器:

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

接口报告器:

1. Reporter