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

VitestをNext.jsで設定する

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

Good to know: async Server ComponentsはReactエコシステムにおいて新しいため、Vitestは現在それをサポートしていません。同期ServerおよびClient Componentsのための単体テストを実行することはできますが、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を使用する場合 \{#using-typescript}
npm install -D vitest @vitejs/plugin-react jsdom @testing-library/react @testing-library/dom vite-tsconfig-paths
# JavaScriptを使用する場合 \{#using-javascript}
npm install -D vitest @vitejs/plugin-react jsdom @testing-library/react @testing-library/dom

プロジェクトのrootに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 Configurationドキュメントを参照してください。

次に、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}
yarn test
# または \{#or}
pnpm test
# または \{#or}
bun test

追加のリソース​

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