Next.js で Vitest をセットアップする方法
Vite と React Testing Library は、ユニットテスト のために頻繁に併用されます。このガイドでは、Next.js で Vitest をセットアップし、最初のテストを記述する方法を紹介します。
豆知識:
asyncサーバーコンポーネントは React エコシステムにとって新しい概念であるため、Vitest は現在これらをサポートしていません。同期型のサーバーおよびクライアントコンポーネントに対してユニットテストを実行することは可能ですが、asyncコンポーネントには E2E テスト の使用を推奨します。
クイックスタート
Next.js の with-vitest サンプルを使用して、create-next-app で素早く開始できます:
npx create-next-app@latest --example with-vitest with-vitest-app手動セットアップ
Vitest を手動でセットアップするには、vitest と以下のパッケージを開発依存関係としてインストールします:
npm install -D vitest @vitejs/plugin-react jsdom @testing-library/react
# または
yarn add -D vitest @vitejs/plugin-react jsdom @testing-library/react
# または
pnpm install -D vitest @vitejs/plugin-react jsdom @testing-library/react
# または
bun add -D vitest @vitejs/plugin-react jsdom @testing-library/reactプロジェクトのルートに vitest.config.ts|js ファイルを作成し、以下の設定を追加します:
import { defineConfig } from 'vitest/config'
import react from '@vitejs/plugin-react'
export default defineConfig({
plugins: [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 スクリプトを追加します:
{
"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ルーター内に配置することもできます。
テストの実行
以下のコマンドを実行してテストを実行します:
npm run test
# または
yarn test
# または
pnpm test
# または
bun test追加リソース
以下のリソースが役立つかもしれません: