feat: add include and exclude options to instrument command (#1007)

BREAKING CHANGE: `nyc instrument` now honors `include` and `exclude`
settings, potentially resulting in some files that were previously
instrumented being ignored.

Author: AndrewFinlay

index.js

@@ -179,9 +179,11 @@ NYC.prototype.instrumentAllFiles = function (input, output, cb) {
     const outCode = this._transform(inCode, inFile) || inCode
 
     if (output) {
+      const mode = fs.statSync(inFile).mode
       const outFile = path.resolve(output, relFile)
       mkdirp.sync(path.dirname(outFile))
-      fs.writeFileSync(outFile, outCode, 'utf-8')
+      fs.writeFileSync(outFile, outCode)
+      fs.chmodSync(outFile, mode)
     } else {
       console.log(outCode)
     }

lib/commands/instrument.js

@@ -1,6 +1,7 @@
 const NYC = require('../../index.js')
 const path = require('path')
 const rimraf = require('rimraf')
+const testExclude = require('test-exclude')
 
 exports.command = 'instrument <input> [output]'
 
@@ -48,6 +49,16 @@ exports.builder = function (yargs) {
       type: 'boolean',
       description: 'should nyc exit when an instrumentation failure occurs?'
     })
+    .option('include', {
+      alias: 'n',
+      default: [],
+      describe: 'a list of specific files and directories that should be instrumented, glob patterns are supported'
+    })
+    .option('exclude', {
+      alias: 'x',
+      default: testExclude.defaultExclude,
+      describe: 'a list of specific files and directories that should not be instrumented, glob patterns are supported'
+    })
     .option('es-modules', {
       default: true,
       type: 'boolean',
@@ -62,6 +73,28 @@ exports.builder = function (yargs) {
 }
 
 exports.handler = function (argv) {
+  if (argv.output && (path.resolve(argv.cwd, argv.input) === path.resolve(argv.cwd, argv.output))) {
+    console.error(`nyc instrument failed: cannot instrument files in place, <input> must differ from <output>`)
+    process.exitCode = 1
+    return
+  }
+
+  if (path.relative(argv.cwd, path.resolve(argv.cwd, argv.input)).startsWith('..')) {
+    console.error(`nyc instrument failed: cannot instrument files outside of project root directory`)
+    process.exitCode = 1
+    return
+  }
+
+  if (argv.delete && argv.output && argv.output.length !== 0) {
+    const relPath = path.relative(process.cwd(), path.resolve(argv.output))
+    if (relPath !== '' && !relPath.startsWith('..')) {
+      rimraf.sync(argv.output)
+    } else {
+      console.error(`nyc instrument failed: attempt to delete '${process.cwd()}' or containing directory.`)
+      process.exit(1)
+    }
+  }
+
   // If instrument is set to false enable a noop instrumenter.
   argv.instrumenter = (argv.instrument)
     ? './lib/instrumenters/istanbul'
@@ -76,20 +109,12 @@ exports.handler = function (argv) {
     cwd: argv.cwd,
     compact: argv.compact,
     preserveComments: argv.preserveComments,
+    include: argv.include,
+    exclude: argv.exclude,
     esModules: argv.esModules,
     exitOnError: argv.exitOnError
   })
 
-  if (argv.delete && argv.output && argv.output.length !== 0) {
-    const relPath = path.relative(process.cwd(), path.resolve(argv.output))
-    if (relPath !== '' && !relPath.startsWith('..')) {
-      rimraf.sync(argv.output)
-    } else {
-      console.error(`nyc instrument failed: attempt to delete '${process.cwd()}' or containing directory.`)
-      process.exit(1)
-    }
-  }
-
   nyc.instrumentAllFiles(argv.input, argv.output, err => {
     if (err) {
       console.error(err.message)

package-lock.json

@@ -0,0 +1,5 @@
+{
+  "exclude": [
+    "**/exclude-me/**"
+  ]
+}

test/fixtures/cli/.instrument-nycrc

@@ -1 +1,2 @@
 output-dir
+!node_modules

test/fixtures/cli/subdir/.gitignore

@@ -0,0 +1,2 @@
+'use strict';
+console.log('Hello, World!')

test/fixtures/cli/subdir/input-dir/exclude-me/index.js

@@ -0,0 +1,2 @@
+'use strict';
+console.log('Hello, World!')

test/fixtures/cli/subdir/input-dir/include-me/exclude-me.js

@@ -0,0 +1,2 @@
+'use strict';
+console.log('Hello, World!')