@vitest-agent/mcp 1.0.1 → 1.2.0

package/public/vendor/vitest-docs/api/advanced/test-case.md

@@ -1,302 +0,0 @@
-# TestCase
-
-The `TestCase` class represents a single test. This class is only available in the main thread. Refer to the ["Runner API"](/api/advanced/runner#tasks) if you are working with runtime tasks.
-
-The `TestCase` instance always has a `type` property with the value of `test`. You can use it to distinguish between different task types:
-
-```ts
-if (task.type === 'test') {
-  task // TestCase
-}
-```
-
-## project
-
-This references the [`TestProject`](/api/advanced/test-project) that the test belongs to.
-
-## module
-
-This is a direct reference to the [`TestModule`](/api/advanced/test-module) where the test is defined.
-
-## name
-
-This is a test name that was passed to the `test` function.
-
-```ts
-import { test } from 'vitest'
-
-// [!code word:'the validation works correctly']
-test('the validation works correctly', () => {
-  // ...
-})
-```
-
-## fullName
-
-The name of the test including all parent suites separated with `>` symbol. This test has a full name "the validation logic > the validation works correctly":
-
-```ts
-import { describe, test } from 'vitest'
-
-// [!code word:'the validation works correctly']
-// [!code word:'the validation logic']
-describe('the validation logic', () => {
-  test('the validation works correctly', () => {
-    // ...
-  })
-})
-```
-
-## id
-
-This is test's unique identifier. This ID is deterministic and will be the same for the same test across multiple runs. The ID is based on the [project](/api/advanced/test-project) name, module ID and test order.
-
-The ID looks like this:
-
-```
-1223128da3_0_0
-^^^^^^^^^^ the file hash
-           ^ suite index
-             ^ test index
-```
-
-::: tip
-You can generate file hash with `generateFileHash` function from `vitest/node` which is available since Vitest 3:
-
-```ts
-import { generateFileHash } from 'vitest/node'
-
-const hash = generateFileHash(
-  '/file/path.js', // relative path
-  undefined, // the project name or `undefined` is not set
-)
-```
-:::
-
-::: danger
-Don't try to parse the ID. It can have a minus at the start: `-1223128da3_0_0_0`.
-:::
-
-## location
-
-The location in the module where the test was defined. Locations are collected only if [`includeTaskLocation`](/config/includetasklocation) is enabled in the config. Note that this option is automatically enabled if `--reporter=html`, `--ui` or `--browser` flags are used.
-
-The location of this test will be equal to `{ line: 3, column: 1 }`:
-
-```ts:line-numbers {3}
-import { test } from 'vitest'
-
-test('the validation works correctly', () => {
-  // ...
-})
-```
-
-## parent
-
-Parent [suite](/api/advanced/test-suite). If the test was called directly inside the [module](/api/advanced/test-module), the parent will be the module itself.
-
-## options
-
-```ts
-interface TaskOptions {
-  readonly each: boolean | undefined
-  readonly fails: boolean | undefined
-  readonly concurrent: boolean | undefined
-  readonly shuffle: boolean | undefined
-  readonly retry: number | undefined
-  readonly repeats: number | undefined
-  readonly tags: string[] | undefined
-  readonly timeout: number | undefined
-  readonly mode: 'run' | 'only' | 'skip' | 'todo'
-}
-```
-
-The options that test was collected with.
-
-## tags <Version>4.1.0</Version> {#tags}
-
-[Tags](/guide/test-tags) that were implicitly or explicitly assigned to the test.
-
-## ok
-
-```ts
-function ok(): boolean
-```
-
-Checks if the test did not fail the suite. If the test is not finished yet or was skipped, it will return `true`.
-
-## meta
-
-```ts
-function meta(): TaskMeta
-```
-
-Custom [metadata](/api/advanced/metadata) that was attached to the test during its execution. The meta can be attached by assigning a property to the `ctx.task.meta` object during a test run:
-
-```ts {3,6}
-import { test } from 'vitest'
-
-test('the validation works correctly', ({ task }) => {
-  // ...
-
-  task.meta.decorated = false
-})
-```
-
-If the test did not finish running yet, the meta will be an empty object, unless it has static meta:
-
-```ts
-test('the validation works correctly', { meta: { decorated: true } })
-```
-
-Since Vitest 4.1, Vitest inherits [`meta`](/api/advanced/test-suite#meta) property defined on the [suite](/api/advanced/test-suite).
-
-## result
-
-```ts
-function result(): TestResult
-```
-
-Test results. If test is not finished yet or was just collected, it will be equal to `TestResultPending`:
-
-```ts
-export interface TestResultPending {
-  /**
-   * The test was collected, but didn't finish running yet.
-   */
-  readonly state: 'pending'
-  /**
-   * Pending tests have no errors.
-   */
-  readonly errors: undefined
-}
-```
-
-If the test was skipped, the return value will be `TestResultSkipped`:
-
-```ts
-interface TestResultSkipped {
-  /**
-   * The test was skipped with `skip` or `todo` flag.
-   * You can see which one was used in the `options.mode` option.
-   */
-  readonly state: 'skipped'
-  /**
-   * Skipped tests have no errors.
-   */
-  readonly errors: undefined
-  /**
-   * A custom note passed down to `ctx.skip(note)`.
-   */
-  readonly note: string | undefined
-}
-```
-
-::: tip
-If the test was skipped because another test has `only` flag, the `options.mode` will be equal to `skip`.
-:::
-
-If the test failed, the return value will be `TestResultFailed`:
-
-```ts
-interface TestResultFailed {
-  /**
-   * The test failed to execute.
-   */
-  readonly state: 'failed'
-  /**
-   * Errors that were thrown during the test execution.
-   */
-  readonly errors: ReadonlyArray<TestError>
-}
-```
-
-If the test passed, the return value will be `TestResultPassed`:
-
-```ts
-interface TestResultPassed {
-  /**
-   * The test passed successfully.
-   */
-  readonly state: 'passed'
-  /**
-   * Errors that were thrown during the test execution.
-   */
-  readonly errors: ReadonlyArray<TestError> | undefined
-}
-```
-
-::: warning
-Note that the test with `passed` state can still have errors attached - this can happen if `retry` was triggered at least once.
-:::
-
-## diagnostic
-
-```ts
-function diagnostic(): TestDiagnostic | undefined
-```
-
-Useful information about the test like duration, memory usage, etc:
-
-```ts
-interface TestDiagnostic {
-  /**
-   * If the duration of the test is above `slowTestThreshold`.
-   */
-  readonly slow: boolean
-  /**
-   * The amount of memory used by the test in bytes.
-   * This value is only available if the test was executed with `logHeapUsage` flag.
-   */
-  readonly heap: number | undefined
-  /**
-   * The time it takes to execute the test in ms.
-   */
-  readonly duration: number
-  /**
-   * The time in ms when the test started.
-   */
-  readonly startTime: number
-  /**
-   * The amount of times the test was retried.
-   */
-  readonly retryCount: number
-  /**
-   * The amount of times the test was repeated as configured by `repeats` option.
-   * This value can be lower if the test failed during the repeat and no `retry` is configured.
-   */
-  readonly repeatCount: number
-  /**
-   * If test passed on a second retry.
-   */
-  readonly flaky: boolean
-}
-```
-
-::: info
-`diagnostic()` will return `undefined` if the test was not scheduled to run yet.
-:::
-
-## annotations
-
-```ts
-function annotations(): ReadonlyArray<TestAnnotation>
-```
-
-[Test annotations](/guide/test-annotations) added via the [`task.annotate`](/guide/test-context#annotate) API during the test execution.
-
-## artifacts <Version type="experimental">4.0.11</Version> <Experimental /> {#artifacts}
-
-```ts
-function artifacts(): ReadonlyArray<TestArtifact>
-```
-
-[Test artifacts](/api/advanced/artifacts) recorded via the `recordArtifact` API during the test execution.
-
-## toTestSpecification <Version>4.1.0</Version> {#totestspecification}
-
-```ts
-function toTestSpecification(): TestSpecification
-```
-
-Returns a new [test specification](/api/advanced/test-specification) that can be used to filter or run this specific test case.

package/public/vendor/vitest-docs/api/advanced/test-collection.md

@@ -1,89 +0,0 @@
-# TestCollection
-
-`TestCollection` represents a collection of top-level [suites](/api/advanced/test-suite) and [tests](/api/advanced/test-case) in a suite or a module. It also provides useful methods to iterate over itself.
-
-::: info
-Most methods return an iterator instead of an array for better performance in case you don't need every item in the collection. If you prefer working with array, you can spread the iterator: `[...children.allSuites()]`.
-
-Also note that the collection itself is an iterator:
-
-```ts
-for (const child of module.children) {
-  console.log(child.type, child.name)
-}
-```
-:::
-
-## size
-
-The number of tests and suites in the collection.
-
-::: warning
-This number includes only tests and suites at the top-level, it doesn't include nested suites and tests.
-:::
-
-## at
-
-```ts
-function at(index: number): TestCase | TestSuite | undefined
-```
-
-Returns the test or suite at a specific index. This method accepts negative indexes.
-
-## array
-
-```ts
-function array(): (TestCase | TestSuite)[]
-```
-
-The same collection but as an array. This is useful if you want to use `Array` methods like `map` and `filter` that are not supported by the `TaskCollection` implementation.
-
-## allSuites
-
-```ts
-function allSuites(): Generator<TestSuite, undefined, void>
-```
-
-Filters all suites that are part of this collection and its children.
-
-```ts
-for (const suite of module.children.allSuites()) {
-  if (suite.errors().length) {
-    console.log('failed to collect', suite.errors())
-  }
-}
-```
-
-## allTests
-
-```ts
-function allTests(state?: TestState): Generator<TestCase, undefined, void>
-```
-
-Filters all tests that are part of this collection and its children.
-
-```ts
-for (const test of module.children.allTests()) {
-  if (test.result().state === 'pending') {
-    console.log('test', test.fullName, 'did not finish')
-  }
-}
-```
-
-You can pass down a `state` value to filter tests by the state.
-
-## tests
-
-```ts
-function tests(state?: TestState): Generator<TestCase, undefined, void>
-```
-
-Filters only the tests that are part of this collection. You can pass down a `state` value to filter tests by the state.
-
-## suites
-
-```ts
-function suites(): Generator<TestSuite, undefined, void>
-```
-
-Filters only the suites that are part of this collection.

package/public/vendor/vitest-docs/api/advanced/test-module.md

@@ -1,140 +0,0 @@
-# TestModule
-
-The `TestModule` class represents a single module in a single project. This class is only available in the main thread. Refer to the ["Runner API"](/api/advanced/runner#tasks) if you are working with runtime tasks.
-
-The `TestModule` instance always has a `type` property with the value of `module`. You can use it to distinguish between different task types:
-
-```ts
-if (task.type === 'module') {
-  task // TestModule
-}
-```
-
-::: warning Extending Suite Methods
-The `TestModule` class inherits all methods and properties from the [`TestSuite`](/api/advanced/test-suite). This guide will only list methods and properties unique to the `TestModule`.
-:::
-
-## moduleId
-
-This is usually an absolute unix file path (even on Windows). It can be a virtual id if the file is not on the disk. This value corresponds to Vite's `ModuleGraph` id.
-
-```ts
-'C:/Users/Documents/project/example.test.ts' // ✅
-'/Users/mac/project/example.test.ts' // ✅
-'C:\\Users\\Documents\\project\\example.test.ts' // ❌
-```
-
-## relativeModuleId
-
-Module id relative to the project. This is the same as `task.name` in the deprecated API.
-
-```ts
-'project/example.test.ts' // ✅
-'example.test.ts' // ✅
-'project\\example.test.ts' // ❌
-```
-
-## state
-
-```ts
-function state(): TestModuleState
-```
-
-Works the same way as [`testSuite.state()`](/api/advanced/test-suite#state), but can also return `queued` if module wasn't executed yet.
-
-## meta <Version>3.1.0</Version> {#meta}
-
-```ts
-function meta(): TaskMeta
-```
-
-Custom [metadata](/api/advanced/metadata) that was attached to the module during its execution or collection. The meta can be attached by assigning a property to the `task.meta` object during a test run:
-
-```ts {5,10}
-import { test } from 'vitest'
-
-describe('the validation works correctly', (task) => {
-  // assign "decorated" during collection
-  task.file.meta.decorated = false
-
-  test('some test', ({ task }) => {
-    // assign "decorated" during test run, it will be available
-    // only in onTestCaseReady hook
-    task.file.meta.decorated = false
-  })
-})
-```
-
-:::tip
-If metadata was attached during collection (outside of the `test` function), then it will be available in [`onTestModuleCollected`](./reporters#ontestmodulecollected) hook in the custom reporter.
-:::
-
-## diagnostic
-
-```ts
-function diagnostic(): ModuleDiagnostic
-```
-
-Useful information about the module like duration, memory usage, etc. If the module was not executed yet, all diagnostic values will return `0`.
-
-```ts
-interface ModuleDiagnostic {
-  /**
-   * The time it takes to import and initiate an environment.
-   */
-  readonly environmentSetupDuration: number
-  /**
-   * The time it takes Vitest to setup test harness (runner, mocks, etc.).
-   */
-  readonly prepareDuration: number
-  /**
-   * The time it takes to import the test module.
-   * This includes importing everything in the module and executing suite callbacks.
-   */
-  readonly collectDuration: number
-  /**
-   * The time it takes to import the setup module.
-   */
-  readonly setupDuration: number
-  /**
-   * Accumulated duration of all tests and hooks in the module.
-   */
-  readonly duration: number
-  /**
-   * The amount of memory used by the module in bytes.
-   * This value is only available if the test was executed with `logHeapUsage` flag.
-   */
-  readonly heap: number | undefined
-  /**
-   * The time spent importing every non-externalized dependency that Vitest has processed.
-   */
-  readonly importDurations: Record<string, ImportDuration>
-}
-
-/** The time spent importing & executing a non-externalized file. */
-interface ImportDuration {
-  /** The time spent importing & executing the file itself, not counting all non-externalized imports that the file does. */
-  selfTime: number
-
-  /** The time spent importing & executing the file and all its imports. */
-  totalTime: number
-}
-```
-
-## viteEnvironment <Version>4.1.0</Version> {#viteenvironment}
-
-This is a Vite's [`DevEnvironment`](https://vite.dev/guide/api-environment) that transforms all files inside of the test module.
-
-::: details History
-- `v4.0.15`: added as experimental
-:::
-
-## toTestSpecification <Version>4.1.0</Version> {#totestspecification}
-
-```ts
-function toTestSpecification(testCases?: TestCase[]): TestSpecification
-```
-
-Returns a new [test specification](/api/advanced/test-specification) that can be used to filter or run this specific test module.
-
-It accepts an optional array of test cases that should be filtered.