开玩笑（ts-jest）

jest 是 Facebook 的无痛 JavaScript 测试框架， ts-jest 可用于测试 TypeScript 代码。

使用 npm run 命令安装 jest

npm install --save-dev jest @types/jest ts-jest typescript

为了便于使用，请将 jest 安装为全局包

npm install -g jest

要使 jest 与 TypeScript 一起使用，你需要向 package.json 添加配置

//package.json
{
...
"jest": {
    "transform": {
      ".(ts|tsx)": "<rootDir>/node_modules/ts-jest/preprocessor.js"
    },
    "testRegex": "(/__tests__/.*|\\.(test|spec))\\.(ts|tsx|js)$",
    "moduleFileExtensions": ["ts", "tsx", "js"]
  }
}

现在 jest 准备好了。假设我们有样品 fizz buz 来测试

//fizzBuzz.ts
export function fizzBuzz(n: number): string {
    let output = "";
    for (let i = 1; i <= n; i++) {
        if (i % 5 && i % 3) {
            output += i + ' ';
        }
        if (i % 3 === 0) {
            output += 'Fizz ';
        }
        if (i % 5 === 0) {
            output += 'Buzz ';
        }
    }
    return output;
}

示例测试可能看起来像

//FizzBuzz.test.ts
/// <reference types="jest" />

import {fizzBuzz} from "./fizzBuzz";
test("FizzBuzz test", () =>{
    expect(fizzBuzz(2)).toBe("1 2 ");
    expect(fizzBuzz(3)).toBe("1 2 Fizz ");
});

执行测试运行

jest

在输出中你应该看到

 PASS  ./fizzBuzz.test.ts
  ✓ FizzBuzz test (3ms)

Test Suites: 1 passed, 1 total
Tests:       1 passed, 1 total
Snapshots:   0 total
Time:        1.46s, estimated 2s
Ran all test suites.

代码覆盖率

jest 支持生成代码覆盖率报告。

要使用 TypeScript 进行代码覆盖，你需要向 package.json 添加另一个配置行。

{
...
  "jest": {
  ...
    "testResultsProcessor": "<rootDir>/node_modules/ts-jest/coverageprocessor.js"
  }
}

运行生成覆盖率报告的测试运行

jest --coverage

如果与我们的样本嘶嘶声一起使用你应该看到

 PASS  ./fizzBuzz.test.ts
  ✓ FizzBuzz test (3ms)

-------------|----------|----------|----------|----------|----------------|
File         |  % Stmts | % Branch |  % Funcs |  % Lines |Uncovered Lines |
-------------|----------|----------|----------|----------|----------------|
All files    |    92.31 |     87.5 |      100 |    91.67 |                |
 fizzBuzz.ts |    92.31 |     87.5 |      100 |    91.67 |             13 |
-------------|----------|----------|----------|----------|----------------|
Test Suites: 1 passed, 1 total
Tests:       1 passed, 1 total
Snapshots:   0 total
Time:        1.857s
Ran all test suites.

jest 还创建了文件夹 coverage，其中包含各种格式的覆盖报告，包括 coverage/lcov-report/index.html 中的用户友好的 html 报告