feat: Rename --temp-directory option to --temp-dir (#897)

* Rename --temp-directory option to --temp-dir
* Add -t alias

Deprecates the option name --temp-directory in favour of --temp-dir
--temp-directory has been demoted to a yargs alias of --temp-dir
This change makes the option naming consistent using the form --*-dir

Author: AndrewFinlay

README.md

@@ -291,7 +291,7 @@ Any configuration options that can be set via the command line can also be speci
     ],
     "cache": true,
     "all": true,
-    "temp-directory": "./alternative-tmp",
+    "temp-dir": "./alternative-tmp",
     "report-dir": "./alternative"
   }
 }

index.js

@@ -41,7 +41,7 @@ function NYC (config) {
   this.config = config
 
   this.subprocessBin = config.subprocessBin || path.resolve(__dirname, './bin/nyc.js')
-  this._tempDirectory = config.tempDirectory || './.nyc_output'
+  this._tempDirectory = config.tempDir || config.tempDirectory || './.nyc_output'
   this._instrumenterLib = require(config.instrumenter || './lib/instrumenters/istanbul')
   this._reportDir = config.reportDir || 'coverage'
   this._sourceMap = typeof config.sourceMap === 'boolean' ? config.sourceMap : true

lib/commands/merge.js

@@ -24,10 +24,14 @@ exports.builder = function (yargs) {
       type: 'text',
       default: 'coverage.json'
     })
-    .option('temp-directory', {
+    .option('temp-dir', {
+      alias: 't',
       describe: 'directory to read raw coverage information from',
       default: './.nyc_output'
     })
+    .option('temp-directory', {
+      hidden: true
+    })
     .example('$0 merge ./out coverage.json', 'merge together reports in ./out and output as coverage.json')
 }
 

lib/commands/report.js

@@ -20,10 +20,14 @@ exports.builder = function (yargs) {
       describe: 'directory to output coverage reports in',
       default: 'coverage'
     })
-    .option('temp-directory', {
+    .option('temp-dir', {
+      alias: 't',
       describe: 'directory to read raw coverage information from',
       default: './.nyc_output'
     })
+    .option('temp-directory', {
+      hidden: true
+    })
     .option('show-process-tree', {
       describe: 'display the tree of spawned processes',
       default: false,

lib/config-util.js

@@ -222,11 +222,16 @@ Config.buildYargs = function (cwd) {
       description: 'specify a different .nycrc path',
       global: false
     })
-    .option('temp-directory', {
+    .option('temp-dir', {
+      alias: 't',
       describe: 'directory to output raw coverage information to',
       default: './.nyc_output',
       global: false
     })
+    .option('temp-directory', {
+      hidden: true,
+      global: false
+    })
     .option('skip-empty', {
       describe: 'don\'t show empty files (no lines of code) in report',
       default: false,

package.json

@@ -11,8 +11,8 @@
     "build": "node ./build-tests",
     "instrument": "node ./build-self-coverage.js",
     "test-integration": "tap -t120 --no-cov -b ./test/build/*.js && mocha --timeout=15000 ./test/nyc-bin.js",
-    "test-mocha": "node ./bin/nyc --no-clean --silent --temp-directory=./.self_coverage mocha ./test/nyc.js ./test/process-args.js",
-    "report": "node ./bin/nyc  --temp-directory ./.self_coverage/ -r text -r lcov report",
+    "test-mocha": "node ./bin/nyc --no-clean --silent --temp-dir=./.self_coverage mocha ./test/nyc.js ./test/process-args.js",
+    "report": "node ./bin/nyc  --temp-dir ./.self_coverage/ -r text -r lcov report",
     "release": "standard-version"
   },
   "bin": {