benchmark experimental

• Type: { include?, exclude?, ... }

Options used when running vitest bench.

benchmark.enabled

• Type: boolean
• Default: false

Enables the benchmark project. When set, Vitest creates a dedicated benchmark project alongside your regular test project, runs files matching benchmark.include in it, and exposes the bench fixture to those files. Running vitest bench enables this automatically.

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

• Type: boolean
• Default: false

Include the samples array of per-iteration timings on every benchmark result. Disabled by default to reduce memory usage; enable when a custom reporter or API consumer needs the raw samples.

benchmark.suppressExportGetterWarnings

• Type: boolean
• Default: false

Suppress the warning printed when a benchmark accesses module export getters too many times. Vitest tracks getter access during benchmark runs because Vite's module runner wraps every export in a getter, and excessive access can dominate the measurement (see Module Runner Overhead). Enable this when you've intentionally accepted the overhead, or when the warning is noisy for benchmarks where the getter cost is negligible.