メインコンテンツまでスキップ

VitestをNext.jsで設定する

ViteとReact Testing Libraryは、ユニットテストによく使われます。このガイドでは、VitestをNext.jsでセットアップし、最初のテストを書く方法を示します。

Good to know: async Server ComponentsはReactエコシステムにおいて新しいため、Vitestは現在これをサポートしていません。同期のServerおよびClient Componentsについてはユニットテストを実行できますが、asyncコンポーネントの場合にはE2Eテストを使用することを推奨します。

クイックスタート​

create-next-appを使用して、Next.jsのwith-vitest例を利用して素早く開始できます：

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
# or \{#or}
yarn add -D vitest @vitejs/plugin-react jsdom @testing-library/react @testing-library/dom
# or \{#or}
pnpm install -D vitest @vitejs/plugin-react jsdom @testing-library/react @testing-library/dom
# or \{#or}
bun add -D vitest @vitejs/plugin-react jsdom @testing-library/react @testing-library/dom

プロジェクトのrootに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の設定に関する詳細情報は、Vitest Configurationのドキュメントを参照してください。

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

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

Good to know: 上記の例は一般的な__tests__規約を使用していますが、テストファイルはappルーター内に配置することもできます。

テストの実行​

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

Terminal
npm run test
# or \{#or}
yarn test
# or \{#or}
pnpm test
# or \{#or}
bun test

追加のリソース​

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