typescript-coverage-report.ts

Filename	Percent	Threshold	Total	Covered	Uncovered
src/bin/typescript-coverage-report.ts	91.91%	90%	136	125	11

#!/usr/bin/env node

import { program } from "commander";
import generateCoverageReport, { ProgramOptions } from "../lib";
import path from "path";
import { IPackageJson } from "package-json-type";

type TypeCoverageConfig = {
  outputDir?: string;
  atLeast?: number;
  strict?: boolean;
  debug?: boolean;
  cache?: boolean;
  project?: string;
  ignoreFiles?: boolean;
  ignoreCatch?: boolean;
  ignoreUnread?: boolean;
};

const {
  version,
  description
}: // eslint-disable-next-line @typescript-eslint/no-var-requires
IPackageJson = require("../../package.json");

const {
  typeCoverage = {}
}: // eslint-disable-next-line @typescript-eslint/no-var-requires
IPackageJson & { typeCoverage?: TypeCoverageConfig } = require(path.join(
  process.cwd(),
  "/package.json"
));

const argvWithVersion = (argvs: string[]): string[] => {
  const vPos = argvs.indexOf("-v");

  if (vPos > -1) {
    argvs[vPos] = "-V";
  }

  return argvs;
};

const {
  outputDir = "coverage-ts",
  atLeast = 80,
  strict = false,
  debug = false,
  cache = false,
  project = ".",
  ignoreFiles = false,
  ignoreCatch = false,
  ignoreUnread = false
} = typeCoverage;

program
  .version(version)
  .description(description)
  .option(
    "-o, --outputDir [string]",
    "the output directory where to generate the report.",
    outputDir
  )
  .option(
    "-t, --threshold [number]",
    "the minimum percentage of coverage required.",
    parseFloat,
    atLeast
  )
  .option("-s, --strict [boolean]", "run the check in strict mode.", strict)
  .option("-d, --debug [boolean]", "show debug information.", debug)
  .option(
    "-c, --cache [boolean]",
    "save and reuse type check result from cache.",
    cache
  )
  .option(
    "-p, --project [string]",
    'file path to tsconfig file, eg: --project "./app/tsconfig.app.json"',
    project
  )
  .option(
    "-i, --ignore-files [string[]]",
    'ignore specified files, eg: --ignore-files "demo1/*.ts" --ignore-files "demo2/foo.ts"',
    ignoreFiles
  )
  .option(
    "--ignore-catch [boolean]",
    "ignore type any for (try-)catch clause variable",
    ignoreCatch
  )
  .option(
    "-u, --ignore-unread [boolean]",
    "allow writes to variables with implicit any types",
    ignoreUnread
  )
  .option(
    "-- [string[]]",
    "only checks these files, useful for usage with tools like lint-staged"
  )
  .parse(argvWithVersion(process.argv));

const options: ProgramOptions = {
  /* camelCase keys matching "long" flags in options above */
  outputDir: program.outputDir,
  threshold: program.threshold,
  tsProjectFile: program.project,
  strict: program.strict,
  debug: program.debug,
  cache: program.cache,
  ignoreFiles: program.ignoreFiles,
  ignoreCatch: program.ignoreCatch,
  ignoreUnread: program.ignoreUnread,
  files: program.args.length > 0 ? program.args : undefined
};

generateCoverageReport(options)
  .then(({ percentage }) => {
    if (percentage < options.threshold) {
      console.error(
        `\nThe TypeScript coverage ${percentage.toFixed(
          2
        )}% is lower than the threshold ${options.threshold}%`
      );

      process.exit(2);
    }

    process.exit(0);
  })
  .catch((error) => {
    console.error(error);

    process.exit(255);
  });

[{"file":"src/bin/typescript-coverage-report.ts","line":104,"character":21,"text":"outputDir","kind":1},{"file":"src/bin/typescript-coverage-report.ts","line":105,"character":21,"text":"threshold","kind":1},{"file":"src/bin/typescript-coverage-report.ts","line":106,"character":25,"text":"project","kind":1},{"file":"src/bin/typescript-coverage-report.ts","line":107,"character":18,"text":"strict","kind":1},{"file":"src/bin/typescript-coverage-report.ts","line":108,"character":17,"text":"debug","kind":1},{"file":"src/bin/typescript-coverage-report.ts","line":109,"character":17,"text":"cache","kind":1},{"file":"src/bin/typescript-coverage-report.ts","line":110,"character":23,"text":"ignoreFiles","kind":1},{"file":"src/bin/typescript-coverage-report.ts","line":111,"character":23,"text":"ignoreCatch","kind":1},{"file":"src/bin/typescript-coverage-report.ts","line":112,"character":24,"text":"ignoreUnread","kind":1},{"file":"src/bin/typescript-coverage-report.ts","line":130,"character":10,"text":"error","kind":1},{"file":"src/bin/typescript-coverage-report.ts","line":131,"character":18,"text":"error","kind":1}]

TypeScript coverage report