#reporters

• Type:

type ReporterConfig =
  | BuiltInReporterNames
  | (string & {})
  | [name: string, options: Record<string, unknown>]
  | Reporter;
type Reporters = ReporterConfig | ReporterConfig[];

• Reporter options reference: Reporter option types are defined in packages/core/src/types/reporter.ts

• Default:

process.env.GITHUB_ACTIONS === 'true'
  ? ['default', 'github-actions']
  : ['default'];

• CLI: --reporters=<name> --reporters=<name1> (--reporter is also accepted as an alias)

Configure which reporters to use for test result output.

Built-in reporter names include default, dot, verbose, md, github-actions, junit, json, and blob.

#Usage

#Basic example

You can specify reporters in the rstest.config.ts file or via the CLI.

npx rstest --reporters=default

import { defineConfig } from '@rstest/core';

export default defineConfig({
  reporters: 'default',
});

#Multiple reporters

You can use multiple reporters to output test results in different formats simultaneously. This is useful when you want both console output and a file report for CI/CD pipelines.

import { defineConfig } from '@rstest/core';

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

#Configuring reporters with options

Many reporters support configuration options. Pass them as a tuple [reporterName, options]:

import { defineConfig } from '@rstest/core';

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

#Using custom reporters

You can use a custom reporter module by passing its module specifier, or a tuple with options. The module must default export a reporter class. Rstest constructs it with the options (an empty object for the string form) and a context containing rootPath and the resolved config. The module can be JavaScript or TypeScript; .ts and .mts modules load directly on Node runtimes with type stripping enabled (Node 22.18+ or 24):

import { defineConfig } from '@rstest/core';

export default defineConfig({
  reporters: './custom-reporter.js',
});

// To pass options:
export const configWithOptions = defineConfig({
  reporters: [['./custom-reporter.js', { outputPath: './report.json' }]],
});

You can also pass an already constructed object that implements the Reporter interface. Reporter classes cannot be passed directly.

#Related documentation

• Reporters guide - Usage examples and built-in reporter details
• Reporter API reference - Custom reporter implementation