@vitest-agent/mcp 1.1.0 → 1.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (208) hide show
  1. package/README.md +1 -2
  2. package/index.d.ts +2 -2
  3. package/index.js +1 -1
  4. package/package.json +1 -1
  5. package/server.js +2 -4
  6. package/patterns/_meta.json +0 -67
  7. package/patterns/authoring-a-custom-vitest-agent-reporter.md +0 -82
  8. package/patterns/known-issues-and-caveats.md +0 -52
  9. package/patterns/operating-vitest-agent-as-an-agent.md +0 -62
  10. package/patterns/running-tests-via-mcp.md +0 -103
  11. package/patterns/silencing-leaking-output-in-tests.md +0 -91
  12. package/patterns/testing-effect-schema-definitions.md +0 -71
  13. package/patterns/testing-effect-services-with-mock-layers.md +0 -63
  14. package/resources/index.js +0 -166
  15. package/resources/indexes.js +0 -77
  16. package/resources/manifest-schema.js +0 -46
  17. package/resources/paths.js +0 -20
  18. package/resources/patterns.js +0 -22
  19. package/resources/upstream-docs.js +0 -22
  20. package/vendor/vitest-docs/ATTRIBUTION.md +0 -5
  21. package/vendor/vitest-docs/api/advanced/artifacts.md +0 -189
  22. package/vendor/vitest-docs/api/advanced/metadata.md +0 -68
  23. package/vendor/vitest-docs/api/advanced/plugin.md +0 -168
  24. package/vendor/vitest-docs/api/advanced/reporters.md +0 -342
  25. package/vendor/vitest-docs/api/advanced/runner.md +0 -334
  26. package/vendor/vitest-docs/api/advanced/test-case.md +0 -302
  27. package/vendor/vitest-docs/api/advanced/test-collection.md +0 -89
  28. package/vendor/vitest-docs/api/advanced/test-module.md +0 -140
  29. package/vendor/vitest-docs/api/advanced/test-project.md +0 -321
  30. package/vendor/vitest-docs/api/advanced/test-specification.md +0 -96
  31. package/vendor/vitest-docs/api/advanced/test-suite.md +0 -230
  32. package/vendor/vitest-docs/api/advanced/vitest.md +0 -684
  33. package/vendor/vitest-docs/api/assert-type.md +0 -22
  34. package/vendor/vitest-docs/api/assert.md +0 -1960
  35. package/vendor/vitest-docs/api/browser/assertions.md +0 -1277
  36. package/vendor/vitest-docs/api/browser/commands.md +0 -154
  37. package/vendor/vitest-docs/api/browser/context.md +0 -338
  38. package/vendor/vitest-docs/api/browser/interactivity.md +0 -681
  39. package/vendor/vitest-docs/api/browser/locators.md +0 -1171
  40. package/vendor/vitest-docs/api/browser/react.md +0 -346
  41. package/vendor/vitest-docs/api/browser/svelte.md +0 -292
  42. package/vendor/vitest-docs/api/browser/vue.md +0 -222
  43. package/vendor/vitest-docs/api/describe.md +0 -374
  44. package/vendor/vitest-docs/api/expect-typeof.md +0 -571
  45. package/vendor/vitest-docs/api/expect.md +0 -2304
  46. package/vendor/vitest-docs/api/hooks.md +0 -463
  47. package/vendor/vitest-docs/api/mock.md +0 -701
  48. package/vendor/vitest-docs/api/test.md +0 -926
  49. package/vendor/vitest-docs/api/vi.md +0 -1372
  50. package/vendor/vitest-docs/config/alias.md +0 -13
  51. package/vendor/vitest-docs/config/allowonly.md +0 -32
  52. package/vendor/vitest-docs/config/api.md +0 -27
  53. package/vendor/vitest-docs/config/attachmentsdir.md +0 -6
  54. package/vendor/vitest-docs/config/bail.md +0 -9
  55. package/vendor/vitest-docs/config/benchmark.md +0 -65
  56. package/vendor/vitest-docs/config/browser/api.md +0 -23
  57. package/vendor/vitest-docs/config/browser/commands.md +0 -6
  58. package/vendor/vitest-docs/config/browser/connecttimeout.md +0 -10
  59. package/vendor/vitest-docs/config/browser/detailspanelposition.md +0 -38
  60. package/vendor/vitest-docs/config/browser/enabled.md +0 -40
  61. package/vendor/vitest-docs/config/browser/expect.md +0 -250
  62. package/vendor/vitest-docs/config/browser/headless.md +0 -7
  63. package/vendor/vitest-docs/config/browser/instances.md +0 -47
  64. package/vendor/vitest-docs/config/browser/isolate.md +0 -11
  65. package/vendor/vitest-docs/config/browser/locators.md +0 -24
  66. package/vendor/vitest-docs/config/browser/orchestratorscripts.md +0 -39
  67. package/vendor/vitest-docs/config/browser/playwright.md +0 -214
  68. package/vendor/vitest-docs/config/browser/preview.md +0 -32
  69. package/vendor/vitest-docs/config/browser/provider.md +0 -79
  70. package/vendor/vitest-docs/config/browser/screenshotdirectory.md +0 -6
  71. package/vendor/vitest-docs/config/browser/screenshotfailures.md +0 -6
  72. package/vendor/vitest-docs/config/browser/testerhtmlpath.md +0 -5
  73. package/vendor/vitest-docs/config/browser/trace.md +0 -43
  74. package/vendor/vitest-docs/config/browser/trackunhandlederrors.md +0 -10
  75. package/vendor/vitest-docs/config/browser/ui.md +0 -7
  76. package/vendor/vitest-docs/config/browser/viewport.md +0 -6
  77. package/vendor/vitest-docs/config/browser/webdriverio.md +0 -64
  78. package/vendor/vitest-docs/config/cache.md +0 -26
  79. package/vendor/vitest-docs/config/chaiconfig.md +0 -29
  80. package/vendor/vitest-docs/config/clearmocks.md +0 -22
  81. package/vendor/vitest-docs/config/coverage.md +0 -455
  82. package/vendor/vitest-docs/config/css.md +0 -47
  83. package/vendor/vitest-docs/config/dangerouslyignoreunhandlederrors.md +0 -23
  84. package/vendor/vitest-docs/config/deps.md +0 -127
  85. package/vendor/vitest-docs/config/detectasyncleaks.md +0 -39
  86. package/vendor/vitest-docs/config/diff.md +0 -96
  87. package/vendor/vitest-docs/config/dir.md +0 -7
  88. package/vendor/vitest-docs/config/disableconsoleintercept.md +0 -15
  89. package/vendor/vitest-docs/config/env.md +0 -5
  90. package/vendor/vitest-docs/config/environment.md +0 -96
  91. package/vendor/vitest-docs/config/environmentoptions.md +0 -30
  92. package/vendor/vitest-docs/config/exclude.md +0 -49
  93. package/vendor/vitest-docs/config/execargv.md +0 -10
  94. package/vendor/vitest-docs/config/expandsnapshotdiff.md +0 -7
  95. package/vendor/vitest-docs/config/expect.md +0 -38
  96. package/vendor/vitest-docs/config/experimental.md +0 -510
  97. package/vendor/vitest-docs/config/faketimers.md +0 -51
  98. package/vendor/vitest-docs/config/fileparallelism.md +0 -11
  99. package/vendor/vitest-docs/config/forcereruntriggers.md +0 -19
  100. package/vendor/vitest-docs/config/globals.md +0 -42
  101. package/vendor/vitest-docs/config/globalsetup.md +0 -72
  102. package/vendor/vitest-docs/config/hideskippedtests.md +0 -7
  103. package/vendor/vitest-docs/config/hooktimeout.md +0 -7
  104. package/vendor/vitest-docs/config/include-source.md +0 -115
  105. package/vendor/vitest-docs/config/include.md +0 -71
  106. package/vendor/vitest-docs/config/includetasklocation.md +0 -17
  107. package/vendor/vitest-docs/config/index.md +0 -85
  108. package/vendor/vitest-docs/config/isolate.md +0 -13
  109. package/vendor/vitest-docs/config/logheapusage.md +0 -7
  110. package/vendor/vitest-docs/config/maxconcurrency.md +0 -9
  111. package/vendor/vitest-docs/config/maxworkers.md +0 -49
  112. package/vendor/vitest-docs/config/mockreset.md +0 -22
  113. package/vendor/vitest-docs/config/mode.md +0 -7
  114. package/vendor/vitest-docs/config/name.md +0 -111
  115. package/vendor/vitest-docs/config/onconsolelog.md +0 -25
  116. package/vendor/vitest-docs/config/onstacktrace.md +0 -32
  117. package/vendor/vitest-docs/config/onunhandlederror.md +0 -35
  118. package/vendor/vitest-docs/config/open.md +0 -7
  119. package/vendor/vitest-docs/config/outputfile.md +0 -7
  120. package/vendor/vitest-docs/config/passwithnotests.md +0 -7
  121. package/vendor/vitest-docs/config/pool.md +0 -45
  122. package/vendor/vitest-docs/config/printconsoletrace.md +0 -6
  123. package/vendor/vitest-docs/config/projects.md +0 -6
  124. package/vendor/vitest-docs/config/provide.md +0 -45
  125. package/vendor/vitest-docs/config/reporters.md +0 -69
  126. package/vendor/vitest-docs/config/resolvesnapshotpath.md +0 -36
  127. package/vendor/vitest-docs/config/restoremocks.md +0 -22
  128. package/vendor/vitest-docs/config/retry.md +0 -140
  129. package/vendor/vitest-docs/config/root.md +0 -6
  130. package/vendor/vitest-docs/config/runner.md +0 -6
  131. package/vendor/vitest-docs/config/sequence.md +0 -158
  132. package/vendor/vitest-docs/config/server.md +0 -68
  133. package/vendor/vitest-docs/config/setupfiles.md +0 -40
  134. package/vendor/vitest-docs/config/silent.md +0 -9
  135. package/vendor/vitest-docs/config/slowtestthreshold.md +0 -7
  136. package/vendor/vitest-docs/config/snapshotenvironment.md +0 -27
  137. package/vendor/vitest-docs/config/snapshotformat.md +0 -28
  138. package/vendor/vitest-docs/config/snapshotserializers.md +0 -6
  139. package/vendor/vitest-docs/config/stricttags.md +0 -30
  140. package/vendor/vitest-docs/config/tags.md +0 -141
  141. package/vendor/vitest-docs/config/teardowntimeout.md +0 -7
  142. package/vendor/vitest-docs/config/testnamepattern.md +0 -21
  143. package/vendor/vitest-docs/config/testtimeout.md +0 -7
  144. package/vendor/vitest-docs/config/typecheck.md +0 -77
  145. package/vendor/vitest-docs/config/ui.md +0 -15
  146. package/vendor/vitest-docs/config/unstubenvs.md +0 -20
  147. package/vendor/vitest-docs/config/unstubglobals.md +0 -20
  148. package/vendor/vitest-docs/config/update.md +0 -16
  149. package/vendor/vitest-docs/config/vmmemorylimit.md +0 -30
  150. package/vendor/vitest-docs/config/watch.md +0 -11
  151. package/vendor/vitest-docs/config/watchtriggerpatterns.md +0 -29
  152. package/vendor/vitest-docs/guide/advanced/index.md +0 -147
  153. package/vendor/vitest-docs/guide/advanced/pool.md +0 -148
  154. package/vendor/vitest-docs/guide/advanced/reporters.md +0 -93
  155. package/vendor/vitest-docs/guide/advanced/tests.md +0 -125
  156. package/vendor/vitest-docs/guide/browser/aria-snapshots.md +0 -470
  157. package/vendor/vitest-docs/guide/browser/component-testing.md +0 -571
  158. package/vendor/vitest-docs/guide/browser/index.md +0 -630
  159. package/vendor/vitest-docs/guide/browser/multiple-setups.md +0 -121
  160. package/vendor/vitest-docs/guide/browser/trace-view.md +0 -126
  161. package/vendor/vitest-docs/guide/browser/visual-regression-testing.md +0 -734
  162. package/vendor/vitest-docs/guide/cli-generated.md +0 -972
  163. package/vendor/vitest-docs/guide/cli.md +0 -234
  164. package/vendor/vitest-docs/guide/common-errors.md +0 -163
  165. package/vendor/vitest-docs/guide/coverage.md +0 -515
  166. package/vendor/vitest-docs/guide/debugging.md +0 -127
  167. package/vendor/vitest-docs/guide/environment.md +0 -101
  168. package/vendor/vitest-docs/guide/extending-matchers.md +0 -160
  169. package/vendor/vitest-docs/guide/features.md +0 -310
  170. package/vendor/vitest-docs/guide/filtering.md +0 -175
  171. package/vendor/vitest-docs/guide/ide.md +0 -43
  172. package/vendor/vitest-docs/guide/improving-performance.md +0 -245
  173. package/vendor/vitest-docs/guide/in-source.md +0 -159
  174. package/vendor/vitest-docs/guide/index.md +0 -128
  175. package/vendor/vitest-docs/guide/learn/async.md +0 -147
  176. package/vendor/vitest-docs/guide/learn/debugging-tests.md +0 -210
  177. package/vendor/vitest-docs/guide/learn/matchers.md +0 -277
  178. package/vendor/vitest-docs/guide/learn/mock-functions.md +0 -277
  179. package/vendor/vitest-docs/guide/learn/setup-teardown.md +0 -240
  180. package/vendor/vitest-docs/guide/learn/snapshots.md +0 -166
  181. package/vendor/vitest-docs/guide/learn/testing-in-practice.md +0 -430
  182. package/vendor/vitest-docs/guide/learn/writing-tests-with-ai.md +0 -127
  183. package/vendor/vitest-docs/guide/learn/writing-tests.md +0 -231
  184. package/vendor/vitest-docs/guide/lifecycle.md +0 -379
  185. package/vendor/vitest-docs/guide/migration.md +0 -863
  186. package/vendor/vitest-docs/guide/mocking/classes.md +0 -158
  187. package/vendor/vitest-docs/guide/mocking/dates.md +0 -52
  188. package/vendor/vitest-docs/guide/mocking/file-system.md +0 -74
  189. package/vendor/vitest-docs/guide/mocking/functions.md +0 -61
  190. package/vendor/vitest-docs/guide/mocking/globals.md +0 -20
  191. package/vendor/vitest-docs/guide/mocking/modules.md +0 -414
  192. package/vendor/vitest-docs/guide/mocking/requests.md +0 -114
  193. package/vendor/vitest-docs/guide/mocking/timers.md +0 -48
  194. package/vendor/vitest-docs/guide/mocking.md +0 -239
  195. package/vendor/vitest-docs/guide/open-telemetry.md +0 -156
  196. package/vendor/vitest-docs/guide/parallelism.md +0 -82
  197. package/vendor/vitest-docs/guide/profiling-test-performance.md +0 -243
  198. package/vendor/vitest-docs/guide/projects.md +0 -291
  199. package/vendor/vitest-docs/guide/recipes.md +0 -59
  200. package/vendor/vitest-docs/guide/reporters.md +0 -723
  201. package/vendor/vitest-docs/guide/snapshot.md +0 -620
  202. package/vendor/vitest-docs/guide/test-annotations.md +0 -103
  203. package/vendor/vitest-docs/guide/test-context.md +0 -902
  204. package/vendor/vitest-docs/guide/test-tags.md +0 -314
  205. package/vendor/vitest-docs/guide/testing-types.md +0 -149
  206. package/vendor/vitest-docs/guide/ui.md +0 -160
  207. package/vendor/vitest-docs/guide/using-plugins.md +0 -5
  208. package/vendor/vitest-docs/manifest.json +0 -1691
@@ -1,1691 +0,0 @@
1
- {
2
- "tag": "v4.1.5",
3
- "commitSha": "e399846850fedf10b8228cbe46a419628998acd9",
4
- "capturedAt": "2026-05-05T18:49:19.433Z",
5
- "source": "https://github.com/vitest-dev/vitest",
6
- "pages": [
7
- {
8
- "path": "api/advanced/artifacts",
9
- "title": "Test artifacts (advanced)",
10
- "description": "Use when building Vitest extensions that record structured per-test data — `recordArtifact(task, artifact)`, TestArtifactBase, TestAttachment, attachment serialization to attachmentsDir. Internal/library-author API; users wanting test notes should use test annotations instead.",
11
- "annotations": {
12
- "audience": ["assistant"],
13
- "priority": 0.8
14
- }
15
- },
16
- {
17
- "path": "api/advanced/metadata",
18
- "title": "Task metadata (advanced)",
19
- "description": "Use when passing data from inside tests to a custom reporter — `task.meta` property on test and suite tasks, populated in beforeAll / afterAll / test context, read in onTestCaseResult and onTestRunEnd. One-way (test → reporter); reporter-side mutations are not visible in tests.",
20
- "annotations": {
21
- "audience": ["assistant"],
22
- "priority": 0.8
23
- }
24
- },
25
- {
26
- "path": "api/advanced/plugin",
27
- "title": "Plugin API (advanced)",
28
- "description": "Use when authoring a Vite plugin that needs Vitest-specific behavior — the `configureVitest(context: VitestPluginContext)` hook (since Vitest 3.1), VitestPluginContext shape, and the vite-and-vitest dual-plugin pattern. Library-author API; not for typical app config.",
29
- "annotations": {
30
- "audience": ["assistant"],
31
- "priority": 0.8
32
- }
33
- },
34
- {
35
- "path": "api/advanced/reporters",
36
- "title": "Reporter API (advanced)",
37
- "description": "Use when implementing a custom reporter — full Reporter lifecycle hooks (onInit, onTestModuleStart, onTestCaseReady, onTestCaseResult, onCoverage, onTestRunEnd, etc.) with their TestModule / TestSuite / TestCase parameters. Extend BaseReporter to override selectively.",
38
- "annotations": {
39
- "audience": ["assistant"],
40
- "priority": 0.8
41
- }
42
- },
43
- {
44
- "path": "api/advanced/runner",
45
- "title": "VitestRunner (advanced)",
46
- "description": "Use when implementing a custom test runner via the `runner` config option — VitestRunner interface (onBeforeCollect, onCollected, onBeforeRunTask, onBeforeTryTask, onAfterRunTask, onAfterRunFiles, onCancel), Test/Suite/File task shapes, runtime-task vs main-thread-TestCase distinction.",
47
- "annotations": {
48
- "audience": ["assistant"],
49
- "priority": 0.8
50
- }
51
- },
52
- {
53
- "path": "api/advanced/test-case",
54
- "title": "TestCase (advanced)",
55
- "description": "Use when introspecting a single test in a custom reporter — TestCase.project / module / name / fullName / location / parent / state / result / annotations / artifacts / meta. Main-thread API; for in-worker runtime tasks see the Runner API.",
56
- "annotations": {
57
- "audience": ["assistant"],
58
- "priority": 0.8
59
- }
60
- },
61
- {
62
- "path": "api/advanced/test-collection",
63
- "title": "TestCollection (advanced)",
64
- "description": "Use when iterating top-level suites and tests inside a TestSuite or TestModule — collection.size / at / array / values / allTests / allSuites returning iterators (spread `[...iter]` if you need an array). Top-level only — does not flatten nested suites unless you use allTests/allSuites.",
65
- "annotations": {
66
- "audience": ["assistant"],
67
- "priority": 0.8
68
- }
69
- },
70
- {
71
- "path": "api/advanced/test-module",
72
- "title": "TestModule (advanced)",
73
- "description": "Use when inspecting a single test file in a custom reporter — TestModule.moduleId (absolute unix path or virtual id) / relativeModuleId, plus all inherited TestSuite methods (children, errors, diagnostic, state). One TestModule per file per project.",
74
- "annotations": {
75
- "audience": ["assistant"],
76
- "priority": 0.8
77
- }
78
- },
79
- {
80
- "path": "api/advanced/test-project",
81
- "title": "TestProject (advanced)",
82
- "description": "Use when working with the Node.js TestProject API — project.name / config / vite / globalConfig / vitest / serializedConfig / createSpecification / globTestFiles / collectTests. For declaring projects in user config see /guide/projects.",
83
- "annotations": {
84
- "audience": ["assistant"],
85
- "priority": 0.8
86
- }
87
- },
88
- {
89
- "path": "api/advanced/test-specification",
90
- "title": "TestSpecification (advanced)",
91
- "description": "Use when constructing a test-run programmatically via `project.createSpecification` — module id, optional testLines / testNamePattern / testIds / testTagsFilter filters, taskId / project / pool fields. Specification does not auto-resolve files.",
92
- "annotations": {
93
- "audience": ["assistant"],
94
- "priority": 0.8
95
- }
96
- },
97
- {
98
- "path": "api/advanced/test-suite",
99
- "title": "TestSuite (advanced)",
100
- "description": "Use when inspecting a suite in a custom reporter — TestSuite.project / module / name / fullName / location / parent / children (TestCollection), errors, diagnostic, state. Inherited by TestModule.",
101
- "annotations": {
102
- "audience": ["assistant"],
103
- "priority": 0.8
104
- }
105
- },
106
- {
107
- "path": "api/advanced/vitest",
108
- "title": "Vitest class (advanced)",
109
- "description": "Use when driving Vitest from a Node.js script — Vitest.mode / config / projects / vite / state / cancelCurrentRun / start / close / globTestSpecifications / getModuleSpecifications / invalidateFile / onFilterWatchedSpecification. Documents v4 removals (server, getProjectsByTestFile, listFile, etc.).",
110
- "annotations": {
111
- "audience": ["assistant"],
112
- "priority": 0.8
113
- }
114
- },
115
- {
116
- "path": "api/assert",
117
- "title": "assert",
118
- "description": "Use when reaching for chai's `assert.*` API — assert.equal / deepEqual / strictEqual / isOk / isTrue / isNotNull / fail, narrow type guards via assertion functions. Reexported from chai for invariant-style checks alongside or instead of expect.",
119
- "annotations": {
120
- "audience": ["assistant"],
121
- "priority": 0.9
122
- }
123
- },
124
- {
125
- "path": "api/assert-type",
126
- "title": "assertType",
127
- "description": "Use when type-checking a single expression under `--typecheck` — `assertType<T>(value)` shorthand for expectTypeOf. Pair with `@ts-expect-error` for negative cases. Runtime no-op; requires --typecheck flag.",
128
- "annotations": {
129
- "audience": ["assistant"],
130
- "priority": 0.9
131
- }
132
- },
133
- {
134
- "path": "api/browser/assertions",
135
- "title": "DOM assertions (browser API)",
136
- "description": "Use when asserting on the DOM in browser-mode tests — `expect.element(locator)` matchers: toBeVisible / toBeInTheDocument / toHaveTextContent / toHaveClass / toBeEnabled / toBeChecked / toHaveAttribute / toHaveValue, all with built-in retry. Forked from @testing-library/jest-dom.",
137
- "annotations": {
138
- "audience": ["assistant"],
139
- "priority": 0.55
140
- }
141
- },
142
- {
143
- "path": "api/browser/commands",
144
- "title": "Server commands (browser API)",
145
- "description": "Use when calling server-side functions from a browser test — built-in readFile / writeFile / removeFile (governed by server.fs.allow and api.allowWrite), defining custom commands via the `browser.commands` config option. Paths resolve relative to project root since 3.2.",
146
- "annotations": {
147
- "audience": ["assistant"],
148
- "priority": 0.55
149
- }
150
- },
151
- {
152
- "path": "api/browser/context",
153
- "title": "vitest/browser exports (browser API)",
154
- "description": "Use when importing browser-mode primitives from `vitest/browser` — `page` (locator root), `server` (commands, config), `userEvent` (interactivity), `cdp()` (Chrome DevTools Protocol session). Entry-point API surface.",
155
- "annotations": {
156
- "audience": ["assistant"],
157
- "priority": 0.55
158
- }
159
- },
160
- {
161
- "path": "api/browser/interactivity",
162
- "title": "userEvent (browser API)",
163
- "description": "Use when simulating user interactions in browser tests — userEvent.click / dblClick / tripleClick / type / keyboard / hover / fill / selectOptions / clear / upload / drag, userEvent.setup for stateful sessions. Backed by Playwright/WebDriver (real input events), not faked DOM events.",
164
- "annotations": {
165
- "audience": ["assistant"],
166
- "priority": 0.55
167
- }
168
- },
169
- {
170
- "path": "api/browser/locators",
171
- "title": "page locators (browser API)",
172
- "description": "Use when querying DOM in browser tests — page.getByRole / getByText / getByLabelText / getByTestId / getByPlaceholder / getByTitle / getByAltText, locator chaining via .filter / .nth / .first / .last / .and / .or, .element / .query / .all escape hatches. Backed by Playwright's Ivya.",
173
- "annotations": {
174
- "audience": ["assistant"],
175
- "priority": 0.55
176
- }
177
- },
178
- {
179
- "path": "api/browser/react",
180
- "title": "vitest-browser-react (browser API)",
181
- "description": "Use when rendering React components in browser-mode tests — `render(<Component />)` returns a screen with locators that interact via userEvent and retry under expect.element. Community package; recommended over @testing-library/react for browser mode.",
182
- "annotations": {
183
- "audience": ["assistant"],
184
- "priority": 0.55
185
- }
186
- },
187
- {
188
- "path": "api/browser/svelte",
189
- "title": "vitest-browser-svelte (browser API)",
190
- "description": "Use when rendering Svelte components in browser-mode tests — `render(Component, props)` returns a screen with locators integrated with userEvent and expect.element retries. Community package; alternative to @testing-library/svelte for browser mode.",
191
- "annotations": {
192
- "audience": ["assistant"],
193
- "priority": 0.55
194
- }
195
- },
196
- {
197
- "path": "api/browser/vue",
198
- "title": "vitest-browser-vue (browser API)",
199
- "description": "Use when rendering Vue components in browser-mode tests — `render(Component, { props })` returns a screen with locator-based queries that interact via userEvent and retry under expect.element. Community package; alternative to @testing-library/vue for browser mode.",
200
- "annotations": {
201
- "audience": ["assistant"],
202
- "priority": 0.55
203
- }
204
- },
205
- {
206
- "path": "api/describe",
207
- "title": "describe",
208
- "description": "Use when organizing tests with `describe` (alias `suite`) — nested suites, describe.each parametrization, describe.skip / only / todo / sequential / concurrent / shuffle, hierarchical fullName composition for `> ` separated test paths.",
209
- "annotations": {
210
- "audience": ["assistant"],
211
- "priority": 0.9
212
- }
213
- },
214
- {
215
- "path": "api/expect",
216
- "title": "expect",
217
- "description": "Use when writing assertions with `expect` — Jest-style matchers (`toBe`, `toEqual`, `toThrow`, `toHaveBeenCalled`, `toMatchSnapshot`, etc.), chai-style chains, asymmetric matchers (`expect.anything`, `expect.stringContaining`), `expect.poll` for async retries, `expect.extend` for custom matchers.",
218
- "annotations": {
219
- "audience": ["assistant"],
220
- "priority": 0.9
221
- }
222
- },
223
- {
224
- "path": "api/expect-typeof",
225
- "title": "expectTypeOf",
226
- "description": "Use when writing type-level assertions for the `--typecheck` flag — toEqualTypeOf, toExtend (replaces deprecated toMatchTypeOf), toMatchObjectType, parameters / returns / instance / constructorParameters inspection. Runtime no-op.",
227
- "annotations": {
228
- "audience": ["assistant"],
229
- "priority": 0.9
230
- }
231
- },
232
- {
233
- "path": "api/hooks",
234
- "title": "Lifecycle hooks",
235
- "description": "Use when adding setup or teardown — beforeEach / afterEach / beforeAll / afterAll, hook timeouts (configurable via hookTimeout), the return-cleanup-function pattern, onTestFinished / onTestFailed handlers, sequence.hooks ordering. Skipped when running --typecheck.",
236
- "annotations": {
237
- "audience": ["assistant"],
238
- "priority": 0.9
239
- }
240
- },
241
- {
242
- "path": "api/mock",
243
- "title": "MockInstance",
244
- "description": "Use when inspecting or controlling the MockInstance returned by `vi.fn` and `vi.spyOn` — mock.calls / results / instances / contexts, mockReturnValue / mockResolvedValue / mockRejectedValue (plus *Once variants), mockImplementation, mockReset / mockClear / mockRestore, and class-mock caveats with `vi.fn(class {})`.",
245
- "annotations": {
246
- "audience": ["assistant"],
247
- "priority": 0.9
248
- }
249
- },
250
- {
251
- "path": "api/test",
252
- "title": "test",
253
- "description": "Use when defining a test with `test` or `it` — modifiers (skip, only, todo, concurrent, fails, retry), `test.each` / `test.for` parametrization, `test.extend` fixtures, options-object form, the test-name-from-function shorthand.",
254
- "annotations": {
255
- "audience": ["assistant"],
256
- "priority": 0.9
257
- }
258
- },
259
- {
260
- "path": "api/vi",
261
- "title": "vi",
262
- "description": "Use when reaching for `vi.*` helpers — `vi.mock` / `vi.hoisted` / `vi.importActual` for module mocking, `vi.fn` / `vi.spyOn` for function mocking, `vi.useFakeTimers` / `vi.advanceTimersByTime` for timers, `vi.stubEnv` / `vi.stubGlobal` for env and global stubbing.",
263
- "annotations": {
264
- "audience": ["assistant"],
265
- "priority": 0.9
266
- }
267
- },
268
- {
269
- "path": "config/alias",
270
- "title": "config.alias",
271
- "description": "Use when configuring `alias` — Type `Record | Array`. Define custom aliases when running inside tests. They will be merged with aliases from `resolve.alias`.",
272
- "annotations": {
273
- "audience": ["assistant"],
274
- "priority": 0.85
275
- }
276
- },
277
- {
278
- "path": "config/allowonly",
279
- "title": "config.allowOnly",
280
- "description": "Use when configuring `allowOnly` — Type `boolean`, default `!process.env.CI`, CLI `--allowOnly`. 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.",
281
- "annotations": {
282
- "audience": ["assistant"],
283
- "priority": 0.85
284
- }
285
- },
286
- {
287
- "path": "config/api",
288
- "title": "config.api",
289
- "description": "Use when configuring `api` — Type `boolean | number | object`, default `false`, CLI `--api`. Listen to port and serve API for [the UI](/guide/ui) or [browser server](/guide/browser/). When set to `true`, the default port is `51204`.",
290
- "annotations": {
291
- "audience": ["assistant"],
292
- "priority": 0.85
293
- }
294
- },
295
- {
296
- "path": "config/attachmentsdir",
297
- "title": "config.attachmentsDir",
298
- "description": "Use when configuring `attachmentsDir` — Type `string`, default `'.vitest-attachments'`. Directory path for storing attachments created by [`context.annotate`](/guide/test-context#annotate) relative to the project root.",
299
- "annotations": {
300
- "audience": ["assistant"],
301
- "priority": 0.85
302
- }
303
- },
304
- {
305
- "path": "config/bail",
306
- "title": "config.bail",
307
- "description": "Use when configuring `bail` — Type `number`, default `0`, CLI `--bail=`. Stop test execution when given number of tests have failed.",
308
- "annotations": {
309
- "audience": ["assistant"],
310
- "priority": 0.85
311
- }
312
- },
313
- {
314
- "path": "config/benchmark",
315
- "title": "config.benchmark",
316
- "description": "Use when configuring `benchmark` — Type `{ include?, exclude?, ... }`, default `['**/*.{bench,benchmark}.?(c|m)[jt]s?(x)']`. Options used when running `vitest bench`.",
317
- "annotations": {
318
- "audience": ["assistant"],
319
- "priority": 0.85
320
- }
321
- },
322
- {
323
- "path": "config/browser/api",
324
- "title": "config.browser.api",
325
- "description": "Use when configuring `browser.api` — Type `number | object`, default port `63315`, CLI `--browser.api=63315`. Vite server that serves browser-mode test code. Independent of `test.api` (the Node-mode API server); the default port avoids dev-server conflicts.",
326
- "annotations": {
327
- "audience": ["assistant"],
328
- "priority": 0.55
329
- }
330
- },
331
- {
332
- "path": "config/browser/commands",
333
- "title": "config.browser.commands",
334
- "description": "Use when configuring `browser.commands` — Type `Record`, default `{ readFile, writeFile, ... }`. Custom [commands](/api/browser/commands) that can be imported during browser tests from `vitest/browser`.",
335
- "annotations": {
336
- "audience": ["assistant"],
337
- "priority": 0.55
338
- }
339
- },
340
- {
341
- "path": "config/browser/connecttimeout",
342
- "title": "config.browser.connectTimeout",
343
- "description": "Use when configuring `browser.connectTimeout` — Type `number`, default `60_000`. The timeout in milliseconds. If connection to the browser takes longer, the test suite will fail.",
344
- "annotations": {
345
- "audience": ["assistant"],
346
- "priority": 0.55
347
- }
348
- },
349
- {
350
- "path": "config/browser/detailspanelposition",
351
- "title": "config.browser.detailsPanelPosition",
352
- "description": "Use when configuring `browser.detailsPanelPosition` — Type `'right' | 'bottom'`, default `'right'`, CLI `--browser.detailsPanelPosition=bottom`. Controls the default position of the details panel in the Vitest UI when running browser tests.",
353
- "annotations": {
354
- "audience": ["assistant"],
355
- "priority": 0.55
356
- }
357
- },
358
- {
359
- "path": "config/browser/enabled",
360
- "title": "config.browser.enabled",
361
- "description": "Use when configuring `browser.enabled` — Type `boolean`, default `false`, CLI `--browser`. Enabling this flag makes Vitest run all tests in a [browser](/guide/browser/) by default. If you are configuring other browser options via the CLI, you can use `--browser.enabled` alongside them instead of `--browser`:",
362
- "annotations": {
363
- "audience": ["assistant"],
364
- "priority": 0.55
365
- }
366
- },
367
- {
368
- "path": "config/browser/expect",
369
- "title": "config.browser.expect",
370
- "description": "Use when configuring `browser.expect` — Type `ExpectOptions`. Default options for browser-mode `expect.element` matchers (timeout, interval). Browser-mode counterpart of the Node-mode `test.expect` option.",
371
- "annotations": {
372
- "audience": ["assistant"],
373
- "priority": 0.55
374
- }
375
- },
376
- {
377
- "path": "config/browser/headless",
378
- "title": "config.browser.headless",
379
- "description": "Use when configuring `browser.headless` — Type `boolean`, default `process.env.CI`, CLI `--browser.headless`. Run the browser in a `headless` mode. If you are running Vitest in CI, it will be enabled by default.",
380
- "annotations": {
381
- "audience": ["assistant"],
382
- "priority": 0.55
383
- }
384
- },
385
- {
386
- "path": "config/browser/instances",
387
- "title": "config.browser.instances",
388
- "description": "Use when configuring `browser.instances` — Type `BrowserConfig`, default `[]`. Defines multiple browser setups. Every config has to have at least a `browser` field.",
389
- "annotations": {
390
- "audience": ["assistant"],
391
- "priority": 0.55
392
- }
393
- },
394
- {
395
- "path": "config/browser/isolate",
396
- "title": "config.browser.isolate",
397
- "description": "Use when configuring `browser.isolate` — Type `boolean`, default the same as [`--isolate`](/config/isolate), CLI `--browser.isolate`. Run every test in a separate iframe.",
398
- "annotations": {
399
- "audience": ["assistant"],
400
- "priority": 0.55
401
- }
402
- },
403
- {
404
- "path": "config/browser/locators",
405
- "title": "config.browser.locators",
406
- "description": "Use when configuring `browser.locators` — Type `string`, default `data-testid`. Options for built-in [browser locators](/api/browser/locators).",
407
- "annotations": {
408
- "audience": ["assistant"],
409
- "priority": 0.55
410
- }
411
- },
412
- {
413
- "path": "config/browser/orchestratorscripts",
414
- "title": "config.browser.orchestratorScripts",
415
- "description": "Use when configuring `browser.orchestratorScripts` — Type `BrowserScript[]`, default `[]`. Custom scripts that should be injected into the orchestrator HTML before test iframes are initiated. This HTML document only sets up iframes and doesn't actually import your code.",
416
- "annotations": {
417
- "audience": ["assistant"],
418
- "priority": 0.55
419
- }
420
- },
421
- {
422
- "path": "config/browser/playwright",
423
- "title": "Configuring Playwright",
424
- "description": "Use when configuring `Configuring Playwright` — Type `boolean | string`, default no timeout. To run tests using playwright, you need to install the [`@vitest/browser-playwright`](https://npmx.dev/package/@vitest/browser-playwright) npm package and specify its `playwright` export in the `test.browser.provider`...",
425
- "annotations": {
426
- "audience": ["assistant"],
427
- "priority": 0.55
428
- }
429
- },
430
- {
431
- "path": "config/browser/preview",
432
- "title": "Configuring Preview",
433
- "description": "Use when configuring `Configuring Preview`. The `preview` provider's main functionality is to show tests in a real browser environment. However, it does not support advanced browser automation features like multiple browser instances or headless mode. For more ...",
434
- "annotations": {
435
- "audience": ["assistant"],
436
- "priority": 0.55
437
- }
438
- },
439
- {
440
- "path": "config/browser/provider",
441
- "title": "config.browser.provider",
442
- "description": "Use when configuring `browser.provider` — Type `BrowserProviderOption`. The return value of the provider factory. You can import the factory from `@vitest/browser-` or make your own provider:",
443
- "annotations": {
444
- "audience": ["assistant"],
445
- "priority": 0.55
446
- }
447
- },
448
- {
449
- "path": "config/browser/screenshotdirectory",
450
- "title": "config.browser.screenshotDirectory",
451
- "description": "Use when configuring `browser.screenshotDirectory` — Type `string`, default `__screenshots__` in the test file directory. Path to the screenshots directory relative to the `root`.",
452
- "annotations": {
453
- "audience": ["assistant"],
454
- "priority": 0.55
455
- }
456
- },
457
- {
458
- "path": "config/browser/screenshotfailures",
459
- "title": "config.browser.screenshotFailures",
460
- "description": "Use when configuring `browser.screenshotFailures` — Type `boolean`, default `!browser.ui`. Should Vitest take screenshots if the test fails.",
461
- "annotations": {
462
- "audience": ["assistant"],
463
- "priority": 0.55
464
- }
465
- },
466
- {
467
- "path": "config/browser/testerhtmlpath",
468
- "title": "config.browser.testerHtmlPath",
469
- "description": "Use when configuring `browser.testerHtmlPath` — Type `string`. A path to the HTML entry point. Can be relative to the root of the project. This file will be processed with [`transformIndexHtml`](https://vite.dev/guide/api-plugin#transformindexhtml) hook.",
470
- "annotations": {
471
- "audience": ["assistant"],
472
- "priority": 0.55
473
- }
474
- },
475
- {
476
- "path": "config/browser/trace",
477
- "title": "config.browser.trace",
478
- "description": "Use when configuring `browser.trace` — Type `'on' | 'off' | 'on-first-retry' | 'on-all-retries' | 'retain-on-failure' | object`, default `'off'`, CLI `--browser.trace=on`. Capture a trace of your browser test runs. You can preview traces with [Playwright Trace Viewer](https://trace.playwright.dev/).",
479
- "annotations": {
480
- "audience": ["assistant"],
481
- "priority": 0.55
482
- }
483
- },
484
- {
485
- "path": "config/browser/trackunhandlederrors",
486
- "title": "config.browser.trackUnhandledErrors",
487
- "description": "Use when configuring `browser.trackUnhandledErrors` — Type `boolean`, default `true`. Enables tracking uncaught errors and exceptions so they can be reported by Vitest.",
488
- "annotations": {
489
- "audience": ["assistant"],
490
- "priority": 0.55
491
- }
492
- },
493
- {
494
- "path": "config/browser/ui",
495
- "title": "config.browser.ui",
496
- "description": "Use when configuring `browser.ui` — Type `boolean`, default `!isCI`, CLI `--browser.ui=false`. Should Vitest UI be injected into the page. By default, injects UI iframe during development.",
497
- "annotations": {
498
- "audience": ["assistant"],
499
- "priority": 0.55
500
- }
501
- },
502
- {
503
- "path": "config/browser/viewport",
504
- "title": "config.browser.viewport",
505
- "description": "Use when configuring `browser.viewport` — Type `{ width, height }`, default `414x896`. Default iframe's viewport.",
506
- "annotations": {
507
- "audience": ["assistant"],
508
- "priority": 0.55
509
- }
510
- },
511
- {
512
- "path": "config/browser/webdriverio",
513
- "title": "Configuring WebdriverIO",
514
- "description": "Use when configuring `Configuring WebdriverIO`. If you do not already use WebdriverIO in your project, we recommend starting with [Playwright](/config/browser/playwright) as it is easier to configure and has more flexible API.",
515
- "annotations": {
516
- "audience": ["assistant"],
517
- "priority": 0.55
518
- }
519
- },
520
- {
521
- "path": "config/cache",
522
- "title": "config.cache",
523
- "description": "Use when configuring `cache` — Type `false`, CLI `--no-cache`. 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.",
524
- "annotations": {
525
- "audience": ["assistant"],
526
- "priority": 0.85
527
- }
528
- },
529
- {
530
- "path": "config/chaiconfig",
531
- "title": "config.chaiConfig",
532
- "description": "Use when configuring `chaiConfig` — Type `{ includeStack?, showDiff?, truncateThreshold? }`, default `{ includeStack: false, showDiff: true, truncateThreshold: 40 }`. Equivalent to [Chai config](https://github.com/chaijs/chai/blob/4.x.x/lib/chai/config.js).",
533
- "annotations": {
534
- "audience": ["assistant"],
535
- "priority": 0.85
536
- }
537
- },
538
- {
539
- "path": "config/clearmocks",
540
- "title": "config.clearMocks",
541
- "description": "Use when configuring `clearMocks` — Type `boolean`, default `false`. Should Vitest automatically call [`vi.clearAllMocks()`](/api/vi#vi-clearallmocks) before each test.",
542
- "annotations": {
543
- "audience": ["assistant"],
544
- "priority": 0.85
545
- }
546
- },
547
- {
548
- "path": "config/coverage",
549
- "title": "config.coverage",
550
- "description": "Use when configuring `coverage` — Type `'v8' | 'istanbul' | 'custom'`, default `'v8'`, CLI `--coverage.provider=`. You can use [`v8`](/guide/coverage.html#v8-provider), [`istanbul`](/guide/coverage.html#istanbul-provider) or [a custom coverage solution](/guide/coverage#custom-coverage-provider) for coverage collection.",
551
- "annotations": {
552
- "audience": ["assistant"],
553
- "priority": 0.85
554
- }
555
- },
556
- {
557
- "path": "config/css",
558
- "title": "config.css",
559
- "description": "Use when configuring `css` — Type `boolean | { include?, exclude?, modules? }`, default `[]`. 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.",
560
- "annotations": {
561
- "audience": ["assistant"],
562
- "priority": 0.85
563
- }
564
- },
565
- {
566
- "path": "config/dangerouslyignoreunhandlederrors",
567
- "title": "config.dangerouslyIgnoreUnhandledErrors",
568
- "description": "Use when configuring `dangerouslyIgnoreUnhandledErrors` — Type `boolean`, default `false`, CLI `--dangerouslyIgnoreUnhandledErrors`. Suppresses test-run failure on uncaught errors and unhandled promise rejections. Escape hatch for legacy code; rarely correct.",
569
- "annotations": {
570
- "audience": ["assistant"],
571
- "priority": 0.85
572
- }
573
- },
574
- {
575
- "path": "config/deps",
576
- "title": "config.deps",
577
- "description": "Use when configuring `deps` — Type `{ optimizer?, ... }`, default `false`. Handling for dependencies resolution.",
578
- "annotations": {
579
- "audience": ["assistant"],
580
- "priority": 0.85
581
- }
582
- },
583
- {
584
- "path": "config/detectasyncleaks",
585
- "title": "config.detectAsyncLeaks",
586
- "description": "Use when configuring `detectAsyncLeaks` — Type `boolean`, default `false`, CLI `--detectAsyncLeaks`. Enabling this option will make your tests run much slower. Use only when debugging or developing tests.",
587
- "annotations": {
588
- "audience": ["assistant"],
589
- "priority": 0.85
590
- }
591
- },
592
- {
593
- "path": "config/diff",
594
- "title": "config.diff",
595
- "description": "Use when configuring `diff` — Type `string`, default `true`, CLI `--diff=`. `DiffOptions` object or a path to a module which exports `DiffOptions`. Useful if you want to customize diff display.",
596
- "annotations": {
597
- "audience": ["assistant"],
598
- "priority": 0.85
599
- }
600
- },
601
- {
602
- "path": "config/dir",
603
- "title": "config.dir",
604
- "description": "Use when configuring `dir` — Type `string`, default same as `root`, CLI `--dir=`. Base directory to scan for the test files. You can specify this option to speed up test discovery if your root covers the whole project",
605
- "annotations": {
606
- "audience": ["assistant"],
607
- "priority": 0.85
608
- }
609
- },
610
- {
611
- "path": "config/disableconsoleintercept",
612
- "title": "config.disableConsoleIntercept",
613
- "description": "Use when configuring `disableConsoleIntercept` — Type `boolean`, default `false`, CLI `--disableConsoleIntercept`. By default, Vitest automatically intercepts console logging during tests for extra formatting of test file, test title, etc.",
614
- "annotations": {
615
- "audience": ["assistant"],
616
- "priority": 0.85
617
- }
618
- },
619
- {
620
- "path": "config/env",
621
- "title": "config.env",
622
- "description": "Use when configuring `env` — Type `Partial`. Environment variables available on `process.env` and `import.meta.env` during tests. These variables will not be available in the main process (in `globalSetup`, for example).",
623
- "annotations": {
624
- "audience": ["assistant"],
625
- "priority": 0.85
626
- }
627
- },
628
- {
629
- "path": "config/environment",
630
- "title": "config.environment",
631
- "description": "Use when configuring `environment` — Type `'node' | 'jsdom' | 'happy-dom' | 'edge-runtime' | string`, default `'node'`, CLI `--environment=`. The environment that will be used for testing. The default environment in Vitest",
632
- "annotations": {
633
- "audience": ["assistant"],
634
- "priority": 0.85
635
- }
636
- },
637
- {
638
- "path": "config/environmentoptions",
639
- "title": "config.environmentOptions",
640
- "description": "Use when configuring `environmentOptions` — Type `Record`, default `{}`. These options are passed to the setup method of the current [environment](/config/environment). By default, you can configure options only for `jsdom` and `happyDOM` when you use them as your test environment.",
641
- "annotations": {
642
- "audience": ["assistant"],
643
- "priority": 0.85
644
- }
645
- },
646
- {
647
- "path": "config/exclude",
648
- "title": "config.exclude",
649
- "description": "Use when configuring `exclude` — Type `string[]`, default `['**/node_modules/**', '**/.git/**']`, CLI `--exclude`. Glob patterns of files excluded from test discovery, resolved relative to `root`. Pair with `include` to scope discovery; tinyglobby is the matcher.",
650
- "annotations": {
651
- "audience": ["assistant"],
652
- "priority": 0.85
653
- }
654
- },
655
- {
656
- "path": "config/execargv",
657
- "title": "config.execArgv",
658
- "description": "Use when configuring `execArgv` — Type `string[]`, default `[]`. Pass additional arguments to `node` in the runner worker. See [Command-line API | Node.js](https://nodejs.org/docs/latest/api/cli.html) for more information.",
659
- "annotations": {
660
- "audience": ["assistant"],
661
- "priority": 0.85
662
- }
663
- },
664
- {
665
- "path": "config/expandsnapshotdiff",
666
- "title": "config.expandSnapshotDiff",
667
- "description": "Use when configuring `expandSnapshotDiff` — Type `boolean`, default `false`, CLI `--expandSnapshotDiff`. Show full diff when snapshot fails instead of a patch.",
668
- "annotations": {
669
- "audience": ["assistant"],
670
- "priority": 0.85
671
- }
672
- },
673
- {
674
- "path": "config/expect",
675
- "title": "config.expect",
676
- "description": "Use when configuring `expect` — Type `ExpectOptions`, default `false`. The same as calling [`expect.hasAssertions()`](/api/expect#expect-hasassertions) at the start of every test. This makes sure that no test will pass accidentally.",
677
- "annotations": {
678
- "audience": ["assistant"],
679
- "priority": 0.85
680
- }
681
- },
682
- {
683
- "path": "config/experimental",
684
- "title": "config.experimental",
685
- "description": "Use when configuring `experimental` — Type `boolean`, default `false`. Please leave feedback regarding this feature in a [GitHub Discussion](https://github.com/vitest-dev/vitest/discussions/9221).",
686
- "annotations": {
687
- "audience": ["assistant"],
688
- "priority": 0.85
689
- }
690
- },
691
- {
692
- "path": "config/faketimers",
693
- "title": "config.fakeTimers",
694
- "description": "Use when configuring `fakeTimers` — Type `FakeTimerInstallOpts`, default `Date.now()`. Options that Vitest will pass down to [`@sinon/fake-timers`](https://npmx.dev/package/@sinonjs/fake-timers) when using [`vi.useFakeTimers()`](/api/vi#vi-usefaketimers).",
695
- "annotations": {
696
- "audience": ["assistant"],
697
- "priority": 0.85
698
- }
699
- },
700
- {
701
- "path": "config/fileparallelism",
702
- "title": "config.fileParallelism",
703
- "description": "Use when configuring `fileParallelism` — Type `boolean`, default `true`, CLI `--no-file-parallelism`. Should all test files run in parallel. Setting this to `false` will override `maxWorkers` option to `1`.",
704
- "annotations": {
705
- "audience": ["assistant"],
706
- "priority": 0.85
707
- }
708
- },
709
- {
710
- "path": "config/forcereruntriggers",
711
- "title": "config.forceRerunTriggers",
712
- "description": "Use when configuring `forceRerunTriggers` — 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.",
713
- "annotations": {
714
- "audience": ["assistant"],
715
- "priority": 0.85
716
- }
717
- },
718
- {
719
- "path": "config/globals",
720
- "title": "config.globals",
721
- "description": "Use when configuring `globals` — Type `boolean`, default `false`, CLI `--globals`. By default, `vitest` does not provide global APIs for explicitness. If you prefer to use the APIs globally like Jest, you can pass the `--globals` option to CLI or add `globals: true` in the config.",
722
- "annotations": {
723
- "audience": ["assistant"],
724
- "priority": 0.85
725
- }
726
- },
727
- {
728
- "path": "config/globalsetup",
729
- "title": "config.globalSetup",
730
- "description": "Use when configuring `globalSetup` — Type `string | string[]`. Path to global setup files relative to project [root](/config/root).",
731
- "annotations": {
732
- "audience": ["assistant"],
733
- "priority": 0.85
734
- }
735
- },
736
- {
737
- "path": "config/hideskippedtests",
738
- "title": "config.hideSkippedTests",
739
- "description": "Use when configuring `hideSkippedTests` — Type `boolean`, default `false`, CLI `--hideSkippedTests`. Hide logs for skipped tests",
740
- "annotations": {
741
- "audience": ["assistant"],
742
- "priority": 0.85
743
- }
744
- },
745
- {
746
- "path": "config/hooktimeout",
747
- "title": "config.hookTimeout",
748
- "description": "Use when configuring `hookTimeout` — Type `number`, default `10_000` in Node.js, `30_000` if `browser.enabled` is `true`, CLI `--hook-timeout=10000`. Default timeout of a hook in milliseconds. Use `0` to disable timeout completely.",
749
- "annotations": {
750
- "audience": ["assistant"],
751
- "priority": 0.85
752
- }
753
- },
754
- {
755
- "path": "config/include",
756
- "title": "config.include",
757
- "description": "Use when configuring `include` — Type `string[]`, default `['**/*.{test,spec}.?(c|m)[jt]s?(x)']`, CLI `vitest [...include]`. Glob patterns matching test files, resolved relative to `root`. Pair with `includeSource` for in-source tests; tinyglobby is the matcher.",
758
- "annotations": {
759
- "audience": ["assistant"],
760
- "priority": 0.85
761
- }
762
- },
763
- {
764
- "path": "config/include-source",
765
- "title": "config.includeSource",
766
- "description": "Use when configuring `includeSource` — Type `string[]`, default `[]`. A list of [glob patterns](https://superchupu.dev/tinyglobby/comparison) that match your [in-source test files](/guide/in-source). These patterns are resolved relative to the [`root`](/config/root) ([`process.cwd()`](h...",
767
- "annotations": {
768
- "audience": ["assistant"],
769
- "priority": 0.85
770
- }
771
- },
772
- {
773
- "path": "config/includetasklocation",
774
- "title": "config.includeTaskLocation",
775
- "description": "Use when configuring `includeTaskLocation` — Type `boolean`, default `false`. Should `location` property be included when Vitest API receives tasks in [reporters](/config/reporters). If you have a lot of tests, this might cause a small performance regression.",
776
- "annotations": {
777
- "audience": ["assistant"],
778
- "priority": 0.85
779
- }
780
- },
781
- {
782
- "path": "config/index",
783
- "title": "Configuring Vitest",
784
- "description": "Use when configuring `Configuring Vitest`. If you are using Vite and have a `vite.config` file, Vitest will read it to match with the plugins and setup as your Vite app. If you want to have a different configuration for testing or your main app doesn't rely on...",
785
- "annotations": {
786
- "audience": ["assistant"],
787
- "priority": 0.85
788
- }
789
- },
790
- {
791
- "path": "config/isolate",
792
- "title": "config.isolate",
793
- "description": "Use when configuring `isolate` — Type `boolean`, default `true`, CLI `--no-isolate`. Run tests in an isolated environment. This option has no effect on `vmThreads` and `vmForks` pools.",
794
- "annotations": {
795
- "audience": ["assistant"],
796
- "priority": 0.85
797
- }
798
- },
799
- {
800
- "path": "config/logheapusage",
801
- "title": "config.logHeapUsage",
802
- "description": "Use when configuring `logHeapUsage` — Type `boolean`, default `false`, CLI `--logHeapUsage`. Show heap usage after each test. Useful for debugging memory leaks.",
803
- "annotations": {
804
- "audience": ["assistant"],
805
- "priority": 0.85
806
- }
807
- },
808
- {
809
- "path": "config/maxconcurrency",
810
- "title": "config.maxConcurrency",
811
- "description": "Use when configuring `maxConcurrency` — Type `number`, default `5`, CLI `--max-concurrency=10`. The maximum number of tests and hooks that can run at the same time when using `test.concurrent` or `describe.concurrent`.",
812
- "annotations": {
813
- "audience": ["assistant"],
814
- "priority": 0.85
815
- }
816
- },
817
- {
818
- "path": "config/maxworkers",
819
- "title": "config.maxWorkers",
820
- "description": "Use when configuring `maxWorkers` — Type `number | string`. - if [`watch`](/config/watch) is disabled, uses all available parallelism",
821
- "annotations": {
822
- "audience": ["assistant"],
823
- "priority": 0.85
824
- }
825
- },
826
- {
827
- "path": "config/mockreset",
828
- "title": "config.mockReset",
829
- "description": "Use when configuring `mockReset` — Type `boolean`, default `false`. Should Vitest automatically call [`vi.resetAllMocks()`](/api/vi#vi-resetallmocks) before each test.",
830
- "annotations": {
831
- "audience": ["assistant"],
832
- "priority": 0.85
833
- }
834
- },
835
- {
836
- "path": "config/mode",
837
- "title": "config.mode",
838
- "description": "Use when configuring `mode` — Type `string`, default `'test'`, CLI `--mode=staging`. Overrides Vite mode.",
839
- "annotations": {
840
- "audience": ["assistant"],
841
- "priority": 0.85
842
- }
843
- },
844
- {
845
- "path": "config/name",
846
- "title": "config.name",
847
- "description": "Use when configuring `name`. Assign a custom name to the test project or Vitest process. The name will be visible in the CLI and UI, and available in the Node.js API via [`project.name`](/api/advanced/test-project#name).",
848
- "annotations": {
849
- "audience": ["assistant"],
850
- "priority": 0.85
851
- }
852
- },
853
- {
854
- "path": "config/onconsolelog",
855
- "title": "config.onConsoleLog",
856
- "description": "Use when configuring `onConsoleLog`. Custom handler for `console` methods in tests. If you return `false`, Vitest will not print the log to the console. Note that Vitest ignores all other falsy values.",
857
- "annotations": {
858
- "audience": ["assistant"],
859
- "priority": 0.85
860
- }
861
- },
862
- {
863
- "path": "config/onstacktrace",
864
- "title": "config.onStackTrace",
865
- "description": "Use when configuring `onStackTrace` — 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,...",
866
- "annotations": {
867
- "audience": ["assistant"],
868
- "priority": 0.85
869
- }
870
- },
871
- {
872
- "path": "config/onunhandlederror",
873
- "title": "config.onUnhandledError",
874
- "description": "Use when configuring `onUnhandledError`. A custom callback for filtering unhandled errors that should not be reported. When an error is filtered out, it no longer affects the result of the test run.",
875
- "annotations": {
876
- "audience": ["assistant"],
877
- "priority": 0.85
878
- }
879
- },
880
- {
881
- "path": "config/open",
882
- "title": "config.open",
883
- "description": "Use when configuring `open` — Type `boolean`, default `!process.env.CI`, CLI `--open`. Open Vitest UI automatically if it's [enabled](/config/ui).",
884
- "annotations": {
885
- "audience": ["assistant"],
886
- "priority": 0.85
887
- }
888
- },
889
- {
890
- "path": "config/outputfile",
891
- "title": "config.outputFile",
892
- "description": "Use when configuring `outputFile` — Type `string | Record`, CLI `--outputFile=`. Write test results to a file when the `--reporter=json`, `--reporter=html` or `--reporter=junit` option is also specified.",
893
- "annotations": {
894
- "audience": ["assistant"],
895
- "priority": 0.85
896
- }
897
- },
898
- {
899
- "path": "config/passwithnotests",
900
- "title": "config.passWithNoTests",
901
- "description": "Use when configuring `passWithNoTests` — Type `boolean`, default `false`, CLI `--passWithNoTests`. Vitest will not fail, if no tests will be found.",
902
- "annotations": {
903
- "audience": ["assistant"],
904
- "priority": 0.85
905
- }
906
- },
907
- {
908
- "path": "config/pool",
909
- "title": "config.pool",
910
- "description": "Use when configuring `pool` — Type `'threads' | 'forks' | 'vmThreads' | 'vmForks'`, default `'forks'`, CLI `--pool=threads`. Pool used to run tests in.",
911
- "annotations": {
912
- "audience": ["assistant"],
913
- "priority": 0.85
914
- }
915
- },
916
- {
917
- "path": "config/printconsoletrace",
918
- "title": "config.printConsoleTrace",
919
- "description": "Use when configuring `printConsoleTrace` — Type `boolean`, default `false`. Always print console traces when calling any `console` method. This is useful for debugging.",
920
- "annotations": {
921
- "audience": ["assistant"],
922
- "priority": 0.85
923
- }
924
- },
925
- {
926
- "path": "config/projects",
927
- "title": "config.projects",
928
- "description": "Use when configuring `projects` — Type `TestProjectConfiguration[]`, default `[]`. An array of [projects](/guide/projects).",
929
- "annotations": {
930
- "audience": ["assistant"],
931
- "priority": 0.85
932
- }
933
- },
934
- {
935
- "path": "config/provide",
936
- "title": "config.provide",
937
- "description": "Use when configuring `provide` — Type `Partial`. Define values that can be accessed inside your tests using `inject` method.",
938
- "annotations": {
939
- "audience": ["assistant"],
940
- "priority": 0.85
941
- }
942
- },
943
- {
944
- "path": "config/reporters",
945
- "title": "config.reporters",
946
- "description": "Use when configuring `reporters` — default [`'default'`](/guide/reporters#default-reporter) (or [['default'](/guide/reporters#default-reporter), ['github-actions'](/guide/reporters#github-actions-reporter)] when `process.env.GITHUB_ACTIONS === 'true'`). - `--reporter=tap` for a single reporter",
947
- "annotations": {
948
- "audience": ["assistant"],
949
- "priority": 0.85
950
- }
951
- },
952
- {
953
- "path": "config/resolvesnapshotpath",
954
- "title": "config.resolveSnapshotPath",
955
- "description": "Use when configuring `resolveSnapshotPath` — 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:",
956
- "annotations": {
957
- "audience": ["assistant"],
958
- "priority": 0.85
959
- }
960
- },
961
- {
962
- "path": "config/restoremocks",
963
- "title": "config.restoreMocks",
964
- "description": "Use when configuring `restoreMocks` — Type `boolean`, default `false`. Should Vitest automatically call [`vi.restoreAllMocks()`](/api/vi#vi-restoreallmocks) before each test.",
965
- "annotations": {
966
- "audience": ["assistant"],
967
- "priority": 0.85
968
- }
969
- },
970
- {
971
- "path": "config/retry",
972
- "title": "config.retry",
973
- "description": "Use when configuring `retry` — Type `number | { count?: number, delay?: number, condition?: RegExp }`, default `0`, CLI `--retry `. Retry the test specific number of times if it fails.",
974
- "annotations": {
975
- "audience": ["assistant"],
976
- "priority": 0.85
977
- }
978
- },
979
- {
980
- "path": "config/root",
981
- "title": "config.root",
982
- "description": "Use when configuring `root` — Type `string`, CLI `-r `. Project root",
983
- "annotations": {
984
- "audience": ["assistant"],
985
- "priority": 0.85
986
- }
987
- },
988
- {
989
- "path": "config/runner",
990
- "title": "config.runner",
991
- "description": "Use when configuring `runner` — 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).",
992
- "annotations": {
993
- "audience": ["assistant"],
994
- "priority": 0.85
995
- }
996
- },
997
- {
998
- "path": "config/sequence",
999
- "title": "config.sequence",
1000
- "description": "Use when configuring `sequence` — Type `{ sequencer?, shuffle?, seed?, hooks?, setupFiles?, groupOrder }`, default `BaseSequencer`, CLI `--sequence.shuffle`. Options for how tests should be sorted.",
1001
- "annotations": {
1002
- "audience": ["assistant"],
1003
- "priority": 0.85
1004
- }
1005
- },
1006
- {
1007
- "path": "config/server",
1008
- "title": "config.server",
1009
- "description": "Use when configuring `server` — pre-Vitest-4 option that configured the `vite-node` server. Removed in Vitest 4 (vite-node is gone); kept as a reference for users migrating from v3 configs. New code should not set this.",
1010
- "annotations": {
1011
- "audience": ["assistant"],
1012
- "priority": 0.85
1013
- }
1014
- },
1015
- {
1016
- "path": "config/setupfiles",
1017
- "title": "config.setupFiles",
1018
- "description": "Use when configuring `setupFiles` — Type `string | string[]`. Paths to setup files resolved relative to the [`root`](/config/root). They will run before each _test file_ in the same process. By default, all test files run in parallel, but you can configure it with [`sequence.set...",
1019
- "annotations": {
1020
- "audience": ["assistant"],
1021
- "priority": 0.85
1022
- }
1023
- },
1024
- {
1025
- "path": "config/silent",
1026
- "title": "config.silent",
1027
- "description": "Use when configuring `silent` — Type `boolean | 'passed-only'`, default `false`, CLI `--silent`. Silent console output from tests.",
1028
- "annotations": {
1029
- "audience": ["assistant"],
1030
- "priority": 0.85
1031
- }
1032
- },
1033
- {
1034
- "path": "config/slowtestthreshold",
1035
- "title": "config.slowTestThreshold",
1036
- "description": "Use when configuring `slowTestThreshold` — Type `number`, default `300`, CLI `--slow-test-threshold=`. The number of milliseconds after which a test or suite is considered slow and reported as such in the results.",
1037
- "annotations": {
1038
- "audience": ["assistant"],
1039
- "priority": 0.85
1040
- }
1041
- },
1042
- {
1043
- "path": "config/snapshotenvironment",
1044
- "title": "config.snapshotEnvironment",
1045
- "description": "Use when configuring `snapshotEnvironment` — Type `string`. Path to a custom snapshot environment implementation. This is useful if you are running your tests in an environment that doesn't support Node.js APIs. This option doesn't have any effect on a browser runner.",
1046
- "annotations": {
1047
- "audience": ["assistant"],
1048
- "priority": 0.85
1049
- }
1050
- },
1051
- {
1052
- "path": "config/snapshotformat",
1053
- "title": "config.snapshotFormat",
1054
- "description": "Use when configuring `snapshotFormat` — Type `Omit & { compareKeys?: null | undefined }`. Format options for snapshot testing. These options configure the snapshot-specific formatting layer built on top of [`@vitest/pretty-format`](https://npmx.dev/package/@vitest/pretty-format).",
1055
- "annotations": {
1056
- "audience": ["assistant"],
1057
- "priority": 0.85
1058
- }
1059
- },
1060
- {
1061
- "path": "config/snapshotserializers",
1062
- "title": "config.snapshotSerializers",
1063
- "description": "Use when configuring `snapshotSerializers` — Type `string[]`, default `[]`. A list of paths to snapshot serializer modules for snapshot testing, useful if you want add custom snapshot serializers. See [Custom Serializer](/guide/snapshot#custom-serializer) for more information.",
1064
- "annotations": {
1065
- "audience": ["assistant"],
1066
- "priority": 0.85
1067
- }
1068
- },
1069
- {
1070
- "path": "config/stricttags",
1071
- "title": "config.strictTags",
1072
- "description": "Use when configuring `strictTags` — Type `boolean`, default `true`, CLI `--strict-tags`. Should Vitest throw an error if test has a [`tag`](/config/tags) that is not defined in the config to avoid silently doing something surprising due to mistyped names (applying the wrong configuration or skipping the t...",
1073
- "annotations": {
1074
- "audience": ["assistant"],
1075
- "priority": 0.85
1076
- }
1077
- },
1078
- {
1079
- "path": "config/tags",
1080
- "title": "config.tags",
1081
- "description": "Use when configuring `tags` — Type `TestTagDefinition[]`, default `[]`. Defines all [available tags](/guide/test-tags) in your test project. By default, if test defines a name not listed here, Vitest will throw an error, but this can be configured via a [`strictTags`](/config/stricttags) ...",
1082
- "annotations": {
1083
- "audience": ["assistant"],
1084
- "priority": 0.85
1085
- }
1086
- },
1087
- {
1088
- "path": "config/teardowntimeout",
1089
- "title": "config.teardownTimeout",
1090
- "description": "Use when configuring `teardownTimeout` — Type `number`, default `10000`, CLI `--teardown-timeout=5000`. Default timeout to wait for close when Vitest shuts down, in milliseconds",
1091
- "annotations": {
1092
- "audience": ["assistant"],
1093
- "priority": 0.85
1094
- }
1095
- },
1096
- {
1097
- "path": "config/testnamepattern",
1098
- "title": "config.testNamePattern",
1099
- "description": "Use when configuring `testNamePattern` — Type `string | RegExp`, CLI `-t `. Run tests with full names matching the pattern.",
1100
- "annotations": {
1101
- "audience": ["assistant"],
1102
- "priority": 0.85
1103
- }
1104
- },
1105
- {
1106
- "path": "config/testtimeout",
1107
- "title": "config.testTimeout",
1108
- "description": "Use when configuring `testTimeout` — Type `number`, default `5_000` in Node.js, `15_000` if `browser.enabled` is `true`, CLI `--test-timeout=5000`. Default timeout of a test in milliseconds. Use `0` to disable timeout completely.",
1109
- "annotations": {
1110
- "audience": ["assistant"],
1111
- "priority": 0.85
1112
- }
1113
- },
1114
- {
1115
- "path": "config/typecheck",
1116
- "title": "config.typecheck",
1117
- "description": "Use when configuring `typecheck` — Type `boolean`, default `false`, CLI `--typecheck`. Options for configuring [typechecking](/guide/testing-types) test environment.",
1118
- "annotations": {
1119
- "audience": ["assistant"],
1120
- "priority": 0.85
1121
- }
1122
- },
1123
- {
1124
- "path": "config/ui",
1125
- "title": "config.ui",
1126
- "description": "Use when configuring `ui` — Type `boolean`, default `false`, CLI `--ui`. Enable [Vitest UI](/guide/ui).",
1127
- "annotations": {
1128
- "audience": ["assistant"],
1129
- "priority": 0.85
1130
- }
1131
- },
1132
- {
1133
- "path": "config/unstubenvs",
1134
- "title": "config.unstubEnvs",
1135
- "description": "Use when configuring `unstubEnvs` — Type `boolean`, default `false`. Should Vitest automatically call [`vi.unstubAllEnvs()`](/api/vi#vi-unstuballenvs) before each test.",
1136
- "annotations": {
1137
- "audience": ["assistant"],
1138
- "priority": 0.85
1139
- }
1140
- },
1141
- {
1142
- "path": "config/unstubglobals",
1143
- "title": "config.unstubGlobals",
1144
- "description": "Use when configuring `unstubGlobals` — Type `boolean`, default `false`. Should Vitest automatically call [`vi.unstubAllGlobals()`](/api/vi#vi-unstuballglobals) before each test.",
1145
- "annotations": {
1146
- "audience": ["assistant"],
1147
- "priority": 0.85
1148
- }
1149
- },
1150
- {
1151
- "path": "config/update",
1152
- "title": "config.update",
1153
- "description": "Use when configuring `update` — Type `boolean | 'new' | 'all' | 'none'`, default `false`, CLI `-u`. Define snapshot update behavior.",
1154
- "annotations": {
1155
- "audience": ["assistant"],
1156
- "priority": 0.85
1157
- }
1158
- },
1159
- {
1160
- "path": "config/vmmemorylimit",
1161
- "title": "config.vmMemoryLimit",
1162
- "description": "Use when configuring `vmMemoryLimit` — Type `string | number`, default `1 / CPU Cores`. This option affects only `vmForks` and `vmThreads` pools.",
1163
- "annotations": {
1164
- "audience": ["assistant"],
1165
- "priority": 0.85
1166
- }
1167
- },
1168
- {
1169
- "path": "config/watch",
1170
- "title": "config.watch",
1171
- "description": "Use when configuring `watch` — Type `boolean`, default `!process.env.CI && process.stdin.isTTY`, CLI `-w`. Enable watch mode",
1172
- "annotations": {
1173
- "audience": ["assistant"],
1174
- "priority": 0.85
1175
- }
1176
- },
1177
- {
1178
- "path": "config/watchtriggerpatterns",
1179
- "title": "config.watchTriggerPatterns",
1180
- "description": "Use when configuring `watchTriggerPatterns` — Type `WatcherTriggerPattern[]`. Vitest reruns tests based on the module graph which is populated by static and dynamic `import` statements. However, if you are reading from the file system or fetching from a proxy, then Vitest cannot detect those de...",
1181
- "annotations": {
1182
- "audience": ["assistant"],
1183
- "priority": 0.85
1184
- }
1185
- },
1186
- {
1187
- "path": "guide/advanced/index",
1188
- "title": "Advanced API: getting started",
1189
- "description": "Use when driving Vitest from a Node.js script — `startVitest(mode, filters, opts, viteOpts, vitestOpts)` and `createVitest` from `vitest/node`, accessing the resulting Vitest instance, project iteration, programmatic test runs. Library-author API.",
1190
- "annotations": {
1191
- "audience": ["assistant"],
1192
- "priority": 0.7
1193
- }
1194
- },
1195
- {
1196
- "path": "guide/advanced/pool",
1197
- "title": "Custom pool runners (advanced)",
1198
- "description": "Use when implementing a custom Vitest pool — `PoolRunnerInitializer` shape, the `pool` config option pointing at a function/path, choosing between threads/forks/vmThreads/browser/typescript baseline pools. Library-author API; experimental and low-level.",
1199
- "annotations": {
1200
- "audience": ["assistant"],
1201
- "priority": 0.7
1202
- }
1203
- },
1204
- {
1205
- "path": "guide/advanced/reporters",
1206
- "title": "Custom reporters (advanced)",
1207
- "description": "Use when extending built-in reporters — `DefaultReporter` / `BasicReporter` / `BlobReporter` from `vitest/node`, overriding lifecycle methods, accessing TestModule/TestSuite/TestCase instances. For from-scratch implementations see /api/advanced/reporters.",
1208
- "annotations": {
1209
- "audience": ["assistant"],
1210
- "priority": 0.7
1211
- }
1212
- },
1213
- {
1214
- "path": "guide/advanced/tests",
1215
- "title": "Running tests programmatically (advanced)",
1216
- "description": "Use when driving a test run from a Node.js script — `startVitest` (start + run) vs `createVitest` (start only), iterating `vitest.state.getTestModules()`, applying CLI filters, overriding test/Vite config from code.",
1217
- "annotations": {
1218
- "audience": ["assistant"],
1219
- "priority": 0.7
1220
- }
1221
- },
1222
- {
1223
- "path": "guide/browser/aria-snapshots",
1224
- "title": "ARIA snapshots (browser, experimental)",
1225
- "description": "Use when asserting accessibility-tree structure — `expect.element(locator).toMatchAriaInlineSnapshot(...)` / `.toMatchAriaSnapshot(name)` capturing role and accessible-name structure (the same tree screen readers see). Browser mode only; experimental since 4.1.4.",
1226
- "annotations": {
1227
- "audience": ["assistant"],
1228
- "priority": 0.55
1229
- }
1230
- },
1231
- {
1232
- "path": "guide/browser/component-testing",
1233
- "title": "Component testing (browser)",
1234
- "description": "Use when testing UI components in real browsers — Vue, React, Svelte, Lit, Preact, Qwik, Solid, Marko via the corresponding `vitest-browser-*` package, browser-mode setup with Playwright/WebdriverIO/preview, why real browsers over jsdom for catching CSS/layout bugs.",
1235
- "annotations": {
1236
- "audience": ["assistant"],
1237
- "priority": 0.55
1238
- }
1239
- },
1240
- {
1241
- "path": "guide/browser/index",
1242
- "title": "Browser mode setup",
1243
- "description": "Use when setting up Vitest browser mode — `vitest init browser` scaffold, `browser.enabled` config, choosing between Playwright / WebdriverIO / preview providers, `browser.instances`, headless mode, the `vitest/browser` entry-point.",
1244
- "annotations": {
1245
- "audience": ["assistant"],
1246
- "priority": 0.55
1247
- }
1248
- },
1249
- {
1250
- "path": "guide/browser/multiple-setups",
1251
- "title": "Multiple browser instances (browser)",
1252
- "description": "Use when running the same browser tests against multiple browsers or configurations — `browser.instances` array (chromium, firefox, webkit, mobile devices), per-instance overrides, shared Vite-server cache benefit over multi-project alternative.",
1253
- "annotations": {
1254
- "audience": ["assistant"],
1255
- "priority": 0.55
1256
- }
1257
- },
1258
- {
1259
- "path": "guide/browser/trace-view",
1260
- "title": "Playwright trace files (browser)",
1261
- "description": "Use when capturing Playwright trace files for debugging browser tests — `browser.trace: 'on' | 'retain-on-failure' | 'on-first-retry'`, trace artifacts location, viewing in Playwright Trace Viewer. Playwright provider only.",
1262
- "annotations": {
1263
- "audience": ["assistant"],
1264
- "priority": 0.55
1265
- }
1266
- },
1267
- {
1268
- "path": "guide/browser/visual-regression-testing",
1269
- "title": "Visual regression testing (browser)",
1270
- "description": "Use when adding screenshot-comparison tests to catch unintended visual changes — `expect.element(locator).toMatchScreenshot()`, reference-image storage, threshold config, CI-vs-local screenshot stability. Browser mode only.",
1271
- "annotations": {
1272
- "audience": ["assistant"],
1273
- "priority": 0.55
1274
- }
1275
- },
1276
- {
1277
- "path": "guide/cli",
1278
- "title": "Command-line interface",
1279
- "description": "Use when running tests from a shell — `vitest`, `vitest run`, `vitest watch`, `vitest related`, `vitest bench`, `vitest list`, `vitest init`, plus filename and `filename:line` filters. For per-flag reference see cli-generated.",
1280
- "annotations": {
1281
- "audience": ["assistant"],
1282
- "priority": 0.78
1283
- }
1284
- },
1285
- {
1286
- "path": "guide/cli-generated",
1287
- "title": "CLI flags reference",
1288
- "description": "Use when looking up a specific CLI flag — auto-generated reference for every flag (--root, --config, --update, --watch, --reporter, --pool, --typecheck, --browser, --maxWorkers, --bail, --retry, --coverage, --shard). Each flag links to its config equivalent.",
1289
- "annotations": {
1290
- "audience": ["assistant"],
1291
- "priority": 0.78
1292
- }
1293
- },
1294
- {
1295
- "path": "guide/common-errors",
1296
- "title": "Common errors and fixes",
1297
- "description": "Use when troubleshooting a Vitest startup or runtime failure — `Cannot find module ./relative-path` (vite-tsconfig-paths), pool segfaults, `Bindings not found`, `Failed to terminate worker`, `JavaScript heap out of memory`, tsconfig baseUrl pitfalls.",
1298
- "annotations": {
1299
- "audience": ["assistant"],
1300
- "priority": 0.78
1301
- }
1302
- },
1303
- {
1304
- "path": "guide/coverage",
1305
- "title": "Code coverage",
1306
- "description": "Use when configuring code coverage — `coverage.provider` (v8 default vs istanbul), `--coverage` flag, ignoring code with `/* v8 ignore */` and istanbul hints, `coverage.reporter`, thresholds, custom reporter, watermarks, migrating from c8.",
1307
- "annotations": {
1308
- "audience": ["assistant"],
1309
- "priority": 0.85
1310
- }
1311
- },
1312
- {
1313
- "path": "guide/debugging",
1314
- "title": "Debugging tests",
1315
- "description": "Use when stepping through a failing test — VS Code JavaScript Debug Terminal, launch.json node configuration, `--inspect-brk` / `--inspect` with `--no-file-parallelism`, `--test-timeout=0` to suspend on breakpoints, browser-mode debugging via Playwright DevTools.",
1316
- "annotations": {
1317
- "audience": ["assistant"],
1318
- "priority": 0.78
1319
- }
1320
- },
1321
- {
1322
- "path": "guide/environment",
1323
- "title": "Test environments",
1324
- "description": "Use when picking a JS runtime environment for tests — `environment` option (node default, jsdom, happy-dom, edge-runtime), `@vitest-environment` per-file directive, `environmentMatchGlobs`, `environmentOptions` for jsdom/happy-dom config, custom environments.",
1325
- "annotations": {
1326
- "audience": ["assistant"],
1327
- "priority": 0.78
1328
- }
1329
- },
1330
- {
1331
- "path": "guide/extending-matchers",
1332
- "title": "Extending matchers",
1333
- "description": "Use when adding custom assertions via `expect.extend` — `{ pass, message }` matcher shape, `this.equals` and `this.utils.diff` helpers, asymmetric matcher support, TypeScript ambient declaration to extend `interface Assertion<T>` and `interface AsymmetricMatchersContaining`.",
1334
- "annotations": {
1335
- "audience": ["assistant"],
1336
- "priority": 0.78
1337
- }
1338
- },
1339
- {
1340
- "path": "guide/features",
1341
- "title": "Vitest features overview",
1342
- "description": "Use when surveying Vitest's capabilities at a glance — watch mode, native ESM/TS/JSX, hot reload, threads/forks isolation, snapshot testing, mocking, code coverage, multi-environment. For working API see /api or specific guide pages.",
1343
- "annotations": {
1344
- "audience": ["assistant"],
1345
- "priority": 0.78
1346
- }
1347
- },
1348
- {
1349
- "path": "guide/filtering",
1350
- "title": "Filtering which tests run",
1351
- "description": "Use when narrowing the test set — filename patterns, `filename:line` filter, `-t`/`--testNamePattern`, `.only` / `.skip` / `.todo` per-test, `--tags-filter`, `--changed`, `--related`, `--experimental.preParse` for skipping unfiltered file loads.",
1352
- "annotations": {
1353
- "audience": ["assistant"],
1354
- "priority": 0.78
1355
- }
1356
- },
1357
- {
1358
- "path": "guide/ide",
1359
- "title": "IDE integrations",
1360
- "description": "Use when wiring Vitest into an editor — official VS Code extension (vitest.explorer), JetBrains built-in support (WebStorm, IntelliJ Ultimate, PhpStorm), Neovim plugin, Zed integration. Test explorer, gutter run/debug, watch indicators.",
1361
- "annotations": {
1362
- "audience": ["assistant"],
1363
- "priority": 0.78
1364
- }
1365
- },
1366
- {
1367
- "path": "guide/improving-performance",
1368
- "title": "Improving test-suite performance",
1369
- "description": "Use when optimizing slow test suites — disabling `isolate`, choosing pool (forks vs threads vs vmThreads vs vmForks), `--shard` for distribution, tuning `maxWorkers`/`minWorkers`, reducing `setupFiles`, mocking expensive imports. Pair with profiling-test-performance for measurement.",
1370
- "annotations": {
1371
- "audience": ["assistant"],
1372
- "priority": 0.78
1373
- }
1374
- },
1375
- {
1376
- "path": "guide/in-source",
1377
- "title": "In-source testing",
1378
- "description": "Use when writing tests inside source files (Rust-style `if (import.meta.vitest)` blocks) — `defineConfig.test.includeSource`, `define: { 'import.meta.vitest': 'undefined' }` for production strip, accessing private state without exporting.",
1379
- "annotations": {
1380
- "audience": ["assistant"],
1381
- "priority": 0.78
1382
- }
1383
- },
1384
- {
1385
- "path": "guide/index",
1386
- "title": "Getting started",
1387
- "description": "Use when first installing Vitest or scaffolding a project — `npm install -D vitest`, writing a first test, `vitest.config.ts` skeleton, the `test` npm script, framework integrations (Vue, React, Svelte), test-file naming conventions.",
1388
- "annotations": {
1389
- "audience": ["assistant"],
1390
- "priority": 0.78
1391
- }
1392
- },
1393
- {
1394
- "path": "guide/learn/async",
1395
- "title": "Tutorial: testing async code",
1396
- "description": "Use when learning how to test asynchronous code — `async`/`await` test functions, `await expect(promise).resolves.toBe(...)` and `.rejects.toThrow(...)`, `expect.poll` for retries, `vi.waitFor` / `vi.waitUntil`, common pitfalls with unawaited promises.",
1397
- "annotations": {
1398
- "audience": ["assistant"],
1399
- "priority": 0.8
1400
- }
1401
- },
1402
- {
1403
- "path": "guide/learn/debugging-tests",
1404
- "title": "Tutorial: debugging failing tests",
1405
- "description": "Use when systematically diagnosing a failing test — reading the FAIL header, assertion message, diff, and code-snippet output, isolating with `-t` and filename filters, `--reporter=verbose`, `console.log` placement, common causes (async, mock leakage, env).",
1406
- "annotations": {
1407
- "audience": ["assistant"],
1408
- "priority": 0.8
1409
- }
1410
- },
1411
- {
1412
- "path": "guide/learn/matchers",
1413
- "title": "Tutorial: using matchers",
1414
- "description": "Use when learning Vitest's matchers in tutorial form — `toBe` (Object.is) vs `toEqual` (deep), `toMatch`, `toContain`, `toThrow`, `toHaveBeenCalled*`, `not` negation, asymmetric matchers like `expect.any(Number)`. For full reference see /api/expect.",
1415
- "annotations": {
1416
- "audience": ["assistant"],
1417
- "priority": 0.8
1418
- }
1419
- },
1420
- {
1421
- "path": "guide/learn/mock-functions",
1422
- "title": "Tutorial: mock functions",
1423
- "description": "Use when learning function mocking from scratch — `vi.fn()` for tracking call counts and args (`toHaveBeenCalled`, `toHaveBeenCalledWith`), `mockReturnValue` / `mockResolvedValue` / `mockImplementation`, `vi.spyOn(obj, 'method')` for tracking existing methods. Module mocking lives at /guide/mocking/modules.",
1424
- "annotations": {
1425
- "audience": ["assistant"],
1426
- "priority": 0.8
1427
- }
1428
- },
1429
- {
1430
- "path": "guide/learn/setup-teardown",
1431
- "title": "Tutorial: setup and teardown",
1432
- "description": "Use when learning how to share state between tests — `beforeEach` / `afterEach` for per-test setup, `beforeAll` / `afterAll` for once-per-suite setup, scoping inside describe blocks, async setup via returned promises, cleanup-function pattern.",
1433
- "annotations": {
1434
- "audience": ["assistant"],
1435
- "priority": 0.8
1436
- }
1437
- },
1438
- {
1439
- "path": "guide/learn/snapshots",
1440
- "title": "Tutorial: snapshot testing",
1441
- "description": "Use when learning snapshot testing from scratch — `toMatchSnapshot()` for stored .snap files vs `toMatchInlineSnapshot()` for in-test snapshots, when snapshots are useful, updating with `-u`, snapshot review discipline.",
1442
- "annotations": {
1443
- "audience": ["assistant"],
1444
- "priority": 0.8
1445
- }
1446
- },
1447
- {
1448
- "path": "guide/learn/testing-in-practice",
1449
- "title": "Tutorial: testing in practice",
1450
- "description": "Use when deciding what and how to test — contract-based thinking (inputs and outputs as the contract), AAA structure, what to assert vs what to mock, test-file organization, integration vs unit testing thresholds.",
1451
- "annotations": {
1452
- "audience": ["assistant"],
1453
- "priority": 0.8
1454
- }
1455
- },
1456
- {
1457
- "path": "guide/learn/writing-tests",
1458
- "title": "Tutorial: writing tests",
1459
- "description": "Use when learning the basics of `test` and `expect` — defining tests, `test` vs `it` aliases, organizing with `describe`, `test.each` / `describe.each` parametrization, naming conventions, file structure (`*.test.ts`, `__tests__/`).",
1460
- "annotations": {
1461
- "audience": ["assistant"],
1462
- "priority": 0.8
1463
- }
1464
- },
1465
- {
1466
- "path": "guide/learn/writing-tests-with-ai",
1467
- "title": "Tutorial: writing tests with AI assistants",
1468
- "description": "Use when working with an AI coding assistant on tests — providing source file, existing tests, vitest config, and dependency types as context; writing specific prompts; reviewing output for tautological tests, mock-rubber-stamps, hallucinated APIs.",
1469
- "annotations": {
1470
- "audience": ["assistant"],
1471
- "priority": 0.8
1472
- }
1473
- },
1474
- {
1475
- "path": "guide/lifecycle",
1476
- "title": "Test-run lifecycle",
1477
- "description": "Use when reasoning about when code runs during a Vitest run — initialization, global setup, worker creation per pool, file collection, test execution with hooks, reporting via reporter lifecycle methods, global teardown. Maps phases to globalSetup/setupFiles/before*/after*.",
1478
- "annotations": {
1479
- "audience": ["assistant"],
1480
- "priority": 0.78
1481
- }
1482
- },
1483
- {
1484
- "path": "guide/migration",
1485
- "title": "Migration guide (Vitest 4)",
1486
- "description": "Use when upgrading to Vitest 4 — Vite >= 6.0.0 / Node >= 20.0.0 prerequisites, V8 coverage AST-aware remapping, removed `coverage.all`/`coverage.extensions`/`coverage.experimentalAstAwareRemapping`/`coverage.ignoreEmptyLines`, `workspace` → `projects` rename, browser-provider package split.",
1487
- "annotations": {
1488
- "audience": ["assistant"],
1489
- "priority": 0.45
1490
- }
1491
- },
1492
- {
1493
- "path": "guide/mocking",
1494
- "title": "Mocking overview",
1495
- "description": "Use as the entry point to mocking guides — links to dedicated pages for mocking classes, dates, file system, functions, globals, modules, requests, timers. For tutorial intro see /guide/learn/mock-functions; for API reference /api/vi.",
1496
- "annotations": {
1497
- "audience": ["assistant"],
1498
- "priority": 0.8
1499
- }
1500
- },
1501
- {
1502
- "path": "guide/mocking/classes",
1503
- "title": "Mocking: classes",
1504
- "description": "Use when mocking an entire class — `vi.fn(class { ... })` mock-class shape, mocking constructors, instance methods, static methods, getters/setters, `vi.spyOn(class.prototype, 'method')` for partial mocks, class-mock caveats around `mockReturnValue`.",
1505
- "annotations": {
1506
- "audience": ["assistant"],
1507
- "priority": 0.8
1508
- }
1509
- },
1510
- {
1511
- "path": "guide/mocking/dates",
1512
- "title": "Mocking: dates",
1513
- "description": "Use when controlling `Date.now()` and the system clock — `vi.useFakeTimers()` + `vi.setSystemTime(date)`, advancing time via `vi.advanceTimersByTime`, restoring real timers with `vi.useRealTimers()`. Backed by @sinonjs/fake-timers.",
1514
- "annotations": {
1515
- "audience": ["assistant"],
1516
- "priority": 0.8
1517
- }
1518
- },
1519
- {
1520
- "path": "guide/mocking/file-system",
1521
- "title": "Mocking: file system (memfs)",
1522
- "description": "Use when isolating tests from disk — `memfs` package + `__mocks__/fs.cjs` and `__mocks__/fs/promises.cjs` redirecting `fs` calls to an in-memory volume, `vi.mock('node:fs')` activation, fixture seeding via `vol.fromJSON`.",
1523
- "annotations": {
1524
- "audience": ["assistant"],
1525
- "priority": 0.8
1526
- }
1527
- },
1528
- {
1529
- "path": "guide/mocking/functions",
1530
- "title": "Mocking: functions (vi.fn vs vi.spyOn)",
1531
- "description": "Use when distinguishing function mocks from spies — `vi.fn()` for new mock functions vs `vi.spyOn(obj, 'method')` for tracking existing methods, mockReset/mockRestore lifecycle, replacing implementations, asserting call counts and arguments.",
1532
- "annotations": {
1533
- "audience": ["assistant"],
1534
- "priority": 0.8
1535
- }
1536
- },
1537
- {
1538
- "path": "guide/mocking/globals",
1539
- "title": "Mocking: globals",
1540
- "description": "Use when stubbing globals not present in jsdom/node — `vi.stubGlobal('IntersectionObserver', mockClass)`, accessible on both `globalThis` and `window`, restoring via `vi.unstubAllGlobals()` or the `unstubGlobals: true` config option.",
1541
- "annotations": {
1542
- "audience": ["assistant"],
1543
- "priority": 0.8
1544
- }
1545
- },
1546
- {
1547
- "path": "guide/mocking/modules",
1548
- "title": "Mocking: modules",
1549
- "description": "Use when mocking ES modules — `vi.mock('./path')` hoisting semantics, factory function returning the module shape, `vi.hoisted` for variables referenced in factories, `vi.importActual` for partial mocks, dynamic `import()` overload, `__mocks__/` automatic resolution.",
1550
- "annotations": {
1551
- "audience": ["assistant"],
1552
- "priority": 0.8
1553
- }
1554
- },
1555
- {
1556
- "path": "guide/mocking/requests",
1557
- "title": "Mocking: network requests (MSW)",
1558
- "description": "Use when intercepting HTTP/WebSocket/GraphQL requests in tests — Mock Service Worker (`msw/node`) with `setupServer`, request handlers via `http.get` / `graphql.query`, lifecycle in beforeAll / afterEach / afterAll. Framework-agnostic; recommended over `vi.mock('node:fetch')`.",
1559
- "annotations": {
1560
- "audience": ["assistant"],
1561
- "priority": 0.8
1562
- }
1563
- },
1564
- {
1565
- "path": "guide/mocking/timers",
1566
- "title": "Mocking: timers",
1567
- "description": "Use when faking `setTimeout` / `setInterval` / `queueMicrotask` — `vi.useFakeTimers()`, `vi.advanceTimersByTime(ms)`, `vi.runAllTimers()`, `vi.runOnlyPendingTimers()`, restoring with `vi.useRealTimers()`. Configure which APIs to fake via the `toFake` option.",
1568
- "annotations": {
1569
- "audience": ["assistant"],
1570
- "priority": 0.8
1571
- }
1572
- },
1573
- {
1574
- "path": "guide/open-telemetry",
1575
- "title": "OpenTelemetry support (experimental)",
1576
- "description": "Use when integrating OpenTelemetry tracing into Vitest — `experimental.openTelemetry.sdkPath` (default-export the SDK module), `experimental.openTelemetry.enabled`, `vitest.runtime.traces` span scope, instrumentation per worker. Increases startup time unless --no-isolate.",
1577
- "annotations": {
1578
- "audience": ["assistant"],
1579
- "priority": 0.78
1580
- }
1581
- },
1582
- {
1583
- "path": "guide/parallelism",
1584
- "title": "Parallelism",
1585
- "description": "Use when reasoning about Vitest's two parallelism levels — file parallelism (workers per `pool`, `maxWorkers`/`minWorkers`, `fileParallelism`) vs test parallelism within a file (`test.concurrent` / `describe.concurrent` / `--sequence.concurrent`). Trade-offs around shared state and external resources.",
1586
- "annotations": {
1587
- "audience": ["assistant"],
1588
- "priority": 0.78
1589
- }
1590
- },
1591
- {
1592
- "path": "guide/profiling-test-performance",
1593
- "title": "Profiling test performance",
1594
- "description": "Use when measuring where Vitest spends time — output time metrics (transform, setup, import, tests, environment), `--logHeapUsage`, `--profile` for V8 CPU profiles, browser tracing, file-transform analysis. Pair with improving-performance for fixes.",
1595
- "annotations": {
1596
- "audience": ["assistant"],
1597
- "priority": 0.78
1598
- }
1599
- },
1600
- {
1601
- "path": "guide/projects",
1602
- "title": "Test projects",
1603
- "description": "Use when defining multiple project configs in one Vitest run — `projects` array (replaces deprecated `workspace`), per-project `name`/`include`/`environment`/`browser`/`pool`, monorepo glob patterns, running a single project via `--project=<name>`.",
1604
- "annotations": {
1605
- "audience": ["assistant"],
1606
- "priority": 0.78
1607
- }
1608
- },
1609
- {
1610
- "path": "guide/recipes",
1611
- "title": "Config recipes",
1612
- "description": "Use when looking for opinionated config snippets — disabling isolation per project, splitting parallel and sequential test files, custom matrix configurations, integrating with frameworks. Drop-in copy/paste examples.",
1613
- "annotations": {
1614
- "audience": ["assistant"],
1615
- "priority": 0.78
1616
- }
1617
- },
1618
- {
1619
- "path": "guide/reporters",
1620
- "title": "Built-in reporters",
1621
- "description": "Use when configuring test output — `--reporter`/`reporters` config, built-ins (default, verbose, dot, tap, tap-flat, junit, json, html, github-actions, blob, hanging-process), reporter-specific options like `outputFile`, plugging in custom reporters.",
1622
- "annotations": {
1623
- "audience": ["assistant"],
1624
- "priority": 0.78
1625
- }
1626
- },
1627
- {
1628
- "path": "guide/snapshot",
1629
- "title": "Snapshot testing",
1630
- "description": "Use when working with snapshot tests — `toMatchSnapshot` / `toMatchInlineSnapshot` / `toMatchFileSnapshot`, snapshot-file location and `resolveSnapshotPath`, `--update` flag, custom snapshot serializers, dedupe and shape-stripping helpers.",
1631
- "annotations": {
1632
- "audience": ["assistant"],
1633
- "priority": 0.78
1634
- }
1635
- },
1636
- {
1637
- "path": "guide/test-annotations",
1638
- "title": "Test annotations",
1639
- "description": "Use when attaching extra context to test results — `context.annotate(message, type)` for warning/error annotations, attaching files/text via `{ body, contentType, bodyEncoding }`, surfaced through the `onTestAnnotate` reporter hook.",
1640
- "annotations": {
1641
- "audience": ["assistant"],
1642
- "priority": 0.78
1643
- }
1644
- },
1645
- {
1646
- "path": "guide/test-context",
1647
- "title": "Test context",
1648
- "description": "Use when working with the per-test context object — built-in `task` / `expect` / `signal` / `annotate` / `onTestFailed` / `onTestFinished` / `onTestRetry`, defining fixtures via `test.extend`, automatic vs manual fixtures, scoped values via `test.scoped`.",
1649
- "annotations": {
1650
- "audience": ["assistant"],
1651
- "priority": 0.78
1652
- }
1653
- },
1654
- {
1655
- "path": "guide/test-tags",
1656
- "title": "Test tags",
1657
- "description": "Use when categorizing tests with tags (Vitest 4.1+) — declaring tags in the `tags: []` config, applying via `test.tag('frontend')`, filtering with `--tags-filter` boolean expressions (`frontend and not slow`), per-tag option overrides (timeout, retry), `strictTags` enforcement.",
1658
- "annotations": {
1659
- "audience": ["assistant"],
1660
- "priority": 0.78
1661
- }
1662
- },
1663
- {
1664
- "path": "guide/testing-types",
1665
- "title": "Testing types",
1666
- "description": "Use when writing type-only tests — `expectTypeOf` / `assertType` in `*.test-d.ts` files, the `--typecheck` flag, `typecheck.tsconfig` / `typecheck.checker` (tsc or vue-tsc), surfacing source type errors, separate-runs vs overlapping `include` patterns.",
1667
- "annotations": {
1668
- "audience": ["assistant"],
1669
- "priority": 0.78
1670
- }
1671
- },
1672
- {
1673
- "path": "guide/ui",
1674
- "title": "Vitest UI",
1675
- "description": "Use when running the interactive Vitest UI — `npm i -D @vitest/ui`, `--ui` flag (requires watch mode), accessible at http://localhost:51204/__vitest__/, alternative `html` reporter for static-HTML report export.",
1676
- "annotations": {
1677
- "audience": ["assistant"],
1678
- "priority": 0.78
1679
- }
1680
- },
1681
- {
1682
- "path": "guide/using-plugins",
1683
- "title": "Using plugins",
1684
- "description": "Use when extending Vitest via Vite plugins — same plugin API as Vite, where to put `plugins` in vitest config, the `configureVitest` plugin hook for Vitest-specific behavior. For plugin authoring see /api/advanced/plugin.",
1685
- "annotations": {
1686
- "audience": ["assistant"],
1687
- "priority": 0.78
1688
- }
1689
- }
1690
- ]
1691
- }