FilesCoverageCheck

检查指定文件单元测试结果，目前支持单元测试报告：istanbul

Usage

tnpm install --save @tencent/files-coverage-check

import { check } from "@tencent/files-coverage-check";

const result = await check({
    summary: "./coverage/json-summary.json",
    checkFiles: "./chenged.txt",
    summaryPrefix: "/workdir/",
    waterLine: {
        lines: 80,
        statements: 80,
        functions: 80,
        branches: 80
    }
});

console.log(result.pass);

输入

• summary: string|json 必选，从指定文件读取单元测试json报告或者json报告对象
• checkFiles: string|Array<string> 可选，从指定文件读取需要检查的文件列表或者直接为文件列表，为空检查全部
• summaryPrefix: string 可选，测试报告里的文件path相对于检查文件path的前缀
• waterLine: object 可选，需要检查的水平线
  • lines: number 可选，要求最低Lines覆盖率，默认为0
  • statements: number 可选，要求最低Statements覆盖率，默认为0
  • functions: number 可选，要求最低Functions覆盖率，默认为0
  • branches: number 可选，要求最低Branches覆盖率，默认为0

输出

• pass: boolean 是否全部文件覆盖率在水平线以上
• detail: Map<filepath, Result> 每个文件的详情
  • filepath: 单个文件路径
  • Result: 单个文件结果
    • pass: boolean 是否通过
    • lines: 行覆盖率
      • pct: 覆盖率
      • pass: 是否通过
    • statements: 语句覆盖率
      • pct: 覆盖率
      • pass: 是否通过
    • functions: 方法覆盖率
      • pct: 覆盖率
      • pass: 是否通过
    • branches: 分支覆盖率
      • pct: 覆盖率
      • pass: 是否通过