flow-coverage-report/dist/lib/cli/args.js

Generate an HTML report of the flow coverage data

"use strict";

var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");

Object.defineProperty(exports, "__esModule", {
  value: true
});
exports["default"] = processArgv;

var _path = _interopRequireDefault(require("path"));

var _yargs = _interopRequireDefault(require("yargs"));

var _package = _interopRequireDefault(require("../../../package"));

var _config = require("./config");

var examples = function examples(appName) {
  return "\nExamples:\n\n  ".concat(appName, " -i \"src/**/*.js\"\n  ").concat(appName, " -p /path/to/project -i \"src/**/*.js\" -x \"src/test/**/*.js\"\n  ").concat(appName, " -t html -p /path/to/project -i \"src/**/*.js\"\n  ").concat(appName, " -t html -t json -t text /path/to/project -i \"src/**/*.js\"\n  ").concat(appName, " -i \"src/**/*.js\" -c 5\n\nFor more informations:\n\n  https://github.com/rpl/flow-coverage-report\n");
};

function processArgv(argv) {
  var appName = _path["default"].basename(argv[1]).split('.')[0];

  return (0, _yargs["default"])(argv).usage('Usage: $0 COMMAND PROJECTDIR [...globs]').help('h').alias('h', 'help').version(_package["default"].name + ' ' + _package["default"].version).alias('v', 'version') // -f flow-command-path
  .option('flow-command-path', {
    alias: 'f',
    type: 'string',
    coerce: function coerce(value) {
      if (typeof value !== 'string') {
        // $FlowIgnore: allow value to be coerced to a string.
        throw new TypeError("Unexpected non-string value: ".concat(value));
      }

      return value.slice(0, 2) === './' ? _path["default"].resolve(value) : value;
    },
    describe: "path to the flow executable (defaults to \"".concat(_config.defaultConfig.flowCommandPath, "\")")
  }).option('flow-command-timeout', {
    type: 'number',
    describe: 'maximum number of milliseconds to wait for a flow response (defaults to 15 seconds)'
  }) // --type text
  .option('type', {
    alias: ['t', 'reportTypes'],
    choices: ['html', 'json', 'text', 'badge'],
    describe: "format of the generated reports (defaults to \"".concat(_config.defaultConfig.reportTypes.join(', '), "\")")
  }) // --project-dir "/project/dir/path"
  .option('project-dir', {
    alias: 'p',
    type: 'string',
    describe: "select the project dir path (defaults to \"".concat(_config.defaultConfig.projectDir, "\")")
  }) // --include-glob "src/**/*.js"
  .option('include-glob', {
    alias: ['i', 'globIncludePatterns'],
    type: 'array',
    describe: 'include the files selected by the specified glob'
  }).option('exclude-glob', {
    alias: ['x', 'globExcludePatterns'],
    type: 'array',
    describe: 'exclude the files selected by the specified glob ' + "(defaults to \"".concat(JSON.stringify(_config.defaultConfig.globExcludePatterns || []), "\")")
  }).options('threshold', {
    type: 'number',
    describe: "the minimum coverage percent requested (defaults to ".concat(_config.defaultConfig.threshold, ")")
  }).options('percent-decimals', {
    alias: ['percentDecimanls'],
    type: 'number',
    describe: 'the number of decimals used for the computed percent values'
  }) // --output-dir "/var/public_html/flow-coverage"
  .option('output-dir', {
    alias: 'o',
    type: 'string',
    describe: "output html or json files to this folder relative to project-dir (defaults to \"".concat(_config.defaultConfig.outputDir, "\")")
  }) // --concurrent-files 5
  .option('concurrent-files', {
    alias: 'c',
    type: 'number',
    describe: "the maximum number of files concurrently submitted to flow (defaults to ".concat(_config.defaultConfig.concurrentFiles, ")")
  }) // --strict-coverage
  .option('strict-coverage', {
    type: 'boolean',
    describe: 'non annotated and flow weak files are considered as completely uncovered. ' + 'Default behavior is for flow to best-guess coverage on all the files included in the report.'
  }).option('exclude-non-flow', {
    type: 'boolean',
    describe: 'Excludes flies without flow annotation from the report'
  }) // --no-config
  .option('no-config', {
    type: 'boolean',
    describe: 'do not load any config file from the project dir'
  }).option('config', {
    type: 'string',
    describe: 'file path of the config file to load'
  }).check(function (argv) {
    if (argv._.length > 2) {
      throw new Error('ERROR: The include glob needs to be quoted.');
    }

    return true;
  }).epilogue(examples(appName)).argv;
}
//# sourceMappingURL=args.js.map