install-nix-action/node_modules/test-exclude/README.md
Domen Kožar 08403cd828
v5
2019-11-13 17:14:48 +01:00

1.5 KiB

test-exclude

The file include/exclude logic used by nyc.

Build Status Coverage Status Standard Version Greenkeeper badge

Usage

const exclude = require('test-exclude');
if (exclude().shouldInstrument('./foo.js')) {
    // let's instrument this file for test coverage!
}

you can load configuration from a key in package.json:

package.json

{
    "name": "awesome-module",
    "test": {
        "include": ["**/index.js"]
    }
}

app.js

const exclude = require('test-exclude');
if (exclude({ configKey: 'test' }).shouldInstrument('./index.js')) {
    // let's instrument this file for test coverage!
}

Including node_modules folder

by default the node_modules folder is added to all groups of exclude rules. In the rare case that you wish to instrument files stored in node_modules, a negative glob can be used:

const exclude = require('test-exclude');
const e = exclude({
    exclude: ['!**/node_modules/**']
});

License

ISC