Einrichten von Vitest mit Next.js

Vite und React Testing Library werden häufig zusammen für Unit-Tests verwendet. Diese Anleitung zeigt dir, wie du Vitest mit Next.js einrichtest und deine ersten Tests schreibst.

Hinweis: Da async Server-Komponenten neu im React-Ökosystem sind, unterstützt Vitest diese derzeit nicht. Während du immer noch Unit-Tests für synchrone Server- und Client-Komponenten durchführen kannst, empfehlen wir E2E-Tests für async-Komponenten.

Schnellstart

Du kannst create-next-app mit dem Next.js with-vitest-Beispiel verwenden, um schnell zu beginnen:

Terminal

npx create-next-app@latest --example with-vitest with-vitest-app

Manuelle Einrichtung

Um Vitest manuell einzurichten, installiere vitest und die folgenden Pakete als Entwicklungsabhängigkeiten:

Terminal

npm install -D vitest @vitejs/plugin-react jsdom @testing-library/react @testing-library/dom
# oder
yarn add -D vitest @vitejs/plugin-react jsdom @testing-library/react @testing-library/dom
# oder
pnpm install -D vitest @vitejs/plugin-react jsdom @testing-library/react @testing-library/dom
# oder
bun add -D vitest @vitejs/plugin-react jsdom @testing-library/react @testing-library/dom

Erstelle eine vitest.config.ts|js-Datei im Stammverzeichnis deines Projekts und füge die folgenden Optionen hinzu:

vitest.config.ts

import { defineConfig } from 'vitest/config'
import react from '@vitejs/plugin-react'
 
export default defineConfig({
  plugins: [react()],
  test: {
    environment: 'jsdom',
  },
})

vitest.config.js

import { defineConfig } from 'vitest/config'
import react from '@vitejs/plugin-react'
 
export default defineConfig({
  plugins: [react()],
  test: {
    environment: 'jsdom',
  },
})

Weitere Informationen zur Konfiguration von Vitest findest du in der Vitest-Konfigurationsdokumentation.

Füge dann ein test-Skript in deine package.json hinzu:

package.json

{
  "scripts": {
    "dev": "next dev",
    "build": "next build",
    "start": "next start",
    "test": "vitest"
  }
}

Wenn du npm run test ausführst, wird Vitest standardmäßig Änderungen in deinem Projekt beobachten.

Erstellen deines ersten Vitest-Unit-Tests

Stelle sicher, dass alles funktioniert, indem du einen Test erstellst, der prüft, ob die <Page />-Komponente eine Überschrift erfolgreich rendert:

app/page.tsx

TypeScript

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

__tests__/page.test.tsx

TypeScript

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

Hinweis: Das obige Beispiel verwendet die gängige __tests__-Konvention, aber Testdateien können auch innerhalb des app-Routers abgelegt werden.

Ausführen deiner Tests

Führe dann den folgenden Befehl aus, um deine Tests durchzuführen:

Terminal

npm run test
# oder
yarn test
# oder
pnpm test
# oder
bun test

Zusätzliche Ressourcen

Diese Ressourcen könnten hilfreich für dich sein: