使用 Next.js 設定 Jest

Jest 和 React 測試函式庫經常搭配使用於單元測試和快照測試。本指南將示範如何使用 Next.js 設定 Jest 並撰寫您的第一個測試。

注意事項：由於 async 伺服器元件是 React 生態系統的新成員，Jest 目前不支援它們。雖然您仍然可以對同步伺服器和客戶端元件執行單元測試，但我們建議對 async 元件使用端對端測試。

快速入門

您可以使用 Next.js 的 create-next-app 搭配 with-jest 範例來快速開始。

終端機

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

手動設定

自 Next.js 12 發佈以來，Next.js 現在已內建 Jest 設定。

要設定 Jest，請將 jest 和以下套件安裝為開發依賴項。

終端機

npm install -D jest jest-environment-jsdom @testing-library/react @testing-library/dom @testing-library/jest-dom ts-node
# or
yarn add -D jest jest-environment-jsdom @testing-library/react @testing-library/dom @testing-library/jest-dom ts-node
# or
pnpm install -D jest jest-environment-jsdom @testing-library/react @testing-library/dom @testing-library/jest-dom ts-node

透過執行以下指令來產生基本的 Jest 設定檔：

終端機

npm init jest@latest
# or
yarn create jest@latest
# or
pnpm create jest@latest

這將會引導您完成一系列的提示，以設定專案的 Jest，包含自動建立 jest.config.ts|js 檔案。

更新您的設定檔以使用 next/jest。這個轉換器包含所有必要的設定選項，讓 Jest 能與 Next.js 協同運作。

jest.config.ts

import type { Config } from 'jest'
import nextJest from 'next/jest.js'
 
const createJestConfig = nextJest({
  // Provide the path to your Next.js app to load next.config.js and .env files in your test environment
  dir: './',
})
 
// Add any custom config to be passed to Jest
const config: Config = {
  coverageProvider: 'v8',
  testEnvironment: 'jsdom',
  // Add more setup options before each test is run
  // setupFilesAfterEnv: ['<rootDir>/jest.setup.ts'],
}
 
// createJestConfig is exported this way to ensure that next/jest can load the Next.js config which is async
export default createJestConfig(config)

在底層，next/jest 會自動為您設定 Jest，包含：

使用 Next.js 編譯器設定 transform。
自動模擬樣式表（.css、.module.css 及其 scss 變體）、圖片導入和 next/font。
將 .env（及其所有變體）載入到 process.env。
從測試解析和轉換中忽略 node_modules。
從測試解析中忽略 .next。
載入 next.config.js 以取得啟用 SWC 轉換的旗標。

注意事項：要直接測試環境變數，請在個別的設定指令碼或 jest.config.ts 檔案中手動載入它們。如需更多資訊，請參閱測試環境變數。

選用：處理絕對導入和模組路徑別名

如果您的專案使用模組路徑別名，您需要設定 Jest 來解析導入，方法是將 jsconfig.json 檔案中的 paths 選項與 jest.config.js 檔案中的 moduleNameMapper 選項匹配。例如：

tsconfig.json 或 jsconfig.json

{
  "compilerOptions": {
    "module": "esnext",
    "moduleResolution": "bundler",
    "baseUrl": "./",
    "paths": {
      "@/components/*": ["components/*"]
    }
  }
}

jest.config.js

moduleNameMapper: {
  // ...
  '^@/components/(.*)$': '<rootDir>/components/$1',
}

選用：使用自訂匹配器擴充 Jest

@testing-library/jest-dom 包含一組方便的自訂匹配器，例如 .toBeInTheDocument()，讓撰寫測試更容易。您可以透過將以下選項添加到 Jest 設定檔，為每個測試導入自訂匹配器。

jest.config.ts

setupFilesAfterEnv: ['<rootDir>/jest.setup.ts']

然後，在 jest.setup.ts 檔案內，加入以下 import 陳述式：

jest.setup.ts

import '@testing-library/jest-dom'

注意事項：extend-expect 已在 v6.0 中移除，因此，如果您使用的是 @testing-library/jest-dom 6.0 以前的版本，則需要改為導入 @testing-library/jest-dom/extend-expect。

如果您需要在每次測試之前新增更多設定選項，您可以將它們新增到上述的 jest.setup.js 檔案中。

將測試腳本新增到 `package.json`：

最後，將 Jest test 腳本新增到您的 package.json 檔案中。

package.json

{
  "scripts": {
    "dev": "next dev",
    "build": "next build",
    "start": "next start",
    "test": "jest",
    "test:watch": "jest --watch"
  }
}

jest --watch 會在檔案變更時重新執行測試。如需更多 Jest CLI 選項，請參閱 Jest 文件。

建立您的第一個測試：

您的專案現在已準備好執行測試。在專案的根目錄中建立一個名為 __tests__ 的資料夾。

例如，我們可以新增一個測試來檢查 <Page /> 元件是否成功渲染標題。

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

__tests__/page.test.jsx

import '@testing-library/jest-dom'
import { render, screen } from '@testing-library/react'
import Page from '../app/page'
 
describe('Page', () => {
  it('renders a heading', () => {
    render(<Page />)
 
    const heading = screen.getByRole('heading', { level: 1 })
 
    expect(heading).toBeInTheDocument()
  })
})

（選用）新增快照測試以追蹤元件中任何非預期的變更。

__tests__/snapshot.js

import { render } from '@testing-library/react'
import Page from '../app/page'
 
it('renders homepage unchanged', () => {
  const { container } = render(<Page />)
  expect(container).toMatchSnapshot()
})

執行您的測試

接著，執行以下指令來執行您的測試

終端機

npm run test
# or
yarn test
# or
pnpm test

額外資源

如需進一步閱讀，您可能會發現以下資源很有幫助