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

# 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ファイルを作成し、以下の設定を追加します:

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

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 />コンポーネントが正常に見出しをレンダリングするかどうかを確認するテストを作成して、すべてが機能していることを確認します:

import Link from 'next/link'

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

import Link from 'next/link'

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

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

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ルーター内に同居させることも可能です。

テストの実行

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

Terminal

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

追加リソース

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

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

クイックスタート

手動セットアップ

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

テストの実行

追加リソース

On this page