入门

概述

Vitest（发音为 "veetest"）是一个由 Vite 驱动的下一代测试框架。

你可以在 为什么选择 Vitest 部分了解更多关于该项目背后的理由。

在线尝试 Vitest

你可以在 StackBlitz 上在线尝试 Vitest。它直接在浏览器中运行 Vitest，几乎与本地设置相同，但不需要在你的机器上安装任何东西。

将 Vitest 添加到你的项目

通过视频学习如何安装

npm

npm install -D vitest

yarn

yarn add -D vitest

pnpm

pnpm add -D vitest

bun

bun add -D vitest

TIP

Vitest 需要 Vite >=v6.4.0 和 Node >=v22.12.0

建议你使用上述方法之一在 package.json 中安装 vitest 副本。但是，如果你更喜欢直接运行 vitest，可以使用 npx vitest（npx 工具随 npm 和 Node.js 一起提供）。

npx 工具将执行指定的命令。默认情况下，npx 将首先检查命令是否存在于本地项目的二进制文件中。如果在那里没有找到，npx 将在系统的 $PATH 中查找并在找到时执行它。如果在这两个位置都没有找到命令，npx 将在执行前将其安装在临时位置。

Vitest 和第三方集成可以使用 .vitest 目录来存储生成的工件。建议将其添加到你的 .gitignore 中。

.gitignore

# Vitest 报告和工件
.vitest/

编写测试

作为一个例子，我们将编写一个简单的测试，验证一个将两个数字相加的函数的输出。

sum.js

export function sum(a, b) {
  return a + b
}

sum.test.js

import { expect, test } from 'vitest'
import { sum } from './sum.js'

test('adds 1 + 2 to equal 3', () => {
  expect(sum(1, 2)).toBe(3)
})

TIP

默认情况下，测试文件的文件名中必须包含 .test. 或 .spec.。

接下来，为了执行测试，将以下部分添加到你的 package.json 中：

package.json

{
  "scripts": {
    "test": "vitest"
  }
}

最后，根据你的包管理器运行 npm run test、yarn test 或 pnpm test，Vitest 将打印此消息：

✓ sum.test.js (1)
  ✓ 1 + 2 等于 3

测试文件  1 个通过 (1)
     测试  1 个通过 (1)
  开始于  02:15:44
  持续时间  311ms

WARNING

如果你使用 Bun 作为包管理器，请确保使用 bun run test 命令而不是 bun test，否则 Bun 将运行其自己的测试运行器。

你的第一个测试已经通过！继续阅读 编写测试，了解如何组织测试、读取测试输出，以及你每天都会使用的核心测试模式。

若要在不监听文件变更的情况下只运行一次测试，请使用 vitest run。你也可以传递诸如 --reporter 或 --coverage 之类的额外标志。有关 CLI 选项的完整列表，请运行 npx vitest --help 或查看 CLI 指南。

配置 Vitest

Vitest 默认读取你的 vite.config.*，因此你现有的 Vite 插件和配置开箱即用。你也可以创建一个专用的 vitest.config.* 用于测试特定设置。详细信息请参见 配置参考。

IDE 集成

我们还为 Visual Studio Code 提供了一个官方扩展，以增强你使用 Vitest 的测试体验。

从 VS Code 市场安装

了解更多关于 IDE 集成

示例

示例	来源	在线玩
basic	GitHub	在线试玩
fastify	GitHub	在线试玩
in-source-test	GitHub	在线试玩
lit	GitHub	在线试玩
vue	GitHub	在线试玩
marko	GitHub	在线试玩
preact	GitHub	在线试玩
qwik	GitHub	在线试玩
react	GitHub	在线试玩
solid	GitHub	在线试玩
svelte	GitHub	在线试玩
profiling	GitHub	不可用
typecheck	GitHub	在线试玩
projects	GitHub	在线试玩

社区

如果你有问题或需要帮助，请在 Discord 和 GitHub Discussions 联系社区。