如何在 Next.js 中設定 Vitest

Vite 和 React Testing Library 經常一起用於單元測試 (Unit Testing)。本指南將展示如何在 Next.js 中設定 Vitest 並撰寫你的第一個測試。

小知識：由於 async 伺服器元件 (Server Components) 是 React 生態系統中的新功能，Vitest 目前不支援它們。雖然你仍然可以為同步的伺服器和客戶端元件執行單元測試，但我們建議對 async 元件使用端對端測試 (E2E tests)。

快速開始

你可以使用 create-next-app 搭配 Next.js 的 with-vitest 範例快速開始：

Terminal

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

手動設定

要手動設定 Vitest，請安裝 vitest 和以下套件作為開發依賴：

Terminal

# 使用 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 的更多資訊，請參考 Vitest 設定文件。

接著，在 package.json 中新增一個 test 指令：

package.json

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

當你執行 npm run test 時，Vitest 預設會監聽 (watch) 專案中的變更。

建立你的第一個 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 路由中。

執行測試

接著，執行以下指令來執行你的測試：

Terminal

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

其他資源

你可能會發現這些資源有幫助：

快速開始

手動設定

建立你的第一個 Vitest 單元測試

執行測試

其他資源

On this page