@vitest-agent/mcp 1.1.0 → 1.3.0

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

@@ -1,13 +0,0 @@
-# alias
-
-- **Type:** `Record<string, string> | Array<{ find: string | RegExp, replacement: string, customResolver?: ResolverFunction | ResolverObject }>`
-
-Define custom aliases when running inside tests. They will be merged with aliases from `resolve.alias`.
-
-::: warning
-Vitest uses Vite SSR primitives to run tests which has [certain pitfalls](https://vitejs.dev/guide/ssr.html#ssr-externals).
-
-1. Aliases affect only modules imported directly with an `import` keyword by an [inlined](/config/server#server-deps-inline) module (all source code is inlined by default).
-2. Vitest does not support aliasing `require` calls.
-3. If you are aliasing an external dependency (e.g., `react` -> `preact`), you may want to alias the actual `node_modules` packages instead to make it work for externalized dependencies. Both [Yarn](https://classic.yarnpkg.com/en/docs/cli/add/#toc-yarn-add-alias) and [pnpm](https://pnpm.io/aliases/) support aliasing via the `npm:` prefix.
-:::

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

@@ -1,32 +0,0 @@
-# allowOnly
-
-- **Type:** `boolean`
-- **Default:** `!process.env.CI`
-- **CLI:** `--allowOnly`, `--allowOnly=false`
-
-By default, Vitest does not permit tests marked with the [`only`](/api/test#test-only) flag in Continuous Integration (CI) environments. Conversely, in local development environments, Vitest allows these tests to run.
-
-::: info
-Vitest uses [`std-env`](https://www.npmjs.com/package/std-env) package to detect the environment.
-:::
-
-You can customize this behavior by explicitly setting the `allowOnly` option to either `true` or `false`.
-
-::: code-group
-```js [vitest.config.js]
-import { defineConfig } from 'vitest/config'
-
-export default defineConfig({
-  test: {
-    allowOnly: true,
-  },
-})
-```
-```bash [CLI]
-vitest --allowOnly
-```
-:::
-
-When enabled, Vitest will not fail the test suite if tests marked with [`only`](/api/test#test-only) are detected, including in CI environments.
-
-When disabled, Vitest will fail the test suite if tests marked with [`only`](/api/test#test-only) are detected, including in local development environments.

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

@@ -1,27 +0,0 @@
-# api
-
-- **Type:** `boolean | number | object`
-- **Default:** `false`
-- **CLI:** `--api`, `--api.port`, `--api.host`, `--api.strictPort`
-
-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`.
-
-## api.allowWrite <Version>4.1.0</Version> {#api-allowwrite}
-
-- **Type:** `boolean`
-- **Default:** `true` if not exposed to the network, `false` otherwise
-
-Vitest server can save test files or snapshot files via the API. This allows anyone who can connect to the API the ability to run any arbitrary code on your machine.
-
-::: danger SECURITY ADVICE
-Vitest does not expose the API to the internet by default and only listens on `localhost`. However if `host` is manually exposed to the network, anyone who connects to it can run arbitrary code on your machine, unless `api.allowWrite` and `api.allowExec` are set to `false`.
-
-If the host is set to anything other than `localhost` or `127.0.0.1`, Vitest will set `api.allowWrite` and `api.allowExec` to `false` by default. This means that any write operations (like changing the code in the UI) will not work. However, if you understand the security implications, you can override them.
-:::
-
-## api.allowExec <Version>4.1.0</Version> {#api-allowexec}
-
-- **Type:** `boolean`
-- **Default:** `true` if not exposed to the network, `false` otherwise
-
-Allows running any test file via the API. See the security advice in [`api.allowWrite`](#api-allowwrite).

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

@@ -1,6 +0,0 @@
-# attachmentsDir
-
-- **Type:** `string`
-- **Default:** `'.vitest-attachments'`
-
-Directory path for storing attachments created by [`context.annotate`](/guide/test-context#annotate) relative to the project root.

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

@@ -1,9 +0,0 @@
-# bail
-
-- **Type:** `number`
-- **Default:** `0`
-- **CLI:** `--bail=<value>`
-
-Stop test execution when given number of tests have failed.
-
-By default Vitest will run all of your test cases even if some of them fail. This may not be desired for CI builds where you are only interested in 100% successful builds and would like to stop test execution as early as possible when test failures occur. The `bail` option can be used to speed up CI runs by preventing it from running more tests when failures have occurred.

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

@@ -1,65 +0,0 @@
-# benchmark <Experimental /> {#benchmark}
-
-- **Type:** `{ include?, exclude?, ... }`
-
-Options used when running `vitest bench`.
-
-## benchmark.include
-
-- **Type:** `string[]`
-- **Default:** `['**/*.{bench,benchmark}.?(c|m)[jt]s?(x)']`
-
-Include globs for benchmark test files
-
-## benchmark.exclude
-
-- **Type:** `string[]`
-- **Default:** `['node_modules', 'dist', '.idea', '.git', '.cache']`
-
-Exclude globs for benchmark test files
-
-## benchmark.includeSource
-
-- **Type:** `string[]`
-- **Default:** `[]`
-
-Include globs for in-source benchmark test files. This option is similar to [`includeSource`](/config/include-source).
-
-When defined, Vitest will run all matched files with `import.meta.vitest` inside.
-
-## benchmark.reporters
-
-- **Type:** `Arrayable<BenchmarkBuiltinReporters | Reporter>`
-- **Default:** `'default'`
-
-Custom reporter for output. Can contain one or more built-in report names, reporter instances, and/or paths to custom reporters.
-
-## benchmark.outputFile
-
-Deprecated in favor of `benchmark.outputJson`.
-
-## benchmark.outputJson {#benchmark-outputJson}
-
-- **Type:** `string | undefined`
-- **Default:** `undefined`
-
-A file path to store the benchmark result, which can be used for `--compare` option later.
-
-For example:
-
-```sh
-# save main branch's result
-git checkout main
-vitest bench --outputJson main.json
-
-# change a branch and compare against main
-git checkout feature
-vitest bench --compare main.json
-```
-
-## benchmark.compare {#benchmark-compare}
-
-- **Type:** `string | undefined`
-- **Default:** `undefined`
-
-A file path to a previous benchmark result to compare against current runs.

package/vendor/vitest-docs/config/browser/api.md

@@ -1,23 +0,0 @@
-# browser.api
-
-- **Type:** `number | object`
-- **Default:** `63315`
-- **CLI:** `--browser.api=63315`, `--browser.api.port=1234, --browser.api.host=example.com`
-
-Configure options for Vite server that serves code in the browser. Does not affect [`test.api`](/config/api) option. By default, Vitest assigns port `63315` to avoid conflicts with the development server, allowing you to run both in parallel.
-
-## api.allowWrite <Version>4.1.0</Version> {#api-allowwrite}
-
-- **Type:** `boolean`
-- **Default:** `true` if not exposed to the network, `false` otherwise
-
-Vitest saves [annotation attachments](/guide/test-annotations), [artifacts](/api/advanced/artifacts) and [snapshots](/guide/snapshot) by receiving a WebSocket connection from the browser. This allows anyone who can connect to the API write any arbitrary code on your machine within the root of your project (configured by [`fs.allow`](https://vite.dev/config/server-options#server-fs-allow)).
-
-If browser server is not exposed to the internet (the host is `localhost`), this should not be a problem, so the default value in that case is `true`. If you override the host, Vitest will set `allowWrite` to `false` by default to prevent potentially harmful writes.
-
-## api.allowExec <Version>4.1.0</Version> {#api-allowexec}
-
-- **Type:** `boolean`
-- **Default:** `true` if not exposed to the network, `false` otherwise
-
-Allows running any test file via the UI. This only applies to the interactive elements (and the server code behind them) in the [UI](/guide/ui) that can run the code. If UI is disabled, this has no effect. See [`api.allowExec`](/config/api#api-allowexec) for more information.

package/vendor/vitest-docs/config/browser/commands.md

@@ -1,6 +0,0 @@
-# browser.commands
-
-- **Type:** `Record<string, BrowserCommand>`
-- **Default:** `{ readFile, writeFile, ... }`
-
-Custom [commands](/api/browser/commands) that can be imported during browser tests from `vitest/browser`.

package/vendor/vitest-docs/config/browser/connecttimeout.md

@@ -1,10 +0,0 @@
-# browser.connectTimeout
-
-- **Type:** `number`
-- **Default:** `60_000`
-
-The timeout in milliseconds. If connection to the browser takes longer, the test suite will fail.
-
-::: info
-This is the time it should take for the browser to establish the WebSocket connection with the Vitest server. In normal circumstances, this timeout should never be reached.
-:::

package/vendor/vitest-docs/config/browser/detailspanelposition.md

@@ -1,38 +0,0 @@
-# browser.detailsPanelPosition
-
-- **Type:** `'right' | 'bottom'`
-- **Default:** `'right'`
-- **CLI:** `--browser.detailsPanelPosition=bottom`, `--browser.detailsPanelPosition=right`
-
-Controls the default position of the details panel in the Vitest UI when running browser tests.
-
-- `'right'` - Shows the details panel on the right side with a horizontal split between the browser viewport and the details panel.
-- `'bottom'` - Shows the details panel at the bottom with a vertical split between the browser viewport and the details panel.
-
-```ts [vitest.config.ts]
-import { defineConfig } from 'vitest/config'
-
-export default defineConfig({
-  test: {
-    browser: {
-      enabled: true,
-      detailsPanelPosition: 'bottom', // or 'right'
-    },
-  },
-})
-```
-
-## Example
-
-::: tabs
-== bottom
-<center>
-  <img alt="Vitest UI with details at the bottom" img-light src="/ui/light-ui-details-bottom.png">
-  <img alt="Vitest UI with details at the bottom" img-dark src="/ui/dark-ui-details-bottom.png">
-</center>
-== right
-<center>
-  <img alt="Vitest UI with details at the right side" img-light src="/ui/light-ui-details-right.png">
-  <img alt="Vitest UI with details at the right side" img-dark src="/ui/dark-ui-details-right.png">
-</center>
-:::

package/vendor/vitest-docs/config/browser/enabled.md

@@ -1,40 +0,0 @@
-# browser.enabled
-
-- **Type:** `boolean`
-- **Default:** `false`
-- **CLI:** `--browser`, `--browser.enabled=false`
-
-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`:
-
-```sh
-vitest --browser.enabled --browser.headless
-```
-
-::: warning
-To enable [Browser Mode](/guide/browser/), you must also specify the [`provider`](/config/browser/provider) and at least one [`instance`](/config/browser/instances). Available providers:
-
-- [playwright](/config/browser/playwright)
-- [webdriverio](/config/browser/webdriverio)
-- [preview](/config/browser/preview)
-:::
-
-## Example
-
-```js{7} [vitest.config.js]
-import { defineConfig } from 'vitest/config'
-import { playwright } from '@vitest/browser-playwright'
-
-export default defineConfig({
-  test: {
-    browser: {
-      enabled: true,
-      provider: playwright(),
-      instances: [
-        { browser: 'chromium' },
-      ],
-    },
-  },
-})
-```
-
-If you use TypeScript, the `browser` field in `instances` provides autocompletion based on your provider.

package/vendor/vitest-docs/config/browser/expect.md

@@ -1,250 +0,0 @@
-# browser.expect
-
-- **Type:** `ExpectOptions`
-
-## browser.expect.toMatchScreenshot
-
-Default options for the
-[`toMatchScreenshot` assertion](/api/browser/assertions.html#tomatchscreenshot).
-These options will be applied to all screenshot assertions.
-
-::: tip
-Setting global defaults for screenshot assertions helps maintain consistency
-across your test suite and reduces repetition in individual tests. You can still
-override these defaults at the assertion level when needed for specific test cases.
-:::
-
-```ts
-import { defineConfig } from 'vitest/config'
-
-export default defineConfig({
-  test: {
-    browser: {
-      enabled: true,
-      expect: {
-        toMatchScreenshot: {
-          comparatorName: 'pixelmatch',
-          comparatorOptions: {
-            threshold: 0.2,
-            allowedMismatchedPixels: 100,
-          },
-          resolveScreenshotPath: ({ arg, browserName, ext, testFileName }) =>
-            `custom-screenshots/${testFileName}/${arg}-${browserName}${ext}`,
-        },
-      },
-    },
-  },
-})
-```
-
-[All options available in the `toMatchScreenshot` assertion](/api/browser/assertions#options)
-can be configured here. Additionally, two path resolution functions are
-available: `resolveScreenshotPath` and `resolveDiffPath`.
-
-## browser.expect.toMatchScreenshot.resolveScreenshotPath
-
-- **Type:** `(data: PathResolveData) => string`
-- **Default output:** `` `${root}/${testFileDirectory}/${screenshotDirectory}/${testFileName}/${arg}-${browserName}-${platform}${ext}` ``
-
-A function to customize where reference screenshots are stored. The function
-receives an object with the following properties:
-
-- `arg: string`
-
-  Path **without** extension, sanitized and relative to the test file.
-
-  This comes from the arguments passed to `toMatchScreenshot`; if called
-  without arguments this will be the auto-generated name.
-
-  ```ts
-  test('calls `onClick`', () => {
-    expect(locator).toMatchScreenshot()
-    // arg = "calls-onclick-1"
-  })
-
-  expect(locator).toMatchScreenshot('foo/bar/baz.png')
-  // arg = "foo/bar/baz"
-
-  expect(locator).toMatchScreenshot('../foo/bar/baz.png')
-  // arg = "foo/bar/baz"
-  ```
-
-- `ext: string`
-
-  Screenshot extension, with leading dot.
-
-  This can be set through the arguments passed to `toMatchScreenshot`, but
-  the value will fall back to `'.png'` if an unsupported extension is used.
-
-- `browserName: string`
-
-  The instance's browser name.
-
-- `platform: NodeJS.Platform`
-
-  The value of
-  [`process.platform`](https://nodejs.org/docs/v22.16.0/api/process.html#processplatform).
-
-- `screenshotDirectory: string`
-
-  The value provided to
-  [`browser.screenshotDirectory`](/config/browser/screenshotdirectory),
-  if none is provided, its default value.
-
-- `root: string`
-
-  Absolute path to the project's [`root`](/config/root).
-
-- `testFileDirectory: string`
-
-  Path to the test file, relative to the project's [`root`](/config/root).
-
-- `testFileName: string`
-
-  The test's filename.
-
-- `testName: string`
-
-  The [`test`](/api/test)'s name, including parent
-  [`describe`](/api/describe), sanitized.
-
-- `attachmentsDir: string`
-
-  The value provided to [`attachmentsDir`](/config/attachmentsdir), if none is
-  provided, its default value.
-
-For example, to group screenshots by browser:
-
-```ts
-resolveScreenshotPath: ({ arg, browserName, ext, root, testFileName }) =>
-  `${root}/screenshots/${browserName}/${testFileName}/${arg}${ext}`
-```
-
-## browser.expect.toMatchScreenshot.resolveDiffPath
-
-- **Type:** `(data: PathResolveData) => string`
-- **Default output:** `` `${root}/${attachmentsDir}/${testFileDirectory}/${testFileName}/${arg}-${browserName}-${platform}${ext}` ``
-
-A function to customize where diff images are stored when screenshot comparisons
-fail. Receives the same data object as
-[`resolveScreenshotPath`](#browser-expect-tomatchscreenshot-resolvescreenshotpath).
-
-For example, to store diffs in a subdirectory of attachments:
-
-```ts
-resolveDiffPath: ({ arg, attachmentsDir, browserName, ext, root, testFileName }) =>
-  `${root}/${attachmentsDir}/screenshot-diffs/${testFileName}/${arg}-${browserName}${ext}`
-```
-
-## browser.expect.toMatchScreenshot.comparators
-
-- **Type:** `Record<string, Comparator>`
-
-Register custom screenshot comparison algorithms, like [SSIM](https://en.wikipedia.org/wiki/Structural_similarity_index_measure) or other perceptual similarity metrics.
-
-To create a custom comparator, you need to register it in your config. If using TypeScript, declare its options in the `ScreenshotComparatorRegistry` interface.
-
-```ts
-import { defineConfig } from 'vitest/config'
-
-// 1. Declare the comparator's options type
-declare module 'vitest/browser' {
-  interface ScreenshotComparatorRegistry {
-    myCustomComparator: {
-      sensitivity?: number
-      ignoreColors?: boolean
-    }
-  }
-}
-
-// 2. Implement the comparator
-export default defineConfig({
-  test: {
-    browser: {
-      expect: {
-        toMatchScreenshot: {
-          comparators: {
-            myCustomComparator: async (
-              reference,
-              actual,
-              {
-                createDiff, // always provided by Vitest
-                sensitivity = 0.01,
-                ignoreColors = false,
-              }
-            ) => {
-              // ...algorithm implementation
-              return { pass, diff, message }
-            },
-          },
-        },
-      },
-    },
-  },
-})
-```
-
-Then use it in your tests:
-
-```ts
-await expect(locator).toMatchScreenshot({
-  comparatorName: 'myCustomComparator',
-  comparatorOptions: {
-    sensitivity: 0.08,
-    ignoreColors: true,
-  },
-})
-```
-
-**Comparator Function Signature:**
-
-```ts
-type Comparator<Options> = (
-  reference: {
-    metadata: { height: number; width: number }
-    data: TypedArray
-  },
-  actual: {
-    metadata: { height: number; width: number }
-    data: TypedArray
-  },
-  options: {
-    createDiff: boolean
-  } & Options
-) => Promise<{
-  pass: boolean
-  diff: TypedArray | null
-  message: string | null
-}> | {
-  pass: boolean
-  diff: TypedArray | null
-  message: string | null
-}
-```
-
-The `reference` and `actual` images are decoded using the appropriate codec (currently only PNG). The `data` property is a flat `TypedArray` (`Buffer`, `Uint8Array`, or `Uint8ClampedArray`) containing pixel data in RGBA format:
-
-- **4 bytes per pixel**: red, green, blue, alpha (from `0` to `255` each)
-- **Row-major order**: pixels are stored left-to-right, top-to-bottom
-- **Total length**: `width × height × 4` bytes
-- **Alpha channel**: always present. Images without transparency have alpha values set to `255` (fully opaque)
-
-::: tip Performance Considerations
-The `createDiff` option indicates whether a diff image is needed. During [stable screenshot detection](/guide/browser/visual-regression-testing#how-visual-tests-work), Vitest calls comparators with `createDiff: false` to avoid unnecessary work.
-
-**Respect this flag to keep your tests fast**.
-:::
-
-::: warning Handle Missing Options
-The `options` parameter in `toMatchScreenshot()` is optional, so users might not provide all your comparator options. Always make them optional with default values:
-
-```ts
-myCustomComparator: (
-  reference,
-  actual,
-  { createDiff, threshold = 0.1, maxDiff = 100 },
-) => {
-  // ...comparison logic
-}
-```
-:::

package/vendor/vitest-docs/config/browser/headless.md

@@ -1,7 +0,0 @@
-# browser.headless
-
-- **Type:** `boolean`
-- **Default:** `process.env.CI`
-- **CLI:** `--browser.headless`, `--browser.headless=false`
-
-Run the browser in a `headless` mode. If you are running Vitest in CI, it will be enabled by default.

package/vendor/vitest-docs/config/browser/instances.md

@@ -1,47 +0,0 @@
-# browser.instances
-
-- **Type:** `BrowserConfig`
-- **Default:** `[]`
-
-Defines multiple browser setups. Every config has to have at least a `browser` field.
-
-You can specify most of the [project options](/config/) (not marked with a <CRoot /> icon) and some of the `browser` options like `browser.testerHtmlPath`.
-
-::: warning
-Every browser config inherits options from the root config:
-
-```ts{3,9} [vitest.config.ts]
-export default defineConfig({
-  test: {
-    setupFile: ['./root-setup-file.js'],
-    browser: {
-      enabled: true,
-      testerHtmlPath: './custom-path.html',
-      instances: [
-        {
-          // will have both setup files: "root" and "browser"
-          setupFile: ['./browser-setup-file.js'],
-          // implicitly has "testerHtmlPath" from the root config // [!code warning]
-          // testerHtmlPath: './custom-path.html', // [!code warning]
-        },
-      ],
-    },
-  },
-})
-```
-
-For more examples, refer to the ["Multiple Setups" guide](/guide/browser/multiple-setups).
-:::
-
-List of available `browser` options:
-
-- `browser` (the name of the browser)
-- [`headless`](/config/browser/headless)
-- [`locators`](/config/browser/locators)
-- [`viewport`](/config/browser/viewport)
-- [`testerHtmlPath`](/config/browser/testerhtmlpath)
-- [`screenshotDirectory`](/config/browser/screenshotdirectory)
-- [`screenshotFailures`](/config/browser/screenshotfailures)
-- [`provider`](/config/browser/provider)
-
-Under the hood, Vitest transforms these instances into separate [test projects](/api/advanced/test-project) sharing a single Vite server for better caching performance.

package/vendor/vitest-docs/config/browser/isolate.md

@@ -1,11 +0,0 @@
-# browser.isolate <Deprecated />
-
-- **Type:** `boolean`
-- **Default:** the same as [`--isolate`](/config/isolate)
-- **CLI:** `--browser.isolate`, `--browser.isolate=false`
-
-Run every test in a separate iframe.
-
-::: danger DEPRECATED
-This option is deprecated. Use [`isolate`](/config/isolate) instead.
-:::

package/vendor/vitest-docs/config/browser/locators.md

@@ -1,24 +0,0 @@
-# browser.locators
-
-Options for built-in [browser locators](/api/browser/locators).
-
-## browser.locators.testIdAttribute
-
-- **Type:** `string`
-- **Default:** `data-testid`
-
-Attribute used to find elements with `getByTestId` locator.
-
-## browser.locators.exact <Version type="experimental">4.1.3</Version> {#browser-locators-exact}
-
-- **Type:** `boolean`
-- **Default:** `false`
-
-When set to `true`, [locators](/api/browser/locators) will match text exactly by default, requiring a full, case-sensitive match. Individual locator calls can override this default via their own `exact` option.
-
-```ts
-// With exact: false (default), this matches "Hello, World!", "Say Hello, World", etc.
-// With exact: true, this only matches the string "Hello, World" exactly.
-const locator = page.getByText('Hello, World', { exact: true })
-await locator.click()
-```

package/vendor/vitest-docs/config/browser/orchestratorscripts.md

@@ -1,39 +0,0 @@
-# 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.
-
-The script `src` and `content` will be processed by Vite plugins. Script should be provided in the following shape:
-
-```ts
-export interface BrowserScript {
-  /**
-   * If "content" is provided and type is "module", this will be its identifier.
-   *
-   * If you are using TypeScript, you can add `.ts` extension here for example.
-   * @default `injected-${index}.js`
-   */
-  id?: string
-  /**
-   * JavaScript content to be injected. This string is processed by Vite plugins if type is "module".
-   *
-   * You can use `id` to give Vite a hint about the file extension.
-   */
-  content?: string
-  /**
-   * Path to the script. This value is resolved by Vite so it can be a node module or a file path.
-   */
-  src?: string
-  /**
-   * If the script should be loaded asynchronously.
-   */
-  async?: boolean
-  /**
-   * Script type.
-   * @default 'module'
-   */
-  type?: string
-}
-```