| 1 | # @istanbuljs/load-nyc-config
|
|---|
| 2 |
|
|---|
| 3 | The utility function which NYC uses to load configuration.
|
|---|
| 4 | This can be used by outside programs to calculate the configuration.
|
|---|
| 5 | Command-line arguments are not considered by this function.
|
|---|
| 6 |
|
|---|
| 7 | ```js
|
|---|
| 8 | const {loadNycConfig} = require('@istanbuljs/load-nyc-config');
|
|---|
| 9 |
|
|---|
| 10 | (async () {
|
|---|
| 11 | console.log(await loadNycConfig());
|
|---|
| 12 | })();
|
|---|
| 13 | ```
|
|---|
| 14 |
|
|---|
| 15 | ## loadNycConfig([options])
|
|---|
| 16 |
|
|---|
| 17 | ### options.cwd
|
|---|
| 18 |
|
|---|
| 19 | Type: `string`
|
|---|
| 20 | Default: `cwd` from parent nyc process or `process.cwd()`
|
|---|
| 21 |
|
|---|
| 22 | ### options.nycrcPath
|
|---|
| 23 |
|
|---|
| 24 | Type: `string`
|
|---|
| 25 | Default: `undefined`
|
|---|
| 26 |
|
|---|
| 27 | Name of the file containing nyc configuration.
|
|---|
| 28 | This can be a relative or absolute path.
|
|---|
| 29 | Relative paths can exist at `options.cwd` or any parent directory.
|
|---|
| 30 | If an nycrc is specified but cannot be found an exception is thrown.
|
|---|
| 31 |
|
|---|
| 32 | If no nycrc option is provided the default priority of config files are:
|
|---|
| 33 |
|
|---|
| 34 | * .nycrc
|
|---|
| 35 | * .nycrc.json
|
|---|
| 36 | * .nycrc.yml
|
|---|
| 37 | * .nycrc.yaml
|
|---|
| 38 | * nyc.config.js
|
|---|
| 39 | * nyc.config.cjs
|
|---|
| 40 | * nyc.config.mjs
|
|---|
| 41 |
|
|---|
| 42 | ## Configuration merging
|
|---|
| 43 |
|
|---|
| 44 | Configuration is first loaded from `package.json` if found, this serves as the package
|
|---|
| 45 | defaults. These options can be overridden by an nycrc if found. Arrays are not merged,
|
|---|
| 46 | so if `package.json` sets `"require": ["@babel/register"]` and `.nycrc` sets `"require": ["esm"]`
|
|---|
| 47 | the effective require setting will only include `"esm"`.
|
|---|
| 48 |
|
|---|
| 49 | ## isLoading
|
|---|
| 50 |
|
|---|
| 51 | ```js
|
|---|
| 52 | const {isLoading} = require('@istanbuljs/load-nyc-config');
|
|---|
| 53 |
|
|---|
| 54 | console.log(isLoading());
|
|---|
| 55 | ```
|
|---|
| 56 |
|
|---|
| 57 | In some cases source transformation hooks can get installed before the configuration is
|
|---|
| 58 | loaded. This allows hooks to ignore source loads that occur during configuration load.
|
|---|
| 59 |
|
|---|
| 60 | ## `@istanbuljs/load-nyc-config` for enterprise
|
|---|
| 61 |
|
|---|
| 62 | Available as part of the Tidelift Subscription.
|
|---|
| 63 |
|
|---|
| 64 | The maintainers of `@istanbuljs/load-nyc-config` and thousands of other packages are working with Tidelift to deliver commercial support and maintenance for the open source dependencies you use to build your applications. Save time, reduce risk, and improve code health, while paying the maintainers of the exact dependencies you use. [Learn more.](https://tidelift.com/subscription/pkg/npm-istanbuljs-load-nyc-config?utm_source=npm-istanbuljs-load-nyc-config&utm_medium=referral&utm_campaign=enterprise)
|
|---|
