find-cypress-specs 1.29.4 → 1.30.1

package/README.md

@@ -159,6 +159,23 @@ $ npx find-cypress-specs --names --tagged <tag1>,<tag2>,<tag3>,...
 # finds all specs and tests, then filters the output showing all tests
 # tagged with tag1 or tag2 or tag3 or ...
 ```
+## File names filtered by a tag
+
+```
+$ npx find-cypress-specs --tagged <single tag>
+# finds all specs and tests, then filters the output showing only the file names associated with the tests
+
+
+# cypress/e2e/spec.cy.js,cypress/e2e/featureA/user.cy.ts
+```
+
+## File names filtered by multiple tags
+
+```
+$ npx find-cypress-specs --tagged <tag1>,<tag2>,<tag3>,...
+# finds all specs and tests, then filters the output showing only the file names associated with the tests
+# tagged with tag1 or tag2 or tag3 or ...
+```
 
 ## Show only the pending tests
 

package/bin/find.js

@@ -61,7 +61,7 @@ const specType = args['--component'] ? 'component' : 'e2e'
 
 const specs = getSpecs(undefined, specType)
 
-if (args['--names'] || args['--tags']) {
+if (args['--names'] || args['--tags'] || args['--tagged']) {
   // counts the number of tests for each tag across all specs
   const { jsonResults, tagTestCounts } = getTests(specs, {
     tags: args['--tags'],
@@ -103,6 +103,12 @@ if (args['--names'] || args['--tags']) {
       console.log(table)
     }
   }
+
+  if (!args['--names'] && !args['--tags']) {
+    debug('printing the spec names list only')
+    const specNames = Object.keys(jsonResults).join(',')
+    console.log(specNames)
+  }
 } else if (args['--branch']) {
   debug('determining specs changed against branch %s', args['--branch'])
   let changedFiles = findChangedFiles(args['--branch'], args['--parent'])
@@ -200,5 +206,6 @@ if (args['--names'] || args['--tags']) {
     console.log(changedSpecs.join(','))
   }
 } else {
+  debug('printing just %d spec names', specs.length)
   console.log(specs.join(','))
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "find-cypress-specs",
-  "version": "1.29.4",
+  "version": "1.30.1",
   "description": "Find Cypress spec files using the config settings",
   "main": "src",
   "files": [

package/src/index.js

@@ -398,7 +398,7 @@ function getTests(specs, options = {}) {
       .split(',')
       .map((s) => s.trim())
       .filter(Boolean)
-    debug('filtering all tests by tag "%o"', splitTags)
+    debug('filtering all tests by tag %o', splitTags)
     pickTaggedTestsFrom(jsonResults, splitTags)
     // recompute the number of tests
     addCounts(jsonResults)

package/src/print.js

@@ -5,47 +5,62 @@ const { formatTestList } = require('find-test-names')
  * Outputs a string representation of the json test results object,
  * like a tree of suites and tests.
  */
-function stringFileTests(fileName, fileInfo) {
-  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 stringFileTests(fileName, fileInfo, tagged) {
+  if (tagged) {
+    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) {
+function stringAllInfo(allInfo, tagged) {
   let fileCount = 0
   let testCount = 0
   let pendingTestCount = 0
 
-  const allInfoString = Object.keys(allInfo)
+  if (!tagged) {
+    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)
+      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)}`
+    const testWord = pluralize('test', testCount, true)
+    if (pendingTestCount) {
+      footer += ` (${testWord}, ${pendingTestCount} pending)`
+    } else {
+      footer += ` (${testWord})`
+    }
 
-  // footer line is something like
-  // found 2 specs (4 tests, 1 pending)
-  let footer = `found ${pluralize('spec', fileCount, true)}`
-  const testWord = pluralize('test', testCount, true)
-  if (pendingTestCount) {
-    footer += ` (${testWord}, ${pendingTestCount} pending)`
+    return allInfoString + '\n' + footer
   } else {
-    footer += ` (${testWord})`
-  }
+    const allInfoString = Object.keys(allInfo)
+    .map((fileName) => {
+      const fileInfo = allInfo[fileName]
+      return stringFileTests(fileName, fileInfo, tagged)
+    })
+    .join(',')
 
-  return allInfoString + '\n' + footer
+    return allInfoString
+  }
 }
 
 module.exports = {
   stringFileTests,
   stringAllInfo,
-}
+}