From 6ff7972e16666361780e3ca076f8f3cdf2c91ad8 Mon Sep 17 00:00:00 2001
From: Vladimir <sleuths.slews0s@icloud.com>
Date: Mon, 20 Apr 2026 09:34:15 +0200
Subject: [PATCH 1/6] fix: alias `agent` reporter to `minimal` (#10157)

---
 config/reporters.md    |  2 +-
 guide/cli-generated.md |  2 +-
 guide/reporters.md     | 15 +++++++++------
 3 files changed, 11 insertions(+), 8 deletions(-)

diff --git a/config/reporters.md b/config/reporters.md
index 6c9b3335..2098d8f6 100644
--- a/config/reporters.md
+++ b/config/reporters.md
@@ -42,7 +42,7 @@ Note that the [coverage](/guide/coverage) feature uses a different [`coverage.re
 - [`tap-flat`](/guide/reporters#tap-flat-reporter)
 - [`hanging-process`](/guide/reporters#hanging-process-reporter)
 - [`github-actions`](/guide/reporters#github-actions-reporter)
-- [`agent`](/guide/reporters#agent-reporter)
+- [`minimal`](/guide/reporters#minimal-reporter) (aliased as `agent`)
 - [`blob`](/guide/reporters#blob-reporter)
 
 ## Example
diff --git a/guide/cli-generated.md b/guide/cli-generated.md
index 63353248..ac54ea5f 100644
--- a/guide/cli-generated.md
+++ b/guide/cli-generated.md
@@ -102,7 +102,7 @@ Hide logs for skipped tests
 - **CLI:** `--reporter <name>`
 - **Config:** [reporters](/config/reporters)
 
-Specify reporters (default, agent, blob, verbose, dot, json, tap, tap-flat, junit, tree, hanging-process, github-actions)
+Specify reporters (default, agent, minimal, blob, verbose, dot, json, tap, tap-flat, junit, tree, hanging-process, github-actions)
 
 ### outputFile
 
diff --git a/guide/reporters.md b/guide/reporters.md
index 72a86146..34307954 100644
--- a/guide/reporters.md
+++ b/guide/reporters.md
@@ -99,7 +99,7 @@ This example will write separate JSON and XML reports as well as printing a verb
 By default (i.e. if no reporter is specified), Vitest will display summary of running tests and their status at the bottom. Once a suite passes, its status will be reported on top of the summary.
 
 ::: tip
-When Vitest detects it is running inside an AI coding agent, the [`agent`](#agent-reporter) reporter is used instead to reduce output and minimize token usage. You can override this by explicitly configuring the [`reporters`](/config/reporters) option.
+When Vitest detects it is running inside an AI coding agent, the [`minimal`](#minimal-reporter) reporter is used instead to reduce output and minimize token usage. You can override this by explicitly configuring the [`reporters`](/config/reporters) option.
 :::
 
 You can disable the summary by configuring the reporter:
@@ -655,21 +655,24 @@ export default defineConfig({
 })
 ```
 
-### Agent Reporter
+### Minimal Reporter
 
-Outputs a minimal report optimized for AI coding assistants and LLM-based workflows. Only failed tests and their error messages are displayed. Console logs from passing tests and the summary section are suppressed to reduce token usage.
+- **Alias:** `agent`
 
-This reporter is automatically enabled when no `reporters` option is configured and Vitest detects it is running inside an AI coding agent. If you configure custom reporters, you can explicitly add `agent`:
+Outputs a minimal report containing only failed tests and their error messages. Console logs from passing tests and the summary section are also suppressed.
+
+::: tip Agent Reporter
+This reporter is well optimized for AI coding assistants and LLM-based workflows to reduce token usage. It is automatically enabled when no `reporters` option is configured and Vitest detects it is running inside an AI coding agent. If you configure custom reporters, you can explicitly add `minimal` or `agent`:
 
 :::code-group
 ```bash [CLI]
-npx vitest --reporter=agent
+npx vitest --reporter=minimal
 ```
 
 ```ts [vitest.config.ts]
 export default defineConfig({
   test: {
-    reporters: ['agent']
+    reporters: ['minimal']
   },
 })
 ```

From 2aae193f0f78a1bf6e7987cb80dc9950fb739a94 Mon Sep 17 00:00:00 2001
From: Bart Waardenburg <bartwaardenburg@gmail.com>
Date: Mon, 20 Apr 2026 13:44:11 +0200
Subject: [PATCH 2/6] feat(coverage): istanbul to support `instrumenter` option
 (#10119)
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

Co-authored-by: Ari Perkkiö <ari.perkkio@gmail.com>
---
 config/coverage.md | 40 ++++++++++++++++++++++++++++++++++++++++
 1 file changed, 40 insertions(+)

diff --git a/config/coverage.md b/config/coverage.md
index 8d3f2269..461466de 100644
--- a/config/coverage.md
+++ b/config/coverage.md
@@ -390,6 +390,46 @@ Watermarks for statements, lines, branches and functions. See [istanbul document
 
 Concurrency limit used when processing the coverage results.
 
+## coverage.instrumenter <Version type="experimental">4.1.5</Version> {#coverage-instrumenter}
+
+- **Type:** `(options: InstrumenterOptions) => CoverageInstrumenter`
+- **Available for providers:** `'istanbul'`
+
+Factory for a custom instrumenter to use in place of the default `istanbul-lib-instrument`. Vitest calls the factory once during initialization and reuses the returned instrumenter for every file. The rest of the Istanbul pipeline (collection, merging, reporting) is unchanged.
+
+The factory receives an `InstrumenterOptions` object with Vitest's runtime coverage settings, and must return an object implementing the `CoverageInstrumenter` interface. Both types are exported from `vitest/node`.
+
+<!-- eslint-skip -->
+```ts
+interface InstrumenterOptions {
+  coverageVariable: string
+  coverageGlobalScope: string
+  coverageGlobalScopeFunc: boolean
+  ignoreClassMethods: string[]
+}
+
+interface CoverageInstrumenter {
+  instrumentSync: (code: string, filename: string, inputSourceMap?: any) => string
+  lastSourceMap: () => any
+  lastFileCoverage: () => any
+}
+```
+
+<!-- eslint-skip -->
+```ts
+import { defineConfig } from 'vitest/config'
+import { createInstrumenter } from '@vitest/some-custom-instrumenter'
+
+export default defineConfig({
+  test: {
+    coverage: {
+      provider: 'istanbul',
+      instrumenter: options => createInstrumenter(options),
+    }
+  }
+})
+```
+
 ## coverage.customProviderModule
 
 - **Type:** `string`

From 7d62aac530f1e35ecc2bc77594218401eefd24b4 Mon Sep 17 00:00:00 2001
From: Hiroshi Ogawa <hi.ogawa.zz@gmail.com>
Date: Tue, 21 Apr 2026 19:54:58 +0900
Subject: [PATCH 3/6] docs: update custom snapshot matcher example (#10169)

---
 guide/snapshot.md | 12 ++++++++----
 1 file changed, 8 insertions(+), 4 deletions(-)

diff --git a/guide/snapshot.md b/guide/snapshot.md
index b6d0280d..371a2a7b 100644
--- a/guide/snapshot.md
+++ b/guide/snapshot.md
@@ -246,8 +246,8 @@ import { expect, test, Snapshots } from 'vitest'
 const { toMatchFileSnapshot, toMatchInlineSnapshot, toMatchSnapshot } = Snapshots
 
 expect.extend({
-  toMatchTrimmedSnapshot(received: string, length: number) {
-    return toMatchSnapshot.call(this, received.slice(0, length))
+  toMatchTrimmedSnapshot(received: string) {
+    return toMatchSnapshot.call(this, received.slice(0, 10))
   },
   toMatchTrimmedInlineSnapshot(received: string, inlineSnapshot?: string) {
     return toMatchInlineSnapshot.call(this, received.slice(0, 10), inlineSnapshot)
@@ -258,15 +258,19 @@ expect.extend({
 })
 
 test('file snapshot', () => {
+  // create __snapshots__/demo.test.ts with
+  // > exports[`file snapshot 1`] = `"extra long"`
   expect('extra long string oh my gerd').toMatchTrimmedSnapshot(10)
 })
 
 test('inline snapshot', () => {
-  expect('extra long string oh my gerd').toMatchTrimmedInlineSnapshot()
+  expect('super long string oh my gerd').toMatchTrimmedInlineSnapshot(`"super long"`)
 })
 
 test('raw file snapshot', async () => {
-  await expect('extra long string oh my gerd').toMatchTrimmedFileSnapshot('./raw-file.txt')
+  // create raw-file.txt with:
+  // > crazy long
+  await expect('crazy long string oh my gerd').toMatchTrimmedFileSnapshot('./raw-file.txt')
 })
 ```
 

From 30df941749c0ffd4dfc4cc5c8691c9770e007b83 Mon Sep 17 00:00:00 2001
From: NoiseFan <noisefan@163.com>
Date: Tue, 21 Apr 2026 18:55:42 +0800
Subject: [PATCH 4/6] docs(typo): fix doucment's some typo (#10083)

---
 api/advanced/vitest.md                     |  2 +-
 api/assert.md                              |  4 +-
 api/expect.md                              | 34 +++++++--------
 config/allowonly.md                        |  4 +-
 config/bail.md                             |  2 +-
 config/browser/provider.md                 |  2 +-
 config/cache.md                            |  4 +-
 config/coverage.md                         |  2 +-
 config/css.md                              | 18 ++++----
 config/dangerouslyignoreunhandlederrors.md |  4 +-
 config/deps.md                             |  2 +-
 config/diff.md                             | 28 ++++++-------
 config/forcereruntriggers.md               |  2 +-
 config/logheapusage.md                     |  4 +-
 config/maxconcurrency.md                   |  6 +--
 config/mode.md                             |  2 +-
 config/onstacktrace.md                     |  2 +-
 config/passwithnotests.md                  |  4 +-
 config/pool.md                             |  2 +-
 config/resolvesnapshotpath.md              |  4 +-
 config/runner.md                           |  4 +-
 config/sequence.md                         | 48 +++++++++++-----------
 config/slowtestthreshold.md                |  6 +--
 config/testnamepattern.md                  |  2 +-
 config/typecheck.md                        | 44 ++++++++++----------
 guide/cli.md                               |  8 ++--
 26 files changed, 122 insertions(+), 122 deletions(-)

diff --git a/api/advanced/vitest.md b/api/advanced/vitest.md
index 83c2d23c..d4eed1bf 100644
--- a/api/advanced/vitest.md
+++ b/api/advanced/vitest.md
@@ -244,7 +244,7 @@ This method is called automatically by [`startVitest`](/guide/advanced/tests) if
 function standalone(): Promise<void>
 ```
 
-- **Alias**: `init` <Deprecated />
+- **Alias:** `init` <Deprecated />
 
 Initialize reporters and the coverage provider. This method doesn't run any tests. If the `--watch` flag is provided, Vitest will still run changed tests even if this method was not called.
 
diff --git a/api/assert.md b/api/assert.md
index a7329a2b..a10d0663 100644
--- a/api/assert.md
+++ b/api/assert.md
@@ -36,7 +36,7 @@ test('assert.fail', () => {
 ## isOk
 
 - **Type:** `<T>(value: T, message?: string) => asserts value`
-- **Alias** `ok`
+- **Alias:** `ok`
 
 Assert that the given `value` is truthy.
 
@@ -52,7 +52,7 @@ test('assert.isOk', () => {
 ## isNotOk
 
 - **Type:** `<T>(value: T, message?: string) => void`
-- **Alias** `notOk`
+- **Alias:** `notOk`
 
 Assert that the given `value` is falsy.
 
diff --git a/api/expect.md b/api/expect.md
index 48374392..c5ac57ee 100644
--- a/api/expect.md
+++ b/api/expect.md
@@ -1075,7 +1075,7 @@ test('spy function', () => {
 
 ## toHaveBeenCalledTimes
 
-- **Type**: `(amount: number) => Awaitable<void>`
+- **Type:** `(amount: number) => Awaitable<void>`
 
 This assertion checks if a function was called a certain amount of times. Requires a spy function to be passed to `expect`.
 
@@ -1100,7 +1100,7 @@ test('spy function called two times', () => {
 
 ## toHaveBeenCalledWith
 
-- **Type**: `(...args: any[]) => Awaitable<void>`
+- **Type:** `(...args: any[]) => Awaitable<void>`
 
 This assertion checks if a function was called at least once with certain parameters. Requires a spy function to be passed to `expect`.
 
@@ -1126,7 +1126,7 @@ test('spy function', () => {
 
 ## toHaveBeenCalledBefore
 
-- **Type**: `(mock: MockInstance, failIfNoFirstInvocation?: boolean) => Awaitable<void>`
+- **Type:** `(mock: MockInstance, failIfNoFirstInvocation?: boolean) => Awaitable<void>`
 
 This assertion checks if a `Mock` was called before another `Mock`.
 
@@ -1145,7 +1145,7 @@ test('calls mock1 before mock2', () => {
 
 ## toHaveBeenCalledAfter
 
-- **Type**: `(mock: MockInstance, failIfNoFirstInvocation?: boolean) => Awaitable<void>`
+- **Type:** `(mock: MockInstance, failIfNoFirstInvocation?: boolean) => Awaitable<void>`
 
 This assertion checks if a `Mock` was called after another `Mock`.
 
@@ -1164,7 +1164,7 @@ test('calls mock1 after mock2', () => {
 
 ## toHaveBeenCalledExactlyOnceWith
 
-- **Type**: `(...args: any[]) => Awaitable<void>`
+- **Type:** `(...args: any[]) => Awaitable<void>`
 
 This assertion checks if a function was called exactly once and with certain parameters. Requires a spy function to be passed to `expect`.
 
@@ -1188,7 +1188,7 @@ test('spy function', () => {
 
 ## toHaveBeenLastCalledWith
 
-- **Type**: `(...args: any[]) => Awaitable<void>`
+- **Type:** `(...args: any[]) => Awaitable<void>`
 
 This assertion checks if a function was called with certain parameters at its last invocation. Requires a spy function to be passed to `expect`.
 
@@ -1214,7 +1214,7 @@ test('spy function', () => {
 
 ## toHaveBeenNthCalledWith
 
-- **Type**: `(time: number, ...args: any[]) => Awaitable<void>`
+- **Type:** `(time: number, ...args: any[]) => Awaitable<void>`
 
 This assertion checks if a function was called with certain parameters at the certain time. The count starts at 1. So, to check the second entry, you would write `.toHaveBeenNthCalledWith(2, ...)`.
 
@@ -1241,7 +1241,7 @@ test('first call of spy function called with right params', () => {
 
 ## toHaveReturned
 
-- **Type**: `() => Awaitable<void>`
+- **Type:** `() => Awaitable<void>`
 
 This assertion checks if a function has successfully returned a value at least once (i.e., did not throw an error). Requires a spy function to be passed to `expect`.
 
@@ -1265,7 +1265,7 @@ test('spy function returned a value', () => {
 
 ## toHaveReturnedTimes
 
-- **Type**: `(amount: number) => Awaitable<void>`
+- **Type:** `(amount: number) => Awaitable<void>`
 
 This assertion checks if a function has successfully returned a value an exact amount of times (i.e., did not throw an error). Requires a spy function to be passed to `expect`.
 
@@ -1284,7 +1284,7 @@ test('spy function returns a value two times', () => {
 
 ## toHaveReturnedWith
 
-- **Type**: `(returnValue: any) => Awaitable<void>`
+- **Type:** `(returnValue: any) => Awaitable<void>`
 
 You can call this assertion to check if a function has successfully returned a value with certain parameters at least once. Requires a spy function to be passed to `expect`.
 
@@ -1302,7 +1302,7 @@ test('spy function returns a product', () => {
 
 ## toHaveLastReturnedWith
 
-- **Type**: `(returnValue: any) => Awaitable<void>`
+- **Type:** `(returnValue: any) => Awaitable<void>`
 
 You can call this assertion to check if a function has successfully returned a certain value when it was last invoked. Requires a spy function to be passed to `expect`.
 
@@ -1321,7 +1321,7 @@ test('spy function returns bananas on a last call', () => {
 
 ## toHaveNthReturnedWith
 
-- **Type**: `(time: number, returnValue: any) => Awaitable<void>`
+- **Type:** `(time: number, returnValue: any) => Awaitable<void>`
 
 You can call this assertion to check if a function has successfully returned a value with certain parameters on a certain call. Requires a spy function to be passed to `expect`.
 
@@ -1342,7 +1342,7 @@ test('spy function returns bananas on second call', () => {
 
 ## toHaveResolved
 
-- **Type**: `() => Awaitable<void>`
+- **Type:** `() => Awaitable<void>`
 
 This assertion checks if a function has successfully resolved a value at least once (i.e., did not reject). Requires a spy function to be passed to `expect`.
 
@@ -1368,7 +1368,7 @@ test('spy function resolved a value', async () => {
 
 ## toHaveResolvedTimes
 
-- **Type**: `(amount: number) => Awaitable<void>`
+- **Type:** `(amount: number) => Awaitable<void>`
 
 This assertion checks if a function has successfully resolved a value an exact amount of times (i.e., did not reject). Requires a spy function to be passed to `expect`.
 
@@ -1389,7 +1389,7 @@ test('spy function resolved a value two times', async () => {
 
 ## toHaveResolvedWith
 
-- **Type**: `(returnValue: any) => Awaitable<void>`
+- **Type:** `(returnValue: any) => Awaitable<void>`
 
 You can call this assertion to check if a function has successfully resolved a certain value at least once. Requires a spy function to be passed to `expect`.
 
@@ -1409,7 +1409,7 @@ test('spy function resolved a product', async () => {
 
 ## toHaveLastResolvedWith
 
-- **Type**: `(returnValue: any) => Awaitable<void>`
+- **Type:** `(returnValue: any) => Awaitable<void>`
 
 You can call this assertion to check if a function has successfully resolved a certain value when it was last invoked. Requires a spy function to be passed to `expect`.
 
@@ -1430,7 +1430,7 @@ test('spy function resolves bananas on a last call', async () => {
 
 ## toHaveNthResolvedWith
 
-- **Type**: `(time: number, returnValue: any) => Awaitable<void>`
+- **Type:** `(time: number, returnValue: any) => Awaitable<void>`
 
 You can call this assertion to check if a function has successfully resolved a certain value on a specific invocation. Requires a spy function to be passed to `expect`.
 
diff --git a/config/allowonly.md b/config/allowonly.md
index 39fd8611..6c75bed7 100644
--- a/config/allowonly.md
+++ b/config/allowonly.md
@@ -5,8 +5,8 @@ outline: deep
 
 # allowOnly
 
-- **Type**: `boolean`
-- **Default**: `!process.env.CI`
+- **Type:** `boolean`
+- **Default:** `!process.env.CI`
 - **CLI:** `--allowOnly`, `--allowOnly=false`
 
 By default, Vitest does not permit tests marked with the [`only`](/api/test#test-only) flag in Continuous Integration (CI) environments. Conversely, in local development environments, Vitest allows these tests to run.
diff --git a/config/bail.md b/config/bail.md
index 27018e56..26c1fc6b 100644
--- a/config/bail.md
+++ b/config/bail.md
@@ -7,7 +7,7 @@ outline: deep
 
 - **Type:** `number`
 - **Default:** `0`
-- **CLI**: `--bail=<value>`
+- **CLI:** `--bail=<value>`
 
 Stop test execution when given number of tests have failed.
 
diff --git a/config/browser/provider.md b/config/browser/provider.md
index c5995fbf..88eee69d 100644
--- a/config/browser/provider.md
+++ b/config/browser/provider.md
@@ -61,7 +61,7 @@ export default defineConfig({
 })
 ```
 
-## Custom Provider <Badge type="danger">advanced</Badge>
+## Custom Provider <Badge type="danger">advanced</Badge> {#custom-provider}
 
 ::: danger ADVANCED API
 The custom provider API is highly experimental and can change between patches. If you just need to run tests in a browser, use the [`browser.instances`](/config/browser/instances) option instead.
diff --git a/config/cache.md b/config/cache.md
index a480f628..2c7058e6 100644
--- a/config/cache.md
+++ b/config/cache.md
@@ -5,8 +5,8 @@ outline: deep
 
 # cache <CRoot />
 
-- **Type**: `false`
-- **CLI**: `--no-cache`, `--cache=false`
+- **Type:** `false`
+- **CLI:** `--no-cache`, `--cache=false`
 
 Use this option if you want to disable the cache feature. At the moment Vitest stores cache for test results to run the longer and failed tests first.
 
diff --git a/config/coverage.md b/config/coverage.md
index 461466de..d7456831 100644
--- a/config/coverage.md
+++ b/config/coverage.md
@@ -65,7 +65,7 @@ See [Including and excluding files from coverage report](/guide/coverage.html#in
 - **Available for providers:** `'v8' | 'istanbul'`
 - **CLI:** `--coverage.clean`, `--coverage.clean=false`
 
-Clean coverage results before running tests
+Clean coverage results before running tests.
 
 ## coverage.cleanOnRerun
 
diff --git a/config/css.md b/config/css.md
index eb096d16..51a4e0b9 100644
--- a/config/css.md
+++ b/config/css.md
@@ -5,7 +5,7 @@ outline: deep
 
 # css
 
-- **Type**: `boolean | { include?, exclude?, modules? }`
+- **Type:** `boolean | { include?, exclude?, modules? }`
 
 Configure if CSS should be processed. When excluded, CSS files will be replaced with empty strings to bypass the subsequent processing. CSS Modules will return a proxy to not affect runtime.
 
@@ -15,8 +15,8 @@ This option is not applied to [browser tests](/guide/browser/).
 
 ## css.include
 
-- **Type**: `RegExp | RegExp[]`
-- **Default**: `[]`
+- **Type:** `RegExp | RegExp[]`
+- **Default:** `[]`
 
 RegExp pattern for files that should return actual CSS and will be processed by Vite pipeline.
 
@@ -26,20 +26,20 @@ To process all CSS files, use `/.+/`.
 
 ## css.exclude
 
-- **Type**: `RegExp | RegExp[]`
-- **Default**: `[]`
+- **Type:** `RegExp | RegExp[]`
+- **Default:** `[]`
 
 RegExp pattern for files that will return an empty CSS file.
 
 ## css.modules
 
-- **Type**: `{ classNameStrategy? }`
-- **Default**: `{}`
+- **Type:** `{ classNameStrategy? }`
+- **Default:** `{}`
 
 ### css.modules.classNameStrategy
 
-- **Type**: `'stable' | 'scoped' | 'non-scoped'`
-- **Default**: `'stable'`
+- **Type:** `'stable' | 'scoped' | 'non-scoped'`
+- **Default:** `'stable'`
 
 If you decide to process CSS files, you can configure if class names inside CSS modules should be scoped. You can choose one of the options:
 
diff --git a/config/dangerouslyignoreunhandlederrors.md b/config/dangerouslyignoreunhandlederrors.md
index 54536f19..a19bf7aa 100644
--- a/config/dangerouslyignoreunhandlederrors.md
+++ b/config/dangerouslyignoreunhandlederrors.md
@@ -5,8 +5,8 @@ outline: deep
 
 # dangerouslyIgnoreUnhandledErrors <CRoot />
 
-- **Type**: `boolean`
-- **Default**: `false`
+- **Type:** `boolean`
+- **Default:** `false`
 - **CLI:**
   - `--dangerouslyIgnoreUnhandledErrors`
   - `--dangerouslyIgnoreUnhandledErrors=false`
diff --git a/config/deps.md b/config/deps.md
index 579544e9..15297b9d 100644
--- a/config/deps.md
+++ b/config/deps.md
@@ -111,7 +111,7 @@ By default, Vitest assumes you are using a bundler to bypass this and will not f
 ## deps.moduleDirectories
 
 - **Type:** `string[]`
-- **Default**: `['node_modules']`
+- **Default:** `['node_modules']`
 
 A list of directories that should be treated as module directories. This config option affects the behavior of [`vi.mock`](/api/vi#vi-mock): when no factory is provided and the path of what you are mocking matches one of the `moduleDirectories` values, Vitest will try to resolve the mock by looking for a `__mocks__` folder in the [root](/config/root) of the project.
 
diff --git a/config/diff.md b/config/diff.md
index 710d66dd..39cd2653 100644
--- a/config/diff.md
+++ b/config/diff.md
@@ -56,16 +56,16 @@ export default {
 
 ## diff.expand
 
-- **Type**: `boolean`
-- **Default**: `true`
+- **Type:** `boolean`
+- **Default:** `true`
 - **CLI:** `--diff.expand=false`
 
 Expand all common lines.
 
 ## diff.truncateThreshold
 
-- **Type**: `number`
-- **Default**: `0`
+- **Type:** `number`
+- **Default:** `0`
 - **CLI:** `--diff.truncateThreshold=<path>`
 
 The maximum length of diff result to be displayed. Diffs above this threshold will be truncated.
@@ -73,29 +73,29 @@ Truncation won't take effect with default value 0.
 
 ## diff.truncateAnnotation
 
-- **Type**: `string`
-- **Default**: `'... Diff result is truncated'`
+- **Type:** `string`
+- **Default:** `'... Diff result is truncated'`
 - **CLI:** `--diff.truncateAnnotation=<annotation>`
 
 Annotation that is output at the end of diff result if it's truncated.
 
 ## diff.truncateAnnotationColor
 
-- **Type**: `DiffOptionsColor = (arg: string) => string`
-- **Default**: `noColor = (string: string): string => string`
+- **Type:** `DiffOptionsColor = (arg: string) => string`
+- **Default:** `noColor = (string: string): string => string`
 
 Color of truncate annotation, default is output with no color.
 
 ## diff.printBasicPrototype
 
-- **Type**: `boolean`
-- **Default**: `false`
+- **Type:** `boolean`
+- **Default:** `false`
 
-Print basic prototype `Object` and `Array` in diff output
+Print basic prototype `Object` and `Array` in diff output.
 
 ## diff.maxDepth
 
-- **Type**: `number`
-- **Default**: `20` (or `8` when comparing different types)
+- **Type:** `number`
+- **Default:** `20` (or `8` when comparing different types)
 
-Limit the depth to recurse when printing nested objects
+Limit the depth to recurse when printing nested objects.
diff --git a/config/forcereruntriggers.md b/config/forcereruntriggers.md
index 342143e1..9dad489c 100644
--- a/config/forcereruntriggers.md
+++ b/config/forcereruntriggers.md
@@ -5,7 +5,7 @@ outline: deep
 
 # forceRerunTriggers <CRoot />
 
-- **Type**: `string[]`
+- **Type:** `string[]`
 - **Default:** `['**/package.json/**', '**/vitest.config.*/**', '**/vite.config.*/**']`
 
 Glob pattern of file paths that will trigger the whole suite rerun. When paired with the `--changed` argument will run the whole test suite if the trigger is found in the git diff.
diff --git a/config/logheapusage.md b/config/logheapusage.md
index a29f251c..a65df7b0 100644
--- a/config/logheapusage.md
+++ b/config/logheapusage.md
@@ -5,8 +5,8 @@ outline: deep
 
 # logHeapUsage
 
-- **Type**: `boolean`
-- **Default**: `false`
+- **Type:** `boolean`
+- **Default:** `false`
 - **CLI:** `--logHeapUsage`, `--logHeapUsage=false`
 
 Show heap usage after each test. Useful for debugging memory leaks.
diff --git a/config/maxconcurrency.md b/config/maxconcurrency.md
index deb88476..b6a707a7 100644
--- a/config/maxconcurrency.md
+++ b/config/maxconcurrency.md
@@ -5,9 +5,9 @@ outline: deep
 
 # maxConcurrency
 
-- **Type**: `number`
-- **Default**: `5`
-- **CLI**: `--max-concurrency=10`, `--maxConcurrency=10`
+- **Type:** `number`
+- **Default:** `5`
+- **CLI:** `--max-concurrency=10`, `--maxConcurrency=10`
 
 The maximum number of tests and hooks that can run at the same time when using `test.concurrent` or `describe.concurrent`.
 
diff --git a/config/mode.md b/config/mode.md
index 5e45a97e..a17786d5 100644
--- a/config/mode.md
+++ b/config/mode.md
@@ -9,4 +9,4 @@ outline: deep
 - **CLI:** `--mode=staging`
 - **Default:** `'test'`
 
-Overrides Vite mode
+Overrides Vite mode.
diff --git a/config/onstacktrace.md b/config/onstacktrace.md
index 3c970589..ed6a6f70 100644
--- a/config/onstacktrace.md
+++ b/config/onstacktrace.md
@@ -5,7 +5,7 @@ outline: deep
 
 # onStackTrace <CRoot />
 
-- **Type**: `(error: Error, frame: ParsedStack) => boolean | void`
+- **Type:** `(error: Error, frame: ParsedStack) => boolean | void`
 
 Apply a filtering function to each frame of each stack trace when handling errors. This does not apply to stack traces printed by [`printConsoleTrace`](/config/printconsoletrace#printconsoletrace). The first argument, `error`, is a `TestError`.
 
diff --git a/config/passwithnotests.md b/config/passwithnotests.md
index eb4bbe2e..23ae4da1 100644
--- a/config/passwithnotests.md
+++ b/config/passwithnotests.md
@@ -5,8 +5,8 @@ outline: deep
 
 # passWithNoTests <CRoot />
 
-- **Type**: `boolean`
-- **Default**: `false`
+- **Type:** `boolean`
+- **Default:** `false`
 - **CLI:** `--passWithNoTests`, `--passWithNoTests=false`
 
 Vitest will not fail, if no tests will be found.
diff --git a/config/pool.md b/config/pool.md
index c9449818..b98bb9fd 100644
--- a/config/pool.md
+++ b/config/pool.md
@@ -13,7 +13,7 @@ Pool used to run tests in.
 
 ## threads
 
-Enable multi-threading. When using threads you are unable to use process related APIs such as `process.chdir()`. Some libraries written in native languages, such as Prisma, `bcrypt` and `canvas`, have problems when running in multiple threads and run into segfaults. In these cases it is advised to use `forks` pool instead.
+Enable multi-threading. When using threads you are unable to use process related APIs such as `process.chdir()`. Some libraries written in native languages, such as `Prisma`, `bcrypt` and `canvas`, have problems when running in multiple threads and run into segfaults. In these cases it is advised to use `forks` pool instead.
 
 ## forks
 
diff --git a/config/resolvesnapshotpath.md b/config/resolvesnapshotpath.md
index c63abfd5..f3d0ca47 100644
--- a/config/resolvesnapshotpath.md
+++ b/config/resolvesnapshotpath.md
@@ -5,8 +5,8 @@ outline: deep
 
 # resolveSnapshotPath <CRoot />
 
-- **Type**: `(testPath: string, snapExtension: string, context: { config: SerializedConfig }) => string`
-- **Default**: stores snapshot files in `__snapshots__` directory
+- **Type:** `(testPath: string, snapExtension: string, context: { config: SerializedConfig }) => string`
+- **Default:** stores snapshot files in `__snapshots__` directory
 
 Overrides default snapshot path. For example, to store snapshots next to test files:
 
diff --git a/config/runner.md b/config/runner.md
index aaf20871..1d47b953 100644
--- a/config/runner.md
+++ b/config/runner.md
@@ -5,7 +5,7 @@ outline: deep
 
 # runner
 
-- **Type**: `VitestRunnerConstructor`
-- **Default**: `node`, when running tests, or `benchmark`, when running benchmarks
+- **Type:** `VitestRunnerConstructor`
+- **Default:** `node`, when running tests, or `benchmark`, when running benchmarks
 
 Path to a custom test runner. This is an advanced feature and should be used with custom library runners. You can read more about it in [the documentation](/api/advanced/runner).
diff --git a/config/sequence.md b/config/sequence.md
index 51c7276b..e55f4b82 100644
--- a/config/sequence.md
+++ b/config/sequence.md
@@ -5,7 +5,7 @@ outline: deep
 
 # sequence
 
-- **Type**: `{ sequencer?, shuffle?, seed?, hooks?, setupFiles?, groupOrder }`
+- **Type:** `{ sequencer?, shuffle?, seed?, hooks?, setupFiles?, groupOrder }`
 
 Options for how tests should be sorted.
 
@@ -17,8 +17,8 @@ npx vitest --sequence.shuffle --sequence.seed=1000
 
 ## sequence.sequencer <CRoot />
 
-- **Type**: `TestSequencerConstructor`
-- **Default**: `BaseSequencer`
+- **Type:** `TestSequencerConstructor`
+- **Default:** `BaseSequencer`
 
 A custom class that defines methods for sharding and sorting. You can extend `BaseSequencer` from `vitest/node`, if you only need to redefine one of the `sort` and `shard` methods, but both should exist.
 
@@ -91,9 +91,9 @@ Tests in these projects will run in this order:
 
 ## sequence.shuffle
 
-- **Type**: `boolean | { files?, tests? }`
-- **Default**: `false`
-- **CLI**: `--sequence.shuffle`, `--sequence.shuffle=false`
+- **Type:** `boolean | { files?, tests? }`
+- **Default:** `false`
+- **CLI:** `--sequence.shuffle`, `--sequence.shuffle=false`
 
 If you want files and tests to run randomly, you can enable it with this option, or CLI argument [`--sequence.shuffle`](/guide/cli).
 
@@ -101,25 +101,25 @@ Vitest usually uses cache to sort tests, so long-running tests start earlier, wh
 
 ### sequence.shuffle.files {#sequence-shuffle-files}
 
-- **Type**: `boolean`
-- **Default**: `false`
-- **CLI**: `--sequence.shuffle.files`, `--sequence.shuffle.files=false`
+- **Type:** `boolean`
+- **Default:** `false`
+- **CLI:** `--sequence.shuffle.files`, `--sequence.shuffle.files=false`
 
 Whether to randomize files, be aware that long running tests will not start earlier if you enable this option.
 
 ### sequence.shuffle.tests {#sequence-shuffle-tests}
 
-- **Type**: `boolean`
-- **Default**: `false`
-- **CLI**: `--sequence.shuffle.tests`, `--sequence.shuffle.tests=false`
+- **Type:** `boolean`
+- **Default:** `false`
+- **CLI:** `--sequence.shuffle.tests`, `--sequence.shuffle.tests=false`
 
 Whether to randomize tests.
 
 ## sequence.concurrent {#sequence-concurrent}
 
-- **Type**: `boolean`
-- **Default**: `false`
-- **CLI**: `--sequence.concurrent`, `--sequence.concurrent=false`
+- **Type:** `boolean`
+- **Default:** `false`
+- **CLI:** `--sequence.concurrent`, `--sequence.concurrent=false`
 
 If you want tests to run in parallel, you can enable it with this option, or CLI argument [`--sequence.concurrent`](/guide/cli).
 
@@ -129,17 +129,17 @@ When you run tests with `sequence.concurrent` and `expect.requireAssertions` set
 
 ## sequence.seed <CRoot />
 
-- **Type**: `number`
-- **Default**: `Date.now()`
-- **CLI**: `--sequence.seed=1000`
+- **Type:** `number`
+- **Default:** `Date.now()`
+- **CLI:** `--sequence.seed=1000`
 
 Sets the randomization seed, if tests are running in random order.
 
 ## sequence.hooks
 
-- **Type**: `'stack' | 'list' | 'parallel'`
-- **Default**: `'stack'`
-- **CLI**: `--sequence.hooks=<value>`
+- **Type:** `'stack' | 'list' | 'parallel'`
+- **Default:** `'stack'`
+- **CLI:** `--sequence.hooks=<value>`
 
 Changes the order in which hooks are executed.
 
@@ -153,9 +153,9 @@ This option doesn't affect [`onTestFinished`](/api/hooks#ontestfinished). It is
 
 ## sequence.setupFiles {#sequence-setupfiles}
 
-- **Type**: `'list' | 'parallel'`
-- **Default**: `'parallel'`
-- **CLI**: `--sequence.setupFiles=<value>`
+- **Type:** `'list' | 'parallel'`
+- **Default:** `'parallel'`
+- **CLI:** `--sequence.setupFiles=<value>`
 
 Changes the order in which setup files are executed.
 
diff --git a/config/slowtestthreshold.md b/config/slowtestthreshold.md
index 84f9594d..dc10baa2 100644
--- a/config/slowtestthreshold.md
+++ b/config/slowtestthreshold.md
@@ -5,8 +5,8 @@ outline: deep
 
 # slowTestThreshold <CRoot />
 
-- **Type**: `number`
-- **Default**: `300`
-- **CLI**: `--slow-test-threshold=<number>`, `--slowTestThreshold=<number>`
+- **Type:** `number`
+- **Default:** `300`
+- **CLI:** `--slow-test-threshold=<number>`, `--slowTestThreshold=<number>`
 
 The number of milliseconds after which a test or suite is considered slow and reported as such in the results.
diff --git a/config/testnamepattern.md b/config/testnamepattern.md
index 7e4b4098..c0646e5b 100644
--- a/config/testnamepattern.md
+++ b/config/testnamepattern.md
@@ -5,7 +5,7 @@ outline: deep
 
 # testNamePattern <CRoot /> {#testnamepattern}
 
-- **Type** `string | RegExp`
+- **Type:** `string | RegExp`
 - **CLI:** `-t <pattern>`, `--testNamePattern=<pattern>`, `--test-name-pattern=<pattern>`
 
 Run tests with full names matching the pattern.
diff --git a/config/typecheck.md b/config/typecheck.md
index cae1854a..4413742c 100644
--- a/config/typecheck.md
+++ b/config/typecheck.md
@@ -9,24 +9,24 @@ Options for configuring [typechecking](/guide/testing-types) test environment.
 
 ## typecheck.enabled {#typecheck-enabled}
 
-- **Type**: `boolean`
-- **Default**: `false`
-- **CLI**: `--typecheck`, `--typecheck.enabled`
+- **Type:** `boolean`
+- **Default:** `false`
+- **CLI:** `--typecheck`, `--typecheck.enabled`
 
 Enable typechecking alongside your regular tests.
 
 ## typecheck.only {#typecheck-only}
 
-- **Type**: `boolean`
-- **Default**: `false`
-- **CLI**: `--typecheck.only`
+- **Type:** `boolean`
+- **Default:** `false`
+- **CLI:** `--typecheck.only`
 
 Run only typecheck tests, when typechecking is enabled. When using CLI, this option will automatically enable typechecking.
 
 ## typecheck.checker
 
-- **Type**: `'tsc' | 'vue-tsc' | string`
-- **Default**: `tsc`
+- **Type:** `'tsc' | 'vue-tsc' | string`
+- **Default:** `tsc`
 
 What tools to use for type checking. Vitest will spawn a process with certain parameters for easier parsing, depending on the type. Checker should implement the same output format as `tsc`.
 
@@ -39,29 +39,29 @@ You can also pass down a path to custom binary or command name that produces the
 
 ## typecheck.include
 
-- **Type**: `string[]`
-- **Default**: `['**/*.{test,spec}-d.?(c|m)[jt]s?(x)']`
+- **Type:** `string[]`
+- **Default:** `['**/*.{test,spec}-d.?(c|m)[jt]s?(x)']`
 
-Glob pattern for files that should be treated as test files
+Glob pattern for files that should be treated as test files.
 
 ## typecheck.exclude
 
-- **Type**: `string[]`
-- **Default**: `['**/node_modules/**', '**/dist/**', '**/cypress/**', '**/.{idea,git,cache,output,temp}/**']`
+- **Type:** `string[]`
+- **Default:** `['**/node_modules/**', '**/dist/**', '**/cypress/**', '**/.{idea,git,cache,output,temp}/**']`
 
-Glob pattern for files that should not be treated as test files
+Glob pattern for files that should not be treated as test files.
 
 ## typecheck.allowJs
 
-- **Type**: `boolean`
-- **Default**: `false`
+- **Type:** `boolean`
+- **Default:** `false`
 
 Check JS files that have `@ts-check` comment. If you have it enabled in tsconfig, this will not overwrite it.
 
 ## typecheck.ignoreSourceErrors
 
-- **Type**: `boolean`
-- **Default**: `false`
+- **Type:** `boolean`
+- **Default:** `false`
 
 Do not fail, if Vitest found errors outside the test files. This will not show you non-test errors at all.
 
@@ -69,14 +69,14 @@ By default, if Vitest finds source error, it will fail test suite.
 
 ## typecheck.tsconfig
 
-- **Type**: `string`
-- **Default**: _tries to find closest tsconfig.json_
+- **Type:** `string`
+- **Default:** _tries to find closest tsconfig.json_
 
 Path to custom tsconfig, relative to the project root.
 
 ## typecheck.spawnTimeout
 
-- **Type**: `number`
-- **Default**: `10_000`
+- **Type:** `number`
+- **Default:** `10_000`
 
 Minimum time in milliseconds it takes to spawn the typechecker.
diff --git a/guide/cli.md b/guide/cli.md
index e1a16c45..01473173 100644
--- a/guide/cli.md
+++ b/guide/cli.md
@@ -191,8 +191,8 @@ vitest --api=false
 
 ### changed
 
-- **Type**: `boolean | string`
-- **Default**: false
+- **Type:** `boolean | string`
+- **Default:** false
 
 Run tests only against changed files. If no value is provided, it will run tests against uncommitted changes (including staged and unstaged).
 
@@ -204,8 +204,8 @@ If paired with the [`forceRerunTriggers`](/config/forcereruntriggers) config opt
 
 ### shard
 
-- **Type**: `string`
-- **Default**: disabled
+- **Type:** `string`
+- **Default:** disabled
 
 Test suite shard to execute in a format of `<index>`/`<count>`, where
 

From bceb2527e6425f398aaec04fc1b3411ac2728bee Mon Sep 17 00:00:00 2001
From: Hiroshi Ogawa <hi.ogawa.zz@gmail.com>
Date: Wed, 22 Apr 2026 13:49:32 +0900
Subject: [PATCH 5/6] refactor!: replace `loupe.inspect` with pretty-format
 (#9609)

Co-authored-by: Claude Opus 4.6 <noreply@anthropic.com>
Co-authored-by: Codex <noreply@openai.com>
---
 api/test.md                            |  2 +-
 config/chaiconfig.md                   |  4 +---
 config/tasktitlevalueformattruncate.md | 15 +++++++++++++++
 3 files changed, 17 insertions(+), 4 deletions(-)
 create mode 100644 config/tasktitlevalueformattruncate.md

diff --git a/api/test.md b/api/test.md
index 4dda739e..18af801f 100644
--- a/api/test.md
+++ b/api/test.md
@@ -618,7 +618,7 @@ test.each`
 ```
 
 ::: tip
-Vitest processes `$values` with Chai `format` method. If the value is too truncated, you can increase [chaiConfig.truncateThreshold](/config/chaiconfig#chaiconfig-truncatethreshold) in your config file.
+Vitest formats interpolated title values with its display formatter. If the value is too truncated, you can increase [taskTitleValueFormatTruncate](/config/tasktitlevalueformattruncate) in your config file.
 :::
 
 ## test.for
diff --git a/config/chaiconfig.md b/config/chaiconfig.md
index 24cf085a..5a6f9b55 100644
--- a/config/chaiconfig.md
+++ b/config/chaiconfig.md
@@ -29,6 +29,4 @@ Influences whether or not the `showDiff` flag should be included in the thrown A
 - **Type:** `number`
 - **Default:** `40`
 
-Sets length threshold for actual and expected values in assertion errors. If this threshold is exceeded, for example for large data structures, the value is replaced with something like `[ Array(3) ]` or `{ Object (prop1, prop2) }`. Set it to `0` if you want to disable truncating altogether.
-
-This config option affects truncating values in `test.each` titles and inside the assertion error message.
+Sets length threshold for actual and expected values in assertion error messages. If this threshold is exceeded, for example for large data structures, the value is replaced with something like `[ Array(3) ]` or `{ Object (prop1, prop2) }`. Set it to `0` if you want to disable truncating altogether.
diff --git a/config/tasktitlevalueformattruncate.md b/config/tasktitlevalueformattruncate.md
new file mode 100644
index 00000000..5bb7eb88
--- /dev/null
+++ b/config/tasktitlevalueformattruncate.md
@@ -0,0 +1,15 @@
+---
+title: taskTitleValueFormatTruncate | Config
+outline: deep
+---
+
+# taskTitleValueFormatTruncate <CRoot /> {#tasktitlevalueformattruncate}
+
+- **Type** `number`
+- **Default:** `40`
+
+Sets the length limit for formatted values interpolated into generated task titles.
+
+This affects values inserted by APIs like `test.each` and `test.for`, including both `$value` and `%` placeholder formatting.
+
+Set it to `0` to disable truncation.

From 1f86109e54689db534e518c85a6a73daa82d5bcf Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Ari=20Perkki=C3=B6?= <ari.perkkio@gmail.com>
Date: Wed, 22 Apr 2026 07:50:28 +0300
Subject: [PATCH 6/6] feat: add `createReport` and `.vitest` report directory
 convention (#9993)

---
 api/advanced/vitest.md      | 119 ++++++++++++++++++++++++++++++++++++
 guide/advanced/reporters.md |  27 ++++++++
 guide/index.md              |   7 +++
 3 files changed, 153 insertions(+)

diff --git a/api/advanced/vitest.md b/api/advanced/vitest.md
index d4eed1bf..0f436591 100644
--- a/api/advanced/vitest.md
+++ b/api/advanced/vitest.md
@@ -687,3 +687,122 @@ Returns module's diagnostic. If [`testModule`](/api/advanced/test-module) is not
 ::: warning
 At the moment, the [browser](/guide/browser/) modules are not supported.
 :::
+
+## createReport <Version>5.0.0</Version> {#createreport}
+
+```ts
+function createReport(scope: string): Report
+```
+
+Creates a report that is limited to the given scope. `Report` follows Vitest's rules around [Storing artifacts on file system](/guide/advanced/reporters.html#storing-artifacts-on-file-system).
+
+`Report` provides collection of utilities for writing test results, temporary files and other artifacts on the file system. It's especially intended for third party integrations like custom reporters.
+
+All operations of `Report` are limited to given `scope`. A single report cannot interfere with other reports. Internally Vitest creates `.vitest` directory where each `scope` creates their own directory. This convention of `.vitest` directory reduces the amount of entries end-users need to specify in their `.gitignore`.
+
+```ts
+import type { Report } from 'vitest/node'
+
+const scope = 'example-yaml-reporter'
+
+// Automatically creates `<project-root>/.vitest/example-yaml-reporter/`
+// directory if it does not exist already
+const report: Report = vitest.createReport(scope)
+```
+
+### Report.root
+
+```ts
+const root: string
+```
+
+The root directory for this scope.
+
+```ts
+const report = vitest.createReport('my-json-reporter')
+
+// Is <project-root>/.vitest/my-json-reporter
+const root = report.root
+```
+
+
+### Report.clean
+
+```ts
+function clean(): Promise<void>
+```
+
+Clean up the report directory for this scope.
+
+```ts
+const report = vitest.createReport('my-json-reporter')
+
+// Removes everything inside <project-root>/.vitest/my-json-reporter/
+await report.clean()
+```
+
+### Report.writeFile
+
+```ts
+function writeFile(
+  filename: string,
+  content: string | Uint8Array,
+  encoding?: BufferEncoding
+): Promise<void>
+```
+
+Write a file to the report directory for this scope. By default the file will be written with UTF-8 encoding. The filename is relative to the scope directory.
+
+```ts
+const report = vitest.createReport('my-json-reporter')
+
+// Writes file to .vitest/my-json-reporter/test-report.json
+await report.writeFile('test-report.json', JSON.stringify(results))
+```
+
+### Report.readFile
+
+```ts
+function readFile(filename: string, encoding?: BufferEncoding): Promise<string>
+```
+
+Read a file from the report directory for this scope.
+
+```ts
+const report = vitest.createReport('my-json-reporter')
+
+// Reads file from .vitest/my-json-reporter/test-report.json
+const content: string = await report.readFile('test-report.json')
+```
+
+### Report.readdir
+
+```ts
+function readdir(): Promise<string[]>
+```
+
+Read contents of the report directory for this scope.
+
+```ts
+const report = vitest.createReport('my-json-reporter')
+
+// Reads contents from .vitest/my-json-reporter
+const filenames: string[] = await report.readdir()
+```
+
+### Report.delete
+
+<!-- eslint-skip -->
+```ts
+function delete(filename: string): Promise<void>
+```
+
+Delete a file from the report directory for this scope.
+
+```ts
+const report = vitest.createReport('my-json-reporter')
+
+// Deletes file from .vitest/my-json-reporter/test-report.json
+await report.delete('test-report.json')
+```
+
diff --git a/guide/advanced/reporters.md b/guide/advanced/reporters.md
index 925e4559..c450b57e 100644
--- a/guide/advanced/reporters.md
+++ b/guide/advanced/reporters.md
@@ -72,6 +72,33 @@ class MyReporter implements Reporter {
 }
 ```
 
+## Storing artifacts on file system
+
+::: tip
+Vitest provides [`vitest.createReport`](/api/advanced/vitest.html#createreport) that exposes collection of utilities for writing artifacts on file system conveniently.
+:::
+
+If your custom reporter needs to store any artifacts on file system it should place them inside `.vitest` directory. This directory is a convention that Vitest reporters and third party integrations can use to co-locate their results in a single directory. This way users of your custom reporter do not need to add multiple exclusion in their `.gitignore`. Only the `.vitest` is needed.
+
+Reporters and other integrations should respect following rules around `.vitest` directory:
+
+- `.vitest` directory is placed in [the `root` of the project](/config/root)
+- Reporter can create `.vitest` directory if it does not already exist
+- Reporter should never remove `.vitest` directory
+- Reporter should create their own directory inside `.vitest`, for example `.vitest/yaml-reporter/`
+- Reporter can remove their own specific directory inside `.vitest`, for example `.vitest/yaml-reporter/`
+
+```ansi
+.vitest
+│
+├── yaml-reporter
+│   ├── results.yaml
+│   └── summary.yaml
+│
+└── junit-reporter
+    └── report.xml
+```
+
 ## Exported Reporters
 
 `vitest` comes with a few [built-in reporters](/guide/reporters) that you can use out of the box.
diff --git a/guide/index.md b/guide/index.md
index 21a1df20..c3ebe8c3 100644
--- a/guide/index.md
+++ b/guide/index.md
@@ -46,6 +46,13 @@ It is recommended that you install a copy of `vitest` in your `package.json`, us
 
 The `npx` tool will execute the specified command. By default, `npx` will first check if the command exists in the local project's binaries. If it is not found there, `npx` will look in the system's `$PATH` and execute it if found. If the command is not found in either location, `npx` will install it in a temporary location prior to execution.
 
+Vitest and third party integrations can use `.vitest` directory to store generated artifacts. It's recommended to add this in your `.gitignore`.
+
+``` sh [.gitignore]
+# Vitest reports and artifacts
+.vitest/
+```
+
 ## Writing Tests
 
 As an example, we will write a simple test that verifies the output of a function that adds two numbers.