feat(cli): --include and --exclude are now accepted as CLI options, thanks @rpominov \o/ see #207

Author: rpominov

bin/nyc.js

@@ -46,6 +46,16 @@ var yargs = require('yargs/yargs')(process.argv.slice(2))
     type: 'boolean',
     describe: 'whether or not to instrument all files of the project (not just the ones touched by your test suite)'
   })
+  .option('exclude', {
+    alias: 'x',
+    default: [],
+    describe: 'a list of specific files and directories that should be excluded from coverage, glob patterns are supported, node_modules is always excluded'
+  })
+  .option('include', {
+    alias: 'n',
+    default: [],
+    describe: 'a list of specific files that should be covered, glob patterns are supported'
+  })
   .option('require', {
     alias: 'i',
     default: [],
@@ -109,9 +119,13 @@ if (argv._[0] === 'report') {
   // wrap subprocesses and execute argv[1]
   if (!Array.isArray(argv.require)) argv.require = [argv.require]
   if (!Array.isArray(argv.extension)) argv.extension = [argv.extension]
+  if (!Array.isArray(argv.exclude)) argv.exclude = [argv.exclude]
+  if (!Array.isArray(argv.include)) argv.include = [argv.include]
 
   var nyc = (new NYC({
-    require: argv.require
+    require: argv.require,
+    include: argv.include,
+    exclude: argv.exclude
   }))
   nyc.reset()
 
@@ -127,6 +141,12 @@ if (argv._[0] === 'report') {
   if (argv.extension.length) {
     env.NYC_EXTENSION = argv.extension.join(',')
   }
+  if (argv.exclude.length) {
+    env.NYC_EXCLUDE = argv.exclude.join(',')
+  }
+  if (argv.include.length) {
+    env.NYC_INCLUDE = argv.include.join(',')
+  }
   sw([wrapper], env)
 
   // Both running the test script invocation and the check-coverage run may

bin/wrap.js

@@ -9,6 +9,8 @@ try {
 ;(new NYC({
   require: process.env.NYC_REQUIRE ? process.env.NYC_REQUIRE.split(',') : [],
   extension: process.env.NYC_EXTENSION ? process.env.NYC_EXTENSION.split(',') : [],
+  exclude: process.env.NYC_EXCLUDE ? process.env.NYC_EXCLUDE.split(',') : [],
+  include: process.env.NYC_INCLUDE ? process.env.NYC_INCLUDE.split(',') : [],
   enableCache: process.env.NYC_CACHE === 'enable'
 })).wrap()
 

index.js

@@ -37,12 +37,16 @@ function NYC (opts) {
 
   // load exclude stanza from config.
   this.include = false
-  if (config.include) {
+  if (config.include && config.include.length > 0) {
     this.include = this._prepGlobPatterns(arrify(config.include))
   }
 
   this.exclude = this._prepGlobPatterns(
-    ['**/node_modules/**'].concat(arrify(config.exclude || ['test/**', 'test{,-*}.js', '**/*.test.js', '**/__tests__/**']))
+    ['**/node_modules/**'].concat(arrify(
+      config.exclude && config.exclude.length > 0
+        ? config.exclude
+        : ['test/**', 'test{,-*}.js', '**/*.test.js', '**/__tests__/**']
+      ))
   )
 
   this.cacheDirectory = findCacheDir({name: 'nyc', cwd: this.cwd})

test/fixtures/cli/test.js

@@ -0,0 +1 @@
+// should be excluded by default.

test/fixtures/conf-empty/package.json

@@ -0,0 +1,6 @@
+{
+  "name": "nyc",
+  "version": "1.1.1",
+  "description": "forking code-coverage using istanbul.",
+  "main": "index.js"
+}

test/src/nyc-bin.js

@@ -7,13 +7,65 @@ var isWindows = require('is-windows')()
 var fixturesCLI = path.resolve(__dirname, '../fixtures/cli')
 var fakebin = path.resolve(fixturesCLI, 'fakebin')
 var bin = path.resolve(__dirname, '../../bin/nyc')
+var rimraf = require('rimraf')
 
 require('chai').should()
 require('tap').mochaGlobals()
 
+// beforeEach
+rimraf.sync(path.resolve(fakebin, 'node'))
+rimraf.sync(path.resolve(fakebin, 'npm'))
+
 describe('the nyc cli', function () {
   var env = { PATH: process.env.PATH }
 
+  describe('--include', function () {
+    it('can be used to limit bin to instrumenting specific files', function (done) {
+      var args = [bin, '--all', '--include', 'half-covered.js', process.execPath, './half-covered.js']
+
+      var proc = spawn(process.execPath, args, {
+        cwd: fixturesCLI,
+        env: env
+      })
+
+      var stdout = ''
+      proc.stdout.on('data', function (chunk) {
+        stdout += chunk
+      })
+
+      proc.on('close', function (code) {
+        code.should.equal(0)
+        stdout.should.match(/half-covered\.js/)
+        stdout.should.not.match(/half-covered-failing\.js/)
+        stdout.should.not.match(/test\.js/)
+        done()
+      })
+    })
+  })
+
+  describe('--exclude', function () {
+    it('should allow default exclude rules to be overridden', function (done) {
+      var args = [bin, '--all', '--exclude', '**/half-covered.js', process.execPath, './half-covered.js']
+
+      var proc = spawn(process.execPath, args, {
+        cwd: fixturesCLI,
+        env: env
+      })
+
+      var stdout = ''
+      proc.stdout.on('data', function (chunk) {
+        stdout += chunk
+      })
+
+      proc.on('close', function (code) {
+        code.should.equal(0)
+        stdout.should.not.match(/half-covered\.js/)
+        stdout.should.match(/test\.js/)
+        done()
+      })
+    })
+  })
+
   describe('--check-coverage', function () {
     it('fails when the expected coverage is below a threshold', function (done) {
       var args = [bin, '--check-coverage', '--lines', '51', process.execPath, './half-covered.js']

test/src/nyc-test.js

@@ -79,6 +79,36 @@ describe('nyc', function () {
 
       nyc.extensions.length.should.eql(3)
     })
+
+    it("ignores 'include' option if it's falsy or []", function () {
+      var nyc1 = new NYC({
+        cwd: path.resolve(__dirname, '../fixtures/conf-empty')
+      })
+
+      nyc1.include.should.equal(false)
+
+      var nyc2 = new NYC({
+        cwd: path.resolve(__dirname, '../fixtures/conf-empty'),
+        include: []
+      })
+
+      nyc2.include.should.equal(false)
+    })
+
+    it("ignores 'exclude' option if it's falsy or []", function () {
+      var nyc1 = new NYC({
+        cwd: path.resolve(__dirname, '../fixtures/conf-empty')
+      })
+
+      nyc1.exclude.length.should.eql(7)
+
+      var nyc2 = new NYC({
+        cwd: path.resolve(__dirname, '../fixtures/conf-empty'),
+        exclude: []
+      })
+
+      nyc2.exclude.length.should.eql(7)
+    })
   })
 
   describe('_prepGlobPatterns', function () {