在 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，请安装 vitest 及以下开发依赖项：

终端

npm install -D vitest @vitejs/plugin-react jsdom @testing-library/react
# 或
yarn add -D vitest @vitejs/plugin-react jsdom @testing-library/react
# 或
pnpm install -D vitest @vitejs/plugin-react jsdom @testing-library/react
# 或
bun add -D vitest @vitejs/plugin-react jsdom @testing-library/react

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

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

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

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

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

有关配置 Vitest 的更多信息，请参阅 Vitest 配置文档。

接着，在 package.json 中添加 test 脚本：

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 '../pages/index'

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 '../pages/index'

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

运行测试

运行以下命令执行测试：

终端

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

其他资源

以下资源可能对您有所帮助：

快速开始

手动配置

创建首个 Vitest 单元测试

运行测试

其他资源

On this page