Playwright reporter options

In playwright.config.ts:

import { defineConfig } from '@playwright/test';

export default defineConfig({
  reporter: [
    ['list'],
    [
      'executable-stories-playwright/reporter',
      {
        /* options */
      },
    ],
  ],
});

Options reference

The reporter uses FormatterOptions from executable-stories-formatters. Same core options as Vitest reporter options.

Output configuration

Option	Type	Default	Description
formats	OutputFormat[]	["html"]	Output formats: "markdown", "html", "junit", "cucumber-json", "cucumber-messages", "cucumber-html".
outputDir	string	"reports"	Base directory for output files.
outputName	string	"index"	Base filename (without extension).
outputNameTimestamp	boolean	false	Append a UTC timestamp suffix to the output filename.
output	OutputConfig	{ mode: "aggregated" }	Output routing configuration.
rawRunPath	string	—	Write the raw run JSON to disk for later CLI use.

Every run also maintains one canonical JSON report per test source under <outputDir>/by-file/. Documentation formats render accumulated state, while JUnit, Cucumber, and release manifests contain only the current execution. Playwright detects grep, grepInvert, sharding, and incomplete collection automatically.

OutputConfig

Field	Type	Default	Description
mode	"aggregated" | "colocated"	"aggregated"	Single file vs one file per source.
colocatedStyle	"mirrored" | "adjacent" | "flat"	"mirrored"	Colocated: mirrored under outputDir, next to source, or directly under outputDir with a clean name.
rules	OutputRule[]	[]	Pattern-based overrides (first match wins).

Markdown options

Nested under markdown. See Vitest config for full list.

The same top-level filtering, history, and notification options are also available in Playwright reporter config.

Examples

Aggregated markdown

[
  'executable-stories-playwright/reporter',
  {
    formats: ['markdown'],
    outputDir: 'docs',
    outputName: 'user-stories',
    output: { mode: 'aggregated' },
    markdown: {
      title: 'User Stories',
      includeStatusIcons: true,
      includeMetadata: true,
    },
  },
];

Multiple formats

[
  'executable-stories-playwright/reporter',
  {
    formats: ['markdown', 'html', 'cucumber-json'],
    outputDir: 'reports',
    outputName: 'test-results',
    output: { mode: 'aggregated' },
  },
];

Colocated output

[
  'executable-stories-playwright/reporter',
  {
    formats: ['markdown'],
    outputDir: 'docs',
    output: {
      mode: 'colocated',
      colocatedStyle: 'mirrored',
    },
  },
];