@bahmutov/cy-grep 1.5.1 → 1.6.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bahmutov/cy-grep",
-  "version": "1.5.1",
+  "version": "1.6.0",
   "description": "Filter Cypress tests using title or tags",
   "main": "src/support.js",
   "scripts": {

package/src/plugin.js

@@ -1,13 +1,12 @@
 // @ts-check
 const debug = require('debug')('cy-grep')
-const globby = require('globby')
 
 const { getSpecs } = require('find-cypress-specs')
 const { getTestNames, findEffectiveTestTags } = require('find-test-names')
 const fs = require('fs')
 const path = require('path')
 const { version } = require('../package.json')
-const { parseGrep, shouldTestRun } = require('./utils')
+const { parseGrep, shouldTestRun, getMentionedTags } = require('./utils')
 
 const isCypressV9 = (config) => !('specPattern' in config)
 
@@ -107,8 +106,12 @@ function cypressGrepPlugin(config) {
       debug('%o', greppedSpecs)
     } else if (grepTags) {
       const parsedGrep = parseGrep(null, grepTags)
-
       debug('parsed grep tags %o', parsedGrep)
+      const mentionedTags = getMentionedTags(grepTags)
+      debug('user mentioned tags %o', mentionedTags)
+      // unique tags found across all specs we search
+      const foundTags = new Set()
+
       greppedSpecs = specFiles.filter((specFile) => {
         const text = fs.readFileSync(specFile, { encoding: 'utf8' })
 
@@ -121,6 +124,15 @@ function cypressGrepPlugin(config) {
           return Object.keys(testTags).some((testTitle) => {
             const effectiveTags = testTags[testTitle].effectiveTags
             const requiredTags = testTags[testTitle].requiredTags
+
+            // remember all found tags
+            effectiveTags.forEach((tag) => {
+              foundTags.add(tag)
+            })
+            requiredTags.forEach((tag) => {
+              foundTags.add(tag)
+            })
+
             return shouldTestRun(
               parsedGrep,
               undefined,
@@ -139,6 +151,17 @@ function cypressGrepPlugin(config) {
 
       debug('found grep tags "%s" in %d specs', grepTags, greppedSpecs.length)
       debug('%o', greppedSpecs)
+
+      debug('all found tags across the specs %o', ...foundTags)
+      debug('user mentioned tags %o', mentionedTags)
+      mentionedTags.forEach((tag) => {
+        if (!foundTags.has(tag)) {
+          console.warn(
+            'cy-grep: could not find the tag "%s" in any of the specs',
+            tag,
+          )
+        }
+      })
     } else {
       // we have no tags to grep
       debug('will try eliminating specs with required tags')
@@ -176,13 +199,14 @@ function cypressGrepPlugin(config) {
         const relativeNames = greppedSpecs.map((filename) =>
           path.relative(integrationFolder, filename),
         )
+        const relativeSpecs = relativeNames.join(', ')
         debug(
           'specs in the integration folder %s %s',
           integrationFolder,
-          relativeNames.join(', '),
+          relativeSpecs,
         )
         // @ts-ignore
-        config.testFiles = relativeNames.join(',')
+        config.testFiles = relativeNames
       } else {
         debug('setting selected %d specs (>= v10)', greppedSpecs.length)
         // @ts-ignore
@@ -190,10 +214,10 @@ function cypressGrepPlugin(config) {
       }
     } else {
       // hmm, we filtered out all specs, probably something is wrong
-      console.warn('grep and/or grepTags has eliminated all specs')
-      grep ? console.warn('grep: %s', grep) : null
-      grepTags ? console.warn('grepTags: %s', grepTags) : null
-      console.warn('Will leave all specs to run to filter at run-time')
+      console.warn('cy-grep: grep and/or grepTags has eliminated all specs')
+      grep ? console.warn('cy-grep: title: %s', grep) : null
+      grepTags ? console.warn('cy-grep: tags: %s', grepTags) : null
+      console.warn('cy-grep: Will leave all specs to run to filter at run-time')
     }
   }
 

package/src/utils.js

@@ -95,6 +95,28 @@ function parseTagsGrep(s) {
   return ORS_filtered
 }
 
+/**
+ * Given a user string of tags to find, with various connectors,
+ * returns the list of just the tags themselves. Could be used to
+ * quickly filter test specs or find misspelled tags.
+ * @returns {string[]} list of unique tags
+ */
+function getMentionedTags(s) {
+  if (!s) {
+    return []
+  }
+  const spaced = s.replaceAll(/[+,]/g, ' ')
+  const tags = spaced
+    .split(' ')
+    .map((s) => s.trim())
+    .filter(Boolean)
+    // remove any "-" at the start of the tag
+    // because these are to signal inverted tags
+    .map((s) => (s.startsWith('-') ? s.slice(1) : s))
+  const uniqueTags = [...new Set(tags)]
+  return uniqueTags.sort()
+}
+
 function shouldTestRunRequiredTags(parsedGrepTags, requiredTags = []) {
   if (!requiredTags.length) {
     // there are no tags to check
@@ -216,4 +238,5 @@ module.exports = {
   shouldTestRunTags,
   shouldTestRunRequiredTags,
   shouldTestRunTitle,
+  getMentionedTags,
 }