Installations

npm install test-exclude

Pull Requests

Open

5

Total

47

Closed

6

Merged

36

Issues

Open

8

Total

15

Closed

7

Releases

2

test-exclude: v7.0.1

test-exclude-v7.0.1

Published on 10 Jun 2024

test-exclude: v7.0.0

test-exclude-v7.0.0

Published on 09 Jun 2024

View all 2 releases

Developer

istanbuljs

Developer Guide

BETA

Module System

CommonJS

Min. Node Version

>=18

Typescript Support

No

Node Version

20.11.1

NPM Version

10.2.3 Statistics

8 Stars

124 Commits

12 Forks

6 Watching

4 Branches

30 Contributors

Updated on 10 Jun 2024

Languages

JavaScript (100%)

Total Downloads

Cumulative downloads

Total Downloads

5,026,292,533

Last day

-8.4%

5,560,546

Compared to previous day

Last week

-0%

32,001,745

Compared to previous week

Last month

13.3%

132,901,792

Compared to previous month

Last year

13.4%

1,332,380,101

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

3

@istanbuljs/schema glob minimatch

Dev Dependencies

2

c8 tap

Versions

test-exclude

The file include/exclude logic used by nyc and babel-plugin-istanbul.

Usage

1const TestExclude = require('test-exclude');
2const exclude = new TestExclude();
3if (exclude().shouldInstrument('./foo.js')) {
4    // let's instrument this file for test coverage!
5}

TestExclude(options)

The test-exclude constructor accepts an options object. The defaults are taken from @istanbuljs/schema.

options.cwd

This is the base directory by which all comparisons are performed. Files outside cwd are not included.

Default: process.cwd()

options.exclude

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.

options.excludeNodeModules

By default node_modules is excluded. Setting this option true allows node_modules to be included.

options.include

Array of path globs that can be included. By default this is unrestricted giving a result similar to ['**'] but more optimized.

options.extension

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']

TestExclude#shouldInstrument(filename): boolean

Test if filename matches the rules of this test-exclude instance.

1const exclude = new TestExclude();
2exclude.shouldInstrument('index.js'); // true
3exclude.shouldInstrument('test.js'); // false
4exclude.shouldInstrument('README.md'); // false
5exclude.shouldInstrument('node_modules/test-exclude/index.js'); // false

In this example code:

index.js is true because it matches the default options.extension list and is not part of the default options.exclude list.
test.js is excluded because it matches the default options.exclude list.
README.md is not matched by the default options.extension
node_modules/test-exclude/index.js is excluded because options.excludeNodeModules is true by default.

TestExculde#globSync(cwd = options.cwd): Array[string]

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.

TestExclude#glob(cwd = options.cwd): Promise<Array[string]>

This function does the same as TestExclude#globSync but does so asynchronously. The Promise resolves to an Array of strings.

`test-exclude` for enterprise

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.

No vulnerabilities found.

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

License

Determines if the project has defined a license.

10

Security-Policy

Determines if the project has published a security policy.

8

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

3

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

0

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

Maintained

Determines if the project is "actively maintained".

0

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Fuzzing

Determines if the project uses fuzzing.

0

SAST

Determines if the project uses static code analysis.

Score

4.5

/10

Last Scanned on 2024-11-25

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More

test-exclude

Installations

Pull Requests

5

47

6

36

Issues

8

15

7

Releases

Developer

istanbuljs

Developer Guide

CommonJS

>=18

No

20.11.1

10.2.3

Statistics

Languages

Total Downloads

5,026,292,533

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

Dev Dependencies

test-exclude

Usage

TestExclude(options)

options.cwd

options.exclude

options.excludeNodeModules

options.include

options.extension

TestExclude#shouldInstrument(filename): boolean

TestExculde#globSync(cwd = options.cwd): Array[string]

TestExclude#glob(cwd = options.cwd): Promise<Array[string]>

test-exclude for enterprise

10

10

10

10

8

3

0

0

0

0

0

0

4.5

/10

`test-exclude` for enterprise