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

VitestとReact Testing Libraryは、単体テストのために頻繁に一緒に使用されます。このガイドでは、VitestをNext.jsでセットアップし、最初のテストを作成する方法を説明します。

知っておくと良いこと: async Server ComponentsはReactエコシステムにとって新しいため、Vitestは現在サポートしていません。同期的なServer ComponentsとClient Componentsの単体テストは引き続き実行できますが、asyncコンポーネントにはE2Eテストを使用することをお勧めします。

クイックスタート

create-next-appとNext.jsのwith-vitestサンプルを使用すると、すぐに開始できます。

npx create-next-app@latest --example with-vitest with-vitest-app

手動セットアップ

Vitestを手動でセットアップするには、vitestと以下のパッケージを開発依存関係としてインストールします。

# Using TypeScript
npm install -D vitest @vitejs/plugin-react jsdom @testing-library/react @testing-library/dom vite-tsconfig-paths
# Using 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',
  },
})

Vitestの設定に関する詳細については、Vitest Configurationドキュメントを参照してください。

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

{
  "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 { 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

追加リソース

これらのリソースが役立つかもしれません。