使用 Next.js 設定 Vitest

Vite 和 React 測試函式庫經常搭配使用於單元測試。本指南將向您展示如何使用 Next.js 設定 Vitest 並撰寫您的第一個測試。

注意事項：由於 async 伺服器組件是 React 生態系統的新功能，Vitest 目前不支援它們。雖然您仍然可以對同步伺服器和客戶端組件執行單元測試，但我們建議對 async 組件使用端對端測試。

快速入門

您可以使用 Next.js 的 create-next-app 搭配 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 @testing-library/dom
# or
yarn add -D vitest @vitejs/plugin-react jsdom @testing-library/react @testing-library/dom
# or
pnpm install -D vitest @vitejs/plugin-react jsdom @testing-library/react @testing-library/dom
# or
bun add -D vitest @vitejs/plugin-react jsdom @testing-library/react @testing-library/dom

在專案根目錄中建立一個 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()
})

注意事項：上述範例使用常見的 __tests__ 慣例，但測試檔案也可以與 app 路由器放在一起。

執行您的測試

然後，執行以下指令來執行您的測試。

終端機

npm run test
# or
yarn test
# or
pnpm test
# or
bun test