使用 Next.js 设置 Jest
Jest 和 React Testing Library 经常一起用于 单元测试 和 快照测试。本指南将向你展示如何使用 Next.js 设置 Jest 并编写你的第一个测试。
须知: 由于
async
服务器组件是 React 生态系统的新功能,Jest 目前不支持它们。虽然你仍然可以为同步服务器和客户端组件运行 单元测试,但我们建议对async
组件使用 E2E 测试。
快速入门
你可以使用 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
# 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 一起工作所需的所有必要配置选项
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
选项相匹配。例如
{
"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']
然后,在 jest.setup
内部,添加以下导入
import '@testing-library/jest-dom'
须知:
extend-expect
在v6.0
中被移除,因此如果你在使用版本 6 之前的@testing-library/jest-dom
,你将需要导入@testing-library/jest-dom/extend-expect
来代替。
如果你需要在每个测试之前添加更多设置选项,你可以将它们添加到上面的 jest.setup
文件中。
向 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 />
组件是否成功渲染了标题
import Link from 'next/link'
export default function Page() {
return (
<div>
<h1>Home</h1>
<Link href="/about">About</Link>
</div>
)
}
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()
})
})
可选地,添加一个 快照测试 以跟踪组件中任何意外的更改
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
其他资源
为了进一步阅读,你可能会发现这些资源很有帮助
- Next.js 与 Jest 示例
- Jest 文档
- React Testing Library 文档
- Testing Playground - 使用良好的测试实践来匹配元素。
这是否有帮助?