对TypeScript库进行单元测试的方法
时间：2020-11-20 17:56:59 | 栏目：JavaScript代码 | 点击：次
原文发布于2017年7月，为保证能正常运行，其中部分命令进行了调整。当时TypeScript版本为2.x，但依旧具有借鉴意义。
单元测试能限制你库中Bug的「生长」。随着编写的库越来越大，你不能总是手工测试每个特性。但你可以使用单元测试来测试每个特性，并且编写起来并不难。下面展示如何在Typescript中设置单元测试!
步骤1：安装用于单元测试的包
单元测试assert(推断)代码中一些属性。例如你有一个方法add(x,y)，其应该正确地将x和y相加，通过单元测试你可以进行如下测试assert(add(3,4)).equals(7)。
一些用于单元测试的库提供了好用的assert方法来执行测试。我们这里使用了Mocha和Chai，通过如下命令进行安装:
npm i mocha @types/mocha chai @types/chai ts-node typescript --save-dev
步骤2：编写第一个单元测试
假设你有以下单元：
typescript-library/src/math.ts
export function add(x: number, y: number) {
return x + y;
}
那对应的单元测试可能是这样的：
typescript-library/src/math.test.ts
import { add } from './math';
import * as mocha from 'mocha';
import * as chai from 'chai';
const expect = chai.expect;
describe('My math library', () => {
it('should be able to add things correctly' , () => {
expect(add(3,4)).to.equal(7);
});
});
步骤3：运行单元测试
您可以使用以下命令运行测试:
./node_modules/mocha/bin/mocha --reporter spec --require ts-node/register src/**/*.test.ts
然后应该会在控制台中看到一个输出，如下所示:
您可以将这个长命令放入package.json中转换成"scripts:{"test":"…"}"然后用npm test运行测试。也就是说此时的package.json应该是:
{
"devDependencies": {
"@types/chai": "^4.1.7",
"@types/mocha": "^5.2.7",
"chai": "^4.2.0",
"ts-node": "^8.3.0",
"mocha": "^6.1.4"
},
"scripts": {
"test": "./node_modules/mocha/bin/mocha --reporter spec --require ts-node/register src/**/*.test.ts"
}
}
如果您想运行单独的某个单元测试，可以用./node_modules/mocha/bin/mocha --reporter spec --grep "TestName" --require ts-node/register src/**/*.test.ts。“TestName”可以是任何的describe值，在本例中就如./node_modules/mocha/bin/mocha --reporter spec --grep "My math library" --require ts-node/register test/**/*.test.ts。