@vitest-agent/mcp 1.0.0 → 1.0.1

package/public/vendor/vitest-docs/config/diff.md

@@ -0,0 +1,96 @@
+# diff
+
+- **Type:** `string`
+- **CLI:** `--diff=<path>`
+
+`DiffOptions` object or a path to a module which exports `DiffOptions`. Useful if you want to customize diff display.
+
+Vitest diff rendering uses [`@vitest/pretty-format`](https://npmx.dev/package/@vitest/pretty-format) under the hood and a part of `DiffOptions` is forwarded to the pretty-format configuration, while the rest affects diff rendering itself.
+
+For example, as a config object:
+
+```ts
+import { defineConfig } from 'vitest/config'
+import c from 'picocolors'
+
+export default defineConfig({
+  test: {
+    diff: {
+      aIndicator: c.bold('--'),
+      bIndicator: c.bold('++'),
+      omitAnnotationLines: true,
+    },
+  },
+})
+```
+
+Or as a module:
+
+:::code-group
+```ts [vitest.config.js]
+import { defineConfig } from 'vitest/config'
+
+export default defineConfig({
+  test: {
+    diff: './vitest.diff.ts',
+  },
+})
+```
+
+```ts [vitest.diff.ts]
+import type { DiffOptions } from 'vitest'
+import c from 'picocolors'
+
+export default {
+  aIndicator: c.bold('--'),
+  bIndicator: c.bold('++'),
+  omitAnnotationLines: true,
+} satisfies DiffOptions
+```
+:::
+
+## diff.expand
+
+- **Type:** `boolean`
+- **Default:** `true`
+- **CLI:** `--diff.expand=false`
+
+Expand all common lines.
+
+## diff.truncateThreshold
+
+- **Type:** `number`
+- **Default:** `0`
+- **CLI:** `--diff.truncateThreshold=<path>`
+
+The maximum length of diff result to be displayed. Diffs above this threshold will be truncated.
+Truncation won't take effect with default value 0.
+
+## diff.truncateAnnotation
+
+- **Type:** `string`
+- **Default:** `'... Diff result is truncated'`
+- **CLI:** `--diff.truncateAnnotation=<annotation>`
+
+Annotation that is output at the end of diff result if it's truncated.
+
+## diff.truncateAnnotationColor
+
+- **Type:** `DiffOptionsColor = (arg: string) => string`
+- **Default:** `noColor = (string: string): string => string`
+
+Color of truncate annotation, default is output with no color.
+
+## diff.printBasicPrototype
+
+- **Type:** `boolean`
+- **Default:** `false`
+
+Print basic prototype `Object` and `Array` in diff output.
+
+## diff.maxDepth
+
+- **Type:** `number`
+- **Default:** `20` (or `8` when comparing different types)
+
+Limit the depth to recurse when printing nested objects.

package/public/vendor/vitest-docs/config/dir.md

@@ -0,0 +1,7 @@
+# dir
+
+- **Type:** `string`
+- **CLI:** `--dir=<path>`
+- **Default:** same as `root`
+
+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

package/public/vendor/vitest-docs/config/disableconsoleintercept.md

@@ -0,0 +1,15 @@
+# disableConsoleIntercept
+
+- **Type:** `boolean`
+- **CLI:** `--disableConsoleIntercept`
+- **Default:** `false`
+
+By default, Vitest automatically intercepts console logging during tests for extra formatting of test file, test title, etc.
+
+This is also required for console log preview on Vitest UI.
+
+However, disabling such interception might help when you want to debug a code with normal synchronous terminal console logging.
+
+::: warning
+This option has no effect on [browser tests](/guide/browser/) since Vitest preserves original logging in browser devtools.
+:::

package/public/vendor/vitest-docs/config/env.md

@@ -0,0 +1,5 @@
+# env
+
+- **Type:** `Partial<NodeJS.ProcessEnv>`
+
+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).

package/public/vendor/vitest-docs/config/environment.md

@@ -0,0 +1,96 @@
+# environment
+
+- **Type:** `'node' | 'jsdom' | 'happy-dom' | 'edge-runtime' | string`
+- **Default:** `'node'`
+- **CLI:** `--environment=<env>`
+
+The environment that will be used for testing. The default environment in Vitest
+is a Node.js environment. If you are building a web application, you can use
+browser-like environment through either [`jsdom`](https://github.com/jsdom/jsdom)
+or [`happy-dom`](https://github.com/capricorn86/happy-dom) instead.
+If you are building edge functions, you can use [`edge-runtime`](https://edge-runtime.vercel.app/packages/vm) environment
+
+::: tip
+You can also use [Browser Mode](/guide/browser/) to run integration or unit tests in the browser without mocking the environment.
+:::
+
+To define custom options for your environment, use [`environmentOptions`](/config/environmentoptions).
+
+By adding a `@vitest-environment` docblock or comment at the top of the file,
+you can specify another environment to be used for all tests in that file:
+
+Docblock style:
+
+```js
+/**
+ * @vitest-environment jsdom
+ */
+
+test('use jsdom in this test file', () => {
+  const element = document.createElement('div')
+  expect(element).not.toBeNull()
+})
+```
+
+Comment style:
+
+```js
+// @vitest-environment happy-dom
+
+test('use happy-dom in this test file', () => {
+  const element = document.createElement('div')
+  expect(element).not.toBeNull()
+})
+```
+
+For compatibility with Jest, there is also a `@jest-environment`:
+
+```js
+/**
+ * @jest-environment jsdom
+ */
+
+test('use jsdom in this test file', () => {
+  const element = document.createElement('div')
+  expect(element).not.toBeNull()
+})
+```
+
+You can also define a custom environment. When non-builtin environment is used, Vitest will try to load the file if it's relative or absolute, or a package `vitest-environment-${name}`, if the name is a bare specifier.
+
+The custom environment file should export an object with the shape of `Environment`:
+
+```ts [environment.js]
+import type { Environment } from 'vitest'
+
+export default <Environment>{
+  name: 'custom',
+  viteEnvironment: 'ssr',
+  setup() {
+    // custom setup
+    return {
+      teardown() {
+        // called after all tests with this env have been run
+      }
+    }
+  }
+}
+```
+
+::: tip
+The `viteEnvironment` field corresponds to the environment defined by the [Vite Environment API](https://vite.dev/guide/api-environment#environment-api). By default, Vite exposes `client` (for the browser) and `ssr` (for the server) environments.
+:::
+
+Vitest also exposes `builtinEnvironments` through `vitest/environments` entry, in case you just want to extend it. You can read more about extending environments in [our guide](/guide/environment).
+
+::: tip
+jsdom environment exposes `jsdom` global variable equal to the current [JSDOM](https://github.com/jsdom/jsdom) instance. If you want TypeScript to recognize it, you can add `vitest/jsdom` to your `tsconfig.json` when you use this environment:
+
+```json [tsconfig.json]
+{
+  "compilerOptions": {
+    "types": ["vitest/jsdom"]
+  }
+}
+```
+:::

package/public/vendor/vitest-docs/config/environmentoptions.md

@@ -0,0 +1,30 @@
+# environmentOptions
+
+- **Type:** `Record<'jsdom' | 'happyDOM' | string, unknown>`
+- **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.
+
+## Example
+
+```js [vitest.config.js]
+import { defineConfig } from 'vitest/config'
+
+export default defineConfig({
+  test: {
+    environmentOptions: {
+      jsdom: {
+        url: 'http://localhost:3000',
+      },
+      happyDOM: {
+        width: 300,
+        height: 400,
+      },
+    },
+  },
+})
+```
+
+::: warning
+Options are scoped to their environment. For example, put jsdom options under the `jsdom` key and happy-dom options under the `happyDOM` key. This lets you mix multiple environments within the same project.
+:::

package/public/vendor/vitest-docs/config/exclude.md

@@ -0,0 +1,49 @@
+# exclude
+
+- **Type:** `string[]`
+- **Default:** `['**/node_modules/**', '**/.git/**']`
+- **CLI:** `vitest --exclude "**/excluded-file" --exclude "*/other-files/*.js"`
+
+A list of [glob patterns](https://superchupu.dev/tinyglobby/comparison) that should be excluded from your test files. These patterns are resolved relative to the [`root`](/config/root) ([`process.cwd()`](https://nodejs.org/api/process.html#processcwd) by default).
+
+Vitest uses the [`tinyglobby`](https://npmx.dev/package/tinyglobby) package to resolve the globs.
+
+::: warning
+This option does not affect coverage. If you need to remove certain files from the coverage report, use [`coverage.exclude`](/config/coverage#exclude).
+
+This is the only option that doesn't override your configuration if you provide it with a CLI flag. All glob patterns added via `--exclude` flag will be added to the config's `exclude`.
+:::
+
+## Example
+
+```js
+import { defineConfig } from 'vitest/config'
+
+export default defineConfig({
+  test: {
+    exclude: [
+      '**/node_modules/**',
+      '**/dist/**',
+      './temp/**',
+    ],
+  },
+})
+```
+
+::: tip
+Although the CLI `exclude` option is additive, manually setting `exclude` in your config will replace the default value. To extend the default `exclude` patterns, use `configDefaults` from `vitest/config`:
+
+```js{6}
+import { configDefaults, defineConfig } from 'vitest/config'
+
+export default defineConfig({
+  test: {
+    exclude: [
+      ...configDefaults.exclude,
+      'packages/template/*',
+      './temp/**',
+    ],
+  },
+})
+```
+:::

package/public/vendor/vitest-docs/config/execargv.md

@@ -0,0 +1,10 @@
+# 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.
+
+:::warning
+Be careful when using, it as some options may crash worker, e.g. `--prof`, `--title`. See https://github.com/nodejs/node/issues/41103.
+:::

package/public/vendor/vitest-docs/config/expandsnapshotdiff.md

@@ -0,0 +1,7 @@
+# expandSnapshotDiff
+
+- **Type:** `boolean`
+- **CLI:** `--expandSnapshotDiff`, `--expand-snapshot-diff`
+- **Default:** `false`
+
+Show full diff when snapshot fails instead of a patch.

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

@@ -0,0 +1,38 @@
+# expect
+
+- **Type:** `ExpectOptions`
+
+## expect.requireAssertions
+
+- **Type:** `boolean`
+- **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.
+
+::: tip
+This only works with Vitest's `expect`. If you use `assert` or `.should` assertions, they will not count, and your test will fail due to the lack of expect assertions.
+
+You can change the value of this by calling `vi.setConfig({ expect: { requireAssertions: false } })`. The config will be applied to every subsequent `expect` call until the `vi.resetConfig` is called manually.
+:::
+
+::: warning
+When you run tests with `sequence.concurrent` and `expect.requireAssertions` set to `true`, you should use [local expect](/guide/test-context.html#expect) instead of the global one. Otherwise, this may cause false negatives in [some situations (#8469)](https://github.com/vitest-dev/vitest/issues/8469).
+:::
+
+## expect.poll
+
+Global configuration options for [`expect.poll`](/api/expect#poll). These are the same options you can pass down to `expect.poll(condition, options)`.
+
+### expect.poll.interval
+
+- **Type:** `number`
+- **Default:** `50`
+
+Polling interval in milliseconds
+
+### expect.poll.timeout
+
+- **Type:** `number`
+- **Default:** `1000`
+
+Polling timeout in milliseconds