close
Rstest
  • 简体中文

      • reporters

      • 类型：
      type Reporter = ReporterName | [ReporterName, ReporterOptions];

type Reporters = Reporter | Reporter[];
      process.env.GITHUB_ACTIONS === 'true'
  ? ['default', 'github-actions']
  : ['default'];
      • CLI： --reporters=<name> --reporters=<name1>（同时兼容 --reporter 作为别名）

      配置用于测试结果输出的报告器。

      内置报告器名称包括 default、dot、verbose、md、github-actions、junit、json 和 blob。

      AI agent 环境

      未显式配置 reporters（配置文件无 reporters，且 CLI 未传 --reporters）时，Rstest 会默认使用 ['md']，将更适合 AI agent 的 markdown 输出到 stdout。

      使用方法

      基本示例

      你可以在 rstest.config.ts 文件中或通过 CLI 指定报告器。

      CLI
      rstest.config.ts
      npx rstest --reporters=default

      数组形式

      你可以通过数组形式同时指定多个报告器。当你既需要控制台输出又需要 CI/CD 管道的文件报告时，这非常有用。

      CLI
      rstest.config.ts
      npx rstest --reporters=default --reporters=junit

      报告器配置

      当报告器支持配置选项时，可以通过 [reporterName, options] 传递配置选项。

      rstest.config.ts
      import { defineConfig } from '@rstest/core';

export default defineConfig({
  reporters: [
    ['default', { verbose: true }],
    ['github-actions', { verbose: true }],
    ['junit', { outputPath: './test-results.xml' }],
  ],
});

      使用自定义报告器

      你可以通过提供实现报告器接口的报告器类或对象来创建和使用自定义报告器：

      rstest.config.ts
      import { defineConfig } from '@rstest/core';
import { CustomReporter } from './custom-reporter';

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

      相关文档