feat: initial

Author: bahmutov

README.md

@@ -0,0 +1,12 @@
+# check-code-coverage
+> Utilities for checking the coverage produced by NYC against extra or missing files
+
+## Use
+
+```shell
+npm i -D check-code-coverage
+# check if .nyc_output/out.json has 100% code coverage for main.js
+npx check-coverage main.js
+# check if .nyc_output/out.json has files foo.js and bar.js covered and nothing else
+npx only-covered foo.js bar.js
+```

bin/check-coverage.js

@@ -0,0 +1,48 @@
+#!/usr/bin/env node
+const { join } = require('path')
+
+const filename = process.argv[2]
+if (!filename) {
+  console.error('Usage: node %s <file name>', __filename)
+  process.exit(1)
+}
+const coverageFilename = join(process.cwd(), '.nyc_output', 'out.json')
+const coverage = require(coverageFilename)
+const fileCoverageKey = Object.keys(coverage).find(name => {
+  const fileCover = coverage[name]
+  if (fileCover.path.endsWith(filename)) {
+    return fileCover
+  }
+})
+
+if (!fileCoverageKey) {
+  console.error(
+    'Could not find file %s in coverage in file %s',
+    filename,
+    coverageFilename
+  )
+  process.exit(1)
+}
+
+const fileCoverage = coverage[fileCoverageKey]
+const statementCounters = fileCoverage.s
+const isThereUncoveredStatement = Object.keys(statementCounters).some(
+  (k, key) => {
+    return statementCounters[key] === 0
+  }
+)
+if (isThereUncoveredStatement) {
+  console.error(
+    'file %s has statements that were not covered by tests',
+    fileCoverage.path
+  )
+  console.log('statement counters %o', statementCounters)
+
+  process.exit(1)
+}
+
+console.log(
+  '✅ All statements in file %s (found for %s) were covered',
+  fileCoverage.path,
+  filename
+)

bin/only-covered.js

@@ -0,0 +1,52 @@
+#!/usr/bin/env node
+const { join } = require('path')
+const _ = require('lodash')
+
+const filenames = process.argv.slice(2)
+if (!filenames.length) {
+  console.error('Usage: node %s <file name 1> <file name 2>', __filename)
+  process.exit(1)
+}
+
+const shouldBeCovered = filepath =>
+  filenames.some(name => filepath.endsWith(name))
+
+const coverageFilename = join(process.cwd(), '.nyc_output', 'out.json')
+const coverage = require(coverageFilename)
+
+const coveredFilepaths = Object.keys(coverage).map(name => coverage[name].path)
+
+// console.log(coveredFilepaths)
+
+const [covered, extraCoveredFiles] = _.partition(
+  coveredFilepaths,
+  shouldBeCovered
+)
+
+if (extraCoveredFiles.length) {
+  console.error('Error: found extra covered files 🔥')
+  console.error('Expected the following files in coverage results')
+  console.error(filenames.join('\n'))
+  console.error('extra files covered 🔥')
+  console.error(extraCoveredFiles.join('\n'))
+  process.exit(1)
+}
+
+if (covered.length < filenames.length) {
+  console.error('Error: expected all files from the list to be covered 🔥')
+  console.error('Expected the following files in coverage results')
+  console.error(filenames.join('\n'))
+  console.error('But found only these files to be covered')
+  console.error(covered.join('\n'))
+
+  console.error('Files missing from the coverage 🔥')
+  const missingFiles = filenames.filter(
+    filename =>
+      !covered.some(coveredFilename => coveredFilename.endsWith(filename))
+  )
+  console.error(missingFiles.join('\n'))
+
+  process.exit(1)
+}
+
+console.log('✅ All and only expected files were covered')

package.json

@@ -0,0 +1,30 @@
+{
+  "name": "check-code-coverage",
+  "version": "1.0.0",
+  "description": "Utilities for checking the coverage produced by NYC against extra or missing files",
+  "main": "index.js",
+  "alias": {
+    "check-coverage": "bin/check-coverage.js",
+    "only-covered": "bin/only-covered.js"
+  },
+  "files": ["bin"],
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/bahmutov/check-code-coverage.git"
+  },
+  "keywords": [
+    "coverage",
+    "code-coverage",
+    "utility",
+    "nyc"
+  ],
+  "author": "Gleb Bahmutov <gleb.bahmutov@gmail.com>",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/bahmutov/check-code-coverage/issues"
+  },
+  "homepage": "https://github.com/bahmutov/check-code-coverage#readme"
+}