---
url: /config/benchmark.md
---

# 基准测试  {#benchmark}

* **类型:** `{ include?, exclude?, ... }`

运行 `vitest bench` 时使用的选项。

## benchmark.enabled

* **类型：** `boolean`
* **默认值：** `false`

启用基准测试项目。设置后，Vitest 会在常规测试项目旁边创建一个专用的基准测试项目，在其中运行匹配 [`benchmark.include`](#benchmark-include) 的文件，并向这些文件暴露 [`bench fixture`](/guide/test-context#bench)。运行 `vitest bench` 会自动启用此功能。

## benchmark.include

* **类型:** `string[]`
* **默认值:** `['**/*.{bench,benchmark}.?(c|m)[jt]s?(x)']`

包含基准测试文件的匹配模式

## benchmark.exclude

* **类型:** `string[]`
* **默认值:** `['**/node_modules/**', '**/.git/**']`

排除基准测试文件的匹配模式。

## benchmark.includeSource

* **类型:** `string[]`
* **默认值:** `[]`

包含源内基准测试文件的匹配模式。此选项类似于 [`includeSource`](/config/include-source)。

定义后，Vitest 将运行所有内部包含 `import.meta.vitest` 的匹配文件。

## benchmark.retainSamples

* **类型：** `boolean`
* **默认值：** `false`

在每个基准测试结果中包含每次迭代耗时的 `samples` 数组。默认禁用以减少内存使用；当自定义 reporter 或 API 消费者需要原始样本时，请启用此选项。

## benchmark.provider

* **类型：** `string`
* **默认值：** `undefined`（使用内置提供程序）

执行已注册基准测试并返回其结果的基准测试提供程序。将其设置为一个模块路径，该模块的默认导出实现了 `BenchmarkProvider`。相对路径从项目根目录解析。

有关设置说明和提供程序 API，请参阅[自定义基准测试提供程序](/guide/advanced/benchmark-provider)指南。

## benchmark.suppressExportGetterWarnings

* **类型：** `boolean`
* **默认值：** `false`

抑制基准测试访问模块导出 getter 次数过多时打印的警告。Vitest 会在基准测试运行期间跟踪 getter 访问，因为 Vite 的模块运行器会将每个导出都包装在 getter 中，而过多的访问可能会占据测量结果的主要部分（请参阅[模块运行器开销](/guide/benchmarking#module-runner-overhead)）。当你有意接受这种开销，或 getter 成本可以忽略不计的基准测试中该警告过于频繁时，可以启用此选项。