@percy/config 1.0.0-beta.9 → 1.0.0

package/README.md

@@ -1,13 +1,14 @@
-## @percy/config
+# @percy/config
 
 Handles loading and adding options to Percy configuration files. Uses
 [cosmiconfig](https://github.com/davidtheclark/cosmiconfig) to load configuration files and [JSON
 schema](https://json-schema.org/) with [AJV](https://github.com/epoberezkin/ajv) to validate those
 configuration files.
 
-## Usage
+- [Loading config files](#loading-config-files)
+- [Extending config options](#extending-config-options)
 
-### Loading config files
+## Loading config files
 
 The `.load()` method will load and validate a configuation file, optionally merging it with any
 provided `overrides`. If no `path` is provided, will search for the first supported config found
@@ -18,14 +19,17 @@ from the current directory up to the home directoy. Configuration files are cach
 import PercyConfig from '@percy/config'
 
 // loading is done synchronously
-const config = PercyConfig.load({
-  path,            // config file path or directory path containing a config file
-  overrides = {},  // configuration option overrides
-  reload = false,  // reload file and update cache
-  bail = false     // return undefined on validation warnings
-})
+const config = PercyConfig.load(options)
 ```
 
+#### Options
+
+- `path` — Config file path or directory containing a config file
+- `overrides` — Config option overrides
+- `reload` — Do not use cached config (**default** `false`)
+- `bail` — Return undefined when failing validation (**default** `false`)
+- `print` — Print info and error logs (**default** `false`)
+
 #### Supported files
 
 - `"percy"` entry in `package.json`
@@ -34,7 +38,7 @@ const config = PercyConfig.load({
 - `.percy.yaml` or `.percy.yml` YAML file
 - `.percy.js` or `percy.config.js` file that exports an object
 
-### Extending config options
+## Extending config options
 
 The `.addSchema()` function will add a sub-schema to the Percy configuration file which will be
 parsed and validated when `PercyConfig.load()` is called. See [JSON
@@ -43,5 +47,7 @@ schema](https://json-schema.org/) for possible schema options.
 ```js
 import PercyConfig from '@percy/config'
 
-PercyConfig.addSchema({ propertyName: JSONSchema })
+PercyConfig.addSchema({
+  propertyName: JSONSchema
+})
 ```

package/package.json

@@ -1,36 +1,45 @@
 {
   "name": "@percy/config",
-  "version": "1.0.0-beta.9",
+  "version": "1.0.0",
   "license": "MIT",
-  "main": "dist/index.js",
-  "types": "types/index.d.ts",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/percy/cli",
+    "directory": "packages/config"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "engines": {
+    "node": ">=14"
+  },
   "files": [
-    "dist",
-    "types/index.d.ts"
+    "./dist",
+    "./types/index.d.ts"
   ],
+  "main": "./dist/index.js",
+  "types": "./types/index.d.ts",
+  "type": "module",
+  "exports": {
+    ".": "./dist/index.js",
+    "./utils": "./dist/utils/index.js",
+    "./test/helpers": "./test/helpers.js"
+  },
   "scripts": {
-    "build": "babel --root-mode upward src --out-dir dist",
+    "build": "node ../../scripts/build",
     "lint": "eslint --ignore-path ../../.gitignore .",
-    "test": "cross-env NODE_ENV=test mocha",
-    "test:coverage": "nyc yarn test",
+    "test": "node ../../scripts/test",
+    "test:coverage": "yarn test --coverage",
     "test:types": "tsd"
   },
-  "publishConfig": {
-    "access": "public"
-  },
-  "mocha": {
-    "require": "../../scripts/babel-register"
-  },
   "dependencies": {
-    "@percy/logger": "^1.0.0-beta.9",
-    "ajv": "^6.12.0",
+    "@percy/logger": "1.0.0",
+    "ajv": "^8.6.2",
     "cosmiconfig": "^7.0.0",
-    "deepmerge": "^4.2.2",
-    "path-type": "^4.0.0",
-    "yaml": "^1.8.0"
+    "yaml": "^1.10.0"
   },
   "devDependencies": {
     "json-schema-typed": "^7.0.3"
   },
-  "gitHead": "57a2eeb90c7f5cdf8827c78be1e5c12df581f4b5"
+  "gitHead": "6df509421a60144e4f9f5d59dc57a5675372a0b2"
 }

package/dist/defaults.js

@@ -1,48 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = getDefaults;
-
-var _deepmerge = _interopRequireDefault(require("deepmerge"));
-
-var _validate = require("./validate");
-
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
-const {
-  assign,
-  entries,
-  freeze
-} = Object; // Recursively walks a schema and collects defaults. When no schema is provided,
-// the default config schema is used. Returned defaults are frozen.
-
-function getDefaultFromSchema(schema) {
-  if (!schema || typeof schema.$ref === 'string') {
-    var _schema$$ref;
-
-    // get the schema from ajv
-    return getDefaultFromSchema((0, _validate.getSchema)((_schema$$ref = schema === null || schema === void 0 ? void 0 : schema.$ref) !== null && _schema$$ref !== void 0 ? _schema$$ref : 'config'));
-  } else if (schema.default != null) {
-    // return the frozen default for this schema
-    return freeze(schema.default);
-  } else if (schema.type === 'object' && schema.properties) {
-    // return a frozen object of default properties
-    return freeze(entries(schema.properties).reduce((acc, [prop, schema]) => {
-      let def = getDefaultFromSchema(schema);
-      return def != null ? assign(acc || {}, {
-        [prop]: def
-      }) : acc;
-    }, undefined));
-  } else {
-    return undefined;
-  }
-}
-
-function getDefaults(overrides = {}) {
-  return _deepmerge.default.all([getDefaultFromSchema(), overrides], {
-    // overwrite default arrays, do not merge
-    arrayMerge: (_, arr) => arr
-  });
-}

package/dist/index.js

@@ -1,33 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = void 0;
-
-var _load = _interopRequireWildcard(require("./load"));
-
-var _validate = _interopRequireWildcard(require("./validate"));
-
-var _defaults = _interopRequireDefault(require("./defaults"));
-
-var _stringify = _interopRequireDefault(require("./stringify"));
-
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
-function _getRequireWildcardCache() { if (typeof WeakMap !== "function") return null; var cache = new WeakMap(); _getRequireWildcardCache = function () { return cache; }; return cache; }
-
-function _interopRequireWildcard(obj) { if (obj && obj.__esModule) { return obj; } if (obj === null || typeof obj !== "object" && typeof obj !== "function") { return { default: obj }; } var cache = _getRequireWildcardCache(); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (Object.prototype.hasOwnProperty.call(obj, key)) { var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null; if (desc && (desc.get || desc.set)) { Object.defineProperty(newObj, key, desc); } else { newObj[key] = obj[key]; } } } newObj.default = obj; if (cache) { cache.set(obj, newObj); } return newObj; }
-
-// Export a single object that can be imported as PercyConfig
-var _default = {
-  load: _load.default,
-  cache: _load.cache,
-  explorer: _load.explorer,
-  validate: _validate.default,
-  addSchema: _validate.addSchema,
-  resetSchema: _validate.resetSchema,
-  getDefaults: _defaults.default,
-  stringify: _stringify.default
-};
-exports.default = _default;

package/dist/load.js

@@ -1,92 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = load;
-exports.explorer = exports.cache = void 0;
-
-var _path = require("path");
-
-var _cosmiconfig = require("cosmiconfig");
-
-var _pathType = require("path-type");
-
-var _deepmerge = _interopRequireDefault(require("deepmerge"));
-
-var _logger = _interopRequireDefault(require("@percy/logger"));
-
-var _defaults = _interopRequireDefault(require("./defaults"));
-
-var _normalize = _interopRequireDefault(require("./normalize"));
-
-var _validate = _interopRequireDefault(require("./validate"));
-
-var _stringify = require("./stringify");
-
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
-// Loaded configuration file cache
-const cache = new Map(); // The cosmiconfig explorer used to load config files
-
-exports.cache = cache;
-const explorer = (0, _cosmiconfig.cosmiconfigSync)('percy', {
-  cache: false,
-  searchPlaces: ['package.json', '.percyrc', '.percy.json', '.percy.yaml', '.percy.yml', '.percy.js', 'percy.config.js']
-}); // Finds and loads a config file using cosmiconfig, merges it with optional
-// inputs, validates the combined config according to the schema, and returns
-// the combined config. Loaded config files are cached and reused on next load,
-// unless `reload` is true in which the file will be reloaded and the cache
-// updated. Validation errors are logged as warnings and the config is returned
-// unless `bail` is true. Supports kebab-case and camelCase config options and
-// always returns camelCase options. Currently only supports version 2 config
-// files; missing versions or other versions are discarded.
-
-exports.explorer = explorer;
-
-function load({
-  path,
-  overrides = {},
-  reload = false,
-  bail = false
-} = {}) {
-  var _Array$from;
-
-  // load cached config; when no path is specified, get the last config cached
-  let config = path ? cache.get(path) : (_Array$from = Array.from(cache)[cache.size - 1]) === null || _Array$from === void 0 ? void 0 : _Array$from[1]; // load config or reload cached config
-
-  if (path !== false && (!config || reload)) {
-    try {
-      let result = !path || (0, _pathType.isDirectorySync)(path) ? explorer.search(path) : explorer.load(path);
-
-      if (result && result.config) {
-        _logger.default.debug(`Found config file: ${(0, _path.relative)('', result.filepath)}`);
-
-        if (result.config.version !== 2) {
-          _logger.default.warn('Ignoring config file - ' + (!result.config.version ? 'missing version' : 'unsupported version'));
-        } else {
-          // normalize to remove empty values and convert snake-case to camelCase
-          config = (0, _normalize.default)(result.config);
-          cache.set(path, config);
-        }
-      } else {
-        _logger.default.debug('Config file not found');
-      }
-    } catch (error) {
-      _logger.default.debug('Failed to load or parse config file');
-
-      _logger.default.debug(error);
-    }
-  } // merge found config with overrides and validate
-
-
-  config = (0, _deepmerge.default)(config || {}, overrides);
-  if (!(0, _validate.default)(config, {
-    scrub: true
-  }) && bail) return; // normalize again to remove empty values from overrides and validation scrubbing
-
-  config = (0, _normalize.default)(config);
-  if (config) _logger.default.debug(`Using config:\n${(0, _stringify.inspect)(config)}`); // merge with defaults
-
-  return (0, _defaults.default)(config);
-}

package/dist/normalize.js

@@ -1,37 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = normalize;
-
-// recursively reduces config objects and arrays to remove undefined and empty
-// values and rename kebab-case properties to camelCase.
-function normalize(subject) {
-  if (typeof subject === 'object') {
-    let isArray = Array.isArray(subject);
-    return Object.entries(subject).reduce((result, [key, value]) => {
-      value = normalize(value);
-
-      if (typeof value !== 'undefined') {
-        return isArray ? (result || []).concat(value) : Object.assign(result || {}, {
-          [camelize(key)]: value
-        });
-      } else {
-        return result;
-      }
-    }, undefined);
-  } else {
-    return subject;
-  }
-} // Edge case camelizations
-
-
-const CAMELIZE_MAP = {
-  css: 'CSS',
-  javascript: 'JavaScript'
-}; // Converts a kebab-cased string to camelCase.
-
-function camelize(s) {
-  return s.replace(/-([^-]+)/g, (_, w) => CAMELIZE_MAP[w] || w[0].toUpperCase() + w.slice(1));
-}

package/dist/stringify.js

@@ -1,42 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.inspect = inspect;
-exports.default = stringify;
-
-var _util = _interopRequireDefault(require("util"));
-
-var _yaml = _interopRequireDefault(require("yaml"));
-
-var _defaults = _interopRequireDefault(require("./defaults"));
-
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
-// Provides native util.inspect with common options for printing configs.
-function inspect(config) {
-  return _util.default.inspect(config, {
-    depth: null,
-    compact: false
-  });
-} // Converts a config to a yaml, json, or js string. When no config is provided,
-// falls back to schema defaults.
-
-
-function stringify(format, config = (0, _defaults.default)()) {
-  switch (format) {
-    case 'yml':
-    case 'yaml':
-      return _yaml.default.stringify(config);
-
-    case 'json':
-      return JSON.stringify(config, null, 2);
-
-    case 'js':
-      return `module.exports = ${inspect(config)}`;
-
-    default:
-      throw new Error(`Unsupported format: ${format}`);
-  }
-}

package/dist/validate.js

@@ -1,121 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.getSchema = getSchema;
-exports.addSchema = addSchema;
-exports.resetSchema = resetSchema;
-exports.default = validate;
-
-var _ajv = _interopRequireDefault(require("ajv"));
-
-var _logger = _interopRequireDefault(require("@percy/logger"));
-
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
-const {
-  assign,
-  entries
-} = Object; // Ajv manages and validates schemas.
-
-const ajv = new _ajv.default({
-  verbose: true,
-  allErrors: true,
-  schemas: {
-    config: getDefaultSchema()
-  }
-}); // Returns a new default schema.
-
-function getDefaultSchema() {
-  return {
-    type: 'object',
-    additionalProperties: false,
-    properties: {
-      version: {
-        type: 'integer',
-        default: 2
-      }
-    }
-  };
-} // Gets the schema object from the AJV schema.
-
-
-function getSchema(name) {
-  return ajv.getSchema(name).schema;
-} // Adds schemas to the config schema's properties. The config schema is removed,
-// modified, and replaced after the new schemas are added to clear any compiled
-// caches. Existing schemas are removed and replaced as well.
-
-
-function addSchema(schemas) {
-  let config = getSchema('config');
-  ajv.removeSchema('config');
-
-  for (let [$id, schema] of entries(schemas)) {
-    if (ajv.getSchema($id)) ajv.removeSchema($id);
-    assign(config.properties, {
-      [$id]: {
-        $ref: $id
-      }
-    });
-    ajv.addSchema(schema, $id);
-  }
-
-  ajv.addSchema(config, 'config');
-} // Resets the schema by removing all schemas and inserting a new default schema.
-
-
-function resetSchema() {
-  ajv.removeSchema();
-  ajv.addSchema(getDefaultSchema(), 'config');
-} // Validates config data according to the config schema and logs warnings to the
-// console. Optionallly scrubs invalid values from the provided config. Returns
-// true when the validation success, false otherwise.
-
-
-function validate(config, {
-  scrub
-} = {}) {
-  let result = ajv.validate('config', config);
-
-  if (!result) {
-    _logger.default.warn('Invalid config:');
-
-    for (let error of ajv.errors) {
-      let {
-        dataPath,
-        keyword,
-        params,
-        message,
-        data
-      } = error;
-      let pre = dataPath ? `'${dataPath.substr(1)}' ` : '';
-
-      if (keyword === 'required') {
-        message = `is missing required property '${params.missingProperty}'`;
-      } else if (keyword === 'additionalProperties') {
-        pre = pre ? `${pre}has ` : '';
-        message = `unknown property '${params.additionalProperty}'`;
-        if (scrub) delete data[params.additionalProperty];
-      } else if (keyword === 'type') {
-        let dataType = Array.isArray(data) ? 'array' : typeof data;
-        message = `should be ${a(params.type)}, received ${a(dataType)}`;
-
-        if (scrub) {
-          let [key, ...path] = dataPath.substr(1).split('.').reverse();
-          delete path.reduceRight((d, k) => d[k], config)[key];
-        }
-      }
-
-      _logger.default.warn(`- ${pre}${message}`);
-    }
-  }
-
-  return result;
-} // Adds "a" or "an" to a word for readability.
-
-
-function a(word) {
-  return `${'aeiou'.includes(word[0]) ? 'an' : 'a'} ${word}`;
-}

package/types/index.d.ts

@@ -1,33 +0,0 @@
-import { JSONSchema } from 'json-schema-typed';
-
-interface Pojo { [x: string]: any; }
-export interface PercyConfigObject extends Pojo { version: number; }
-
-declare namespace PercyConfig {
-  function load(options?: {
-    path?: undefined | string | false,
-    overrides?: Pojo,
-    reload?: boolean,
-    bail?: boolean
-  }): PercyConfigObject;
-
-  function validate(
-    config: PercyConfigObject,
-    options?: { scrub?: boolean }
-  ): boolean;
-
-  function addSchema(schemas: {
-    [x: string]: JSONSchema
-  }): void;
-
-  function getDefaults(
-    overrides?: Pojo
-  ): PercyConfigObject;
-
-  function stringify(
-    format: 'yaml' | 'json' | 'js',
-    config?: PercyConfigObject
-  ): string;
-}
-
-export default PercyConfig