c8 7.9.0 → 7.10.0

package/CHANGELOG.md

@@ -2,6 +2,13 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
+## [7.10.0](https://www.github.com/bcoe/c8/compare/v7.9.0...v7.10.0) (2021-10-06)
+
+
+### Features
+
+* `--100` ([#332](https://www.github.com/bcoe/c8/issues/332)) ([4205f2f](https://www.github.com/bcoe/c8/commit/4205f2f33585693d82c2500d0d6850571965bb8b))
+
 ## [7.9.0](https://www.github.com/bcoe/c8/compare/v7.8.0...v7.9.0) (2021-09-10)
 
 

package/README.md

@@ -35,7 +35,7 @@ Here is a list of common options. Run `c8 --help` for the full list and document
 | `--all` | see [section below](#checking-for-full-source-coverage-using---all) for more info | `boolean` | `false` |
 | `--src` | see [section below](#checking-for-full-source-coverage-using---all) for more info | `Array<string>` | `[process.cwd()]`|
 | `-n`, `--include` | see [section below](#checking-for-full-source-coverage-using---all) for more info | `Array<string>` | `[]` (include all files) |
-| `-x`, `--exclude` | see [section below](#checking-for-full-source-coverage-using---all) for more info | `Array<string>` | [list](https://github.com/istanbuljs/schema/blob/master/default-exclude.js) |
+| `-x`, `--exclude` | see [section below](#checking-for-full-source-coverage-using---all) for more info | `Array<string>` | [list](https://github.com/istanbuljs/schema/blob/main/default-exclude.js) |
 | `--skip-full` | do not show files with 100% statement, branch, and function coverage | `boolean` | `false` |
 | `--check-coverage` | check whether coverage is within thresholds provided | `boolean` | `false` |
 | `--temp-directory` | directory V8 coverage data is written to and read from | `string` | `process.env.NODE_V8_COVERAGE` |
@@ -80,6 +80,24 @@ To check thresholds on a per-file basis run:
 c8 check-coverage --lines 95 --per-file
 ```
 
+If you want to check for 100% coverage across all dimensions, use `--100`:
+
+```shell
+c8 --100 npm test
+```
+
+Is equivalent to
+
+```shell
+c8 --check-coverage --lines 100 --functions 100 --branches 100 --statements 100  npm test
+```
+
+The `--100` flag can be set for the `check-coverage` as well:
+
+```shell
+c8 check-coverage --100
+```
+
 ## Ignoring Uncovered Lines, Functions, and Blocks
 
 Sometimes you might find yourself wanting to ignore uncovered portions of your

package/lib/commands/check-coverage.js

@@ -11,6 +11,14 @@ exports.builder = function (yargs) {
 }
 
 exports.handler = function (argv) {
+  // TODO: this is a workaround until yargs gets upgraded to v17, see https://github.com/bcoe/c8/pull/332#discussion_r721636191
+  if (argv['100']) {
+    argv.lines = 100
+    argv.functions = 100
+    argv.branches = 100
+    argv.statements = 100
+  }
+
   const report = Report({
     include: argv.include,
     exclude: argv.exclude,

package/lib/commands/report.js

@@ -10,6 +10,14 @@ exports.handler = async function (argv) {
 }
 
 exports.outputReport = async function (argv) {
+  // TODO: this is a workaround until yargs gets upgraded to v17, see https://github.com/bcoe/c8/pull/332#discussion_r721636191
+  if (argv['100']) {
+    argv.checkCoverage = 100
+    argv.lines = 100
+    argv.functions = 100
+    argv.branches = 100
+    argv.statements = 100
+  }
   const report = Report({
     include: argv.include,
     exclude: argv.exclude,

package/lib/parse-args.js

@@ -107,6 +107,12 @@ function buildYargs (withCommands = false) {
       description: 'check thresholds per file',
       type: 'boolean'
     })
+    .option('100', {
+      default: false,
+      group: 'Coverage thresholds',
+      description: 'shortcut for --check-coverage --lines 100 --functions 100 --branches 100 --statements 100',
+      type: 'boolean'
+    })
     .option('temp-directory', {
       describe: 'directory V8 coverage data is written to and read from',
       default: process.env.NODE_V8_COVERAGE
@@ -145,6 +151,19 @@ function buildYargs (withCommands = false) {
     })
     .epilog('visit https://git.io/vHysA for list of available reporters')
 
+  // TODO: enable once yargs upgraded to v17: https://github.com/bcoe/c8/pull/332#discussion_r721636191
+  // yargs.middleware((argv) => {
+  //   if (!argv['100']) return argv
+
+  //   return {
+  //     ...argv,
+  //     branches: 100,
+  //     functions: 100,
+  //     lines: 100,
+  //     statements: 100,
+  //   }
+  // })
+
   const checkCoverage = require('./commands/check-coverage')
   const report = require('./commands/report')
   if (withCommands) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "c8",
-  "version": "7.9.0",
+  "version": "7.10.0",
   "description": "output coverage reports using Node.js' built in coverage",
   "main": "./index.js",
   "types": "./index.d.ts",
@@ -37,7 +37,7 @@
     "@istanbuljs/schema": "^0.1.2",
     "find-up": "^5.0.0",
     "foreground-child": "^2.0.0",
-    "istanbul-lib-coverage": "^3.0.0",
+    "istanbul-lib-coverage": "^3.0.1",
     "istanbul-lib-report": "^3.0.0",
     "istanbul-reports": "^3.0.2",
     "rimraf": "^3.0.0",