find-cypress-specs 1.37.0 → 1.38.0

package/README.md

@@ -1,4 +1,4 @@
-# find-cypress-specs [![renovate-app badge][renovate-badge]][renovate-app] ![cypress version](https://img.shields.io/badge/cypress-13.3.2-brightgreen) [![ci](https://github.com/bahmutov/find-cypress-specs/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/bahmutov/find-cypress-specs/actions/workflows/ci.yml)
+# find-cypress-specs [![renovate-app badge][renovate-badge]][renovate-app] ![cypress version](https://img.shields.io/badge/cypress-13.6.0-brightgreen) [![ci](https://github.com/bahmutov/find-cypress-specs/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/bahmutov/find-cypress-specs/actions/workflows/ci.yml)
 
 > Find Cypress spec files using the config settings
 
@@ -157,6 +157,17 @@ Required tags are marked with `[[ ... ]]`.
 
 You can print the results in JSON format using `--json` or `-j` option.
 
+You can print the tests in Markdown format using `--markdown` or `--md` option
+
+| Spec                             |
+| -------------------------------- |
+| **`foo/a/spec.cy.js`** (3 tests) |
+| `suite / test 1`                 |
+| `suite / test 2`                 |
+| `suite / test 3`                 |
+| **`foo/b/spec.cy.js`** (1 test)  |
+| `another / test / test 1`        |
+
 ## Test tags
 
 You can count tags attached to the individual tests using `--tags` arguments
@@ -200,10 +211,12 @@ $ npx find-cypress-specs --tagged <single tag>
 # cypress/e2e/spec.cy.js,cypress/e2e/featureA/user.cy.ts
 ```
 
+If you pass an empty string argument like `--tagged ''`, an empty list is returned.
+
 You can print the number of found tagged specs by adding `--count` argument
 
 ```
-$ npx find-cypress-specs --tagged <single tag>
+$ npx find-cypress-specs --tagged <single tag> --count
 3
 ```
 

package/bin/find.js

@@ -3,7 +3,7 @@
 const arg = require('arg')
 const { getSpecs, findChangedFiles, getTests } = require('../src')
 const { getTestCounts } = require('../src/tests-counts')
-const { stringAllInfo } = require('../src/print')
+const { stringAllInfo, stringMarkdownTests } = require('../src/print')
 const { updateBadge } = require('../src/badge')
 
 const fs = require('fs')
@@ -49,6 +49,9 @@ const args = arg({
   '--test-counts': Boolean,
   // if we count the tests, we can update the README badge
   '--update-badge': Boolean,
+  // output the list in Markdown format
+  '--markdown': Boolean,
+  //
   // aliases
   '-n': '--names',
   '--name': '--names',
@@ -62,6 +65,7 @@ const args = arg({
   // https://glebbahmutov.com/blog/cypress-test-statuses/
   '--pending': '--skipped',
   '--tc': '--test-counts',
+  '--md': '--markdown',
 })
 
 debug('arguments %o', args)
@@ -85,6 +89,10 @@ if (args['--test-counts']) {
 
   const specs = getSpecs(undefined, specType)
 
+  // if the user passes "--tagged ''" we want to find the specs
+  // but then filter them all out
+  const isTaggedPresent = args['--tagged'] || args['--tagged'] === ''
+
   if (args['--branch']) {
     debug('determining specs changed against branch %s', args['--branch'])
     let changedFiles = findChangedFiles(args['--branch'], args['--parent'])
@@ -191,8 +199,9 @@ if (args['--test-counts']) {
     } else {
       console.log(changedSpecs.join(','))
     }
-  } else if (args['--names'] || args['--tags'] || args['--tagged']) {
+  } else if (args['--names'] || args['--tags'] || isTaggedPresent) {
     // counts the number of tests for each tag across all specs
+    debug('count number of tests')
     const { jsonResults, tagTestCounts } = getTests(specs, {
       tags: args['--tags'],
       tagged: args['--tagged'],
@@ -204,6 +213,7 @@ if (args['--test-counts']) {
     debug(tagTestCounts)
 
     if (args['--names']) {
+      debug('output test names')
       if (args['--count']) {
         debug('names and count')
         let n = 0
@@ -214,8 +224,14 @@ if (args['--test-counts']) {
         console.log(n)
       } else {
         if (args['--json']) {
+          debug('names in json format')
           console.log(JSON.stringify(jsonResults, null, 2))
+        } else if (args['--markdown']) {
+          debug('names in Markdown format')
+          const str = stringMarkdownTests(jsonResults)
+          console.log(str)
         } else {
+          debug('names to standard out')
           const str = stringAllInfo(jsonResults)
           console.log(str)
         }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "find-cypress-specs",
-  "version": "1.37.0",
+  "version": "1.38.0",
   "description": "Find Cypress spec files using the config settings",
   "main": "src",
   "files": [
@@ -16,6 +16,7 @@
     "cy:run": "DEBUG=cypress:cli,cypress:server:specs cypress run",
     "demo": "DEBUG=find-cypress-specs node ./bin/find",
     "demo-names": "DEBUG=find-cypress-specs node ./bin/find --names",
+    "demo-names-markdown": "node ./bin/find --names --markdown",
     "demo-skipped-tests": "DEBUG=find-cypress-specs node ./bin/find --names --skipped",
     "demo-count-skipped-tests": "DEBUG=find-cypress-specs node ./bin/find --names --skipped --count",
     "demo-custom-cypress-config": "DEBUG=find-cypress-specs CYPRESS_CONFIG_FILE=test-ts/cypress.config.custom.ts node ./bin/find",
@@ -25,6 +26,7 @@
     "demo-names-and-tags-json": "node ./bin/find --names --tags --json",
     "demo-names-json": "node ./bin/find --names --json",
     "demo-names-tagged": "node ./bin/find --names --tagged @user",
+    "demo-tagged-empty-string": "node ./bin/find --tagged ''",
     "demo-subfolder": "DEBUG=find-cypress-specs CYPRESS_CONFIG_FILE=mocks/my-app/e2e/cypress.config.js node ./bin/find --names",
     "print-changed-specs": "node ./bin/find --branch main",
     "count-changed-specs": "node ./bin/find --branch main --count",
@@ -53,12 +55,12 @@
   "homepage": "https://github.com/bahmutov/find-cypress-specs#readme",
   "devDependencies": {
     "ava": "^4.0.0",
-    "cypress": "13.3.2",
+    "cypress": "13.6.0",
     "dependency-version-badge": "^1.11.0",
     "execa-wrap": "^1.4.0",
     "prettier": "^2.5.1",
     "really-need": "^1.9.2",
-    "semantic-release": "22.0.5",
+    "semantic-release": "22.0.8",
     "sinon": "^13.0.1",
     "typescript": "^4.6.3"
   },

package/src/index.js

@@ -449,7 +449,7 @@ function getTests(specs, options = {}) {
   debug('added counts')
   debug(jsonResults)
 
-  if (tagged) {
+  if (tagged || tagged === '') {
     // filter all collected tests to those that have the given tag(s)
     const splitTags = tagged
       .split(',')

package/src/print.js

@@ -7,36 +7,35 @@ const { formatTestList } = require('find-test-names')
  */
 function stringFileTests(fileName, fileInfo, tagged) {
   if (tagged) {
-    const headerLine = fileName;
-  return headerLine
+    const headerLine = fileName
+    return headerLine
   } else {
     const testCount = pluralize('test', fileInfo.counts.tests, true)
     const headerLine = fileInfo.counts.pending
       ? `${fileName} (${testCount}, ${fileInfo.counts.pending} pending)`
       : `${fileName} (${testCount})`
-  
+
     // console.log(fileInfo.tests)
     const body = formatTestList(fileInfo.tests)
-  
+
     return headerLine + '\n' + body + '\n'
   }
 }
 
 function stringAllInfo(allInfo, tagged) {
-  let fileCount = 0
-  let testCount = 0
-  let pendingTestCount = 0
-
   if (!tagged) {
+    let fileCount = 0
+    let testCount = 0
+    let pendingTestCount = 0
     const allInfoString = Object.keys(allInfo)
-    .map((fileName) => {
-      const fileInfo = allInfo[fileName]
-      fileCount += 1
-      testCount += fileInfo.counts.tests
-      pendingTestCount += fileInfo.counts.pending
-      return stringFileTests(fileName, fileInfo, tagged)
-    })
-    .join('\n')
+      .map((fileName) => {
+        const fileInfo = allInfo[fileName]
+        fileCount += 1
+        testCount += fileInfo.counts.tests
+        pendingTestCount += fileInfo.counts.pending
+        return stringFileTests(fileName, fileInfo, tagged)
+      })
+      .join('\n')
     // footer line is something like
     // found 2 specs (4 tests, 1 pending)
     let footer = `found ${pluralize('spec', fileCount, true)}`
@@ -50,17 +49,73 @@ function stringAllInfo(allInfo, tagged) {
     return allInfoString + '\n' + footer
   } else {
     const allInfoString = Object.keys(allInfo)
-    .map((fileName) => {
-      const fileInfo = allInfo[fileName]
-      return stringFileTests(fileName, fileInfo, tagged)
-    })
-    .join(',')
+      .map((fileName) => {
+        const fileInfo = allInfo[fileName]
+        return stringFileTests(fileName, fileInfo, tagged)
+      })
+      .join(',')
 
     return allInfoString
   }
 }
 
+function getJustTheTestNames(tests, parentName = '', justNames = []) {
+  // console.log(tests)
+  // console.log(justNames)
+  // console.log('parent name "%s"', parentName)
+
+  if (tests.type === 'test') {
+    justNames.push(parentName + tests.name)
+    return
+  } else if (tests.type === 'suite') {
+    const prefix = parentName
+      ? parentName + tests.name + ' / '
+      : tests.name + ' / '
+    getJustTheTestNames(tests.tests, prefix, justNames)
+    if (tests.suites) {
+      tests.suites.forEach((suite) => {
+        getJustTheTestNames(suite, prefix, justNames)
+      })
+    }
+    return
+  }
+
+  // tests can include regular tests plus suites nodes
+  tests.forEach((testOrSuite) => {
+    getJustTheTestNames(testOrSuite, parentName, justNames)
+  })
+  return justNames
+}
+
+/**
+ * Returns a single string with all specs and test names
+ * as a Markdown table
+ * @returns {string}
+ */
+function stringMarkdownTests(allInfo) {
+  const allInfoString =
+    '| Spec |\n| --- |\n' +
+    Object.keys(allInfo)
+      .map((fileName) => {
+        const fileInfo = allInfo[fileName]
+        const n = fileInfo.counts.tests
+        // console.log(fileInfo)
+
+        let specTest =
+          '| **`' + fileName + '`**' + ` (${n} ${pluralize('test', n)}) |\n`
+        const testNames = getJustTheTestNames(fileInfo.tests)
+        testNames.forEach((name) => {
+          specTest += '| `' + name + '` |\n'
+        })
+        return specTest
+      })
+      .join('')
+
+  return allInfoString
+}
+
 module.exports = {
   stringFileTests,
   stringAllInfo,
-}
+  stringMarkdownTests,
+}