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

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

ご存知のとおり: 非同期サーバーコンポーネントはReactエコシステムにとって新しいため、Vitestは現在これらをサポートしていません。同期サーバーコンポーネントおよびクライアントコンポーネントの**ユニットテスト**は引き続き実行できますが、非同期コンポーネントには**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ファイルを作成し、以下のオプションを追加します。

vitest.config.mts

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はデフォルトでプロジェクトの変更を**監視**します。

最初の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 Router内に配置することもできます。

テストの実行

次に、以下のコマンドを実行してテストを実行します。

ターミナル

npm run test
# or
yarn test
# or
pnpm test
# or
bun test

その他のリソース

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