@percy/config
Advanced tools
Comparing version 1.0.0-beta.39 to 1.0.0-beta.40
{ | ||
"name": "@percy/config", | ||
"version": "1.0.0-beta.39", | ||
"version": "1.0.0-beta.40", | ||
"license": "MIT", | ||
@@ -15,6 +15,6 @@ "main": "dist/index.js", | ||
"scripts": { | ||
"build": "cross-env NODE_ENV=production babel src --out-dir dist --root-mode upward", | ||
"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" | ||
@@ -25,7 +25,4 @@ }, | ||
}, | ||
"mocha": { | ||
"require": "../../scripts/babel-register" | ||
}, | ||
"dependencies": { | ||
"@percy/logger": "^1.0.0-beta.39", | ||
"@percy/logger": "^1.0.0-beta.40", | ||
"ajv": "^7.0.3", | ||
@@ -38,3 +35,3 @@ "cosmiconfig": "^7.0.0", | ||
}, | ||
"gitHead": "bd5cea12ca0d21ca167ce9100df2ead274428b7e" | ||
"gitHead": "1607ab0f5dbe5ab8ef3c9f7b6c2a89f66533348c" | ||
} |
@@ -8,5 +8,6 @@ ## @percy/config | ||
## Usage | ||
- [Loading config files](#loading-config-files) | ||
- [Extending config options](#extending-config-options) | ||
### Loading config files | ||
## Loading config files | ||
@@ -22,10 +23,13 @@ The `.load()` method will load and validate a configuation file, optionally merging it with any | ||
// 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 | ||
@@ -39,3 +43,3 @@ | ||
### Extending config options | ||
## Extending config options | ||
@@ -49,3 +53,5 @@ The `.addSchema()` function will add a sub-schema to the Percy configuration file which will be | ||
PercyConfig.addSchema({ propertyName: JSONSchema }) | ||
PercyConfig.addSchema({ | ||
propertyName: JSONSchema | ||
}) | ||
``` |
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
19534
54
Updated@percy/logger@^1.0.0-beta.40