1
0
Fork 0
mirror of https://github.com/actions/setup-python.git synced 2024-11-29 19:35:17 +00:00
setup-python/node_modules/test-exclude/README.md
Danny McCormick 39c08a0eaa Initial pass
2019-06-26 21:12:00 -04:00

56 lines
1.5 KiB
Markdown

# test-exclude
The file include/exclude logic used by [nyc](https://github.com/istanbuljs/nyc).
[![Build Status](https://travis-ci.org/istanbuljs/test-exclude.svg)](https://travis-ci.org/istanbuljs/test-exclude)
[![Coverage Status](https://coveralls.io/repos/github/istanbuljs/test-exclude/badge.svg?branch=master)](https://coveralls.io/github/istanbuljs/test-exclude?branch=master)
[![Standard Version](https://img.shields.io/badge/release-standard%20version-brightgreen.svg)](https://github.com/conventional-changelog/standard-version)
[![Greenkeeper badge](https://badges.greenkeeper.io/istanbuljs/test-exclude.svg)](https://greenkeeper.io/)
## Usage
```js
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_
```json
{
"name": "awesome-module",
"test": {
"include": ["**/index.js"]
}
}
```
_app.js_
```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:
```js
const exclude = require('test-exclude');
const e = exclude({
exclude: ['!**/node_modules/**']
});
```
## License
ISC