@vitest-agent/mcp 1.1.0 → 1.2.0

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

@@ -1,214 +0,0 @@
-# Configuring Playwright
-
-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` property of your config:
-
-```ts [vitest.config.js]
-import { playwright } from '@vitest/browser-playwright'
-import { defineConfig } from 'vitest/config'
-
-export default defineConfig({
-  test: {
-    browser: {
-      provider: playwright(),
-      instances: [{ browser: 'chromium' }]
-    },
-  },
-})
-```
-
-You can configure the [`launchOptions`](https://playwright.dev/docs/api/class-browsertype#browser-type-launch), [`connectOptions`](https://playwright.dev/docs/api/class-browsertype#browser-type-connect) and [`contextOptions`](https://playwright.dev/docs/api/class-browser#browser-new-context) when calling `playwright` at the top level or inside instances:
-
-```ts{7-14,21-26} [vitest.config.js]
-import { playwright } from '@vitest/browser-playwright'
-import { defineConfig } from 'vitest/config'
-
-export default defineConfig({
-  test: {
-    browser: {
-      // shared provider options between all instances
-      provider: playwright({
-        launchOptions: {
-          slowMo: 50,
-          channel: 'chrome-beta',
-        },
-        actionTimeout: 5_000,
-      }),
-      instances: [
-        { browser: 'chromium' },
-        {
-          browser: 'firefox',
-          // overriding options only for a single instance
-          // this will NOT merge options with the parent one
-          provider: playwright({
-            launchOptions: {
-              firefoxUserPrefs: {
-                'browser.startup.homepage': 'https://example.com',
-              },
-            },
-          })
-        }
-      ],
-    },
-  },
-})
-```
-
-::: warning
-Unlike Playwright test runner, Vitest opens a _single_ page to run all tests that are defined in the same file. This means that isolation is restricted to a single test file, not to every individual test.
-:::
-
-## launchOptions
-
-These options are directly passed down to `playwright[browser].launch` command. You can read more about the command and available arguments in the [Playwright documentation](https://playwright.dev/docs/api/class-browsertype#browser-type-launch).
-
-::: warning
-Vitest will ignore `launch.headless` option. Instead, use [`test.browser.headless`](/config/browser/headless).
-
-Note that Vitest will push debugging flags to `launch.args` if [`--inspect`](/guide/cli#inspect) is enabled.
-:::
-
-::: tip Enabling new Chromium headless mode
-Playwright supports a [new headless mode](https://playwright.dev/docs/browsers#chromium-new-headless-mode) for Chromium that uses the real Chrome browser instead of the dedicated headless shell. This provides more authentic, reliable test execution and removes the need to install a separate headless Chromium build.
-
-To opt in, set `channel` to `'chromium'` in `launchOptions`:
-
-```ts [vitest.config.ts]
-import { playwright } from '@vitest/browser-playwright'
-import { defineConfig } from 'vitest/config'
-
-export default defineConfig({
-  test: {
-    browser: {
-      headless: true,
-      provider: playwright({
-        launchOptions: {
-          channel: 'chromium',
-        },
-      }),
-      instances: [{ browser: 'chromium' }],
-    },
-  },
-})
-```
-:::
-
-## connectOptions
-
-These options are directly passed down to `playwright[browser].connect` command. You can read more about the command and available arguments in the [Playwright documentation](https://playwright.dev/docs/api/class-browsertype#browser-type-connect).
-
-Use `connectOptions.wsEndpoint` to connect to an existing Playwright server instead of launching browsers locally. This is useful for running browsers in Docker, in CI, or on a remote machine.
-
-::: warning
-
-Vitest forwards `launchOptions` to Playwright server via the `x-playwright-launch-options` header. This works only if the remote Playwright server supports this header, for example when using the `playwright run-server` CLI.
-
-:::
-
-::: details Example: Running a Playwright Server in Docker
-To run browsers in a Docker container (see [Playwright Docker guide](https://playwright.dev/docs/docker#remote-connection)):
-
-Start a Playwright server using Docker Compose:
-
-```yaml [docker-compose.yml]
-services:
-  playwright:
-    image: mcr.microsoft.com/playwright:v1.58.1-noble
-    command: /bin/sh -c "npx -y playwright@1.58.1 run-server --port 6677 --host 0.0.0.0"
-    init: true
-    ipc: host
-    user: pwuser
-    ports:
-      - '6677:6677'
-```
-
-```sh
-docker compose up -d
-```
-
-Then configure Vitest to connect to it. The [`exposeNetwork`](https://playwright.dev/docs/api/class-browsertype#browser-type-connect-option-expose-network) option lets the containerized browser reach Vitest's dev server on the host:
-
-```ts [vitest.config.ts]
-import { playwright } from '@vitest/browser-playwright'
-import { defineConfig } from 'vitest/config'
-
-export default defineConfig({
-  test: {
-    browser: {
-      provider: playwright({
-        connectOptions: {
-          wsEndpoint: 'ws://127.0.0.1:6677/',
-          exposeNetwork: '<loopback>',
-        },
-      }),
-      instances: [
-        { browser: 'chromium' },
-        { browser: 'firefox' },
-        { browser: 'webkit' },
-      ],
-    },
-  },
-})
-```
-:::
-
-## contextOptions
-
-Vitest creates a new context for every test file by calling [`browser.newContext()`](https://playwright.dev/docs/api/class-browsercontext). You can configure this behaviour by specifying [custom arguments](https://playwright.dev/docs/api/class-browser#browser-new-context).
-
-::: tip
-Note that the context is created for every _test file_, not every _test_ like in playwright test runner.
-:::
-
-::: warning
-Vitest always sets `ignoreHTTPSErrors` to `true` in case your server is served via HTTPS and `serviceWorkers` to `'allow'` to support module mocking via [MSW](https://mswjs.io).
-
-It is also recommended to use [`test.browser.viewport`](/config/browser/headless) instead of specifying it here as it will be lost when tests are running in headless mode.
-:::
-
-## `actionTimeout`
-
-- **Default:** no timeout
-
-This value configures the default timeout it takes for Playwright to wait until all accessibility checks pass and [the action](/api/browser/interactivity) is actually done.
-
-You can also configure the action timeout per-action:
-
-```ts
-import { page, userEvent } from 'vitest/browser'
-
-await userEvent.click(page.getByRole('button'), {
-  timeout: 1_000,
-})
-```
-
-## `persistentContext` <Version>4.1.0</Version> {#persistentcontext}
-
-- **Type:** `boolean | string`
-- **Default:** `false`
-
-When enabled, Vitest uses Playwright's [persistent context](https://playwright.dev/docs/api/class-browsertype#browser-type-launch-persistent-context) instead of a regular browser context. This allows browser state (cookies, localStorage, DevTools settings, etc.) to persist between test runs.
-
-::: warning
-This option is ignored when running tests in parallel (e.g. when headless with [`fileParallelism`](/config/fileparallelism) enabled) since persistent context cannot be shared across parallel sessions.
-:::
-
-- When set to `true`, the user data is stored in `./node_modules/.cache/vitest-playwright-user-data`
-- When set to a string, the value is used as the path to the user data directory
-
-```ts [vitest.config.js]
-import { playwright } from '@vitest/browser-playwright'
-import { defineConfig } from 'vitest/config'
-
-export default defineConfig({
-  test: {
-    browser: {
-      provider: playwright({
-        persistentContext: true,
-        // or specify a custom directory:
-        // persistentContext: './my-browser-data',
-      }),
-      instances: [{ browser: 'chromium' }],
-    },
-  },
-})
-```

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

@@ -1,32 +0,0 @@
-# Configuring Preview
-
-::: warning
-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 complex scenarios, consider using [Playwright](/config/browser/playwright) or [WebdriverIO](/config/browser/webdriverio).
-:::
-
-To see your tests running in a real browser, you need to install the [`@vitest/browser-preview`](https://npmx.dev/package/@vitest/browser-preview) npm package and specify its `preview` export in the `test.browser.provider` property of your config:
-
-```ts [vitest.config.js]
-import { preview } from '@vitest/browser-preview'
-import { defineConfig } from 'vitest/config'
-
-export default defineConfig({
-  test: {
-    browser: {
-      provider: preview(),
-      instances: [{ browser: 'chromium' }]
-    },
-  },
-})
-```
-
-This will open a new browser window using your default browser to run the tests. You can configure which browser to use by setting the `browser` property in the `instances` array. Vitest will try to open that browser automatically, but it might not work in some environments. In that case, you can manually open the provided URL in your desired browser.
-
-## Differences with Other Providers
-
-The preview provider has some limitations compared to other providers like [Playwright](/config/browser/playwright) or [WebdriverIO](/config/browser/webdriverio):
-
-- It does not support headless mode; the browser window will always be visible.
-- It does not support multiple instances of the same browser; each instance must use a different browser.
-- It does not support advanced browser capabilities or options; you can only specify the browser name.
-- It does not support CDP (Chrome DevTools Protocol) commands or other low-level browser interactions. Unlike Playwright or WebdriverIO, the [`userEvent`](/api/browser/interactivity) API is just re-exported from [`@testing-library/user-event`](https://npmx.dev/package/@testing-library/user-event) and does not have any special integration with the browser.

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

@@ -1,79 +0,0 @@
-# browser.provider {#browser-provider}
-
-- **Type:** `BrowserProviderOption`
-
-The return value of the provider factory. You can import the factory from `@vitest/browser-<provider-name>` or make your own provider:
-
-```ts{8-10}
-import { playwright } from '@vitest/browser-playwright'
-import { webdriverio } from '@vitest/browser-webdriverio'
-import { preview } from '@vitest/browser-preview'
-
-export default defineConfig({
-  test: {
-    browser: {
-      provider: playwright(),
-      provider: webdriverio(),
-      provider: preview(),
-    },
-  },
-})
-```
-
-To configure how provider initializes the browser, you can pass down options to the factory function:
-
-```ts{7-13,20-26}
-import { playwright } from '@vitest/browser-playwright'
-
-export default defineConfig({
-  test: {
-    browser: {
-      // shared provider options between all instances
-      provider: playwright({
-        launchOptions: {
-          slowMo: 50,
-          channel: 'chrome-beta',
-        },
-        actionTimeout: 5_000,
-      }),
-      instances: [
-        { browser: 'chromium' },
-        {
-          browser: 'firefox',
-          // overriding options only for a single instance
-          // this will NOT merge options with the parent one
-          provider: playwright({
-            launchOptions: {
-              firefoxUserPrefs: {
-                'browser.startup.homepage': 'https://example.com',
-              },
-            },
-          })
-        }
-      ],
-    },
-  },
-})
-```
-
-## Custom Provider <Badge type="danger">advanced</Badge> {#custom-provider}
-
-::: danger ADVANCED API
-The custom provider API is highly experimental and can change between patches. If you just need to run tests in a browser, use the [`browser.instances`](/config/browser/instances) option instead.
-:::
-
-```ts
-export interface BrowserProvider {
-  name: string
-  mocker?: BrowserModuleMocker
-  readonly initScripts?: string[]
-  /**
-   * @experimental opt-in into file parallelisation
-   */
-  supportsParallelism: boolean
-  getCommandsContext: (sessionId: string) => Record<string, unknown>
-  openPage: (sessionId: string, url: string) => Promise<void>
-  getCDPSession?: (sessionId: string) => Promise<CDPSession>
-  close: () => Awaitable<void>
-}
-```

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

@@ -1,6 +0,0 @@
-# browser.screenshotDirectory
-
-- **Type:** `string`
-- **Default:** `__screenshots__` in the test file directory
-
-Path to the screenshots directory relative to the `root`.

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

@@ -1,6 +0,0 @@
-# browser.screenshotFailures
-
-- **Type:** `boolean`
-- **Default:** `!browser.ui`
-
-Should Vitest take screenshots if the test fails.

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

@@ -1,5 +0,0 @@
-# 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.

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

@@ -1,43 +0,0 @@
-# browser.trace
-
-- **Type:** `'on' | 'off' | 'on-first-retry' | 'on-all-retries' | 'retain-on-failure' | object`
-- **CLI:** `--browser.trace=on`, `--browser.trace=retain-on-failure`
-- **Default:** `'off'`
-
-Capture a trace of your browser test runs. You can preview traces with [Playwright Trace Viewer](https://trace.playwright.dev/).
-
-This options supports the following values:
-
-- `'on'` - capture trace for all tests. (not recommended as it's performance heavy)
-- `'off'` - do not capture traces.
-- `'on-first-retry'` - capture trace only when retrying the test for the first time.
-- `'on-all-retries'` - capture trace on every retry of the test.
-- `'retain-on-failure'` - capture trace only for tests that fail. This will automatically delete traces for tests that pass.
-- `object` - an object with the following shape:
-
-```ts
-interface TraceOptions {
-  mode: 'on' | 'off' | 'on-first-retry' | 'on-all-retries' | 'retain-on-failure'
-  /**
-   * The directory where all traces will be stored. By default, Vitest
-   * stores all traces in `__traces__` folder close to the test file.
-   */
-  tracesDir?: string
-  /**
-   * Whether to capture screenshots during tracing. Screenshots are used to build a timeline preview.
-   * @default true
-   */
-  screenshots?: boolean
-  /**
-   * If this option is true tracing will
-   * - capture DOM snapshot on every action
-   * - record network activity
-   * @default true
-   */
-  snapshots?: boolean
-}
-```
-
-::: danger WARNING
-This option is supported only by the [**playwright**](/config/browser/playwright) provider.
-:::

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

@@ -1,10 +0,0 @@
-# browser.trackUnhandledErrors
-
-- **Type:** `boolean`
-- **Default:** `true`
-
-Enables tracking uncaught errors and exceptions so they can be reported by Vitest.
-
-If you need to hide certain errors, it is recommended to use [`onUnhandledError`](/config/onunhandlederror) option instead.
-
-Disabling this will completely remove all Vitest error handlers, which can help debugging with the "Pause on exceptions" checkbox turned on.

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

@@ -1,7 +0,0 @@
-# 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.

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

@@ -1,6 +0,0 @@
-# browser.viewport
-
-- **Type:** `{ width, height }`
-- **Default:** `414x896`
-
-Default iframe's viewport.

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

@@ -1,64 +0,0 @@
-# Configuring WebdriverIO
-
-::: info Playwright vs 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.
-:::
-
-To run tests using WebdriverIO, you need to install the [`@vitest/browser-webdriverio`](https://npmx.dev/package/@vitest/browser-webdriverio) npm package and specify its `webdriverio` export in the `test.browser.provider` property of your config:
-
-```ts [vitest.config.js]
-import { webdriverio } from '@vitest/browser-webdriverio'
-import { defineConfig } from 'vitest/config'
-
-export default defineConfig({
-  test: {
-    browser: {
-      provider: webdriverio(),
-      instances: [{ browser: 'chrome' }]
-    },
-  },
-})
-```
-
-You can configure all the parameters that [`remote`](https://webdriver.io/docs/api/modules/#remoteoptions-modifier) function accepts:
-
-```ts{8-12,19-25} [vitest.config.js]
-import { webdriverio } from '@vitest/browser-webdriverio'
-import { defineConfig } from 'vitest/config'
-
-export default defineConfig({
-  test: {
-    browser: {
-      // shared provider options between all instances
-      provider: webdriverio({
-        capabilities: {
-          browserVersion: '82',
-        },
-      }),
-      instances: [
-        { browser: 'chrome' },
-        {
-          browser: 'firefox',
-          // overriding options only for a single instance
-          // this will NOT merge options with the parent one
-          provider: webdriverio({
-            capabilities: {
-              'moz:firefoxOptions': {
-                args: ['--disable-gpu'],
-              },
-            },
-          })
-        },
-      ],
-    },
-  },
-})
-```
-
-You can find most available options in the [WebdriverIO documentation](https://webdriver.io/docs/configuration/). Note that Vitest will ignore all test runner options because we only use `webdriverio`'s browser capabilities.
-
-::: tip
-Most useful options are located on `capabilities` object. WebdriverIO allows nested capabilities, but Vitest will ignore those options because we rely on a different mechanism to spawn several browsers.
-
-Note that Vitest will ignore `capabilities.browserName` — use [`test.browser.instances.browser`](/config/browser/instances#browser) instead.
-:::

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

@@ -1,26 +0,0 @@
-# cache <CRoot />
-
-- **Type:** `false`
-- **CLI:** `--no-cache`, `--cache=false`
-
-Use this option if you want to disable the cache feature. At the moment Vitest stores cache for test results to run the longer and failed tests first.
-
-The cache directory is controlled by the Vite's [`cacheDir`](https://vitejs.dev/config/shared-options.html#cachedir) option:
-
-```ts
-import { defineConfig } from 'vitest/config'
-
-export default defineConfig({
-  cacheDir: 'custom-folder/.vitest'
-})
-```
-
-You can limit the directory only for Vitest by using `process.env.VITEST`:
-
-```ts
-import { defineConfig } from 'vitest/config'
-
-export default defineConfig({
-  cacheDir: process.env.VITEST ? 'custom-folder/.vitest' : undefined
-})
-```

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

@@ -1,29 +0,0 @@
-# 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).
-
-## chaiConfig.includeStack
-
-- **Type:** `boolean`
-- **Default:** `false`
-
-Influences whether stack trace is included in Assertion error message. Default of false suppresses stack trace in the error message.
-
-## chaiConfig.showDiff
-
-- **Type:** `boolean`
-- **Default:** `true`
-
-Influences whether or not the `showDiff` flag should be included in the thrown AssertionErrors. `false` will always be `false`; `true` will be true when the assertion has requested a diff to be shown.
-
-## chaiConfig.truncateThreshold
-
-- **Type:** `number`
-- **Default:** `40`
-
-Sets length threshold for actual and expected values in assertion errors. If this threshold is exceeded, for example for large data structures, the value is replaced with something like `[ Array(3) ]` or `{ Object (prop1, prop2) }`. Set it to `0` if you want to disable truncating altogether.
-
-This config option affects truncating values in `test.each` titles and inside the assertion error message.

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

@@ -1,22 +0,0 @@
-# clearMocks
-
-- **Type:** `boolean`
-- **Default:** `false`
-
-Should Vitest automatically call [`vi.clearAllMocks()`](/api/vi#vi-clearallmocks) before each test.
-
-This will clear mock history without affecting mock implementations.
-
-```js [vitest.config.js]
-import { defineConfig } from 'vitest/config'
-
-export default defineConfig({
-  test: {
-    clearMocks: 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 clear the mock history for all mocks, including those currently being used by other tests in progress.
-:::