@percy/config v1.28.6
@percy/config
Handles loading and adding options to Percy configuration files. Uses cosmiconfig to load configuration files and JSON schema with AJV to validate those configuration 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
from the current directory up to the home directoy. Configuration files are cached and reused unless
reload
is true
.
import PercyConfig from '@percy/config'
// loading is done synchronously
const config = PercyConfig.load(options)
Options
path
— Config file path or directory containing a config fileoverrides
— Config option overridesreload
— Do not use cached config (defaultfalse
)bail
— Return undefined when failing validation (defaultfalse
)print
— Print info and error logs (defaultfalse
)
Supported files
"percy"
entry inpackage.json
.percyrc
YAML or JSON file.percy.json
JSON file.percy.yaml
or.percy.yml
YAML file.percy.js
orpercy.config.js
file that exports an object
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
schema for possible schema options.
import PercyConfig from '@percy/config'
PercyConfig.addSchema({
propertyName: JSONSchema
})
12 days ago
26 days ago
26 days ago
28 days ago
28 days ago
1 month ago
1 month ago
2 months ago
2 months ago
2 months ago
2 months ago
2 months ago
2 months ago
3 months ago
3 months ago
3 months ago
3 months ago
3 months ago
3 months ago
3 months ago
3 months ago
3 months ago
4 months ago
4 months ago
4 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
6 months ago
6 months ago
8 months ago
10 months ago
11 months ago
7 months ago
10 months ago
11 months ago
10 months ago
11 months ago
11 months ago
8 months ago
8 months ago
9 months ago
9 months ago
7 months ago
10 months ago
10 months ago
9 months ago
7 months ago
7 months ago
6 months ago
7 months ago
7 months ago
9 months ago
10 months ago
6 months ago
7 months ago
6 months ago
11 months ago
12 months ago
12 months ago
11 months ago
1 year ago
12 months ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
2 years ago
1 year ago
1 year ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago