find-cypress-specs 1.3.0 → 1.7.0

package/README.md

@@ -16,19 +16,37 @@ You can print each spec file with the suite and test names inside of it (found u
 $ npx find-cypress-specs --names
 # prints something like
 
-cypress/e2e/spec.js
+cypress/e2e/spec.js (2 tests)
 └─ parent suite [@main]
-  ├─ works
+  ├─ works well enough
   └─ inner suite
     └─ shows something [@user]
 
-cypress/e2e/featureA/user.js
+cypress/e2e/featureA/user.js (2 tests, 1 pending)
 ├─ works
 └⊙ needs to be written
+
+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.
 
+## Test tags
+
+You can count tags attached to the individual tests using `--tags` arguments
+
+```
+$ npx find-cypress-specs --tags
+# prints the tags table sorted by tag
+
+Tag    Tests
+-----  ----------
+@sign  1
+@user  2
+```
+
+Each tag count includes the tests that use the tag directly, and the _effective_ tags applied from the parent suites.
+
 ## 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.

package/bin/find.js

@@ -4,42 +4,96 @@ const arg = require('arg')
 const { getSpecs } = require('../src')
 const fs = require('fs')
 const pluralize = require('pluralize')
-const { getTestNames, formatTestList } = require('find-test-names')
+const { getTestNames, formatTestList, countTags } = require('find-test-names')
+const consoleTable = require('console.table')
 
 const args = arg({
   '--names': Boolean,
+  '--tags': Boolean,
 
   // aliases
   '-n': '--names',
+  '--name': '--names',
+  '-t': '--tags',
+  '--tag': '--tags',
 })
 
 const specs = getSpecs()
-if (args['--names']) {
+if (args['--names'] || args['--tags']) {
   if (!specs.length) {
     console.log('no specs found')
   } else {
     console.log('')
     let testsN = 0
+    let pendingTestsN = 0
+
+    // counts the number of tests for each tag across all specs
+    const tagTestCounts = {}
+
     specs.forEach((filename) => {
       const source = fs.readFileSync(filename, 'utf8')
       const result = getTestNames(source, true)
       // enable if need to debug the parsed test
       // console.dir(result.structure, { depth: null })
 
-      testsN += result.testNames.length
+      testsN += result.testCount
       const testCount = pluralize('test', result.testNames.length, true)
+      pendingTestsN += result.pendingTestCount
 
-      console.log('%s (%s)', filename, testCount)
-      console.log(formatTestList(result.structure))
-      console.log('')
+      if (args['--names']) {
+        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('')
+      }
+
+      if (args['--tags']) {
+        const specTagCounts = countTags(result.structure)
+        Object.keys(specTagCounts).forEach((tag) => {
+          if (!(tag in tagTestCounts)) {
+            tagTestCounts[tag] = specTagCounts[tag]
+          } else {
+            tagTestCounts[tag] += specTagCounts[tag]
+          }
+        })
+      }
     })
 
-    console.log(
-      'found %s and %s',
-      pluralize('spec', specs.length, true),
-      pluralize('test', testsN, true),
-    )
-    console.log('')
+    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),
+        )
+      }
+      console.log('')
+    }
+
+    if (args['--tags']) {
+      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])
+      })
+      const table = consoleTable.getTable(['Tag', 'Tests'], sortedTagEntries)
+      console.log(table)
+    }
   }
 } else {
   console.log(specs.join(','))

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "find-cypress-specs",
-  "version": "1.3.0",
+  "version": "1.7.0",
   "description": "Find Cypress spec files using the config settings",
   "main": "src",
   "files": [
@@ -15,6 +15,8 @@
     "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 --tags",
+    "demo-names-and-tags": "node ./bin/find --names --tags",
     "semantic-release": "semantic-release"
   },
   "repository": {
@@ -38,8 +40,9 @@
   },
   "dependencies": {
     "arg": "^5.0.1",
+    "console.table": "^0.10.0",
     "debug": "^4.3.3",
-    "find-test-names": "^1.9.4",
+    "find-test-names": "^1.14.1",
     "globby": "^11.0.4",
     "minimatch": "^3.0.4",
     "pluralize": "^8.0.0"