adds .taprc file support #228

a few changes to .taprc file support #234

includes:
- moves parsing of `process.env.TAP` back to where it was
- restructures dotfile tests
- updates a test that was copied from another, but not updated

Author: kgraves

bin/run.js

@@ -8,29 +8,31 @@ var supportsColor = require('supports-color')
 var nycBin = require.resolve('nyc/bin/nyc.js')
 var glob = require('glob')
 var isexe = require('isexe')
+var osHomedir = require('os-homedir')
+var extend = require('deep-extend')
+var yaml = require('js-yaml')
+var parseRcFile = require('./utils').parseRcFile
 
 var coverageServiceTest = process.env.COVERAGE_SERVICE_TEST === 'true'
 
 // console.error(process.argv.join(' '))
 // console.error('CST=%j', process.env.COVERAGE_SERVICE_TEST)
 // console.error('CRT=%j', process.env.COVERALLS_REPO_TOKEN)
-// console.error('CCT=%j', process.env.CODECOV_TOKEN)
 if (coverageServiceTest) {
   console.log('COVERAGE_SERVICE_TEST')
 }
 
 // Add new coverage services here.
 // it'll check for the environ named and pipe appropriately.
+//
+// Currently only Coveralls is supported, but the infrastructure
+// is left in place in case some noble soul fixes the codecov
+// module in the future.  See https://github.com/tapjs/node-tap/issues/270
 var coverageServices = [
   {
     env: 'COVERALLS_REPO_TOKEN',
     bin: require.resolve('coveralls/bin/coveralls.js'),
     name: 'Coveralls'
-  },
-  {
-    env: 'CODECOV_TOKEN',
-    bin: require.resolve('codecov.io/bin/codecov.io.js'),
-    name: 'Codecov'
   }
 ]
 
@@ -44,7 +46,17 @@ function main () {
     process.exit(1)
   }
 
-  var options = parseArgs(args)
+  // set default args
+  var defaults = constructDefaultArgs()
+
+  // parse dotfile
+  var rcOptions = parseRcFile(osHomedir() + '/.taprc')
+
+  // supplement defaults with parsed rc options
+  defaults = extend(defaults, rcOptions)
+
+  // parse args
+  var options = parseArgs(args, defaults)
 
   if (!options) {
     return
@@ -93,26 +105,34 @@ function main () {
   runTests(options)
 }
 
-function parseArgs (args) {
-  var options = {}
+function constructDefaultArgs () {
+  var defaultArgs = {
+    nodeArgs: [],
+    nycArgs: [],
+    timeout: process.env.TAP_TIMEOUT || 30,
+    color: supportsColor,
+    reporter: null,
+    files: [],
+    bail: false,
+    saveFile: null,
+    pipeToService: false,
+    coverageReport: null,
+    openBrowser: true
+  }
 
-  options.nodeArgs = []
-  options.nycArgs = []
-  options.timeout = process.env.TAP_TIMEOUT || 30
-  // coverage tools run slow.
-  /* istanbul ignore else */
   if (global.__coverage__) {
-    options.timeout = 240
+    defaultArgs.timeout = 240
   }
 
-  options.color = supportsColor
   if (process.env.TAP_COLORS !== undefined) {
-    options.color = !!(+process.env.TAP_COLORS)
+    defaultArgs.color = !!(+process.env.TAP_COLORS)
   }
-  options.reporter = null
-  options.files = []
-  options.bail = false
-  options.saveFile = null
+
+  return defaultArgs
+}
+
+function parseArgs (args, defaults) {
+  var options = defaults || {}
 
   var singleFlags = {
     b: 'bail',
@@ -131,7 +151,6 @@ function parseArgs (args) {
 
   // If we're running under Travis-CI with a Coveralls.io token,
   // then it's a safe bet that we ought to output coverage.
-  options.pipeToService = false
   for (var i = 0; i < coverageServices.length && !options.pipeToService; i++) {
     if (process.env[coverageServices[i].env]) {
       options.pipeToService = true
@@ -140,9 +159,6 @@ function parseArgs (args) {
 
   var defaultCoverage = options.pipeToService
 
-  options.coverageReport = null
-  options.openBrowser = true
-
   for (i = 0; i < args.length; i++) {
     var arg = args[i]
     if (arg.charAt(0) !== '-' || arg === '-') {
@@ -428,7 +444,7 @@ function runCoverageReportOnly (options, code, signal) {
   // console.error('run coverage report', args)
 
   var child
-  // automatically hook into coveralls and/or codecov
+  // automatically hook into coveralls
   if (options.coverageReport === 'text-lcov' && options.pipeToService) {
     // console.error('pipeToService')
     child = spawn(node, args, { stdio: [ 0, 'pipe', 2 ] })

bin/utils.js

@@ -0,0 +1,38 @@
+var fs = require('fs')
+var yaml = require('js-yaml')
+
+function parseYaml (contents) {
+  try {
+    var parsed = yaml.safeLoad(contents)
+
+    // js-yaml parses an empty file as undefined, one with only comments as
+    // null. We want to return an empty object in these cases.
+    if (!parsed) {
+      parsed = {}
+    }
+
+    return parsed
+  } catch(er) {
+    // invalid yaml, fail gracefully
+    return {}
+  }
+}
+
+function parseRcFile (path) {
+  var parsed = {}
+
+  try {
+    var contents = fs.readFileSync(path, 'utf8')
+    parsed = parseYaml(contents)
+  } catch(er) {
+    // if no dotfile exists, fail gracefully
+    parsed = {}
+  }
+
+  return parsed
+}
+
+module.exports = {
+  parseYaml: parseYaml,
+  parseRcFile: parseRcFile
+}

package.json

@@ -17,13 +17,15 @@
     "codecov.io": "0.1.6",
     "coveralls": "^2.11.2",
     "deeper": "^2.1.0",
+    "deep-extend": "0.4.1",
     "foreground-child": "^1.3.3",
     "glob": "^7.0.0",
     "isexe": "^1.0.0",
     "js-yaml": "^3.3.1",
     "nyc": "^6.6.1",
     "only-shallow": "^1.0.2",
     "opener": "^1.4.1",
+    "os-homedir": "1.0.1",
     "readable-stream": "^2.0.2",
     "signal-exit": "^2.0.0",
     "stack-utils": "^0.4.0",

test/fixtures/invalid-rc-file.yml

@@ -0,0 +1 @@
+asdf: asdf: asdf

test/fixtures/valid-rc-file.yml

@@ -0,0 +1,5 @@
+# this is a comment
+timeout: 9999
+coverage: false
+coverageReport: false
+reporter: 'classic'

test/utils.js

@@ -0,0 +1,48 @@
+var fs = require('fs')
+var t = require('../')
+var utils = require('../bin/utils')
+
+t.test('parseYaml', function (t) {
+  t.test('returns empty object when not valid yaml', function (t) {
+    t.strictSame(utils.parseYaml('a: b c: d'), {})
+    t.end()
+  })
+
+  t.test('returns empty object when empty file', function (t) {
+    t.strictSame(utils.parseYaml(''), {})
+    t.end()
+  })
+
+  t.test('returns empty object when only comments', function (t) {
+    t.strictSame(utils.parseYaml('# this is a comment'), {})
+    t.end()
+  })
+
+  t.end()
+})
+
+t.test('parseRcFile', function (t) {
+  t.test('when file does not exist, returns empty object', function (t) {
+    t.strictSame(utils.parseRcFile('./this-file-does-not-exist'), {})
+    t.end()
+  })
+
+  t.test('returns empty object when not valid yaml', function (t) {
+    t.strictSame(utils.parseRcFile('./test/fixtures/invalid-rc-file.yml'), {})
+    t.end()
+  })
+
+  t.test('parses when valid yaml', function (t) {
+    var expected = {
+      timeout: 9999,
+      coverage: false,
+      coverageReport: false,
+      reporter: 'classic'
+    }
+    var actual = utils.parseRcFile('./test/fixtures/valid-rc-file.yml')
+    t.strictSame(actual, expected)
+    t.end()
+  })
+
+  t.end()
+})