NextJS中文文档 - Jest

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

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

快速开始

你可以使用 create-next-app 和 Next.js 的 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 @types/jest
# 或
yarn add -D jest jest-environment-jsdom @testing-library/react @testing-library/dom @testing-library/jest-dom ts-node @types/jest
# 或
pnpm install -D jest jest-environment-jsdom @testing-library/react @testing-library/dom @testing-library/jest-dom ts-node @types/jest

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

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

这将引导你完成一系列提示，为你的项目设置 Jest，包括自动创建 jest.config.ts|js 文件。

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

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)

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（及所有变体）加载中。
• 从测试解析和转换中忽略 node_modules。
• 从测试解析中忽略 .next。
• 加载 next.config.js 以获取启用 SWC 转换的标志。

提示：要直接测试环境变量，请在单独的设置脚本或 jest.config.ts 文件中手动加载它们。有关更多信息，请参阅测试环境变量。

可选：处理绝对导入和模块路径别名

如果你的项目使用了模块路径别名，你需要配置 Jest 来解析导入，方法是将 jsconfig.json 文件中的 paths 选项与 jest.config.js 文件中的 moduleNameMapper 选项匹配。例如：

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

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

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

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

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

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

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

import '@testing-library/jest-dom'

import '@testing-library/jest-dom'

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

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