@bahmutov/cy-grep 1.5.2 → 1.7.0

package/README.md

@@ -70,6 +70,7 @@ Watch the video [intro to cypress-grep plugin](https://www.youtube.com/watch?v=H
     - [Debugging in the browser](#debugging-in-the-browser)
   - [Examples](#examples)
   - [See also](#see-also)
+  - [cy-grep vs cypress-grep vs @cypress/grep](#cy-grep-vs-cypress-grep-vs-cypressgrep)
   - [Small Print](#small-print)
 
 <!-- /MarkdownTOC -->
@@ -288,6 +289,13 @@ If you can pass commas in the environment variable `grepTags`, you can use `,` t
 CYPRESS_grepTags=one,two npx cypress run
 ```
 
+If a specific tag is not found in the specs, you will get a warning in the terminal:
+
+```
+$ npx cypress run --env grepTags=@wrong-tag
+cy-grep: could not find the tag "@wrong-tag" in any of the specs
+```
+
 ### Tags in the test config object
 
 Cypress tests can have their own [test config object](https://on.cypress.io/configuration#Test-Configuration), and when using this plugin you can put the test tags there, either as a single tag string or as an array of tags.
@@ -643,8 +651,25 @@ To see how to debug this plugin, watch the video [Debug cypress-grep Plugin](htt
 - [cypress-select-tests](https://github.com/bahmutov/cypress-select-tests)
 - [cypress-skip-test](https://github.com/cypress-io/cypress-skip-test)
 
+## cy-grep vs cypress-grep vs @cypress/grep
+
+Many years ago I wrote a plugin `cypress-grep`. When I left the company Cypress, I transferred that MIT-licensed plugin to the Cypress GitHub organization. They moved it to the Cypress monorepo and renamed the NPM module `@cypress/grep`. I still use this grep plugin in some projects. When Cypress v10 was released, it broke some of the things in the plugin. Since I needed to fix it quickly and the monorepo setup is suboptimal, I forked the plugin back to my own repo `bahmutov/cy-grep` (this repo) and released under NPM name `@bahmutov/cy-grep`.
+
+I plan to maintain the plugin `@bahmutov/cy-grep` in the future, since I rely on it myself **a lot**.
+
 ## Small Print
 
+Author: Gleb Bahmutov &lt;gleb.bahmutov@gmail.com&gt; &copy; 2022
+
+- [@bahmutov](https://twitter.com/bahmutov)
+- [glebbahmutov.com](https://glebbahmutov.com)
+- [blog](https://glebbahmutov.com/blog)
+- [videos](https://www.youtube.com/glebbahmutov)
+- [presentations](https://slides.com/bahmutov)
+- [cypress.tips](https://cypress.tips)
+- [Cypress Tips & Tricks Newsletter](https://cypresstips.substack.com/)
+- [my Cypress courses](https://cypress.tips/courses)
+
 License: MIT - do anything with the code, but don't blame me if it does not work.
 
 Support: if you find any problems with this module, email / tweet /

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bahmutov/cy-grep",
-  "version": "1.5.2",
+  "version": "1.7.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')
@@ -191,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

@@ -37,13 +37,20 @@ function parseFullTitleGrep(s) {
 
 /**
  * Parses tags to grep for.
- * @param {string} s Tags string like "@tag1+@tag2"
+ * @param {string|string[]} s Tags string like "@tag1+@tag2", or array of tags
+ * @example
+ *  parseTagsGrep('@tag1+@tag2')
+ * @example
+ *  parseTagsGrep(['@tag1', '@tag2'])
  */
 function parseTagsGrep(s) {
   if (!s) {
     return []
   }
 
+  if (Array.isArray(s)) {
+    s = s.join(',')
+  }
   const explicitNotTags = []
 
   // top level split - using space or comma, each part is OR
@@ -95,6 +102,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 +245,5 @@ module.exports = {
   shouldTestRunTags,
   shouldTestRunRequiredTags,
   shouldTestRunTitle,
+  getMentionedTags,
 }