Skip to content

Commit f890360

Browse files
Sintendocoreyfarrell
authored andcommitted
docs: Fix URL to default excludes in README.md (#1214)
Also remove some trailing white-space and correct a spelling mistake.
1 parent 3726bbb commit f890360

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

README.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,7 @@ You can then add the specific configuration options you want that aren't in that
7878

7979
### Configuration files
8080

81-
Any configuration options that can be set via the command line can also be specified in the `nyc` stanza of your package.json, or within a seperate configuration file - a variety of flavors are available:
81+
Any configuration options that can be set via the command line can also be specified in the `nyc` stanza of your package.json, or within a separate configuration file - a variety of flavors are available:
8282

8383
| File name | File Association |
8484
|-----------------|------------------|
@@ -108,7 +108,7 @@ This table is a quick TLDR for the rest of this readme and there are more advanc
108108

109109
Configuration can also be provided by `nyc.config.js` if programmed logic is required:
110110
```js
111-
'use strict';
111+
'use strict';
112112
const {defaultExclude} = require('test-exclude');
113113
const isWindows = require('is-windows');
114114

@@ -142,7 +142,7 @@ module.exports = {
142142

143143
By default, nyc only collects coverage for source files that are visited during a test.
144144
It does this by watching for files that are `require()`'d during the test.
145-
When a file is `require()`'d, nyc creates and returns an instrumented version of the source, rather than the original.
145+
When a file is `require()`'d, nyc creates and returns an instrumented version of the source, rather than the original.
146146
Only source files that are visited during a test will appear in the coverage report and contribute to coverage statistics.
147147

148148
nyc will instrument all files if the `--all` flag is set or if running `nyc instrument`.
@@ -172,7 +172,7 @@ You can also specify negated paths in the `exclude` array, by prefixing them wit
172172
Negated paths can restore paths that have been already been excluded in the `exclude` array.
173173
Multiple `exclude` globs can be specified on the command line, each must follow a `--exclude`, `-x` switch.
174174

175-
The default `exclude` list is defined in the [test-exclude module](https://github.com/istanbuljs/istanbuljs/blob/master/packages/test-exclude/default-exclude.js).
175+
The default `exclude` list is defined in the [@istanbuljs/schema module](https://github.com/istanbuljs/schema/blob/master/default-exclude.js).
176176
Specifying your own exclude property completely replaces these defaults.
177177

178178
For example, the following config will collect coverage for every file in the `src` directory regardless of whether it is `require()`'d in a test.
@@ -200,7 +200,7 @@ To prevent this, wrap each glob in single quotes.
200200
We always add `**/node_modules/**` to the exclude list, even if not specified in the config.
201201
You can override this by setting `--exclude-node-modules=false`.
202202

203-
For example, in the following config, `"excludeNodeModules: false"` will prevent `node_modules` from being added to the exclude rules.
203+
For example, in the following config, `"excludeNodeModules: false"` will prevent `node_modules` from being added to the exclude rules.
204204
The set of include rules then restrict nyc to only consider instrumenting files found under the `lib/` and `node_modules/@my-org/` directories.
205205
The exclude rules then prevent nyc instrumenting anything in a `test` folder and the file `node_modules/@my-org/something/unwanted.js`.
206206

0 commit comments

Comments
 (0)