Vitest

The official Flakiness.io reporter for Vitest. The open source implementation is available at github.com/flakiness/vitest.

A custom Vitest reporter that generates Flakiness Reports from your Vitest test runs. The reporter automatically converts Vitest test results into the standardized Flakiness JSON format, capturing test outcomes, system utilization, and environment information.

Quick Start

1. Install the Flakiness.io Vitest reporter:

   npm install -D @flakiness/vitest

2. Configure the reporter in your vitest.config.ts file:

   vitest.config.ts

   import { defineConfig } from 'vitest/config';
   
   export default defineConfig({
     test: {
       includeTaskLocation: true,
       reporters: [
         'default',
         ['@flakiness/vitest', { flakinessProject: 'my-org/my-project' }]
       ],
     },
   });

   Note

   Include 'default' (or another built-in reporter) to retain the standard terminal output, since Vitest only uses the reporters listed in the reporters array.

   Tip

   Setting includeTaskLocation: true is recommended to enable test locations in the report.

3. Run your tests. The report will be automatically generated in the ./flakiness-report folder:

   npx vitest run

4. View the interactive report:

   npx flakiness show ./flakiness-report

Tip

Make sure to add flakiness-report folder to your .gitignore. You can also use the Flakiness CLI to view reports locally.

CI/CD Integration

Reports are automatically uploaded to Flakiness.io at the end of each test run when authentication is configured. If no credentials are present, the report is still generated locally and can be uploaded manually later.

When uploading succeeds, you’ll see a confirmation in your terminal:

  45 passed (1.5m)
[flakiness.io] ✓ Uploaded as https://flakiness.io/flakiness/flakiness/run/6574

Upload Method	Status	Guide
GitHub OIDC	Supported	GitHub Actions
Access Token	Supported	GitHub Actions
Other CI	Supported	Other CI Providers

Tip

GitHub OIDC is the recommended method — no secrets to manage. It requires the flakinessProject config option. See the GitHub Actions guide for setup instructions.

Configuration

For a full list of configuration options, see the reporter README on GitHub.