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

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

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

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 />コンポーネントが正常に見出しをレンダリングするかどうかを確認するテストを作成して、すべてが機能していることを確認します。

pages/index.tsx

import Link from 'next/link'
 
export default function Page() {
  return (
    <div>
      <h1>Home</h1>
      <Link href="/about">About</Link>
    </div>
  )
}

__tests__/index.test.tsx

import { expect, test } from 'vitest'
import { render, screen } from '@testing-library/react'
import Page from '../pages/index'
 
test('Page', () => {
  render(<Page />)
  expect(screen.getByRole('heading', { level: 1, name: 'Home' })).toBeDefined()
})

テストの実行

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

ターミナル

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

追加リソース

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

この情報はお役に立ちましたか？