@vitest-agent/mcp 1.1.0 → 1.3.0

package/vendor/vitest-docs/config/setupfiles.md

@@ -1,40 +0,0 @@
-# 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.setupFiles`](/config/sequence#sequence-setupfiles) option.
-
-Vitest will ignore any exports from these files.
-
-:::warning
-Note that setup files are executed in the same process as tests, unlike [`globalSetup`](/config/globalsetup) that runs once in the main thread before any test worker is created.
-:::
-
-:::info
-Editing a setup file will automatically trigger a rerun of all tests.
-:::
-
-If you have a heavy process running in the background, you can use `process.env.VITEST_POOL_ID` (integer-like string) inside to distinguish between workers and spread the workload.
-
-:::warning
-If [isolation](/config/isolate) is disabled, imported modules are cached, but the setup file itself is executed again before each test file, meaning that you are accessing the same global object before each test file. Make sure you are not doing the same thing more than necessary.
-
-For example, you may rely on a global variable:
-
-```ts
-import { config } from '@some-testing-lib'
-
-if (!globalThis.setupInitialized) {
-  config.plugins = [myCoolPlugin]
-  computeHeavyThing()
-  globalThis.setupInitialized = true
-}
-
-// hooks reset before each test file
-afterEach(() => {
-  cleanup()
-})
-
-globalThis.resetBeforeEachTest = true
-```
-:::

package/vendor/vitest-docs/config/silent.md

@@ -1,9 +0,0 @@
-# silent <CRoot /> {#silent}
-
-- **Type:** `boolean | 'passed-only'`
-- **Default:** `false`
-- **CLI:** `--silent`, `--silent=false`
-
-Silent console output from tests.
-
-Use `'passed-only'` to see logs from failing tests only. Logs from failing tests are printed after a test has finished.

package/vendor/vitest-docs/config/slowtestthreshold.md

@@ -1,7 +0,0 @@
-# slowTestThreshold <CRoot />
-
-- **Type:** `number`
-- **Default:** `300`
-- **CLI:** `--slow-test-threshold=<number>`, `--slowTestThreshold=<number>`
-
-The number of milliseconds after which a test or suite is considered slow and reported as such in the results.

package/vendor/vitest-docs/config/snapshotenvironment.md

@@ -1,27 +0,0 @@
-# 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.
-
-This object should have the shape of `SnapshotEnvironment` and is used to resolve and read/write snapshot files:
-
-```ts
-export interface SnapshotEnvironment {
-  getVersion: () => string
-  getHeader: () => string
-  resolvePath: (filepath: string) => Promise<string>
-  resolveRawPath: (testPath: string, rawPath: string) => Promise<string>
-  saveSnapshotFile: (filepath: string, snapshot: string) => Promise<void>
-  readSnapshotFile: (filepath: string) => Promise<string | null>
-  removeSnapshotFile: (filepath: string) => Promise<void>
-}
-```
-
-You can extend default `VitestSnapshotEnvironment` from `vitest/snapshot` entry point if you need to overwrite only a part of the API.
-
-::: warning
-This is a low-level option and should be used only for advanced cases where you don't have access to default Node.js APIs.
-
-If you just need to configure snapshots feature, use [`snapshotFormat`](/config/snapshotformat) or [`resolveSnapshotPath`](/config/resolvesnapshotpath) options.
-:::

package/vendor/vitest-docs/config/snapshotformat.md

@@ -1,28 +0,0 @@
-# snapshotFormat <CRoot />
-
-- **Type:** `Omit<PrettyFormatOptions, 'plugins' | 'compareKeys'> & { 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).
-
-For the full option surface of `PrettyFormatOptions`, see [`@vitest/pretty-format`](https://npmx.dev/package/@vitest/pretty-format). This page focuses on the Vitest snapshot-specific defaults and constraints.
-
-Vitest snapshots already apply these defaults before your `snapshotFormat` overrides:
-
-- `printBasicPrototype: false`
-- `escapeString: false`
-- `escapeRegex: true`
-- `printFunctionName: false`
-
-Vitest also supports formatter options such as `printShadowRoot` and `maxOutputLength` in `snapshotFormat`.
-
-`printShadowRoot` controls whether shadow-root contents are included in DOM snapshots.
-
-`maxOutputLength` is an approximate per-depth output budget, not a hard cap on the final rendered string.
-
-By default, snapshot keys are sorted using the formatter's default behavior. Set `compareKeys` to `null` to disable key sorting. Custom compare functions are not supported in `snapshotFormat`.
-
-::: tip
-Beware that `plugins` on this object will be ignored.
-
-If you need to extend snapshot serialization via pretty-format plugins, use [`expect.addSnapshotSerializer`](/api/expect#expect-addsnapshotserializer) or [`snapshotSerializers`](/config/snapshotserializers) instead.
-:::

package/vendor/vitest-docs/config/snapshotserializers.md

@@ -1,6 +0,0 @@
-# snapshotSerializers <CRoot />
-
-- **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.

package/vendor/vitest-docs/config/stricttags.md

@@ -1,30 +0,0 @@
-# strictTags <Version>4.1.0</Version> {#stricttags}
-
-- **Type:** `boolean`
-- **Default:** `true`
-- **CLI:** `--strict-tags`, `--no-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 test due to a `--tags-filter` flag).
-
-Note that Vitest will always throw an error if `--tags-filter` flag defines a tag not present in the config.
-
-For example, this test will throw an error because the tag `fortnend` has a typo (it should be `frontend`):
-
-::: code-group
-```js [form.test.js]
-test('renders a form', { tags: ['fortnend'] }, () => {
-  // ...
-})
-```
-```js [vitest.config.js]
-import { defineConfig } from 'vitest/config'
-
-export default defineConfig({
-  test: {
-    tags: [
-      { name: 'frontend' },
-    ],
-  },
-})
-```
-:::

package/vendor/vitest-docs/config/tags.md

@@ -1,141 +0,0 @@
-# tags <Version>4.1.0</Version> {#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) option.
-
-If you are using [`projects`](/config/projects), they will inherit all global tags definitions automatically.
-
-Use [`--tags-filter`](/guide/test-tags#syntax) to filter tests by their tags. Use [`--list-tags`](/guide/cli#listtags) to print every tag in your Vitest workspace.
-
-## name
-
-- **Type:** `string`
-- **Required:** `true`
-
-The name of the tag. This is what you use in the `tags` option in tests.
-
-```ts
-export default defineConfig({
-  test: {
-    tags: [
-      { name: 'unit' },
-      { name: 'e2e' },
-    ],
-  },
-})
-```
-
-::: tip
-If you are using TypeScript, you can enforce what tags are available by augmenting the `TestTags` type with a property that contains a union of strings (make sure this file is included by your `tsconfig`):
-
-```ts [vitest.shims.ts]
-import 'vitest'
-
-declare module 'vitest' {
-  interface TestTags {
-    tags:
-      | 'frontend'
-      | 'backend'
-      | 'db'
-      | 'flaky'
-  }
-}
-```
-:::
-
-## description
-
-- **Type:** `string`
-
-A human-readable description for the tag. This will be shown in UI and inside error messages when a tag is not found.
-
-```ts
-export default defineConfig({
-  test: {
-    tags: [
-      {
-        name: 'slow',
-        description: 'Tests that take a long time to run.',
-      },
-    ],
-  },
-})
-```
-
-## priority
-
-- **Type:** `number`
-- **Default:** `Infinity`
-
-Priority for merging options when multiple tags with the same options are applied to a test. Lower number means higher priority (e.g., priority `1` takes precedence over priority `3`).
-
-```ts
-export default defineConfig({
-  test: {
-    tags: [
-      {
-        name: 'flaky',
-        timeout: 30_000,
-        priority: 1, // higher priority
-      },
-      {
-        name: 'db',
-        timeout: 60_000,
-        priority: 2, // lower priority
-      },
-    ],
-  },
-})
-```
-
-When a test has both tags, the `timeout` will be `30_000` because `flaky` has a higher priority.
-
-## Test Options
-
-Tags can define [test options](/api/test#test-options) that will be applied to every test marked with the tag. These options are merged with the test's own options, with the test's options taking precedence.
-
-::: warning
-The [`retry.condition`](/api/test#retry) can only be a regexp because the config values need to be serialised.
-
-Tags also cannot apply other [tags](/api/test#tags) via these options.
-:::
-
-## Example
-
-```ts
-import { defineConfig } from 'vitest/config'
-
-export default defineConfig({
-  test: {
-    tags: [
-      {
-        name: 'unit',
-        description: 'Unit tests.',
-      },
-      {
-        name: 'e2e',
-        description: 'End-to-end tests.',
-        timeout: 60_000,
-      },
-      {
-        name: 'flaky',
-        description: 'Flaky tests that need retries.',
-        retry: process.env.CI ? 3 : 0,
-        priority: 1,
-      },
-      {
-        name: 'slow',
-        description: 'Slow tests.',
-        timeout: 120_000,
-      },
-      {
-        name: 'skip-ci',
-        description: 'Tests to skip in CI.',
-        skip: !!process.env.CI,
-      },
-    ],
-  },
-})
-```

package/vendor/vitest-docs/config/teardowntimeout.md

@@ -1,7 +0,0 @@
-# teardownTimeout <CRoot /> {#teardowntimeout}
-
-- **Type:** `number`
-- **Default:** `10000`
-- **CLI:** `--teardown-timeout=5000`, `--teardownTimeout=5000`
-
-Default timeout to wait for close when Vitest shuts down, in milliseconds

package/vendor/vitest-docs/config/testnamepattern.md

@@ -1,21 +0,0 @@
-# testNamePattern <CRoot /> {#testnamepattern}
-
-- **Type:** `string | RegExp`
-- **CLI:** `-t <pattern>`, `--testNamePattern=<pattern>`, `--test-name-pattern=<pattern>`
-
-Run tests with full names matching the pattern.
-If you add `OnlyRunThis` to this property, tests not containing the word `OnlyRunThis` in the test name will be skipped.
-
-```js
-import { expect, test } from 'vitest'
-
-// run
-test('OnlyRunThis', () => {
-  expect(true).toBe(true)
-})
-
-// skipped
-test('doNotRun', () => {
-  expect(true).toBe(true)
-})
-```

package/vendor/vitest-docs/config/testtimeout.md

@@ -1,7 +0,0 @@
-# testTimeout
-
-- **Type:** `number`
-- **Default:** `5_000` in Node.js, `15_000` if `browser.enabled` is `true`
-- **CLI:** `--test-timeout=5000`, `--testTimeout=5000`
-
-Default timeout of a test in milliseconds. Use `0` to disable timeout completely.

package/vendor/vitest-docs/config/typecheck.md

@@ -1,77 +0,0 @@
-# typecheck <Experimental /> {#typecheck}
-
-Options for configuring [typechecking](/guide/testing-types) test environment.
-
-## typecheck.enabled {#typecheck-enabled}
-
-- **Type:** `boolean`
-- **Default:** `false`
-- **CLI:** `--typecheck`, `--typecheck.enabled`
-
-Enable typechecking alongside your regular tests.
-
-## typecheck.only {#typecheck-only}
-
-- **Type:** `boolean`
-- **Default:** `false`
-- **CLI:** `--typecheck.only`
-
-Run only typecheck tests, when typechecking is enabled. When using CLI, this option will automatically enable typechecking.
-
-## typecheck.checker
-
-- **Type:** `'tsc' | 'vue-tsc' | string`
-- **Default:** `tsc`
-
-What tools to use for type checking. Vitest will spawn a process with certain parameters for easier parsing, depending on the type. Checker should implement the same output format as `tsc`.
-
-You need to have a package installed to use typechecker:
-
-- `tsc` requires `typescript` package
-- `vue-tsc` requires `vue-tsc` package
-
-You can also pass down a path to custom binary or command name that produces the same output as `tsc --noEmit --pretty false`.
-
-## typecheck.include
-
-- **Type:** `string[]`
-- **Default:** `['**/*.{test,spec}-d.?(c|m)[jt]s?(x)']`
-
-Glob pattern for files that should be treated as test files.
-
-## typecheck.exclude
-
-- **Type:** `string[]`
-- **Default:** `['**/node_modules/**', '**/dist/**', '**/cypress/**', '**/.{idea,git,cache,output,temp}/**']`
-
-Glob pattern for files that should not be treated as test files.
-
-## typecheck.allowJs
-
-- **Type:** `boolean`
-- **Default:** `false`
-
-Check JS files that have `@ts-check` comment. If you have it enabled in tsconfig, this will not overwrite it.
-
-## typecheck.ignoreSourceErrors
-
-- **Type:** `boolean`
-- **Default:** `false`
-
-Do not fail, if Vitest found errors outside the test files. This will not show you non-test errors at all.
-
-By default, if Vitest finds source error, it will fail test suite.
-
-## typecheck.tsconfig
-
-- **Type:** `string`
-- **Default:** _tries to find closest tsconfig.json_
-
-Path to custom tsconfig, relative to the project root.
-
-## typecheck.spawnTimeout
-
-- **Type:** `number`
-- **Default:** `10_000`
-
-Minimum time in milliseconds it takes to spawn the typechecker.

package/vendor/vitest-docs/config/ui.md

@@ -1,15 +0,0 @@
-# ui <CRoot />
-
-- **Type:** `boolean`
-- **Default:** `false`
-- **CLI:** `--ui`, `--ui=false`
-
-Enable [Vitest UI](/guide/ui).
-
-::: warning
-This features requires a [`@vitest/ui`](https://npmx.dev/package/@vitest/ui) package to be installed. If you do not have it already, Vitest will install it when you run the test command for the first time.
-:::
-
-::: danger SECURITY ADVICE
-Make sure that your UI server is not exposed to the network. Since Vitest 4.1 setting [`api.host`](/config/api) to anything other than `localhost` will disable the buttons to save the code or run any tests for security reasons, effectively making UI a readonly reporter.
-:::

package/vendor/vitest-docs/config/unstubenvs.md

@@ -1,20 +0,0 @@
-# unstubEnvs
-
-- **Type:** `boolean`
-- **Default:** `false`
-
-Should Vitest automatically call [`vi.unstubAllEnvs()`](/api/vi#vi-unstuballenvs) before each test.
-
-```js [vitest.config.js]
-import { defineConfig } from 'vitest/config'
-
-export default defineConfig({
-  test: {
-    unstubEnvs: true,
-  },
-})
-```
-
-::: warning
-Be aware that this option may cause problems with async [concurrent tests](/api/test#test-concurrent). If enabled, the completion of one test will restore all the values changed with [`vi.stubEnv`](/api/vi#vi-stubenv), including those currently being used by other tests in progress.
-:::

package/vendor/vitest-docs/config/unstubglobals.md

@@ -1,20 +0,0 @@
-# unstubGlobals
-
-- **Type:** `boolean`
-- **Default:** `false`
-
-Should Vitest automatically call [`vi.unstubAllGlobals()`](/api/vi#vi-unstuballglobals) before each test.
-
-```js [vitest.config.js]
-import { defineConfig } from 'vitest/config'
-
-export default defineConfig({
-  test: {
-    unstubGlobals: true,
-  },
-})
-```
-
-::: warning
-Be aware that this option may cause problems with async [concurrent tests](/api/test#test-concurrent). If enabled, the completion of one test will restore all global values that were changed with [`vi.stubGlobal`](/api/vi#vi-stubglobal), including those currently being used by other tests in progress.
-:::

package/vendor/vitest-docs/config/update.md

@@ -1,16 +0,0 @@
-# update <CRoot /> {#update}
-
-- **Type:** `boolean | 'new' | 'all' | 'none'`
-- **Default:** `false`
-- **CLI:** `-u`, `--update`, `--update=false`, `--update=new`, `--update=none`
-
-Define snapshot update behavior.
-
-- `true` or `'all'`: updates all changed snapshots and deletes obsolete ones
-- `new`: generates new snapshots without changing or deleting obsolete ones
-- `none`: does not write snapshots and fails on snapshot mismatches, missing snapshots, and obsolete snapshots
-
-When `update` is `false` (the default), Vitest resolves snapshot update mode by environment:
-
-- Local runs (non-CI): works same as `new`
-- CI runs (`process.env.CI` is truthy): works same as `none`

package/vendor/vitest-docs/config/vmmemorylimit.md

@@ -1,30 +0,0 @@
-# vmMemoryLimit
-
-- **Type:** `string | number`
-- **Default:** `1 / CPU Cores`
-
-This option affects only `vmForks` and `vmThreads` pools.
-
-Specifies the memory limit for workers before they are recycled. This value heavily depends on your environment, so it's better to specify it manually instead of relying on the default.
-
-::: tip
-The implementation is based on Jest's [`workerIdleMemoryLimit`](https://jestjs.io/docs/configuration#workeridlememorylimit-numberstring).
-
-The limit can be specified in a number of different ways and whatever the result is `Math.floor` is used to turn it into an integer value:
-
-- `<= 1` - The value is assumed to be a percentage of system memory. So 0.5 sets the memory limit of the worker to half of the total system memory
-- `\> 1` - Assumed to be a fixed byte value. Because of the previous rule if you wanted a value of 1 byte (I don't know why) you could use 1.1.
-- With units
-  - `50%` - As above, a percentage of total system memory
-  - `100KB`, `65MB`, etc - With units to denote a fixed memory limit.
-    - `K` / `KB` - Kilobytes (x1000)
-    - `KiB` - Kibibytes (x1024)
-    - `M` / `MB` - Megabytes
-    - `MiB` - Mebibytes
-    - `G` / `GB` - Gigabytes
-    - `GiB` - Gibibytes
-:::
-
-::: warning
-Percentage based memory limit [does not work on Linux CircleCI](https://github.com/jestjs/jest/issues/11956#issuecomment-1212925677) workers due to incorrect system memory being reported.
-:::

package/vendor/vitest-docs/config/watch.md

@@ -1,11 +0,0 @@
-# watch <CRoot /> {#watch}
-
-- **Type:** `boolean`
-- **Default:** `!process.env.CI && process.stdin.isTTY`
-- **CLI:** `-w`, `--watch`, `--watch=false`
-
-Enable watch mode
-
-In interactive environments, this is the default, unless `--run` is specified explicitly.
-
-In CI, or when run from a non-interactive shell, "watch" mode is not the default, but can be enabled explicitly with this flag.

package/vendor/vitest-docs/config/watchtriggerpatterns.md

@@ -1,29 +0,0 @@
-# watchTriggerPatterns <CRoot /> <Version>3.2.0</Version>
-
-- **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 dependencies.
-
-To correctly rerun those tests, you can define a regex pattern and a function that returns a list of test files to run.
-
-```ts
-import { defineConfig } from 'vitest/config'
-
-export default defineConfig({
-  test: {
-    watchTriggerPatterns: [
-      {
-        pattern: /^src\/(mailers|templates)\/(.*)\.(ts|html|txt)$/,
-        testsToRun: (id, match) => {
-          // relative to the root value
-          return `./api/tests/mailers/${match[2]}.test.ts`
-        },
-      },
-    ],
-  },
-})
-```
-
-::: warning
-Returned files should be either absolute or relative to the root. Note that this is a global option, and it cannot be used inside of [project](/guide/projects) configs.
-:::