coverage-badges-cli/src/index.ts

Create coverage badges from coverage reports. Using GitHub Actions and GitHub Workflow CPU time (no 3rd parties servers).

import minimist, { ParsedArgs } from 'minimist';
import { create } from './create';
import { BadgeOption } from './badges';

export interface RunArgvs extends ParsedArgs, Partial<BadgeOption> {
  source?: string;
  version?: string;
  output?: string;
  jsonPath?: string;
  /// <Color RGB> or <Color Name> (default: '555')
  labelColor?: string;
}

export default function run() {
  const argvs: RunArgvs = minimist(process.argv.slice(2), {
    alias: {
      help: 'h',
      source: 's',
      output: 'o',
    },
    default: {
      style: 'classic',
      source: 'coverage/coverage-summary.json',
      output: 'coverage/badges.svg',
      jsonPath: 'total.statements.pct',
    },
  });
  if (argvs.h || argvs.help) {
    cliHelp()
    exampleHelp()
    return;
  }
  const { version } = require('../package.json');
  if (argvs.v || argvs.version) {
    console.log(`\n coverage-badges-cli v${version}\n`);
    return;
  }
  console.log("argvs: ", argvs);  
  create(argvs);
}


export function cliHelp() {
  console.log('\n  Usage: coverage-badges [options] [--help|h]');
  console.log('\n  Options:\n');
  console.log('    --version, -v  ','Show version number');
  console.log('    --help, -h     ','Displays help information.');
  console.log('    --output, -o   ','Output directory.');
  console.log('    --source, -s   ','The path of the target file "coverage-summary.json".');
  console.log('    --style        ','Badges style: flat, flat-square.');
  console.log('    --type         ','Coverage type: lines, statements, functions, branches.');
  console.log('    --scale        ','Set badge scale (default: 1)');
  console.log('    --icon         ','Path to icon file');
  console.log('    --iconWidth    ','Set this if icon is not square (default: 13)');
  console.log('    --label        ','The left label of the badge, usually static (default `coverage`).');
  console.log('    --labelColor   ','<Color RGB> or <Color Name> (default: "555")');
  console.log('    --color        ','<Color RGB> or <Color Name> (default: "")');
}

export function exampleHelp() {
  console.log('\n  Example:\n');
  console.log('    \x1b[35mnpm\x1b[0m coverage-badges-cli \x1b[33m--output\x1b[0m coverage/badges.svg');
  console.log('    \x1b[35mnpm\x1b[0m coverage-badges-cli \x1b[33m--style\x1b[0m plastic');
  console.log('    \x1b[35mnpm\x1b[0m coverage-badges-cli \x1b[33m--source\x1b[0m coverage/coverage-summary.json');
  console.log('    \x1b[35mnpm\x1b[0m coverage-badges-cli \x1b[33m--labelColor\x1b[0m ADF');
  console.log('\n');
}