Menu

How to set up Jest with Next.js

Jest 和 React Testing Library 经常一起用于单元测试和快照测试。本指南将向你展示如何在 Next.js 中设置 Jest 并编写你的第一个测试。

值得注意的是： 由于 async 服务器组件是 React 生态系统的新功能，Jest 目前不支持它们。虽然你仍然可以为同步的服务器和客户端组件运行单元测试，但我们建议为 async 组件使用端到端测试。

快速开始

你可以使用带有 Next.js with-jest 示例的 create-next-app 来快速开始：

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

手动设置

自 Next.js 12 发布以来，Next.js 现在有了内置的 Jest 配置。

要设置 Jest，请安装 jest 和以下开发依赖包：

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

通过运行以下命令生成基本的 Jest 配置文件：

Terminal
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
TypeScript
import type { Config } from 'jest'
import nextJest from 'next/jest.js'
 
const createJestConfig = nextJest({
  // 提供 Next.js 应用的路径，以在测试环境中加载 next.config.js 和 .env 文件
  dir: './',
})
 
// 添加要传递给 Jest 的任何自定义配置
const config: Config = {
  coverageProvider: 'v8',
  testEnvironment: 'jsdom',
  // 在运行每个测试之前添加更多设置选项
  // setupFilesAfterEnv: ['<rootDir>/jest.setup.ts'],
}
 
// createJestConfig 以这种方式导出，以确保 next/jest 可以加载异步的 Next.js 配置
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
{
  "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
TypeScript
setupFilesAfterEnv: ['<rootDir>/jest.setup.ts']

然后，在 jest.setup 中添加以下导入：

jest.setup.ts
TypeScript
import '@testing-library/jest-dom'

值得注意的是： extend-expect 在 v6.0 中被移除，因此如果你使用的是 6 版本之前的 @testing-library/jest-dom，你需要导入 @testing-library/jest-dom/extend-expect。

如果你需要在每个测试之前添加更多设置选项，可以将它们添加到上面的 jest.setup 文件中。

将测试脚本添加到 package.json

最后，向你的 package.json 文件添加一个 Jest test 脚本：

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 /> 组件是否成功渲染了一个标题：

app/page.js
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()
})

运行你的测试

然后，运行以下命令来运行你的测试：

Terminal
npm run test
# or
yarn test
# or
pnpm test

额外资源

如需进一步阅读，你可能会发现这些资源很有帮助：