feat: badge changes color depending on coverage (#8)

Author: bahmutov

README.md

@@ -44,10 +44,15 @@ update-badge
 
 If the coverage summary has 96%, then the above badge would be updated to
 
-
     ![code coverage](https://img.shields.io/badge/code--coverage-96%-brightgreen)
 
 Related project: [dependency-version-badge](https://github.com/bahmutov/dependency-version-badge)
 
+The badges will have different colors, depending on the coverage, see [bin/update-badge.js](bin/update-badge.js)
+
+## Debug
+
+To see verbose log messages, run with `DEBUG=check-code-coverage` environment variable
+
 [ci image]: https://github.com/bahmutov/check-code-coverage/workflows/ci/badge.svg?branch=master
 [ci url]: https://github.com/bahmutov/check-code-coverage/actions

bin/update-badge.js

@@ -1,9 +1,27 @@
 #!/usr/bin/env node
 // @ts-check
 
+const debug = require('debug')('check-code-coverage')
 const path = require('path')
 const fs = require('fs')
 
+const availableColors = ['red', 'yellow', 'green', 'brightgreen']
+
+const availableColorsReStr = '(:?' + availableColors.join('|') + ')'
+
+function getColor(coveredPercent) {
+  if (coveredPercent < 60) {
+    return 'red'
+  }
+  if (coveredPercent < 80) {
+    return 'yellow'
+  }
+  if (coveredPercent < 90) {
+    return 'green'
+  }
+  return 'brightgreen'
+}
+
 function updateBadge() {
   const coverageFilename = path.join(process.cwd(), 'coverage', 'coverage-summary.json')
   const coverage = require(coverageFilename)
@@ -13,15 +31,28 @@ function updateBadge() {
   const readmeText = fs.readFileSync(readmeFilename, 'utf8')
 
   function replaceShield() {
+    const color = getColor(pct)
+    debug('for coverage %d% badge color "%s"', pct, color)
+    if (!availableColors.includes(color)) {
+      console.error('cannot pick code coverage color for %d%', pct)
+      console.error('color "%s" is invalid', color)
+      return readmeText
+    }
+
     // note, Shields.io escaped '-' with '--'
     const coverageRe = new RegExp(
-      'https://img\\.shields\\.io/badge/code--coverage-(\\d+)%-brightgreen',
+      `https://img\\.shields\\.io/badge/code--coverage-\\d+%-${availableColorsReStr}`,
     )
-    const coverageBadge = `https://img.shields.io/badge/code--coverage-${pct}%-brightgreen`
+    const coverageBadge = `https://img.shields.io/badge/code--coverage-${pct}%-${color}`
+    debug('coverage regex: "%s"', coverageRe)
+    debug('new coverage badge: "%s"', coverageBadge)
 
     const updatedReadmeText = readmeText.replace(
       coverageRe,
-      coverageBadge,
+      (match) => {
+        debug('match: %o', match)
+        return coverageBadge
+      },
     )
     return updatedReadmeText
   }
@@ -30,6 +61,8 @@ function updateBadge() {
   if (maybeChangedText !== readmeText) {
     console.log('saving updated readme with coverage %d%%', pct)
     fs.writeFileSync(readmeFilename, maybeChangedText, 'utf8')
+  } else {
+    debug('no code coverage badge change')
   }
 }
 

coverage/coverage-summary.json

@@ -1,4 +1,80 @@
-{"total": {"lines":{"total":3,"covered":3,"skipped":0,"pct":100},"statements":{"total":3,"covered":3,"skipped":0,"pct":100},"functions":{"total":1,"covered":1,"skipped":0,"pct":100},"branches":{"total":0,"covered":0,"skipped":0,"pct":100}}
-,"/Users/gleb/git/instrument-example/src/App.js": {"lines":{"total":1,"covered":1,"skipped":0,"pct":100},"functions":{"total":1,"covered":1,"skipped":0,"pct":100},"statements":{"total":1,"covered":1,"skipped":0,"pct":100},"branches":{"total":0,"covered":0,"skipped":0,"pct":100}}
-,"/Users/gleb/git/instrument-example/src/index.js": {"lines":{"total":2,"covered":2,"skipped":0,"pct":100},"functions":{"total":0,"covered":0,"skipped":0,"pct":100},"statements":{"total":2,"covered":2,"skipped":0,"pct":100},"branches":{"total":0,"covered":0,"skipped":0,"pct":100}}
+{
+    "total": {
+        "lines": {
+            "total": 3,
+            "covered": 3,
+            "skipped": 0,
+            "pct": 100
+        },
+        "statements": {
+            "total": 3,
+            "covered": 3,
+            "skipped": 0,
+            "pct": 100
+        },
+        "functions": {
+            "total": 1,
+            "covered": 1,
+            "skipped": 0,
+            "pct": 100
+        },
+        "branches": {
+            "total": 0,
+            "covered": 0,
+            "skipped": 0,
+            "pct": 100
+        }
+    },
+    "/Users/gleb/git/instrument-example/src/App.js": {
+        "lines": {
+            "total": 1,
+            "covered": 1,
+            "skipped": 0,
+            "pct": 100
+        },
+        "functions": {
+            "total": 1,
+            "covered": 1,
+            "skipped": 0,
+            "pct": 100
+        },
+        "statements": {
+            "total": 1,
+            "covered": 1,
+            "skipped": 0,
+            "pct": 100
+        },
+        "branches": {
+            "total": 0,
+            "covered": 0,
+            "skipped": 0,
+            "pct": 100
+        }
+    },
+    "/Users/gleb/git/instrument-example/src/index.js": {
+        "lines": {
+            "total": 2,
+            "covered": 2,
+            "skipped": 0,
+            "pct": 100
+        },
+        "functions": {
+            "total": 0,
+            "covered": 0,
+            "skipped": 0,
+            "pct": 100
+        },
+        "statements": {
+            "total": 2,
+            "covered": 2,
+            "skipped": 0,
+            "pct": 100
+        },
+        "branches": {
+            "total": 0,
+            "covered": 0,
+            "skipped": 0,
+            "pct": 100
+        }
+    }
 }

package-lock.json

@@ -37,6 +37,7 @@
   },
   "dependencies": {
     "arg": "4.1.3",
+    "debug": "4.1.1",
     "lodash": "4.17.15"
   }
 }