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 Configuration のドキュメントを参照してください。

次に、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

追加リソース

以下のリソースが役立つかもしれません