Next.jsでVitestをセットアップする

ViteとReact Testing Libraryは、ユニットテストにおいて頻繁に一緒に使用されます。このガイドでは、Next.jsでVitestをセットアップし、最初のテストを書く方法を説明します。

補足: asyncサーバーコンポーネントは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

npm install -D vitest @vitejs/plugin-react jsdom @testing-library/react @testing-library/dom
# または
yarn add -D vitest @vitejs/plugin-react jsdom @testing-library/react @testing-library/dom
# または
pnpm install -D vitest @vitejs/plugin-react jsdom @testing-library/react @testing-library/dom
# または
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.config.js

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ユニットテストの作成

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

app/page.tsx

TypeScript

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

__tests__/page.test.tsx

TypeScript

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__の規則を使用していますが、テストファイルはアプリルーター内にも配置できます。

テストの実行

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

Terminal

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

追加のリソース

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