flow-coverage-report/dist/lib/cli/config.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.loadConfig = loadConfig;
exports.validateConfig = validateConfig;
exports.defaultConfig = exports.DEFAULT_FLOW_TIMEOUT = exports.UsageError = void 0;

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

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

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

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

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

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

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

var _fs = _interopRequireDefault(require("fs"));

var _parseJson = _interopRequireDefault(require("parse-json"));

var _stripJsonComments = _interopRequireDefault(require("strip-json-comments"));

function _createForOfIteratorHelper(o, allowArrayLike) { var it; if (typeof Symbol === "undefined" || o[Symbol.iterator] == null) { if (Array.isArray(o) || (it = _unsupportedIterableToArray(o)) || allowArrayLike && o && typeof o.length === "number") { if (it) o = it; var i = 0; var F = function F() {}; return { s: F, n: function n() { if (i >= o.length) return { done: true }; return { done: false, value: o[i++] }; }, e: function e(_e) { throw _e; }, f: F }; } throw new TypeError("Invalid attempt to iterate non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); } var normalCompletion = true, didErr = false, err; return { s: function s() { it = o[Symbol.iterator](); }, n: function n() { var step = it.next(); normalCompletion = step.done; return step; }, e: function e(_e2) { didErr = true; err = _e2; }, f: function f() { try { if (!normalCompletion && it["return"] != null) it["return"](); } finally { if (didErr) throw err; } } }; }

function _unsupportedIterableToArray(o, minLen) { if (!o) return; if (typeof o === "string") return _arrayLikeToArray(o, minLen); var n = Object.prototype.toString.call(o).slice(8, -1); if (n === "Object" && o.constructor) n = o.constructor.name; if (n === "Map" || n === "Set") return Array.from(o); if (n === "Arguments" || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(n)) return _arrayLikeToArray(o, minLen); }

function _arrayLikeToArray(arr, len) { if (len == null || len > arr.length) len = arr.length; for (var i = 0, arr2 = new Array(len); i < len; i++) { arr2[i] = arr[i]; } return arr2; }

function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); if (enumerableOnly) symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; }); keys.push.apply(keys, symbols); } return keys; }

function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = arguments[i] != null ? arguments[i] : {}; if (i % 2) { ownKeys(Object(source), true).forEach(function (key) { (0, _defineProperty2["default"])(target, key, source[key]); }); } else if (Object.getOwnPropertyDescriptors) { Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)); } else { ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } } return target; }

function _createSuper(Derived) { var hasNativeReflectConstruct = _isNativeReflectConstruct(); return function _createSuperInternal() { var Super = (0, _getPrototypeOf2["default"])(Derived), result; if (hasNativeReflectConstruct) { var NewTarget = (0, _getPrototypeOf2["default"])(this).constructor; result = Reflect.construct(Super, arguments, NewTarget); } else { result = Super.apply(this, arguments); } return (0, _possibleConstructorReturn2["default"])(this, result); }; }

function _isNativeReflectConstruct() { if (typeof Reflect === "undefined" || !Reflect.construct) return false; if (Reflect.construct.sham) return false; if (typeof Proxy === "function") return true; try { Date.prototype.toString.call(Reflect.construct(Date, [], function () {})); return true; } catch (e) { return false; } }

var UsageError = /*#__PURE__*/function (_Error) {
  (0, _inherits2["default"])(UsageError, _Error);

  var _super = _createSuper(UsageError);

  function UsageError(message) {
    var _this;

    (0, _classCallCheck2["default"])(this, UsageError);
    _this = _super.call(this, message);
    _this.name = 'UsageError';
    return _this;
  }

  return UsageError;
}( /*#__PURE__*/(0, _wrapNativeSuper2["default"])(Error));

exports.UsageError = UsageError;

var toArray = function toArray(value) {
  return Array.isArray(value) ? value : [value];
}; // Default timeout for flow coverage commands.


var DEFAULT_FLOW_TIMEOUT = 15 * 1000;
exports.DEFAULT_FLOW_TIMEOUT = DEFAULT_FLOW_TIMEOUT;
var defaultConfig = {
  reportTypes: ['text'],
  flowCommandPath: 'flow',
  flowCommandTimeout: DEFAULT_FLOW_TIMEOUT,
  projectDir: _path["default"].resolve(process.cwd()),
  globExcludePatterns: ['node_modules/**'],
  globIncludePatterns: [],
  threshold: 80,
  percentDecimals: 0,
  outputDir: './flow-coverage',
  concurrentFiles: 1,
  strictCoverage: false,
  excludeNonFlow: false,
  noConfig: false,
  htmlTemplateOptions: {
    autoHeightSource: true,
    showMeterBar: false
  }
};
exports.defaultConfig = defaultConfig;

var getProjectDir = function getProjectDir(config) {
  var _defaultConfig$config = _objectSpread(_objectSpread({}, defaultConfig), config),
      projectDir = _defaultConfig$config.projectDir;

  if (!projectDir) {
    throw new UsageError('projectDir option is mandatory');
  }

  if (typeof projectDir !== 'string') {
    throw new UsageError('Unexpected non-string projectDir option');
  }

  return projectDir;
};
/**
 * Normalize config properties to match the property name used internally
 * when it has multiple aliases.
 *
 * @param {object} config
 */


function normalizedConfig(config) {
  if (typeof config.includeGlob !== 'undefined') {
    console.warn('WARN: "includeGlob" config file property has been renamed to "globIncludePatterns"');
    config.globIncludePatterns = toArray(config.includeGlob);
  }

  if (typeof config.excludeGlob !== 'undefined') {
    console.warn('WARN: "excludeGlob" config file property has been renamed to "globExcludePatterns"');
    config.globExcludePatterns = toArray(config.excludeGlob);
  }

  if (typeof config.type !== 'undefined') {
    console.warn('WARN: "type" config file property has been renamed to "reportTypes"');
    config.reportTypes = toArray(config.type);
  }

  return config;
}
/**
 * Try to load configuration parameters from the project dir if the following order:
 * - do not load any config if --no-config option is specified
 * - from the package.json "flow-coverage-report" property, if any
 * - from a .flow-coverage-report.json, if any
 * - from the --config cli parameter, if any
 */


function loadConfig(args) {
  // Remove any undefined property from the yargs object.
  for (var _i = 0, _Object$keys = Object.keys(args); _i < _Object$keys.length; _i++) {
    var key = _Object$keys[_i];

    if (typeof args[key] === 'undefined') {
      delete args[key];
    }
  }

  if (args.noConfig) {
    return _objectSpread(_objectSpread({}, defaultConfig), args);
  }

  if (args.includeGlob) {
    args.includeGlob = toArray(args.includeGlob);
  }

  if (args.globIncludePatterns) {
    args.globIncludePatterns = toArray(args.globIncludePatterns);
  }

  if (args.config) {
    var filePath = _path["default"].resolve(args.config);

    var fileRawData = _fs["default"].readFileSync(filePath);

    var fileConfigData = (0, _parseJson["default"])((0, _stripJsonComments["default"])(String(fileRawData)));

    if (process.env.VERBOSE) {
      console.log('Loaded config from file', filePath, fileConfigData);
    }

    return _objectSpread(_objectSpread(_objectSpread({}, defaultConfig), normalizedConfig(fileConfigData)), args);
  }

  var packageJSONPath;

  try {
    packageJSONPath = _path["default"].resolve(_path["default"].join(getProjectDir(args), 'package.json')); // $FlowIgnore: the following dynamic require loads only the package.json file.

    var pkg = require(packageJSONPath);

    if (pkg['flow-coverage-report']) {
      if (process.env.VERBOSE) {
        console.log('Loaded config from package.json', pkg['flow-coverage-report']);
      }

      return _objectSpread(_objectSpread(_objectSpread({}, defaultConfig), normalizedConfig(pkg['flow-coverage-report'])), args);
    }
  } catch (error) {
    if (process.env.VERBOSE) {
      console.error('Unable to load config from project package.json', packageJSONPath, error);
    }
  }

  var projectConfigPath;

  try {
    projectConfigPath = _path["default"].resolve(_path["default"].join(getProjectDir(args), '.flow-coverage-report.json'));

    var projectConfigRaw = _fs["default"].readFileSync(projectConfigPath);

    var projectConfigData = (0, _parseJson["default"])((0, _stripJsonComments["default"])(String(projectConfigRaw)));

    if (process.env.VERBOSE) {
      console.log('Loaded config from project dir', projectConfigPath, projectConfigData);
    }

    return _objectSpread(_objectSpread(_objectSpread({}, defaultConfig), normalizedConfig(projectConfigData)), args);
  } catch (error) {
    if (process.env.VERBOSE) {
      console.error('Unable to load config from file', projectConfigPath, error);
    }
  }

  return _objectSpread(_objectSpread({}, defaultConfig), args);
}
/**
 * Validate the arguments collected from the command line and config files and
 * ensure that it is a valid FlowCoverageReportOptions object (as described by its
 * flow type declaration in the "src/lib/index.js module")
 */


function validateConfig(args) {
  function raiseErrorIfArray(value, message) {
    if (Array.isArray(value)) {
      throw new UsageError("ERROR: Only one ".concat(message, " can be specified."));
    }
  }

  var preventDuplicatedOptions = {
    projectDir: 'project dir',
    outputDir: 'output dir',
    threshold: 'threshold',
    flowCommandPath: 'flow command',
    concurrentFiles: '--concurrent-files option'
  };

  for (var _i2 = 0, _Object$keys2 = Object.keys(preventDuplicatedOptions); _i2 < _Object$keys2.length; _i2++) {
    var option = _Object$keys2[_i2];
    var message = preventDuplicatedOptions[option];
    raiseErrorIfArray(args[option], message);
  }

  var globIncludePatterns = args.globIncludePatterns;

  if (!globIncludePatterns || globIncludePatterns.length === 0 || !globIncludePatterns[0]) {
    throw new UsageError('ERROR: No glob has been specified.');
  }

  var _iterator = _createForOfIteratorHelper(globIncludePatterns),
      _step;

  try {
    for (_iterator.s(); !(_step = _iterator.n()).done;) {
      var glob = _step.value;

      if (glob[0] === '!') {
        throw new UsageError('ERROR: Only include glob syntax are supported.');
      }
    }
  } catch (err) {
    _iterator.e(err);
  } finally {
    _iterator.f();
  }

  return args;
}
//# sourceMappingURL=config.js.map