使用 Next.js 設定 Vitest

Vite 和 React Testing Library 經常一起用於單元測試。本指南將說明如何使用 Next.js 設定 Vitest 並編寫您的第一個測試。

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

快速開始

您可以使用 create-next-app 與 Next.js with-vitest 範例快速開始

終端機

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

手動設定

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

終端機

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

在專案根目錄中建立 vitest.config.mts|js 檔案，並新增以下選項

vitest.config.mts

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',
  },
})

如需設定 Vitest 的更多資訊，請參閱 Vitest 設定文件。

然後，將 test 腳本新增至您的 package.json

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

其他資源

您可能會覺得這些資源很有幫助