next.js 中文文档

主题

在 Next.js 中设置 Jest ​

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

须知： 由于 async 服务器组件在 React 生态系统中是新事物，Jest 目前还不支持它们。尽管您仍然可以为同步的服务器和客户端组件运行单元测试，但我们建议对 async 组件使用端到端测试。

快速入门 ​

您可以使用 create-next-app 和 Next.js 的 with-jest 示例快速开始：

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

手动设置 ​

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

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

bash
npm install -D jest jest-environment-jsdom @testing-library/react @testing-library/jest-dom
# 或
yarn add -D jest jest-environment-jsdom @testing-library/react @testing-library/jest-dom
# 或
pnpm install -D jest jest-environment-jsdom @testing-library/react @testing-library/jest-dom

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

bash
npm init jest@latest
# 或
yarn create jest@latest
# 或
pnpm create jest@latest

这将通过一系列提示引导您为项目设置 Jest，包括自动创建一个 jest.config.ts|js 文件。

更新您的配置文件以使用 next/jest。这个转换器包含了 Jest 与 Next.js 一起工作所需的所有配置选项：

ts
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)
js
const nextJest = require('next/jest')

/** @type {import('jest').Config} */
const createJestConfig = nextJest({
  // 提供您的 Next.js 应用的路径以在测试环境中加载 next.config.js 和 .env 文件
  dir: './',
})

// 添加任何要传递给 Jest 的自定义配置
const config = {
  coverageProvider: 'v8',
  testEnvironment: 'jsdom',
  // 在每个测试运行之前添加更多的设置选项
  // setupFilesAfterEnv: ['<rootDir>/jest.setup.ts'],
}

// createJestConfig 以这种方式导出，以确保 next/jest 可以加载 Next.js 配置，该配置是异步的
module.exports = 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 选项匹配来解析导入。例如：

json
{
  "compilerOptions": {
    "module": "esnext",
    "moduleResolution": "bundler",
    "baseUrl": "./",
    "paths": {
      "@/components/*": ["components/*"]
    }
  }
}
js
moduleNameMapper: {
  // ...
  '^@/components/(.*)$': '<rootDir>/components/$1',
}

可选：使用自定义匹配器扩展 Jest ​

@testing-library/jest-dom 包含了一组方便的自定义匹配器，例如 .toBeInTheDocument()，这使得编写测试更加容易。您可以通过向 Jest 配置文件添加以下选项，为每个测试导入自定义匹配器：

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

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

ts
import '@testing-library/jest-dom'
js
import '@testing-library/jest-dom'

须知： extend-expect 在 v6.0 中已被移除，因此如果您使用的是 @testing-library/jest-dom 6 之前的版本，您将需要导入 @testing-library/jest-dom/extend-expect 替代。

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

在 package.json 中添加测试脚本 ​

最后，将 Jest test 脚本添加到您的 package.json 文件中：

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

jest --watch 将在文件更改时重新运行测试。有关更多 Jest CLI 选项，请参考 Jest 文档。

创建您的第一个测试： ​

您的项目现在已准备好运行测试。在项目的根目录中创建一个名为 __tests__ 的文件夹。

可选地，添加一个 快照测试 以跟踪组件中的任何意外更改：

运行您的测试 ​

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

bash
npm run test
# 或
yarn test
# 或
pnpm test

其他资源 ​

如需进一步阅读，您可能会发现以下资源有帮助：