Configuring Vitest

To create a Vitest configuration file, follow the guide. Make sure you understand how Vitest config resolution works before proceeding.

WARNING

All listed options here are located on a test property inside the config:

export default defineConfig({
  test: {
    exclude: [],
  },
})

TIP

In addition to the following options, you can also use any configuration option from Vite. For example, define to define global variables, or resolve.alias to define aliases.

All configuration options that are not supported inside a workspace project config have * sign next to them.

include

Type: string[]
Default: ['**/*.{test,spec}.?(c|m)[jt]s?(x)']
CLI: vitest [...include], vitest **/*.test.js

A list of glob patterns that match your test files.

NOTE

When using coverage, Vitest automatically adds test files include patterns to coverage's default exclude patterns. See coverage.exclude.

exclude

Type: string[]
Default: ['**/node_modules/**', '**/dist/**', '**/cypress/**', '**/.{idea,git,cache,output,temp}/**', '**/{karma,rollup,webpack,vite,vitest,jest,ava,babel,nyc,cypress,tsup,build}.config.*']
CLI: vitest --exclude "**/excluded-file"

A list of glob patterns that should be excluded from your test files.

WARNING

This option does not affect coverage. If you need to remove certain files from the coverage report, use 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.

includeSource

Type: string[]
Default: []

Include globs for in-source test files.

When defined, Vitest will run all matched files with import.meta.vitest inside.

server

Type: { sourcemap?, deps?, ... }

Vite-Node server options.

server.sourcemap

Type: 'inline' | boolean
Default: 'inline'

Inject inline source map to modules.

server.debug

Type: { dumpModules?, loadDumppedModules? }

Vite-Node debugger options.

server.debug.dumpModules

Type: boolean | string

Dump the transformed module to filesystem. Passing a string will dump to the specified path.

server.debug.loadDumppedModules

Type: boolean

Read dumped module from filesystem whenever exists. Useful for debugging by modifying the dump result from the filesystem.

server.deps

Type: { external?, inline?, ... }

Handling for dependencies resolution.

server.deps.external

Type: (string | RegExp)[]
Default: [/\/node_modules\//]

Externalize means that Vite will bypass the package to the native Node. Externalized dependencies will not be applied to Vite's transformers and resolvers, so they do not support HMR on reload. By default, all packages inside node_modules are externalized.

These options support package names as they are written in node_modules or specified inside deps.moduleDirectories. For example, package @company/some-name located inside packages/some-name should be specified as some-name, and packages should be included in deps.moduleDirectories. Basically, Vitest always checks the file path, not the actual package name.

If regexp is used, Vitest calls it on the file path, not the package name.

server.deps.inline

Type: (string | RegExp)[] | true
Default: []

Vite will process inlined modules. This could be helpful to handle packages that ship .js in ESM format (that Node can't handle).

If true, every dependency will be inlined. All dependencies, specified in ssr.noExternal will be inlined by default.

server.deps.fallbackCJS

Type boolean
Default: false

When a dependency is a valid ESM package, try to guess the cjs version based on the path. This might be helpful, if a dependency has the wrong ESM file.

This might potentially cause some misalignment if a package has different logic in ESM and CJS mode.

server.deps.cacheDir

Type string
Default: 'node_modules/.vite'

Directory to save cache files.

deps

Type: { optimizer?, ... }

Handling for dependencies resolution.

deps.optimizer

Type: { ssr?, web? }
See also: Dep Optimization Options

Enable dependency optimization. If you have a lot of tests, this might improve their performance.

When Vitest encounters the external library listed in include, it will be bundled into a single file using esbuild and imported as a whole module. This is good for several reasons:

Importing packages with a lot of imports is expensive. By bundling them into one file we can save a lot of time
Importing UI libraries is expensive because they are not meant to run inside Node.js
Your alias configuration is now respected inside bundled packages
Code in your tests is running closer to how it's running in the browser

Be aware that only packages in deps.optimizer?.[mode].include option are bundled (some plugins populate this automatically, like Svelte). You can read more about available options in Vite docs (Vitest doesn't support disable and noDiscovery options). By default, Vitest uses optimizer.web for jsdom and happy-dom environments, and optimizer.ssr for node and edge environments, but it is configurable by transformMode.

This options also inherits your optimizeDeps configuration (for web Vitest will extend optimizeDeps, for ssr - ssr.optimizeDeps). If you redefine include/exclude option in deps.optimizer it will extend your optimizeDeps when running tests. Vitest automatically removes the same options from include, if they are listed in exclude.

TIP

You will not be able to edit your node_modules code for debugging, since the code is actually located in your cacheDir or test.cache.dir directory. If you want to debug with console.log statements, edit it directly or force rebundling with deps.optimizer?.[mode].force option.

deps.optimizer.{mode}.enabled

Type: boolean
Default: false

Enable dependency optimization.

deps.web

Type: { transformAssets?, ... }

Options that are applied to external files when transform mode is set to web. By default, jsdom and happy-dom use web mode, while node and edge environments use ssr transform mode, so these options will have no affect on files inside those environments.

Usually, files inside node_modules are externalized, but these options also affect files in server.deps.external.

deps.web.transformAssets

Type: boolean
Default: true

Should Vitest process assets (.png, .svg, .jpg, etc) files and resolve them like Vite does in the browser.

This module will have a default export equal to the path to the asset, if no query is specified.

WARNING

At the moment, this option only works with vmThreads and vmForks pools.

deps.web.transformCss

Type: boolean
Default: true

Should Vitest process CSS (.css, .scss, .sass, etc) files and resolve them like Vite does in the browser.

If CSS files are disabled with css options, this option will just silence ERR_UNKNOWN_FILE_EXTENSION errors.

WARNING

At the moment, this option only works with vmThreads and vmForks pools.

deps.web.transformGlobPattern

Type: RegExp | RegExp[]
Default: []

Regexp pattern to match external files that should be transformed.

By default, files inside node_modules are externalized and not transformed, unless it's CSS or an asset, and corresponding option is not disabled.

WARNING

At the moment, this option only works with vmThreads and vmForks pools.

deps.interopDefault

Type: boolean
Default: true

Interpret CJS module's default as named exports. Some dependencies only bundle CJS modules and don't use named exports that Node.js can statically analyze when a package is imported using import syntax instead of require. When importing such dependencies in Node environment using named exports, you will see this error:

import { read } from 'fs-jetpack';
         ^^^^
SyntaxError: Named export 'read' not found. The requested module 'fs-jetpack' is a CommonJS module, which may not support all module.exports as named exports.
CommonJS modules can always be imported via the default export.

Vitest doesn't do static analysis, and cannot fail before your running code, so you will most likely see this error when running tests, if this feature is disabled:

TypeError: createAsyncThunk is not a function
TypeError: default is not a function

By default, Vitest assumes you are using a bundler to bypass this and will not fail, but you can disable this behaviour manually, if you code is not processed.

deps.moduleDirectories

Type: string[]
Default: ['node_modules']

A list of directories that should be treated as module directories. This config option affects the behavior of vi.mock: when no factory is provided and the path of what you are mocking matches one of the moduleDirectories values, Vitest will try to resolve the mock by looking for a __mocks__ folder in the root of the project.

This option will also affect if a file should be treated as a module when externalizing dependencies. By default, Vitest imports external modules with native Node.js bypassing Vite transformation step.

Setting this option will override the default, if you wish to still search node_modules for packages include it along with any other options:

import { defineConfig } from 'vitest/config'

export default defineConfig({
  test: {
    deps: {
      moduleDirectories: ['node_modules', path.resolve('../../packages')],
    }
  },
})

runner

Type: VitestRunnerConstructor
Default: node, when running tests, or benchmark, when running benchmarks

Path to a custom test runner. This is an advanced feature and should be used with custom library runners. You can read more about it in the documentation.

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.

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

Type: string | undefined
Default: undefined

A file path to store the benchmark result, which can be used for --compare option later.

For example:

# 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

Type: string | undefined
Default: undefined

A file path to a previous benchmark result to compare against current runs.

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.

Aliases affect only modules imported directly with an import keyword by an inlined module (all source code is inlined by default).
Vitest does not support aliasing require calls.
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 and pnpm support aliasing via the npm: prefix.

globals

Type: boolean
Default: false
CLI: --globals, --globals=false

By default, vitest does not provide global APIs for explicitness. If you prefer to use the APIs globally like Jest, you can pass the --globals option to CLI or add globals: true in the config.

// vitest.config.ts
import { defineConfig } from 'vitest/config'

export default defineConfig({
  test: {
    globals: true,
  },
})

To get TypeScript working with the global APIs, add vitest/globals to the types field in your tsconfig.json

json

// tsconfig.json
{
  "compilerOptions": {
    "types": ["vitest/globals"]
  }
}

If you are already using unplugin-auto-import in your project, you can also use it directly for auto importing those APIs.

// vitest.config.ts
import { defineConfig } from 'vitest/config'
import AutoImport from 'unplugin-auto-import/vite'

export default defineConfig({
  plugins: [
    AutoImport({
      imports: ['vitest'],
      dts: true, // generate TypeScript declaration
    }),
  ],
})

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 or happy-dom instead. If you are building edge functions, you can use edge-runtime environment

TIP

You can also use Browser Mode to run integration or unit tests in the browser without mocking the environment.

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:

/**
 * @vitest-environment jsdom
 */

test('use jsdom in this test file', () => {
  const element = document.createElement('div')
  expect(element).not.toBeNull()
})

Comment style:

// @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:

/**
 * @jest-environment jsdom
 */

test('use jsdom in this test file', () => {
  const element = document.createElement('div')
  expect(element).not.toBeNull()
})

If you are running Vitest with --isolate=false flag, your tests will be run in this order: node, jsdom, happy-dom, edge-runtime, custom environments. Meaning, that every test with the same environment is grouped, but is still running sequentially.

Starting from 0.23.0, you can also define custom environment. When non-builtin environment is used, Vitest will try to load package vitest-environment-${name}. That package should export an object with the shape of Environment:

import type { Environment } from 'vitest'

export default <Environment>{
  name: 'custom',
  transformMode: 'ssr',
  setup() {
    // custom setup
    return {
      teardown() {
        // called after all tests with this env have been run
      }
    }
  }
}

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.

TIP

jsdom environment exposes jsdom global variable equal to the current JSDOM instance. If you want TypeScript to recognize it, you can add vitest/jsdom to your tsconfig.json when you use this environment:

json

{
  "compilerOptions": {
    "types": ["vitest/jsdom"]
  }
}

environmentOptions

Type: Record<'jsdom' | string, unknown>
Default: {}

These options are passed down to setup method of current environment. By default, you can configure only JSDOM options, if you are using it as your test environment.

environmentMatchGlobs

Type: [string, EnvironmentName][]
Default: []

Automatically assign environment based on globs. The first match will be used.

For example:

import { defineConfig } from 'vitest/config'

export default defineConfig({
  test: {
    environmentMatchGlobs: [
      // all tests in tests/dom will run in jsdom
      ['tests/dom/**', 'jsdom'],
      // all tests in tests/ with .edge.test.ts will run in edge-runtime
      ['**\/*.edge.test.ts', 'edge-runtime'],
      // ...
    ]
  }
})

poolMatchGlobs

Type: [string, 'threads' | 'forks' | 'vmThreads' | 'vmForks' | 'typescript'][]
Default: []

Automatically assign pool in which tests will run based on globs. The first match will be used.

For example:

import { defineConfig } from 'vitest/config'

export default defineConfig({
  test: {
    poolMatchGlobs: [
      // all tests in "worker-specific" directory will run inside a worker as if you enabled `--pool=threads` for them,
      ['**/tests/worker-specific/**', 'threads'],
      // run all tests in "browser" directory in an actual browser
      ['**/tests/browser/**', 'browser'],
      // all other tests will run based on "browser.enabled" and "threads" options, if you didn't specify other globs
      // ...
    ]
  }
})

update *

Type: boolean
Default: false
CLI: -u, --update, --update=false

Update snapshot files. This will update all changed snapshots and delete obsolete ones.

watch *

Type: boolean
Default: !process.env.CI
CLI: -w, --watch, --watch=false

Enable watch mode

root

Type: string
CLI: -r <path>, --root=<path>

Project root

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

reporters *

Type: Reporter | Reporter[]
Default: 'default'
CLI: --reporter=<name>, --reporter=<name1> --reporter=<name2>

Custom reporters for output. Reporters can be a Reporter instance, a string to select built-in reporters, or a path to a custom implementation (e.g. './path/to/reporter.ts', '@scope/reporter').

outputFile *

Type: string | Record<string, string>
CLI: --outputFile=<path>, --outputFile.json=./path

Write test results to a file when the --reporter=json, --reporter=html or --reporter=junit option is also specified. By providing an object instead of a string you can define individual outputs when using multiple reporters.

pool *

Type: 'threads' | 'forks' | 'vmThreads' | 'vmForks'
Default: 'forks'
CLI: --pool=threads

Pool used to run tests in.

threads *

Enable multi-threading using tinypool (a lightweight fork of Piscina). When using threads you are unable to use process related APIs such as process.chdir(). Some libraries written in native languages, such as Prisma, bcrypt and canvas, have problems when running in multiple threads and run into segfaults. In these cases it is advised to use forks pool instead.

forks *

Similar as threads pool but uses child_process instead of worker_threads via tinypool. Communication between tests and main process is not as fast as with threads pool. Process related APIs such as process.chdir() are available in forks pool.

vmThreads *

Run tests using VM context (inside a sandboxed environment) in a threads pool.

This makes tests run faster, but the VM module is unstable when running ESM code. Your tests will leak memory - to battle that, consider manually editing poolOptions.vmThreads.memoryLimit value.

WARNING

Running code in a sandbox has some advantages (faster tests), but also comes with a number of disadvantages.

The globals within native modules, such as (fs, path, etc), differ from the globals present in your test environment. As a result, any error thrown by these native modules will reference a different Error constructor compared to the one used in your code:

try {
  fs.writeFileSync('/doesnt exist')
}
catch (err) {
  console.log(err instanceof Error) // false
}

Importing ES modules caches them indefinitely which introduces memory leaks if you have a lot of contexts (test files). There is no API in Node.js that clears that cache.
Accessing globals takes longer in a sandbox environment.

Please, be aware of these issues when using this option. Vitest team cannot fix any of the issues on our side.

vmForks *

Similar as vmThreads pool but uses child_process instead of worker_threads via tinypool. Communication between tests and the main process is not as fast as with vmThreads pool. Process related APIs such as process.chdir() are available in vmForks pool. Please be aware that this pool has the same pitfalls listed in vmThreads.

poolOptions *

Type: Record<'threads' | 'forks' | 'vmThreads' | 'vmForks', {}>
Default: {}

poolOptions.threads

Options for threads pool.

import { defineConfig } from 'vitest/config'

export default defineConfig({
  test: {
    poolOptions: {
      threads: {
        // Threads related options here
      }
    }
  }
})

poolOptions.threads.maxThreads *

Type: number | string
Default: available CPUs

Maximum number or percentage of threads. You can also use VITEST_MAX_THREADS environment variable.

poolOptions.threads.minThreads *

Type: number | string
Default: available CPUs

Minimum number or percentage of threads. You can also use VITEST_MIN_THREADS environment variable.

poolOptions.threads.singleThread

Type: boolean
Default: false

Run all tests with the same environment inside a single worker thread. This will disable built-in module isolation (your source code or inlined code will still be reevaluated for each test), but can improve test performance.

WARNING

Even though this option will force tests to run one after another, this option is different from Jest's --runInBand. Vitest uses workers not only for running tests in parallel, but also to provide isolation. By disabling this option, your tests will run sequentially, but in the same global context, so you must provide isolation yourself.

This might cause all sorts of issues, if you are relying on global state (frontend frameworks usually do) or your code relies on environment to be defined separately for each test. But can be a speed boost for your tests (up to 3 times faster), that don't necessarily rely on global state or can easily bypass that.

poolOptions.threads.useAtomics *

Type: boolean
Default: false

Use Atomics to synchronize threads.

This can improve performance in some cases, but might cause segfault in older Node versions.

poolOptions.threads.isolate

Type: boolean
Default: true

Isolate environment for each test file.

poolOptions.threads.execArgv *

Type: string[]
Default: []

Pass additional arguments to node in the threads. See Command-line API | Node.js 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.

poolOptions.forks

Options for forks pool.

import { defineConfig } from 'vitest/config'

export default defineConfig({
  test: {
    poolOptions: {
      forks: {
        // Forks related options here
      }
    }
  }
})

poolOptions.forks.maxForks *

Type: number | string
Default: available CPUs

Maximum number or percentage of forks.

poolOptions.forks.minForks *

Type: number | string
Default: available CPUs

Minimum number or percentage of forks.

poolOptions.forks.isolate

Type: boolean
Default: true

Isolate environment for each test file.

poolOptions.forks.singleFork

Type: boolean
Default: false

Run all tests with the same environment inside a single child process. This will disable built-in module isolation (your source code or inlined code will still be reevaluated for each test), but can improve test performance.

WARNING

Even though this option will force tests to run one after another, this option is different from Jest's --runInBand. Vitest uses child processes not only for running tests in parallel, but also to provide isolation. By disabling this option, your tests will run sequentially, but in the same global context, so you must provide isolation yourself.

poolOptions.forks.execArgv *

Type: string[]
Default: []

Pass additional arguments to node process in the child processes. See Command-line API | Node.js 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.

poolOptions.vmThreads

Options for vmThreads pool.

import { defineConfig } from 'vitest/config'

export default defineConfig({
  test: {
    poolOptions: {
      vmThreads: {
        // VM threads related options here
      }
    }
  }
})

poolOptions.vmThreads.maxThreads *

Type: number | string
Default: available CPUs

Maximum number or percentage of threads. You can also use VITEST_MAX_THREADS environment variable.

poolOptions.vmThreads.minThreads *

Type: number | string
Default: available CPUs

Minimum number or percentage of threads. You can also use VITEST_MIN_THREADS environment variable.

poolOptions.vmThreads.memoryLimit *

Type: string | number
Default: 1 / CPU Cores

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.

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 workers due to incorrect system memory being reported.

poolOptions.vmThreads.useAtomics *

Type: boolean
Default: false

Use Atomics to synchronize threads.

This can improve performance in some cases, but might cause segfault in older Node versions.

poolOptions.vmThreads.execArgv *

Type: string[]
Default: []

Pass additional arguments to node process in the VM context. See Command-line API | Node.js 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.

poolOptions.vmForks *

Options for vmForks pool.

import { defineConfig } from 'vitest/config'

export default defineConfig({
  test: {
    poolOptions: {
      vmForks: {
        // VM forks related options here
      }
    }
  }
})

poolOptions.vmForks.maxForks *

Type: number | string
Default: available CPUs

Maximum number or percentage of threads. You can also use VITEST_MAX_FORKS environment variable.

poolOptions.vmForks.minForks *

Type: number | string
Default: available CPUs

Minimum number or percentage of threads. You can also use VITEST_MIN_FORKS environment variable.

poolOptions.vmForks.memoryLimit *

Type: string | number
Default: 1 / CPU Cores

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. How the value is calculated is described in poolOptions.vmThreads.memoryLimit

poolOptions.vmForks.execArgv *

Type: string[]
Default: []

Pass additional arguments to node process in the VM context. See Command-line API | Node.js 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.

fileParallelism *

Type: boolean
Default: true
CLI: --no-file-parallelism, --fileParallelism=false

Should all test files run in parallel. Setting this to false will override maxWorkers and minWorkers options to 1.

TIP

This option doesn't affect tests running in the same file. If you want to run those in parallel, use concurrent option on describe or via a config.

maxWorkers *

Type: number | string

Maximum number or percentage of workers to run tests in. poolOptions.{threads,vmThreads}.maxThreads/poolOptions.forks.maxForks has higher priority.

minWorkers *

Type: number | string

Minimum number or percentage of workers to run tests in. poolOptions.{threads,vmThreads}.minThreads/poolOptions.forks.minForks has higher priority.

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

hookTimeout

Type: number
Default: 10_000 in Node.js, 30_000 if browser.enabled is true
CLI: --hook-timeout=10000, --hookTimeout=10000

Default timeout of a hook in milliseconds

teardownTimeout *

Type: number
Default: 10000
CLI: --teardown-timeout=5000, --teardownTimeout=5000

Default timeout to wait for close when Vitest shuts down, in milliseconds

silent *

Type: boolean
Default: false
CLI: --silent, --silent=false

Silent console output from tests

setupFiles

Type: string | string[]

Path to setup files. They will be run before each test file.

INFO

Editing a setup file will automatically trigger a rerun of all tests.

You can use process.env.VITEST_POOL_ID (integer-like string) inside to distinguish between threads.

TIP

Note, that if you are running --isolate=false, this setup file will be run in the same global scope multiple times. Meaning, that you are accessing the same global object before each test, so make sure you are not doing the same thing more than you need.

For example, you may rely on a global variable:

import { config } from '@some-testing-lib'

if (!globalThis.defined) {
  config.plugins = [myCoolPlugin]
  computeHeavyThing()
  globalThis.defined = true
}

// hooks are reset before each suite
afterEach(() => {
  cleanup()
})

globalThis.resetBeforeEachTest = true

provide 2.1.0+

Type: Partial<ProvidedContext>

Define values that can be accessed inside your tests using inject method.

vitest.config.jsmy.test.js

import { defineConfig } from 'vitest/config'

export default defineConfig({
  test: {
    provide: {
      API_KEY: '123',
    },
  },
})

import { expect, inject, test } from 'vitest'

test('api key is defined', () => {
  expect(inject('API_KEY')).toBe('123')
})

WARNING

Properties have to be strings and values need to be serializable because this object will be transferred between different processes.

TIP

If you are using TypeScript, you will need to augment ProvidedContext type for type safe access:

// vitest.shims.d.ts

declare module 'vitest' {
  export interface ProvidedContext {
    API_KEY: string
  }
}

// mark this file as a module so augmentation works correctly
export {}

globalSetup

Type: string | string[]

Path to global setup files, relative to project root.

A global setup file can either export named functions setup and teardown or a default function that returns a teardown function (example).

INFO

Multiple globalSetup files are possible. setup and teardown are executed sequentially with teardown in reverse order.

WARNING

Global setup runs only if there is at least one running test. This means that global setup might start running during watch mode after test file is changed (the test file will wait for global setup to finish before running).

Beware that the global setup is running in a different global scope, so your tests don't have access to variables defined here. However, you can pass down serializable data to tests via provide method:

globalSetup.jsglobalSetup.tsexample.test.js

export default function setup({ provide }) {
  provide('wsPort', 3000)
}

import type { GlobalSetupContext } from 'vitest/node'

export default function setup({ provide }: GlobalSetupContext) {
  provide('wsPort', 3000)
}

declare module 'vitest' {
  export interface ProvidedContext {
    wsPort: number
  }
}

import { inject } from 'vitest'

inject('wsPort') === 3000

Since Vitest 2.2.0, you can define a custom callback function to be called when Vitest reruns tests. If the function is asynchronous, the runner will wait for it to complete before executing the tests.

import type { GlobalSetupContext } from 'vitest/node'

export default function setup({ onTestsRerun }: GlobalSetupContext) {
  onTestsRerun(async () => {
    await restartDb()
  })
}

forceRerunTriggers *

Type: string[]
Default: ['**/package.json/**', '**/vitest.config.*/**', '**/vite.config.*/**']

Glob pattern of file paths that will trigger the whole suite rerun. When paired with the --changed argument will run the whole test suite if the trigger is found in the git diff.

Useful if you are testing calling CLI commands, because Vite cannot construct a module graph:

test('execute a script', async () => {
  // Vitest cannot rerun this test, if content of `dist/index.js` changes
  await execa('node', ['dist/index.js'])
})

TIP

Make sure that your files are not excluded by server.watch.ignored.

coverage *

You can use v8, istanbul or a custom coverage solution for coverage collection.

You can provide coverage options to CLI with dot notation:

npx vitest --coverage.enabled --coverage.provider=istanbul --coverage.all

WARNING

If you are using coverage options with dot notation, don't forget to specify --coverage.enabled. Do not provide a single --coverage option in that case.

coverage.provider

Type: 'v8' | 'istanbul' | 'custom'
Default: 'v8'
CLI: --coverage.provider=<provider>

Use provider to select the tool for coverage collection.

coverage.enabled

Type: boolean
Default: false
Available for providers: 'v8' | 'istanbul'
CLI: --coverage.enabled, --coverage.enabled=false

Enables coverage collection. Can be overridden using --coverage CLI option.

coverage.include

Type: string[]
Default: ['**']
Available for providers: 'v8' | 'istanbul'
CLI: --coverage.include=<path>, --coverage.include=<path1> --coverage.include=<path2>

List of files included in coverage as glob patterns

coverage.extension

Type: string | string[]
Default: ['.js', '.cjs', '.mjs', '.ts', '.mts', '.tsx', '.jsx', '.vue', '.svelte', '.marko', '.astro']
Available for providers: 'v8' | 'istanbul'
CLI: --coverage.extension=<extension>, --coverage.extension=<extension1> --coverage.extension=<extension2>

coverage.exclude

Type: string[]
Default:

[
  'coverage/**',
  'dist/**',
  '**/node_modules/**',
  '**/[.]**',
  'packages/*/test?(s)/**',
  '**/*.d.ts',
  '**/virtual:*',
  '**/__x00__*',
  '**/\x00*',
  'cypress/**',
  'test?(s)/**',
  'test?(-*).?(c|m)[jt]s?(x)',
  '**/*{.,-}{test,spec,bench,benchmark}?(-d).?(c|m)[jt]s?(x)',
  '**/__tests__/**',
  '**/{karma,rollup,webpack,vite,vitest,jest,ava,babel,nyc,cypress,tsup,build,eslint,prettier}.config.*',
  '**/vitest.{workspace,projects}.[jt]s?(on)',
  '**/.{eslint,mocha,prettier}rc.{?(c|m)js,yml}',
]

Available for providers: 'v8' | 'istanbul'
CLI: --coverage.exclude=<path>, --coverage.exclude=<path1> --coverage.exclude=<path2>

List of files excluded from coverage as glob patterns.

This option overrides all default options. Extend the default options when adding new patterns to ignore:

import { coverageConfigDefaults, defineConfig } from 'vitest/config'

export default defineConfig({
  test: {
    coverage: {
      exclude: ['**/custom-pattern/**', ...coverageConfigDefaults.exclude]
    },
  },
})

NOTE

Vitest automatically adds test files include patterns to the default value of coverage.exclude.

coverage.all

Type: boolean
Default: true
Available for providers: 'v8' | 'istanbul'
CLI: --coverage.all, --coverage.all=false

Whether to include all files, including the untested ones into report.

coverage.clean

Type: boolean
Default: true
Available for providers: 'v8' | 'istanbul'
CLI: --coverage.clean, --coverage.clean=false

Clean coverage results before running tests

coverage.cleanOnRerun

Type: boolean
Default: true
Available for providers: 'v8' | 'istanbul'
CLI: --coverage.cleanOnRerun, --coverage.cleanOnRerun=false

Clean coverage report on watch rerun. Set to false to preserve coverage results from previous run in watch mode.

coverage.reportsDirectory

Type: string
Default: './coverage'
Available for providers: 'v8' | 'istanbul'
CLI: --coverage.reportsDirectory=<path>

WARNING

Vitest will delete this directory before running tests if coverage.clean is enabled (default value).

Directory to write coverage report to.

To preview the coverage report in the output of HTML reporter, this option must be set as a sub-directory of the html report directory (for example ./html/coverage).

coverage.reporter

Type: string | string[] | [string, {}][]
Default: ['text', 'html', 'clover', 'json']
Available for providers: 'v8' | 'istanbul'
CLI: --coverage.reporter=<reporter>, --coverage.reporter=<reporter1> --coverage.reporter=<reporter2>

Coverage reporters to use. See istanbul documentation for detailed list of all reporters. See @types/istanbul-reporter for details about reporter specific options.

The reporter has three different types:

A single reporter: { reporter: 'html' }
Multiple reporters without options: { reporter: ['html', 'json'] }

A single or multiple reporters with reporter options:

{
  reporter: [
    ['lcov', { 'projectRoot': './src' }],
    ['json', { 'file': 'coverage.json' }],
    ['text']
  ]
}

You can also pass custom coverage reporters. See Guide - Custom Coverage Reporter for more information.

  {
    reporter: [
      // Specify reporter using name of the NPM package
      '@vitest/custom-coverage-reporter',
      ['@vitest/custom-coverage-reporter', { someOption: true }],

      // Specify reporter using local path
      '/absolute/path/to/custom-reporter.cjs',
      ['/absolute/path/to/custom-reporter.cjs', { someOption: true }],
    ]
  }

You can check your coverage report in Vitest UI: check Vitest UI Coverage for more details.

coverage.reportOnFailure

Type: boolean
Default: false
Available for providers: 'v8' | 'istanbul'
CLI: --coverage.reportOnFailure, --coverage.reportOnFailure=false

Generate coverage report even when tests fail.

coverage.allowExternal

Type: boolean
Default: false
Available for providers: 'v8' | 'istanbul'
CLI: --coverage.allowExternal, --coverage.allowExternal=false

Collect coverage of files outside the project root.

coverage.excludeAfterRemap 2.1.0+

Type: boolean
Default: false
Available for providers: 'v8' | 'istanbul'
CLI: --coverage.excludeAfterRemap, --coverage.excludeAfterRemap=false

Apply exclusions again after coverage has been remapped to original sources. This is useful when your source files are transpiled and may contain source maps of non-source files.

Use this option when you are seeing files that show up in report even if they match your coverage.exclude patterns.

coverage.skipFull

Type: boolean
Default: false
Available for providers: 'v8' | 'istanbul'
CLI: --coverage.skipFull, --coverage.skipFull=false

Do not show files with 100% statement, branch, and function coverage.

coverage.thresholds

Options for coverage thresholds

coverage.thresholds.lines

Type: number
Available for providers: 'v8' | 'istanbul'
CLI: --coverage.thresholds.lines=<number>

Global threshold for lines. See istanbul documentation for more information.

coverage.thresholds.functions

Type: number
Available for providers: 'v8' | 'istanbul'
CLI: --coverage.thresholds.functions=<number>

Global threshold for functions. See istanbul documentation for more information.

coverage.thresholds.branches

Type: number
Available for providers: 'v8' | 'istanbul'
CLI: --coverage.thresholds.branches=<number>

Global threshold for branches. See istanbul documentation for more information.

coverage.thresholds.statements

Type: number
Available for providers: 'v8' | 'istanbul'
CLI: --coverage.thresholds.statements=<number>

Global threshold for statements. See istanbul documentation for more information.

coverage.thresholds.perFile

Type: boolean
Default: false
Available for providers: 'v8' | 'istanbul'
CLI: --coverage.thresholds.perFile, --coverage.thresholds.perFile=false

Check thresholds per file.

coverage.thresholds.autoUpdate

Type: boolean
Default: false
Available for providers: 'v8' | 'istanbul'
CLI: --coverage.thresholds.autoUpdate=<boolean>

Update all threshold values lines, functions, branches and statements to configuration file when current coverage is above the configured thresholds. This option helps to maintain thresholds when coverage is improved.

coverage.thresholds.100

Type: boolean
Default: false
Available for providers: 'v8' | 'istanbul'
CLI: --coverage.thresholds.100, --coverage.thresholds.100=false

Sets global thresholds to 100. Shortcut for --coverage.thresholds.lines 100 --coverage.thresholds.functions 100 --coverage.thresholds.branches 100 --coverage.thresholds.statements 100.

coverage.thresholds[glob-pattern]

Type: { statements?: number functions?: number branches?: number lines?: number }
Default: undefined
Available for providers: 'v8' | 'istanbul'

Sets thresholds for files matching the glob pattern.

NOTE

Vitest counts all files, including those covered by glob-patterns, into the global coverage thresholds. This is different from Jest behavior.

{
  coverage: {
    thresholds: {
      // Thresholds for all files
      functions: 95,
      branches: 70,

      // Thresholds for matching glob pattern
      'src/utils/**.ts': {
        statements: 95,
        functions: 90,
        branches: 85,
        lines: 80,
      },

      // Files matching this pattern will only have lines thresholds set.
      // Global thresholds are not inherited.
      '**/math.ts': {
        lines: 100,
      }
    }
  }
}

coverage.thresholds[glob-pattern].100 2.1.0+

Type: boolean
Default: false
Available for providers: 'v8' | 'istanbul'

Sets thresholds to 100 for files matching the glob pattern.

{
  coverage: {
    thresholds: {
      // Thresholds for all files
      functions: 95,
      branches: 70,

      // Thresholds for matching glob pattern
      'src/utils/**.ts': { 100: true },
      '**/math.ts': { 100: true }
    }
  }
}

coverage.ignoreEmptyLines

Type: boolean
Default: true (false in v1)
Available for providers: 'v8'
CLI: --coverage.ignoreEmptyLines=<boolean>

Ignore empty lines, comments and other non-runtime code, e.g. Typescript types.

This option works only if the used compiler removes comments and other non-runtime code from the transpiled code. By default Vite uses ESBuild which removes comments and Typescript types from .ts, .tsx and .jsx files.

If you want to apply ESBuild to other files as well, define them in esbuild options:

import { defineConfig } from 'vitest/config'

export default defineConfig({
  esbuild: {
    // Transpile all files with ESBuild to remove comments from code coverage.
    // Required for `test.coverage.ignoreEmptyLines` to work:
    include: ['**/*.js', '**/*.jsx', '**/*.mjs', '**/*.ts', '**/*.tsx'],
  },
  test: {
    coverage: {
      provider: 'v8',
      ignoreEmptyLines: true,
    },
  },
})

coverage.ignoreClassMethods

Type: string[]
Default: []
Available for providers: 'istanbul'
CLI: --coverage.ignoreClassMethods=<method>

Set to array of class method names to ignore for coverage. See istanbul documentation for more information.

coverage.watermarks

Type:

{
  statements?: [number, number],
  functions?: [number, number],
  branches?: [number, number],
  lines?: [number, number]
}

Default:

{
  statements: [50, 80],
  functions: [50, 80],
  branches: [50, 80],
  lines: [50, 80]
}

Available for providers: 'v8' | 'istanbul'
CLI: --coverage.watermarks.statements=50,80, --coverage.watermarks.branches=50,80

Watermarks for statements, lines, branches and functions. See istanbul documentation for more information.

coverage.processingConcurrency

Type: boolean
Default: Math.min(20, os.availableParallelism?.() ?? os.cpus().length)
Available for providers: 'v8' | 'istanbul'
CLI: --coverage.processingConcurrency=<number>

Concurrency limit used when processing the coverage results.

coverage.customProviderModule

Type: string
Available for providers: 'custom'
CLI: --coverage.customProviderModule=<path or module name>

Specifies the module name or path for the custom coverage provider module. See Guide - Custom Coverage Provider for more information.

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.

import { expect, test } from 'vitest'

// run
test('OnlyRunThis', () => {
  expect(true).toBe(true)
})

// skipped
test('doNotRun', () => {
  expect(true).toBe(true)
})

open *

Type: boolean
Default: !process.env.CI
CLI: --open, --open=false

Open Vitest UI (WIP)

api

Type: boolean | number
Default: false
CLI: --api, --api.port, --api.host, --api.strictPort

Listen to port and serve API. When set to true, the default port is 51204

browser

Type: { enabled?, name?, provider?, headless?, api? }
Default: { enabled: false, headless: process.env.CI, api: 63315 }
CLI: --browser, --browser=<name>, --browser.name=chrome --browser.headless

Run Vitest tests in a browser. We use WebdriverIO for running tests by default, but it can be configured with browser.provider option.

NOTE

Read more about testing in a real browser in the guide page.

WARNING

This is an experimental feature. Breaking changes might not follow SemVer, please pin Vitest's version when using it.

browser.enabled

Type: boolean
Default: false
CLI: --browser, --browser.enabled=false

Run all tests inside a browser by default. Can be overridden with poolMatchGlobs option.

browser.name

Type: string
CLI: --browser=safari

Run all tests in a specific browser. Possible options in different providers:

webdriverio: firefox, chrome, edge, safari
playwright: firefox, webkit, chromium
custom: any string that will be passed to the provider

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.

browser.isolate

Type: boolean
Default: true
CLI: --browser.isolate, --browser.isolate=false

Run every test in a separate iframe.

browser.testerHtmlPath

Type: string
Default: @vitest/browser/tester.html
Version: Since Vitest 2.1.4

A path to the HTML entry point. Can be relative to the root of the project. This file will be processed with transformIndexHtml hook.

browser.api

Type: number | { port?, strictPort?, host? }
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 option. By default, Vitest assigns port 63315 to avoid conflicts with the development server, allowing you to run both in parallel.

browser.provider

Type: 'webdriverio' | 'playwright' | 'preview' | string
Default: 'preview'
CLI: --browser.provider=playwright

Path to a provider that will be used when running browser tests. Vitest provides three providers which are preview (default), webdriverio and playwright. Custom providers should be exported using default export and have this shape:

export interface BrowserProvider {
  name: string
  getSupportedBrowsers: () => readonly string[]
  initialize: (ctx: Vitest, options: { browser: string; options?: BrowserProviderOptions }) => Awaitable<void>
  openPage: (url: string) => Awaitable<void>
  close: () => Awaitable<void>
}

WARNING

This is an advanced API for library authors. If you just need to run tests in a browser, use the browser option.

browser.providerOptions

Type: BrowserProviderOptions

Options that will be passed down to provider when calling provider.initialize.

export default defineConfig({
  test: {
    browser: {
      providerOptions: {
        launch: {
          devtools: true,
        }
      }
    }
  }
})

TIP

To have a better type safety when using built-in providers, you can add one of these types (for provider that you are using) to your tsconfig's compilerOptions.types field:

json

{
  "compilerOptions": {
    "types": [
      "@vitest/browser/providers/webdriverio",
      "@vitest/browser/providers/playwright"
    ]
  }
}

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.

browser.viewport

Type: { width, height }
Default: 414x896

Default iframe's viewport.

browser.locators

Options for built-in browser locators.

browser.locators.testIdAttribute

Type: string
Default: data-testid

Attribute used to find elements with getByTestId locator.

browser.screenshotDirectory

Type: string
Default: __snapshots__ in the test file directory

Path to the snapshots directory relative to the root.

browser.screenshotFailures

Type: boolean
Default: !browser.ui

Should Vitest take screenshots if the test fails.

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:

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
}

browser.testerScripts

Type: BrowserScript[]
Default: []

Custom scripts that should be injected into the tester HTML before the tests environment is initiated. This is useful to inject polyfills required for Vitest browser implementation. It is recommended to use setupFiles in almost all cases instead of this.

The script src and content will be processed by Vite plugins.

browser.commands

Type: Record<string, BrowserCommand>
Default: { readFile, writeFile, ... }

Custom commands that can be imported during browser tests from @vitest/browser/commands.

clearMocks

Type: boolean
Default: false

Will call .mockClear() on all spies before each test. This will clear mock history, but not reset its implementation to the default one.

mockReset

Type: boolean
Default: false

Will call .mockReset() on all spies before each test. This will clear mock history and reset its implementation to an empty function (will return undefined).

restoreMocks

Type: boolean
Default: false

Will call .mockRestore() on all spies before each test. This will clear mock history and reset its implementation to the original one.

unstubEnvs

Type: boolean
Default: false

Will call vi.unstubAllEnvs before each test.

unstubGlobals

Type: boolean
Default: false

Will call vi.unstubAllGlobals before each test.

testTransformMode

Type: { web?, ssr? }

Determine the transform method for all modules imported inside a test that matches the glob pattern. By default, relies on the environment. For example, tests with JSDOM environment will process all files with ssr: false flag and tests with Node environment process all modules with ssr: true.

testTransformMode.ssr

Type: string[]
Default: []

Use SSR transform pipeline for all modules inside specified tests.
Vite plugins will receive ssr: true flag when processing those files.

testTransformMode.web

Type: string[]
Default: []

First do a normal transform pipeline (targeting browser), then do a SSR rewrite to run the code in Node.
Vite plugins will receive ssr: false flag when processing those files.

snapshotFormat *

Type: PrettyFormatOptions

Format options for snapshot testing. These options are passed down to pretty-format.

TIP

Beware that plugins field on this object will be ignored.

If you need to extend snapshot serializer via pretty-format plugins, please, use expect.addSnapshotSerializer API or snapshotSerializers option.

snapshotSerializers *

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 for more information.

resolveSnapshotPath *

Type: (testPath: string, snapExtension: string, context: { config: SerializedConfig }) => string
Default: stores snapshot files in __snapshots__ directory

Overrides default snapshot path. For example, to store snapshots next to test files:

import { defineConfig } from 'vitest/config'

export default defineConfig({
  test: {
    resolveSnapshotPath: (testPath, snapExtension) => testPath + snapExtension,
  },
})

allowOnly

Type: boolean
Default: !process.env.CI
CLI: --allowOnly, --allowOnly=false

Allow tests and suites that are marked as only.

dangerouslyIgnoreUnhandledErrors *

Type: boolean
Default: false
CLI: --dangerouslyIgnoreUnhandledErrors --dangerouslyIgnoreUnhandledErrors=false

Ignore any unhandled errors that occur.

passWithNoTests *

Type: boolean
Default: false
CLI: --passWithNoTests, --passWithNoTests=false

Vitest will not fail, if no tests will be found.

logHeapUsage

Type: boolean
Default: false
CLI: --logHeapUsage, --logHeapUsage=false

Show heap usage after each test. Useful for debugging memory leaks.

css

Type: boolean | { include?, exclude?, modules? }

Configure if CSS should be processed. When excluded, CSS files will be replaced with empty strings to bypass the subsequent processing. CSS Modules will return a proxy to not affect runtime.

css.include

Type: RegExp | RegExp[]
Default: []

RegExp pattern for files that should return actual CSS and will be processed by Vite pipeline.

TIP

To process all CSS files, use /.+/.

css.exclude

Type: RegExp | RegExp[]
Default: []

RegExp pattern for files that will return an empty CSS file.

css.modules

Type: { classNameStrategy? }
Default: {}

css.modules.classNameStrategy

Type: 'stable' | 'scoped' | 'non-scoped'
Default: 'stable'

If you decide to process CSS files, you can configure if class names inside CSS modules should be scoped. You can choose one of the options:

stable: class names will be generated as _${name}_${hashedFilename}, which means that generated class will stay the same, if CSS content is changed, but will change, if the name of the file is modified, or file is moved to another folder. This setting is useful, if you use snapshot feature.
scoped: class names will be generated as usual, respecting css.modules.generateScopedName method, if you have one and CSS processing is enabled. By default, filename will be generated as _${name}_${hash}, where hash includes filename and content of the file.
non-scoped: class names will not be hashed.

WARNING

By default, Vitest exports a proxy, bypassing CSS Modules processing. If you rely on CSS properties on your classes, you have to enable CSS processing using include option.

maxConcurrency

Type: number
Default: 5
CLI: --max-concurrency=10, --maxConcurrency=10

A number of tests that are allowed to run at the same time marked with test.concurrent.

Test above this limit will be queued to run when available slot appears.

cache *

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 option:

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:

import { defineConfig } from 'vitest/config'

export default defineConfig({
  cacheDir: process.env.VITEST ? 'custom-folder/.vitest' : undefined
})

sequence

Type: { sequencer?, shuffle?, seed?, hooks?, setupFiles? }

Options for how tests should be sorted.

You can provide sequence options to CLI with dot notation:

npx vitest --sequence.shuffle --sequence.seed=1000

sequence.sequencer *

Type: TestSequencerConstructor
Default: BaseSequencer

A custom class that defines methods for sharding and sorting. You can extend BaseSequencer from vitest/node, if you only need to redefine one of the sort and shard methods, but both should exist.

Sharding is happening before sorting, and only if --shard option is provided.

sequence.shuffle

Type: boolean | { files?, tests? }
Default: false
CLI: --sequence.shuffle, --sequence.shuffle=false

If you want files and tests to run randomly, you can enable it with this option, or CLI argument --sequence.shuffle.

Vitest usually uses cache to sort tests, so long running tests start earlier - this makes tests run faster. If your files and tests will run in random order you will lose this performance improvement, but it may be useful to track tests that accidentally depend on another run previously.

sequence.shuffle.files

Type: boolean
Default: false
CLI: --sequence.shuffle.files, --sequence.shuffle.files=false

Whether to randomize files, be aware that long running tests will not start earlier if you enable this option.

sequence.shuffle.tests

Type: boolean
Default: false
CLI: --sequence.shuffle.tests, --sequence.shuffle.tests=false

Whether to randomize tests.

sequence.concurrent

Type: boolean
Default: false
CLI: --sequence.concurrent, --sequence.concurrent=false

If you want tests to run in parallel, you can enable it with this option, or CLI argument --sequence.concurrent.

sequence.seed *

Type: number
Default: Date.now()
CLI: --sequence.seed=1000

Sets the randomization seed, if tests are running in random order.

sequence.hooks

Type: 'stack' | 'list' | 'parallel'
Default: 'parallel'
CLI: --sequence.hooks=<value>

Changes the order in which hooks are executed.

stack will order "after" hooks in reverse order, "before" hooks will run in the order they were defined
list will order all hooks in the order they are defined
parallel will run hooks in a single group in parallel (hooks in parent suites will still run before the current suite's hooks)

TIP

This option doesn't affect onTestFinished. It is always called in reverse order.

sequence.setupFiles

Type: 'list' | 'parallel'
Default: 'parallel'
CLI: --sequence.setupFiles=<value>

Changes the order in which setup files are executed.

list will run setup files in the order they are defined
parallel will run setup files in parallel

typecheck

Options for configuring typechecking test environment.

typecheck.enabled

Type: boolean
Default: false
CLI: --typecheck, --typecheck.enabled

Enable typechecking alongside your regular tests.

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.

slowTestThreshold *

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.

chaiConfig

Type: { includeStack?, showDiff?, truncateThreshold? }
Default: { includeStack: false, showDiff: true, truncateThreshold: 40 }

Equivalent to Chai config.

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.

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.

retry

Type: number
Default: 0
CLI: --retry=<value>

Retry the test specific number of times if it fails.

onConsoleLog *

Type: (log: string, type: 'stdout' | 'stderr') => boolean | void

Custom handler for console.log in tests. If you return false, Vitest will not print the log to the console.

Can be useful for filtering out logs from third-party libraries.

import { defineConfig } from 'vitest/config'

export default defineConfig({
  test: {
    onConsoleLog(log: string, type: 'stdout' | 'stderr'): boolean | void {
      return !(log === 'message from third party library' && type === 'stdout')
    },
  },
})

onStackTrace *

Type: (error: Error, frame: ParsedStack) => boolean | void

Apply a filtering function to each frame of each stack trace when handling errors. The first argument, error, is an object with the same properties as a standard Error, but it is not an actual instance.

Can be useful for filtering out stack trace frames from third-party libraries.

import type { ParsedStack } from 'vitest'
import { defineConfig } from 'vitest/config'

export default defineConfig({
  test: {
    onStackTrace(error: Error, { file }: ParsedStack): boolean | void {
      // If we've encountered a ReferenceError, show the whole stack.
      if (error.name === 'ReferenceError') {
        return
      }

      // Reject all frames from third party libraries.
      if (file.includes('node_modules')) {
        return false
      }
    },
  },
})

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.

For example, as a config object:

vitest.config.js

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:

vitest.config.jsvitest.diff.ts

import { defineConfig } from 'vitest/config'

export default defineConfig({
  test: {
    diff: './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: true

Print basic prototype Object and Array in diff output

fakeTimers

Type: FakeTimerInstallOpts

Options that Vitest will pass down to @sinon/fake-timers when using vi.useFakeTimers().

fakeTimers.now

Type: number | Date
Default: Date.now()

Installs fake timers with the specified Unix epoch.

fakeTimers.toFake

Type: ('setTimeout' | 'clearTimeout' | 'setImmediate' | 'clearImmediate' | 'setInterval' | 'clearInterval' | 'Date' | 'nextTick' | 'hrtime' | 'requestAnimationFrame' | 'cancelAnimationFrame' | 'requestIdleCallback' | 'cancelIdleCallback' | 'performance' | 'queueMicrotask')[]
Default: ['setTimeout', 'clearTimeout', 'setImmediate', 'clearImmediate', 'setInterval', 'clearInterval', 'Date']

An array with names of global methods and APIs to fake.

To only mock setTimeout() and nextTick(), specify this property as ['setTimeout', 'nextTick'].

Mocking nextTick is not supported when running Vitest inside node:child_process by using --pool=forks. NodeJS uses process.nextTick internally in node:child_process and hangs when it is mocked. Mocking nextTick is supported when running Vitest with --pool=threads.

fakeTimers.loopLimit

Type: number
Default: 10_000

The maximum number of timers that will be run when calling vi.runAllTimers().

fakeTimers.shouldAdvanceTime

Type: boolean
Default: false

Tells @sinonjs/fake-timers to increment mocked time automatically based on the real system time shift (e.g. the mocked time will be incremented by 20ms for every 20ms change in the real system time).

fakeTimers.advanceTimeDelta

Type: number
Default: 20

Relevant only when using with shouldAdvanceTime: true. increment mocked time by advanceTimeDelta ms every advanceTimeDelta ms change in the real system time.

fakeTimers.shouldClearNativeTimers

Type: boolean
Default: true

Tells fake timers to clear "native" (i.e. not fake) timers by delegating to their respective handlers. When disabled, it can lead to potentially unexpected behavior if timers existed prior to starting fake timers session.

workspace *

Type: string
CLI: --workspace=./file.js
Default: vitest.{workspace,projects}.{js,ts,json} close to the config file or root

Path to a workspace config file relative to root.

isolate

Type: boolean
Default: true
CLI: --no-isolate, --isolate=false

Run tests in an isolated environment. This option has no effect on vmThreads and vmForks pools.

Disabling this option might improve performance if your code doesn't rely on side effects (which is usually true for projects with node environment).

TIP

You can disable isolation for specific pools by using poolOptions property.

includeTaskLocation

Type: boolean
Default: false

Should location property be included when Vitest API receives tasks in reporters. If you have a lot of tests, this might cause a small performance regression.

The location property has column and line values that correspond to the test or describe position in the original file.

This option will be auto-enabled if you don't disable it explicitly, and you are running Vitest with:

Vitest UI
or using the Browser Mode without headless mode
or using HTML Reporter

TIP

This option has no effect if you do not use custom code that relies on this.

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:

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 or resolveSnapshotPath options.

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).

expect

Type: ExpectOptions

expect.requireAssertions

Type: boolean
Default: false

The same as calling 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.

expect.poll

Global configuration options for 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

printConsoleTrace

Type: boolean
Default: false

Always print console traces when calling any console method. This is useful for debugging.

Configuring Vitest ​

include ​

exclude ​

includeSource ​

server ​

server.sourcemap ​

server.debug ​

server.debug.dumpModules ​

server.debug.loadDumppedModules ​

server.deps ​

server.deps.external ​

server.deps.inline ​

server.deps.fallbackCJS ​

server.deps.cacheDir ​

deps ​

deps.optimizer ​

deps.optimizer.{mode}.enabled ​

deps.web ​

deps.web.transformAssets ​

deps.web.transformCss ​

deps.web.transformGlobPattern ​

deps.interopDefault ​

deps.moduleDirectories ​

runner ​

benchmark ​

benchmark.include ​

benchmark.exclude ​

benchmark.includeSource ​

benchmark.reporters ​

benchmark.outputFile ​

benchmark.outputJson ​

benchmark.compare ​

alias ​

globals ​

environment ​

environmentOptions ​

environmentMatchGlobs ​

poolMatchGlobs ​

update * ​

watch * ​

root ​

dir ​

reporters * ​

outputFile * ​

pool * ​

threads * ​

forks * ​

vmThreads * ​

vmForks * ​

poolOptions * ​

poolOptions.threads ​

poolOptions.threads.maxThreads * ​

poolOptions.threads.minThreads * ​

poolOptions.threads.singleThread ​

poolOptions.threads.useAtomics * ​

poolOptions.threads.isolate ​

poolOptions.threads.execArgv * ​

poolOptions.forks ​

poolOptions.forks.maxForks * ​

poolOptions.forks.minForks * ​

poolOptions.forks.isolate ​

poolOptions.forks.singleFork ​

poolOptions.forks.execArgv * ​

poolOptions.vmThreads ​

poolOptions.vmThreads.maxThreads * ​

poolOptions.vmThreads.minThreads * ​

poolOptions.vmThreads.memoryLimit * ​

poolOptions.vmThreads.useAtomics * ​

poolOptions.vmThreads.execArgv * ​

poolOptions.vmForks * ​

poolOptions.vmForks.maxForks * ​

poolOptions.vmForks.minForks * ​

poolOptions.vmForks.memoryLimit * ​

poolOptions.vmForks.execArgv * ​

fileParallelism * ​

maxWorkers * ​

minWorkers * ​

testTimeout ​

hookTimeout ​

teardownTimeout * ​

Configuring Vitest

include

exclude

includeSource

server

server.sourcemap

server.debug

server.debug.dumpModules

server.debug.loadDumppedModules

server.deps

server.deps.external

server.deps.inline

server.deps.fallbackCJS

server.deps.cacheDir

deps

deps.optimizer

deps.optimizer.{mode}.enabled

deps.web

deps.web.transformAssets

deps.web.transformCss

deps.web.transformGlobPattern

deps.interopDefault

deps.moduleDirectories

runner

benchmark

benchmark.include

benchmark.exclude

benchmark.includeSource

benchmark.reporters

benchmark.outputFile

benchmark.outputJson

benchmark.compare

alias

globals

environment

environmentOptions

environmentMatchGlobs

poolMatchGlobs

update *

watch *

root

dir

reporters *

outputFile *

pool *

threads *

forks *

vmThreads *

vmForks *

poolOptions *

poolOptions.threads

poolOptions.threads.maxThreads *

poolOptions.threads.minThreads *

poolOptions.threads.singleThread

poolOptions.threads.useAtomics *

poolOptions.threads.isolate

poolOptions.threads.execArgv *

poolOptions.forks

poolOptions.forks.maxForks *

poolOptions.forks.minForks *

poolOptions.forks.isolate

poolOptions.forks.singleFork

poolOptions.forks.execArgv *

poolOptions.vmThreads

poolOptions.vmThreads.maxThreads *

poolOptions.vmThreads.minThreads *

poolOptions.vmThreads.memoryLimit *

poolOptions.vmThreads.useAtomics *

poolOptions.vmThreads.execArgv *

poolOptions.vmForks *

poolOptions.vmForks.maxForks *

poolOptions.vmForks.minForks *

poolOptions.vmForks.memoryLimit *

poolOptions.vmForks.execArgv *

fileParallelism *

maxWorkers *

minWorkers *

testTimeout

hookTimeout

teardownTimeout *