Next.jsでVitestを設定する

ViteとReact Testing Libraryはユニットテストでよく一緒に使用されます。このガイドでは、Next.jsでVitestを設定し、最初のテストを作成する方法を説明します。

補足: async Server Componentsは React エコシステムでは新しいため、Vitestは現在それらをサポートしていません。同期的なサーバーコンポーネントとクライアントコンポーネントのユニットテストは実行できますが、async コンポーネントにはE2Eテストを使用することをお勧めします。

クイックスタート

Next.jsのwith-vitestサンプルを使用してcreate-next-appで素早く始めることができます：

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ファイルを作成し、以下のオプションを追加します：

vitest.config.mts

TypeScript

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

次に、package.jsonにtestスクリプトを追加します：

package.json

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

npm run testを実行すると、デフォルトでプロジェクト内の変更を監視します。

最初のVitestユニットテストの作成

<Page />コンポーネントが見出しを正常にレンダリングすることを確認するテストを作成します：

pages/index.tsx

TypeScript

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

__tests__/index.test.tsx

TypeScript

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()
})

テストの実行

以下のコマンドを実行してテストを実行します：

Terminal

npm run test
# または
yarn test
# または
pnpm test
# または
bun test

追加のリソース

以下のリソースが役立つでしょう：