如何在 Next.js 中配置 Vitest

Vite 和 React Testing Library 常被组合用于单元测试。本指南将展示如何在 Next.js 中配置 Vitest 并编写首个测试用例。

须知：由于 async 服务端组件在 React 生态中是新增特性，Vitest 目前暂不支持。虽然你仍可为同步的服务端和客户端组件运行单元测试，但我们推荐对 async 组件使用端到端测试 (E2E tests)。

快速开始

使用 create-next-app 并选择 Next.js 官方 with-vitest 示例快速创建项目：

终端

npx create-next-app@latest --example with-vitest with-vitest-app

手动配置

手动安装 vitest 及相关依赖（开发环境）：

终端

# 使用 TypeScript
npm install -D vitest @vitejs/plugin-react jsdom @testing-library/react @testing-library/dom vite-tsconfig-paths
# 使用 JavaScript
npm install -D vitest @vitejs/plugin-react jsdom @testing-library/react @testing-library/dom

在项目根目录创建 vitest.config.mts|js 文件，添加以下配置：

import { defineConfig } from 'vitest/config'
import react from '@vitejs/plugin-react'
import tsconfigPaths from 'vite-tsconfig-paths'

export default defineConfig({
  plugins: [tsconfigPaths(), react()],
  test: {
    environment: 'jsdom',
  },
})

import { defineConfig } from 'vitest/config'
import react from '@vitejs/plugin-react'

export default defineConfig({
  plugins: [react()],
  test: {
    environment: 'jsdom',
  },
})

更多配置选项请参考 Vitest 配置文档。

在 package.json 中添加测试脚本：

package.json

{
  "scripts": {
    "dev": "next dev",
    "build": "next build",
    "start": "next start",
    "test": "vitest"
  }
}

执行 npm run test 时，Vitest 默认会启用监听模式实时响应文件变更。

创建首个 Vitest 单元测试

通过测试 <Page /> 组件是否能正确渲染标题来验证配置：

import Link from 'next/link'

export default function Page() {
  return (
    <div>
      <h1>Home</h1>
      <Link href="/about">About</Link>
    </div>
  )
}

import Link from 'next/link'

export default function Page() {
  return (
    <div>
      <h1>Home</h1>
      <Link href="/about">About</Link>
    </div>
  )
}

import { expect, test } from 'vitest'
import { render, screen } from '@testing-library/react'
import Page from '../app/page'

test('Page', () => {
  render(<Page />)
  expect(screen.getByRole('heading', { level: 1, name: 'Home' })).toBeDefined()
})

import { expect, test } from 'vitest'
import { render, screen } from '@testing-library/react'
import Page from '../app/page'

test('Page', () => {
  render(<Page />)
  expect(screen.getByRole('heading', { level: 1, name: 'Home' })).toBeDefined()
})

须知：虽然示例使用了常见的 __tests__ 目录约定，但测试文件也可以直接放在 app 路由目录中。

运行测试

执行以下命令运行测试：

终端

npm run test
# 或
yarn test
# 或
pnpm test
# 或
bun test

扩展资源

这些资源可能对你有帮助：

快速开始

手动配置

创建首个 Vitest 单元测试

运行测试

扩展资源

On this page