1---
2name: reporters
3description: Built-in reporters, default selection, and CI/output configuration
4---
5 
6# Reporters
7 
8Select reporters via `--reporter` or `reporters` config. Configuring `reporters` **replaces** the default list — spread `configDefaults.reporters` to keep them.
9 
10```ts
11import { configDefaults, defineConfig } from 'vitest/config'
12 
13export default defineConfig({
14  test: {
15    reporters: ['verbose', ['junit', { suiteName: 'UI tests' }]],
16    // keep defaults and add one:
17    // reporters: ['json', ...configDefaults.reporters],
18  },
19})
20```
21 
22## Default Selection
23 
24When `reporters` is unset, Vitest auto-selects:
25 
26- `default` for normal terminal runs
27- **`minimal` (alias `agent`)** when it detects an **AI coding agent** — only failed tests + errors, no summary or passing logs, optimized to cut token usage
28- `github-actions` is added when `process.env.GITHUB_ACTIONS === 'true'`
29 
30## Built-in Reporters
31 
32| Reporter | Use |
33|----------|-----|
34| `default` | Summary + collapses passing files; prints full tree for single/failing file |
35| `verbose` | One line per finished test (flat list in v4); only reporter that shows annotations on pass |
36| `tree` | Like `default` but always shows each test (the old v3 verbose) |
37| `dot` | One dot per test; details only for failures |
38| `minimal` / `agent` | Failures only; best for AI/LLM workflows |
39| `junit` | JUnit XML (templated, see below) |
40| `json` | Jest-compatible JSON; includes `coverageMap` when coverage enabled |
41| `tap` / `tap-flat` | TAP (nested / flat) |
42| `html` | Interactive UI report (needs `@vitest/ui`) |
43| `blob` | Serialized results for `--merge-reports` |
44| `github-actions` | Workflow annotations + job summary |
45| `hanging-process` | Lists processes preventing exit (debugging) |
46 
47> v4 removed the `basic` reporter (equivalent to `['default', { summary: false }]`). The old `verbose` flat behavior moved here; use `tree` for the nested view.
48 
49## Output Files
50 
51```bash
52vitest --reporter=json --outputFile=./test-output.json
53```
54 
55```ts
56defineConfig({
57  test: {
58    reporters: ['junit', 'json'],
59    outputFile: { junit: './junit.xml', json: './report.json' },
60  },
61})
62```
63 
64## JUnit Templating
65 
66```ts
67reporters: [['junit', {
68  suiteNameTemplate: '{title}',     // {title} {filename} {basename} {displayName}
69  classnameTemplate: '{classname}', // {classname} {title} {suitename} {filename} ...
70  titleTemplate: '{title}',
71  ancestorSeparator: ' > ',
72  addFileAttribute: true,
73}]]
74```
75 
76`{filename}` is the **relative** path (use `{basename}` for the bare name). Templates can also be functions receiving all variables.
77 
78## HTML Report (v5 paths)
79 
80The HTML reporter writes a directory via `outputDir` (default `.vitest`); the entry is `<outputDir>/index.html`. Use `singleFile: true` for a self-contained shareable file (large; coverage not inlined).
81 
82```ts
83reporters: [['html', { singleFile: true }]]
84```
85 
86## Blob & Merge (CI/sharding)
87 
88Blobs default to `.vitest/blob/`. Label environments with `VITEST_BLOB_LABEL` or the reporter `label` option:
89 
90```bash
91vitest run --reporter=blob --outputFile=reports/blob-1.json
92vitest --merge-reports=reports --reporter=junit --reporter=default
93```
94 
95Blob reports don't include file attachments — merge `attachmentsDir` (`.vitest/attachments/`) separately. `--reporter=blob`/`--merge-reports` don't work in watch mode.
96 
97## Key Points
98 
99- Configuring `reporters` replaces defaults — spread `configDefaults.reporters` to keep them
100- The `minimal`/`agent` reporter is auto-selected for AI agents and minimizes token usage
101- Use `tree` for the nested per-test view (old v3 `verbose`)
102- v5 artifacts (blob, attachments, HTML) live under `.vitest/`
103 
104<!--
105Source references:
106- https://vitest.dev/guide/reporters
107- https://vitest.dev/config/reporters
108-->
109