使用 Next.js 配置 Vitest

Vite 和 React Testing Library 经常一起用于单元测试。 本指南将向您展示如何在 Next.js 中设置 Vitest 并编写您的第一个测试。

note

由于async Server 组件是 React 生态系统的新功能，Vitest 目前不支持它们。 虽然您仍然可以运行同步 Server 和 Client 组件的单元测试，但我们建议对于异步组件使用端到端测试。

快速入门

您可以使用 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 @vitejs/plugin-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 文件，并添加以下选项：

vitest.config.ts

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 /> 组件是否成功渲染标题，以确保一切正常：

app/page.tsx

import Link from 'next/link'

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

__tests__/page.test.tsx

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()
})

note

上面的示例使用了常见的 __tests__ 约定，但测试文件也可以与应用程序路由器一起放置。

运行您的测试

然后，运行以下命令来运行您的测试：

npm run test
# 或
yarn test
# 或
pnpm test

附加资源

您可能会发现以下资源有用：

• Next.js with Vitest 示例
• Vitest 文档
• React Testing Library 文档