TypeScript 与测试:如何使用 Jest 和 TypeScript 进行单元测试
在现代前端开发中,单元测试是确保代码质量和维护稳定性的关键环节。而结合 TypeScript 与 Jest,可以让测试代码同时享受类型检查和良好的开发体验。本指南将详细介绍如何使用 Jest 与 TypeScript 进行单元测试,包括项目配置、测试编写及常见问题的解决。
目录
- 环境准备
- 配置项目
- 2.1 初始化项目
- 2.2 配置 TypeScript
- 2.3 安装 Jest 及相关依赖
- 编写测试
- 3.1 编写简单的测试用例
- 3.2 测试异步代码
- 3.3 测试接口调用(Mock 示例)
- 运行与调试
- 最佳实践
- 总结
1. 环境准备
要在项目中使用 TypeScript 和 Jest,首先确保你已安装以下工具:
- Node.js(建议使用 v16 或更高版本)
- npm 或 yarn
- TypeScript(建议使用最新版)
确认安装:
node -v
npm -v
2. 配置项目
2.1 初始化项目
创建一个新的 Node.js 项目并初始化:
mkdir ts-jest-example
cd ts-jest-example
npm init -y
2.2 配置 TypeScript
安装 TypeScript 及相关工具:
npm install typescript @types/node --save-dev
初始化 TypeScript 配置:
npx tsc --init
修改 tsconfig.json
配置,确保开启以下选项:
{
"compilerOptions": {
"target": "ES2017",
"module": "commonjs",
"strict": true,
"esModuleInterop": true,
"outDir": "./dist",
"rootDir": "./src"
}
}
创建 src
文件夹,用于存放代码和测试。
2.3 安装 Jest 及相关依赖
安装 Jest 和 TypeScript 支持插件:
npm install jest ts-jest @types/jest --