Next.js での Vitest のセットアップ

Vite と React Testing Library は、しばしばユニットテストに使用されます。このガイドでは、Next.js で Vitest をセットアップし、最初のテストを記述する方法について説明します。

知っておくと良いこと: async サーバーコンポーネントは React エコシステムにとって新しいものであるため、Vitest は現在サポートしていません。同期サーバーコンポーネントとクライアントコンポーネントのユニットテストは引き続き実行できますが、async コンポーネントにはE2E テストを使用することをお勧めします。

クイックスタート

Next.js の with-vitest 例を使用して create-next-app を使用すると、すぐに開始できます。

ターミナル

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 /> コンポーネントがヘッダーを正しくレンダリングするかどうかをチェックするテストを作成して、すべてが正常に動作していることを確認します。

pages/index.tsx

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

__tests__/index.test.tsx

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
# or
yarn test
# or
pnpm test
# or
bun test

追加リソース

これらのリソースが役立つ場合があります