aboutsummaryrefslogtreecommitdiff
path: root/node_modules/test-exclude/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'node_modules/test-exclude/README.md')
-rw-r--r--node_modules/test-exclude/README.md56
1 files changed, 56 insertions, 0 deletions
diff --git a/node_modules/test-exclude/README.md b/node_modules/test-exclude/README.md
new file mode 100644
index 000000000..fd844f820
--- /dev/null
+++ b/node_modules/test-exclude/README.md
@@ -0,0 +1,56 @@
+# 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