TypeScript Jest 单元测试 搭建

NPM TypeScript 项目搭建

创建目录

bash 复制代码
mkdir mockproject

cd mockproject

初始化NPM项目

bash 复制代码
npm init -y

安装TypeScript

bash 复制代码
npm i -D typescript

使用VSCode 打开项目

创建TS配置文件tsconfig.json

json 复制代码
{
  "compilerOptions": {
    "target": "es5",
    "module": "commonjs",
    "declaration": true,
    "outDir": "./lib",
    "strict": true,
    "lib": ["es6"]
  },
  "include": ["src"],
  "exclude": ["node_modules"]
}

创建src 目录,创建文件src/index.ts 内容如下:

ts 复制代码
export const Hello = (name: string) => `Hello ${name}`;

在package.json中的scripts中添加ts的构建命令

json 复制代码
"build": "tsc"

CTRL + ` 打开终端测试构建。

bash 复制代码
npm run build

构建完成后可以发现项目目录中多了lib 里面就是我们的Hello函数。

Jest 单元测试集成

安装依赖

bash 复制代码
npm i -D jest ts-jest @jest/globals

安装后package.json中开发依赖将会出现如下:

生成Jest配置文件

bash 复制代码
npx ts-jest config:init

jest.config.js 生成内容如下:

js 复制代码
/** @type {import('ts-jest').JestConfigWithTsJest} **/
module.exports = {
  testEnvironment: "node",
  transform: {
    "^.+.tsx?$": ["ts-jest",{}],
  },
};

在package.json中添加单元测试命令,若原来有test命令则删除,填入一下内容。

json 复制代码
"test": "jest"

通常会建立一个tests目录用于存放测试用例,tests中的测试用名称与被测试对象名称保持一致,但是添加上.test.ts后缀,目录结构也保持一致。

创建测试目录tests,创建测试文件tests/index.test.ts

ts 复制代码
import { describe, expect, test } from '@jest/globals';
import { Hello } from '../src/index';

describe('Mock module', () => {
    test('Hello world', () => {
        expect(Hello("abc")).toBe("Hello abc");
    });
});

打开终端使用测试命令执行测试

bash 复制代码
npm run test

可以看到执行测试后执行我们定义的测试用例,并提示了Pass的提示。

参考文献

1. 掘金 . 译文一步步构建发布一个 TypeScript NPM 包 . 小被子 . 2019.07 . https://juejin.cn/post/6844903892119977998

2. jest . Getting Started . 2024 . https://jestjs.io/docs/getting-started

相关推荐
feixing_fx1 小时前
变量与声明:let、const、var 的选择边界
开发语言·前端·javascript·前端框架
程序员大阳1 小时前
副队长Vue3教程(8)--列表渲染 v-for
javascript·vue3·v-for·列表渲染
feixing_fx5 小时前
JavaScript 是什么:从浏览器脚本到通用编程语言
开发语言·前端·javascript·前端框架·ecmascript
小y的笔记5 小时前
JavaScript URL 状态同步
前端·javascript
泯泷9 小时前
Vercel AI SDK 6 完整教程系列 - 第一部分:基础入门篇
前端·javascript
程序员大阳11 小时前
副队长Vue3教程(5)--事件绑定 v-on
前端·javascript·vue.js·vue3·事件绑定·v-on
泯泷11 小时前
Vercel AI SDK 6 完整教程系列 - 第二部分:结构化数据与工具调用
前端·javascript
云起SAAS13 小时前
手机靓号选号商城H5源码 完整前后台可直接运行
前端·javascript·后端
code2cat13 小时前
JavaScript编程篇之异步请求:切换到待办,为什么又显示了全部任务
前端·javascript
1-1=014 小时前
Vue 条件渲染和列表渲染
前端·javascript·vue.js