find-cypress-specs 1.6.0 → 1.10.0

package/README.md

@@ -31,22 +31,26 @@ found 2 specs (4 tests, 1 pending)
 
 Where the tags are listed inside `[ ... ]` (see [cypress-grep](https://github.com/cypress-io/cypress-grep)) and the [pending tests](https://glebbahmutov.com/blog/cypress-test-statuses/) are marked with `⊙` character.
 
+You can print the results in JSON format using `--json` or `-j` option.
+
 ## Test tags
 
-You can count tags attached to the individual tests using `--names --tags` arguments
+You can count tags attached to the individual tests using `--tags` arguments
 
 ```
-$ npx find-cypress-specs --names --tags
-# prints the specs and tests and at the end prints the tags table
+$ npx find-cypress-specs --tags
+# prints the tags table sorted by tag
 
 Tag    Tests
 -----  ----------
-@user  2
 @sign  1
+@user  2
 ```
 
 Each tag count includes the tests that use the tag directly, and the _effective_ tags applied from the parent suites.
 
+You can print the results in JSON format using `--json` or `-j` option.
+
 ## Details
 
 Cypress uses the resolved [configuration values](https://on.cypress.io/configuration) to find the spec files to run. It searches the `integrationFolder` for all patterns listed in `testFiles` and removes any files matching the `ignoreTestFiles` patterns.
@@ -57,6 +61,10 @@ You can see how Cypress finds the specs using `DEBUG=cypress:cli,cypress:server:
 
 Run the utility with environment variable `DEBUG=find-cypress-specs` to see the verbose logs
 
+## Videos
+
+- [Use Ava Snapshots And Execa-wrap To Write End-to-End Tests For CLI Utilities](https://youtu.be/rsw17RqP0G0)
+
 ## Small print
 
 Author: Gleb Bahmutov <gleb.bahmutov@gmail.com> © 2022

package/bin/find.js

@@ -1,7 +1,7 @@
 #!/usr/bin/env node
 
 const arg = require('arg')
-const { getSpecs } = require('../src')
+const { getSpecs, collectResults } = require('../src')
 const fs = require('fs')
 const pluralize = require('pluralize')
 const { getTestNames, formatTestList, countTags } = require('find-test-names')
@@ -10,16 +10,18 @@ const consoleTable = require('console.table')
 const args = arg({
   '--names': Boolean,
   '--tags': Boolean,
+  '--json': Boolean,
 
   // aliases
   '-n': '--names',
   '--name': '--names',
   '-t': '--tags',
   '--tag': '--tags',
+  '-j': '--json',
 })
 
 const specs = getSpecs()
-if (args['--names']) {
+if (args['--names'] || args['--tags']) {
   if (!specs.length) {
     console.log('no specs found')
   } else {
@@ -30,7 +32,10 @@ if (args['--names']) {
     // counts the number of tests for each tag across all specs
     const tagTestCounts = {}
 
+    const jsonResults = {}
+
     specs.forEach((filename) => {
+      jsonResults[filename] = []
       const source = fs.readFileSync(filename, 'utf8')
       const result = getTestNames(source, true)
       // enable if need to debug the parsed test
@@ -40,18 +45,24 @@ if (args['--names']) {
       const testCount = pluralize('test', result.testNames.length, true)
       pendingTestsN += result.pendingTestCount
 
-      if (result.pendingTestCount) {
-        console.log(
-          '%s (%s, %d pending)',
-          filename,
-          testCount,
-          result.pendingTestCount,
-        )
-      } else {
-        console.log('%s (%s)', filename, testCount)
+      if (args['--names']) {
+        if (args['--json']) {
+          collectResults(result.structure, jsonResults[filename])
+        } else {
+          if (result.pendingTestCount) {
+            console.log(
+              '%s (%s, %d pending)',
+              filename,
+              testCount,
+              result.pendingTestCount,
+            )
+          } else {
+            console.log('%s (%s)', filename, testCount)
+          }
+          console.log(formatTestList(result.structure))
+          console.log('')
+        }
       }
-      console.log(formatTestList(result.structure))
-      console.log('')
 
       if (args['--tags']) {
         const specTagCounts = countTags(result.structure)
@@ -65,29 +76,42 @@ if (args['--names']) {
       }
     })
 
-    if (pendingTestsN) {
-      console.log(
-        'found %s (%s, %d pending)',
-        pluralize('spec', specs.length, true),
-        pluralize('test', testsN, true),
-        pendingTestsN,
-      )
-    } else {
-      console.log(
-        'found %s (%s)',
-        pluralize('spec', specs.length, true),
-        pluralize('test', testsN, true),
-      )
+    if (args['--names']) {
+      if (args['--json']) {
+        console.log(JSON.stringify(jsonResults, null, 2))
+      } else {
+        if (pendingTestsN) {
+          console.log(
+            'found %s (%s, %d pending)',
+            pluralize('spec', specs.length, true),
+            pluralize('test', testsN, true),
+            pendingTestsN,
+          )
+        } else {
+          console.log(
+            'found %s (%s)',
+            pluralize('spec', specs.length, true),
+            pluralize('test', testsN, true),
+          )
+        }
+      }
+      console.log('')
     }
-    console.log('')
 
     if (args['--tags']) {
-      const table = consoleTable.getTable(
-        ['Tag', 'Tests'],
-        Object.entries(tagTestCounts),
-      )
-      console.log(table)
-      console.log('')
+      const tagEntries = Object.entries(tagTestCounts)
+      const sortedTagEntries = tagEntries.sort((a, b) => {
+        // every entry is [tag, count], so compare the tags
+        return a[0].localeCompare(b[0])
+      })
+      if (args['--json']) {
+        // assemble a json object with the tag counts
+        const tagResults = Object.fromEntries(sortedTagEntries)
+        console.log(JSON.stringify(tagResults, null, 2))
+      } else {
+        const table = consoleTable.getTable(['Tag', 'Tests'], sortedTagEntries)
+        console.log(table)
+      }
     }
   }
 } else {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "find-cypress-specs",
-  "version": "1.6.0",
+  "version": "1.10.0",
   "description": "Find Cypress spec files using the config settings",
   "main": "src",
   "files": [
@@ -15,7 +15,11 @@
     "cy:run": "DEBUG=cypress:cli,cypress:server:specs cypress run",
     "demo": "DEBUG=find-cypress-specs node ./bin/find",
     "demo-names": "node ./bin/find --names",
-    "demo-tags": "node ./bin/find --names --tags",
+    "demo-tags": "node ./bin/find --tags",
+    "demo-tags-json": "node ./bin/find --tags --json",
+    "demo-names-and-tags": "node ./bin/find --names --tags",
+    "demo-names-and-tags-json": "node ./bin/find --names --tags --json",
+    "demo-names-json": "node ./bin/find --names --json",
     "semantic-release": "semantic-release"
   },
   "repository": {
@@ -34,6 +38,7 @@
   "devDependencies": {
     "ava": "^4.0.0",
     "cypress": "^9.2.0",
+    "execa-wrap": "^1.4.0",
     "prettier": "^2.5.1",
     "semantic-release": "^18.0.1"
   },
@@ -41,7 +46,7 @@
     "arg": "^5.0.1",
     "console.table": "^0.10.0",
     "debug": "^4.3.3",
-    "find-test-names": "^1.14.0",
+    "find-test-names": "^1.14.1",
     "globby": "^11.0.4",
     "minimatch": "^3.0.4",
     "pluralize": "^8.0.0"

package/src/index.js

@@ -72,9 +72,37 @@ function getSpecs() {
   return specs
 }
 
+function collectResults(structure, results) {
+  structure.forEach((t) => {
+    const info = {
+      name: t.name,
+      type: t.type,
+      tags: t.tags,
+    }
+    if (t.pending) {
+      info.pending = t.pending
+    }
+    results.push(info)
+    if (t.type === 'suite') {
+      if (t.suites && t.suites.length) {
+        // skip empty nested suites
+        info.suites = []
+        collectResults(t.suites, info.suites)
+      }
+
+      if (t.tests && t.tests.length) {
+        // skip empty nested tests
+        info.tests = []
+        collectResults(t.tests, info.tests)
+      }
+    }
+  })
+}
+
 module.exports = {
   getSpecs,
   // individual utilities
   getConfig,
   findCypressSpecs,
+  collectResults,
 }