find-cypress-specs 1.32.0 → 1.33.0

package/README.md

@@ -2,6 +2,8 @@
 
 > Find Cypress spec files using the config settings
 
+![Cypress tests](https://img.shields.io/badge/cy%20tests-E2E%204%20%7C%20component%202-blue)
+
 ```bash
 $ npx find-cypress-specs
 # prints all spec files separated by a comma
@@ -235,6 +237,20 @@ $ npx find-cypress-specs --test-counts
 4 e2e tests, 2 component tests
 ```
 
+### Update README badge
+
+You can set or update a badge in README with test counts by adding the `--update-badge` argument
+
+```
+$ npx find-cypress-specs --test-counts --update-badge
+4 e2e tests, 2 component tests
+⚠️ Could not find test count badge
+Insert new badge on the first line
+saving updated readme with new test counts
+```
+
+See the [badges.yml workflow](./.github/workflows/badges.yml)
+
 ## Count skipped tests
 
 Prints the single number with the count of skipped tests

package/bin/find.js

@@ -2,7 +2,9 @@
 
 const arg = require('arg')
 const { getSpecs, findChangedFiles, getTests } = require('../src')
+const { getTestCounts } = require('../src/tests-counts')
 const { stringAllInfo } = require('../src/print')
+const { updateBadge } = require('../src/badge')
 
 const fs = require('fs')
 const path = require('path')
@@ -45,6 +47,8 @@ const args = arg({
   '--component': Boolean,
   // count total number of E2E and component tests
   '--test-counts': Boolean,
+  // if we count the tests, we can update the README badge
+  '--update-badge': Boolean,
   // aliases
   '-n': '--names',
   '--name': '--names',
@@ -63,32 +67,8 @@ const args = arg({
 debug('arguments %o', args)
 
 if (args['--test-counts']) {
-  debug('finding all e2e specs')
-  const e2eSpecs = getSpecs(undefined, 'e2e')
-  debug('found %d e2e specs', e2eSpecs.length)
-  debug('finding all component specs')
-  const componentSpecs = getSpecs(undefined, 'component')
-  debug('found %d component specs', componentSpecs.length)
-
-  debug('counting all e2e tests')
-  const { jsonResults: e2eResults } = getTests(e2eSpecs)
-  debug(e2eResults)
-  let nE2E = 0
-  Object.keys(e2eResults).forEach((filename) => {
-    const n = e2eResults[filename].counts.tests
-    nE2E += n
-  })
-  debug('found %d E2E tests', nE2E)
-
-  debug('counting all component tests')
-  const { jsonResults: componentResults } = getTests(componentSpecs)
-  debug(componentResults)
-  let nComponent = 0
-  Object.keys(componentResults).forEach((filename) => {
-    const n = componentResults[filename].counts.tests
-    nComponent += n
-  })
-  debug('found %d component tests', nComponent)
+  debug('finding test counts')
+  const { nE2E, nComponent } = getTestCounts()
   console.log(
     '%d e2e %s, %d component %s',
     nE2E,
@@ -96,6 +76,10 @@ if (args['--test-counts']) {
     nComponent,
     pluralize('test', nComponent),
   )
+  if (args['--update-badge']) {
+    debug('updating the README test count badge')
+    updateBadge({ nE2E, nComponent })
+  }
 } else {
   const specType = args['--component'] ? 'component' : 'e2e'
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "find-cypress-specs",
-  "version": "1.32.0",
+  "version": "1.33.0",
   "description": "Find Cypress spec files using the config settings",
   "main": "src",
   "files": [
@@ -27,11 +27,13 @@
     "print-changed-specs": "node ./bin/find --branch main",
     "count-changed-specs": "node ./bin/find --branch main --count",
     "demo-test-counts": "node ./bin/find --test-counts",
+    "demo-test-counts-badge": "node ./bin/find --test-counts --update-badge",
     "semantic-release": "semantic-release",
     "deps": "spec-change --folder . --mask 'cypress/**/*.{js,ts}'",
     "deps-changed": "DEBUG=find-cypress-specs node ./bin/find --branch main --parent --trace-imports cypress --time-trace --cache-trace",
     "demo-component": "DEBUG=find-cypress-specs node ./bin/find --component --names",
-    "demo-exclusive": "npm run test-names --prefix test-exclusive --silent"
+    "demo-exclusive": "npm run test-names --prefix test-exclusive --silent",
+    "version-badge": "update-badge cypress"
   },
   "repository": {
     "type": "git",
@@ -49,6 +51,7 @@
   "devDependencies": {
     "ava": "^4.0.0",
     "cypress": "12.9.0",
+    "dependency-version-badge": "^1.11.0",
     "execa-wrap": "^1.4.0",
     "prettier": "^2.5.1",
     "really-need": "^1.9.2",

package/src/badge.js

@@ -1,5 +1,8 @@
+// @ts-check
+
 const debug = require('debug')('find-cypress-specs')
 const os = require('os')
+const fs = require('fs')
 
 function isNumber(n) {
   return typeof n === 'number' && !isNaN(n)
@@ -74,4 +77,22 @@ function replaceBadge({
   return updatedReadmeText
 }
 
-module.exports = { getBadgeMarkdown, replaceBadge }
+function updateBadge({ nE2E, nComponent }) {
+  debug('reading in README file')
+  // TODO: make the filename a parameter
+  const filename = 'README.md'
+  const readmeText = fs.readFileSync(filename, 'utf8')
+  const maybeChangedText = replaceBadge({
+    markdown: readmeText,
+    nE2E,
+    nComponent,
+  })
+  if (maybeChangedText !== readmeText) {
+    console.log('saving updated readme with new test counts')
+    fs.writeFileSync(filename, maybeChangedText, 'utf8')
+  } else {
+    debug('no updates to test counts')
+  }
+}
+
+module.exports = { getBadgeMarkdown, replaceBadge, updateBadge }

package/src/tests-counts.js

@@ -0,0 +1,38 @@
+// @ts-check
+const debug = require('debug')('find-cypress-specs')
+const { getSpecs, getTests } = require('.')
+
+/**
+ * Finds all E2E and component tests and returns totals
+ */
+function getTestCounts() {
+  debug('finding all e2e specs')
+  const e2eSpecs = getSpecs(undefined, 'e2e')
+  debug('found %d e2e specs', e2eSpecs.length)
+  debug('finding all component specs')
+  const componentSpecs = getSpecs(undefined, 'component')
+  debug('found %d component specs', componentSpecs.length)
+
+  debug('counting all e2e tests')
+  const { jsonResults: e2eResults } = getTests(e2eSpecs)
+  debug(e2eResults)
+  let nE2E = 0
+  Object.keys(e2eResults).forEach((filename) => {
+    const n = e2eResults[filename].counts.tests
+    nE2E += n
+  })
+  debug('found %d E2E tests', nE2E)
+
+  debug('counting all component tests')
+  const { jsonResults: componentResults } = getTests(componentSpecs)
+  debug(componentResults)
+  let nComponent = 0
+  Object.keys(componentResults).forEach((filename) => {
+    const n = componentResults[filename].counts.tests
+    nComponent += n
+  })
+  debug('found %d component tests', nComponent)
+  return { nE2E, nComponent }
+}
+
+module.exports = { getTestCounts }