mirror of https://github.com/JamesIves/github-pages-deploy-action.git synced 2023-12-15 20:03:39 +08:00

History

JamesIves 98b9260bfc Dependencies		2020-01-28 00:08:03 -05:00
..
node_modules/.bin	Dependencies	2020-01-28 00:08:03 -05:00
CHANGELOG.md	Dependencies Required	2020-01-28 00:07:56 -05:00
index.js	Dependencies Required	2020-01-28 00:07:56 -05:00
LICENSE	Dependencies Required	2020-01-28 00:07:56 -05:00
load-esm.js	Dependencies Required	2020-01-28 00:07:56 -05:00
package.json	Dependencies Required	2020-01-28 00:07:56 -05:00
README.md	Dependencies Required	2020-01-28 00:07:56 -05:00

README.md

@istanbuljs/load-nyc-config

The utility function which NYC uses to load configuration. This can be used by outside programs to calculate the configuration. Command-line arguments are not considered by this function.

const {loadNycConfig} = require('@istanbuljs/load-nyc-config');

console.log(loadNycConfig());

loadNycConfig([options])

options.cwd

Type: string Default: cwd from parent nyc process or process.cwd()

options.nycrcPath

Type: string Default: undefined

Name of the file containing nyc configuration. This can be a relative or absolute path. Relative paths can exist at options.cwd or any parent directory. If an nycrc is specified but cannot be found an exception is thrown.

If no nycrc option is provided the default priority of config files are:

.nycrc
.nycrc.json
.nycrc.yml
.nycrc.yaml
nyc.config.js

Configuration merging

Configuration is first loaded from package.json if found, this serves as the package defaults. These options can be overridden by an nycrc if found. Arrays are not merged, so if package.json sets "require": ["@babel/register"] and .nycrc sets "require": ["esm"] the effective require setting will only include "esm".