1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
The file include/exclude logic used by [nyc] and [babel-plugin-istanbul].
[](https://travis-ci.org/istanbuljs/test-exclude)
[](https://coveralls.io/github/istanbuljs/test-exclude?branch=master)
[](https://github.com/conventional-changelog/standard-version)
[](https://greenkeeper.io/)
```js
const TestExclude = require('test-exclude');
const exclude = new TestExclude();
if (exclude().shouldInstrument('./foo.js')) {
}
```
The test-exclude constructor accepts an options object. The defaults are taken from
[@istanbuljs/schema].
This is the base directory by which all comparisons are performed. Files outside `cwd`
are not included.
Default: `process.cwd()`
Array of path globs to be ignored. Note this list does not include `node_modules` which
is added separately. See [@istanbuljs/schema/default-excludes.js] for default list.
By default `node_modules` is excluded. Setting this option `true` allows `node_modules`
to be included.
Array of path globs that can be included. By default this is unrestricted giving a result
similar to `['**']` but more optimized.
Array of extensions that can be included. This ensures that nyc only attempts to process
files which it might understand. Note use of some formats may require adding parser
plugins to your nyc or babel configuration.
Default: `['.js', '.cjs', '.mjs', '.ts', '.tsx', '.jsx']`
Test if `filename` matches the rules of this test-exclude instance.
```js
const exclude = new TestExclude();
exclude.shouldInstrument('index.js'); // true
exclude.shouldInstrument('test.js'); // false
exclude.shouldInstrument('README.md'); // false
exclude.shouldInstrument('node_modules/test-exclude/index.js'); // false
```
In this example code:
* ***
This synchronously retrieves a list of files within `cwd` which should be instrumented.
Note that setting `cwd` to a parent of `options.cwd` is ineffective, this argument can
only be used to further restrict the result.
This function does the same as `TestExclude#globSync` but does so asynchronously. The
Promise resolves to an Array of strings.
Available as part of the Tidelift Subscription.
The maintainers of `test-exclude` 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-test-exclude?utm_source=npm-test-exclude&utm_medium=referral&utm_campaign=enterprise&utm_term=repo)