nyc 2.3.0 → 2.4.0

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 ## Change Log
 
+### v2.4.0 (2015/06/24 15:57 +00:00)
+- [#30](https://github.com/bcoe/nyc/pull/30) Added check-coverage functionality, thanks
+  @Raynos! (@bcoe)
+
+### v2.3.0 (2015/06/04 06:43 +00:00)
+- [#27](https://github.com/bcoe/nyc/pull/27) upgraded tap, and switched tests to using tap --coverage (@bcoe)
+- [#25](https://github.com/bcoe/nyc/pull/25) support added for multiple reporters, thanks @jasisk! (@jasisk)
+
 ### v2.2.0 (2015/05/25 21:05 +00:00)
 - [b2e4707](https://github.com/bcoe/nyc/commit/b2e4707ca16750fe274f61039baf1cabdd6b0149) change location of nyc_output to .nyc_output. Added note about coveralls comments. (@sindresorhus)
 

package/README.md

@@ -4,8 +4,12 @@
 [![Coverage Status](https://coveralls.io/repos/bcoe/nyc/badge.svg?branch=)](https://coveralls.io/r/bcoe/nyc?branch=)
 [![NPM version](https://img.shields.io/npm/v/nyc.svg)](https://www.npmjs.com/package/nyc)
 
+```shell
+nyc npm test
+```
+
 a code coverage tool built on [istanbul](https://www.npmjs.com/package/istanbul)
-that works well for applications that spawn subprocesses.
+that works for applications that spawn subprocesses.
 
 ## Instrumenting Your Code
 
@@ -26,6 +30,17 @@ If you're so inclined, you can simply add nyc to the test stanza in your package
 }
 ```
 
+## Checking Coverage
+
+nyc exposes istanbul's check-coverage tool. After running your tests with nyc,
+simply run:
+
+```shell
+nyc check-coverage --lines 95 --functions 95 --branches 95
+```
+
+This feature makes it easy to fail your tests if coverage drops below a given threshold.
+
 ## Running Reports
 
 Once you've run your tests with nyc, simply run:

package/bin/nyc.js

@@ -1,6 +1,7 @@
 #!/usr/bin/env node
-var foreground = require('foreground-child'),
-  sw = require('spawn-wrap')
+var foreground = require('foreground-child')
+var path = require('path')
+var sw = require('spawn-wrap')
 
 if (process.env.NYC_CWD) {
   var NYC = require('../')
@@ -13,36 +14,70 @@ if (process.env.NYC_CWD) {
 
   sw.runMain()
 } else {
-  var NYC = require('../'),
-    yargs = require('yargs')
-      .usage('$0 [command] [options]\n\nrun with a file as the first argument, to instrument it with coverage')
-      .command('report', 'run coverage report for .nyc_output', function (yargs) {
-        yargs
-          .option('r', {
-            alias: 'reporter',
-            describe: 'coverage reporter(s) to use',
-            default: 'text',
-            array: true
-          })
-          .help('h')
-          .example('$0 report --reporter=lcov', 'output an HTML lcov report to ./coverage')
-          .alias('h', 'help')
-      })
-      .help('h')
-      .alias('h', 'help')
-      .version(require('../package.json').version)
-      .example('$0 npm test', 'instrument your tests with coverage')
-      .example('$0 report --reporter=text-lcov', 'output lcov report after running your tests')
-      .epilog('visit http://git.io/vTJJB for list of available reporters'),
-    argv = yargs.argv
+  var NYC = require('../')
+  var yargs = require('yargs')
+    .usage('$0 [command] [options]\n\nrun your tests with the nyc bin to instrument them with coverage')
+    .command('report', 'run coverage report for .nyc_output', function (yargs) {
+      yargs
+        .usage('$0 report [options]')
+        .option('r', {
+          alias: 'reporter',
+          describe: 'coverage reporter(s) to use',
+          default: 'text',
+          array: true
+        })
+        .help('h')
+        .alias('h', 'help')
+        .example('$0 report --reporter=lcov', 'output an HTML lcov report to ./coverage')
+    })
+    .command('check-coverage', 'check whether coverage is within thresholds provided', function (yargs) {
+      yargs
+        .usage('$0 check-coverage [options]')
+        .option('b', {
+          alias: 'branches',
+          default: 0,
+          description: 'what % of branches must be covered?'
+        })
+        .option('f', {
+          alias: 'functions',
+          default: 0,
+          description: 'what % of functions must be covered?'
+        })
+        .option('l', {
+          alias: 'lines',
+          default: 90,
+          description: 'what % of lines must be covered?'
+        })
+        .help('h')
+        .alias('h', 'help')
+        .example('$0 check-coverage --lines 95', "check whether the JSON in nyc's output folder meets the thresholds provided")
+    })
+    .help('h')
+    .alias('h', 'help')
+    .version(require('../package.json').version)
+    .example('$0 npm test', 'instrument your tests with coverage')
+    .example('$0 report --reporter=text-lcov', 'output lcov report after running your tests')
+    .epilog('visit http://git.io/vTJJB for list of available reporters')
+  var argv = yargs.argv
 
-  if (argv._.length && ~argv._.indexOf('report')) {
+  if (~argv._.indexOf('report')) {
     // run a report.
     process.env.NYC_CWD = process.cwd()
 
     ;(new NYC({
       reporter: argv.reporter
     })).report()
+  } else if (~argv._.indexOf('check-coverage')) {
+    foreground(
+      path.resolve(__dirname, '../node_modules/.bin/istanbul'),
+      [
+        'check-coverage',
+        '--lines=' + argv.lines,
+        '--functions=' + argv.functions,
+        '--branches=' + argv.branches,
+        path.resolve(process.cwd(), './.nyc_output/*.json')
+      ]
+    )
   } else if (argv._.length) {
     // wrap subprocesses and execute argv[1]
     ;(new NYC()).cleanup()

package/index.js

@@ -1,12 +1,11 @@
 /* global __coverage__ */
-
-var _ = require('lodash'),
-  fs = require('fs'),
-  mkdirp = require('mkdirp'),
-  path = require('path'),
-  rimraf = require('rimraf'),
-  onExit = require('signal-exit'),
-  stripBom = require('strip-bom')
+var _ = require('lodash')
+var fs = require('fs')
+var mkdirp = require('mkdirp')
+var path = require('path')
+var rimraf = require('rimraf')
+var onExit = require('signal-exit')
+var stripBom = require('strip-bom')
 
 function NYC (opts) {
   _.extend(this, {
@@ -79,18 +78,18 @@ NYC.prototype._wrapRequire = function () {
 }
 
 NYC.prototype._wrapExit = function () {
-  var _this = this,
-    outputCoverage = function () {
-      var coverage = global.__coverage__
-      if (typeof __coverage__ === 'object') coverage = __coverage__
-      if (!coverage) return
-
-      fs.writeFileSync(
-        path.resolve(_this.tmpDirectory(), './', process.pid + '.json'),
-        JSON.stringify(coverage),
-        'utf-8'
-      )
-    }
+  var _this = this
+  var outputCoverage = function () {
+    var coverage = global.__coverage__
+    if (typeof __coverage__ === 'object') coverage = __coverage__
+    if (!coverage) return
+
+    fs.writeFileSync(
+      path.resolve(_this.tmpDirectory(), './', process.pid + '.json'),
+      JSON.stringify(coverage),
+      'utf-8'
+    )
+  }
 
   // we always want to write coverage
   // regardless of how the process exits.
@@ -106,8 +105,8 @@ NYC.prototype.wrap = function (bin) {
 }
 
 NYC.prototype.report = function (_collector, _reporter) {
-  var collector = _collector || new this.istanbul.Collector(),
-    reporter = _reporter || new this.istanbul.Reporter()
+  var collector = _collector || new this.istanbul.Collector()
+  var reporter = _reporter || new this.istanbul.Reporter()
 
   this._loadReports().forEach(function (report) {
     collector.add(report)
@@ -121,8 +120,8 @@ NYC.prototype.report = function (_collector, _reporter) {
 }
 
 NYC.prototype._loadReports = function () {
-  var _this = this,
-    files = fs.readdirSync(this.tmpDirectory())
+  var _this = this
+  var files = fs.readdirSync(this.tmpDirectory())
 
   return _.map(files, function (f) {
     try {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "nyc",
-  "version": "2.3.0",
+  "version": "2.4.0",
   "description": "a code coverage tool that works well with subprocesses.",
   "main": "index.js",
   "scripts": {
@@ -36,20 +36,20 @@
   "license": "ISC",
   "dependencies": {
     "foreground-child": "^1.2.0",
-    "istanbul": "^0.3.14",
+    "istanbul": "^0.3.16",
     "lodash": "^3.8.0",
     "mkdirp": "^0.5.0",
-    "rimraf": "^2.3.3",
+    "rimraf": "^2.4.0",
     "signal-exit": "^2.1.1",
     "spawn-wrap": "^1.0.1",
     "strip-bom": "^1.0.0",
-    "yargs": "^3.8.0"
+    "yargs": "^3.12.0"
   },
   "devDependencies": {
     "chai": "^3.0.0",
-    "sinon": "^1.14.1",
-    "standard": "^4.0.1",
-    "tap": "^1.2.0"
+    "sinon": "^1.15.3",
+    "standard": "^4.3.2",
+    "tap": "^1.3.0"
   },
   "repository": {
     "type": "git",

package/test/nyc-test.js

@@ -1,12 +1,12 @@
 /* global describe, it */
 
-var _ = require('lodash'),
-  fs = require('fs'),
-  NYC = require('../'),
-  path = require('path'),
-  rimraf = require('rimraf'),
-  sinon = require('sinon'),
-  spawn = require('child_process').spawn
+var _ = require('lodash')
+var fs = require('fs')
+var NYC = require('../')
+var path = require('path')
+var rimraf = require('rimraf')
+var sinon = require('sinon')
+var spawn = require('child_process').spawn
 
 require('chai').should()
 require('tap').mochaGlobals()
@@ -94,14 +94,14 @@ describe('nyc', function () {
   describe('report', function () {
     it('runs reports for all JSON in output directory', function (done) {
       var nyc = new NYC({
-          cwd: process.cwd()
-        }),
-        proc = spawn(process.execPath, ['./test/fixtures/sigint.js'], {
-          cwd: process.cwd(),
-          env: process.env,
-          stdio: 'inherit'
-        }),
-        start = fs.readdirSync(nyc.tmpDirectory()).length
+        cwd: process.cwd()
+      })
+      var proc = spawn(process.execPath, ['./test/fixtures/sigint.js'], {
+        cwd: process.cwd(),
+        env: process.env,
+        stdio: 'inherit'
+      })
+      var start = fs.readdirSync(nyc.tmpDirectory()).length
 
       proc.on('close', function () {
         nyc.report(
@@ -130,13 +130,13 @@ describe('nyc', function () {
 
     it('handles corrupt JSON files', function (done) {
       var nyc = new NYC({
-          cwd: process.cwd()
-        }),
-        proc = spawn(process.execPath, ['./test/fixtures/sigint.js'], {
-          cwd: process.cwd(),
-          env: process.env,
-          stdio: 'inherit'
-        })
+        cwd: process.cwd()
+      })
+      var proc = spawn(process.execPath, ['./test/fixtures/sigint.js'], {
+        cwd: process.cwd(),
+        env: process.env,
+        stdio: 'inherit'
+      })
 
       fs.writeFileSync('./.nyc_output/bad.json', '}', 'utf-8')
 
@@ -157,13 +157,13 @@ describe('nyc', function () {
     })
 
     it('handles multiple reporters', function (done) {
-      var reporters = ['text-summary', 'text-lcov'],
-      incr = 0,
-      nyc = new NYC({
+      var reporters = ['text-summary', 'text-lcov']
+      var incr = 0
+      var nyc = new NYC({
         cwd: process.cwd(),
         reporter: reporters
-      }),
-      proc = spawn(process.execPath, ['./test/fixtures/sigint.js'], {
+      })
+      var proc = spawn(process.execPath, ['./test/fixtures/sigint.js'], {
         cwd: process.cwd(),
         env: process.env,
         stdio: 'inherit'