@bahmutov/cy-grep 1.8.0 → 1.9.1

package/README.md

@@ -62,6 +62,7 @@ Watch the video [intro to cypress-grep plugin](https://www.youtube.com/watch?v=H
   - [Required tags](#required-tags)
   - [Negative grep](#negative-grep)
   - [TypeScript support](#typescript-support)
+  - [grepPrefixAt](#grepprefixat)
   - [General advice](#general-advice)
   - [DevTools console](#devtools-console)
     - [grepFailed](#grepfailed)
@@ -538,6 +539,19 @@ If you have `tsconfig.json` file, add this library to the types list
 }
 ```
 
+## grepPrefixAt
+
+Using test tags that start with `@` is so common, you can enforce it using the env option `grepPrefixAt: true`. This lets you use `@tag1,@tag2, ...` or `tag1,tag2, ...` when calling.
+
+```
+# use grepPrefixAt in your env settings object
+# use { tags: '@tag1' } in your tests
+
+# then these two are equivalent
+--env grepTags=@tag1
+--env grepTags=tag1
+```
+
 ## General advice
 
 - keep it simple.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bahmutov/cy-grep",
-  "version": "1.8.0",
+  "version": "1.9.1",
   "description": "Filter Cypress tests using title or tags",
   "main": "src/support.js",
   "scripts": {
@@ -8,7 +8,8 @@
     "cy:open": "cypress open --e2e -b electron --config specPattern='**/unit.js'",
     "badges": "npx -p dependency-version-badge update-badge cypress",
     "semantic-release": "semantic-release",
-    "deps": "npm audit --report --omit dev"
+    "deps": "npm audit --report --omit dev",
+    "stop-only": "stop-only --folder cypress/e2e"
   },
   "dependencies": {
     "cypress-plugin-config": "^1.2.0",
@@ -23,6 +24,7 @@
     "cypress-expect": "^3.1.0",
     "prettier": "^2.8.1",
     "semantic-release": "^20.1.3",
+    "stop-only": "^3.3.1",
     "typescript": "^4.7.4"
   },
   "peerDependencies": {

package/src/plugin.js

@@ -22,11 +22,13 @@ function getGrepSettings(config) {
     console.log('cy-grep: tests with "%s" in their names', grep.trim())
   }
 
+  const grepPrefixAt = env.grepPrefixAt || env['grep-prefix-at']
+
   const grepTags = env.grepTags || env['grep-tags']
 
   if (grepTags) {
     console.log('cy-grep: filtering using tag(s) "%s"', grepTags)
-    const parsedGrep = parseGrep(null, grepTags)
+    const parsedGrep = parseGrep(null, grepTags, grepPrefixAt)
 
     debug('parsed grep tags %o', parsedGrep.tags)
   }
@@ -51,7 +53,11 @@ function getGrepSettings(config) {
 
   const grepFilterSpecs = env.grepFilterSpecs === true
 
-  return { grep, grepTags, grepFilterSpecs }
+  if (grepPrefixAt) {
+    console.log('cy-grep: all tags will be forced to start with @')
+  }
+
+  return { grep, grepTags, grepFilterSpecs, grepPrefixAt }
 }
 
 /**
@@ -63,7 +69,8 @@ function cypressGrepPlugin(config) {
     return config
   }
 
-  const { grep, grepTags, grepFilterSpecs } = getGrepSettings(config)
+  const { grep, grepTags, grepFilterSpecs, grepPrefixAt } =
+    getGrepSettings(config)
 
   if (grepFilterSpecs) {
     const specFiles = getSpecs(config)
@@ -74,7 +81,7 @@ function cypressGrepPlugin(config) {
 
     if (grep) {
       console.log('cy-grep: filtering specs using "%s" in the title', grep)
-      const parsedGrep = parseGrep(grep)
+      const parsedGrep = parseGrep(grep, undefined, grepPrefixAt)
 
       debug('parsed grep %o', parsedGrep)
       greppedSpecs = specFiles.filter((specFile) => {
@@ -105,9 +112,9 @@ function cypressGrepPlugin(config) {
       debug('found grep "%s" in %d specs', grep, greppedSpecs.length)
       debug('%o', greppedSpecs)
     } else if (grepTags) {
-      const parsedGrep = parseGrep(null, grepTags)
+      const parsedGrep = parseGrep(null, grepTags, grepPrefixAt)
       debug('parsed grep tags %o', parsedGrep)
-      const mentionedTags = getMentionedTags(grepTags)
+      const mentionedTags = getMentionedTags(grepTags, grepPrefixAt)
       debug('user mentioned tags %o', mentionedTags)
       // unique tags found across all specs we search
       const foundTags = new Set()

package/src/support.js

@@ -61,12 +61,23 @@ function registerCyGrep() {
     getPluginConfigValue('grepOmitFiltered') ||
     getPluginConfigValue('grep-omit-filtered')
 
-  debug('grep %o', { grep, grepTags, grepBurn, omitFiltered, version })
+  const grepPrefixAt =
+    getPluginConfigValue('grepPrefixAt') ||
+    getPluginConfigValue('grep-prefix-at')
+
+  debug('grep %o', {
+    grep,
+    grepTags,
+    grepBurn,
+    omitFiltered,
+    grepPrefixAt,
+    version,
+  })
   if (!Cypress._.isInteger(grepBurn) || grepBurn < 1) {
     throw new Error(`Invalid grep burn value: ${grepBurn}`)
   }
 
-  const parsedGrep = parseGrep(grep, grepTags)
+  const parsedGrep = parseGrep(grep, grepTags, grepPrefixAt)
 
   debug('parsed grep %o', parsedGrep)
 

package/src/utils.js

@@ -38,12 +38,13 @@ function parseFullTitleGrep(s) {
 /**
  * Parses tags to grep for.
  * @param {string|string[]} s Tags string like "@tag1+@tag2", or array of tags
+ * @param {boolean} grepPrefixAt Prefix all tags with "@" if needed
  * @example
  *  parseTagsGrep('@tag1+@tag2')
  * @example
  *  parseTagsGrep(['@tag1', '@tag2'])
  */
-function parseTagsGrep(s) {
+function parseTagsGrep(s, grepPrefixAt = false) {
   if (!s) {
     return []
   }
@@ -99,6 +100,17 @@ function parseTagsGrep(s) {
     }
   }
 
+  if (grepPrefixAt) {
+    const prefix = '@'
+    ORS_filtered.forEach((OR) => {
+      OR.forEach((token) => {
+        if (token.tag && !token.tag.startsWith(prefix)) {
+          token.tag = prefix + token.tag
+        }
+      })
+    })
+  }
+
   return ORS_filtered
 }
 
@@ -106,9 +118,11 @@ function parseTagsGrep(s) {
  * 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.
+ * @param {string} s String of tags passed by the user
+ * @param {boolean} grepPrefixAt Enforce the `@` character at the start of each tag
  * @returns {string[]} list of unique tags
  */
-function getMentionedTags(s) {
+function getMentionedTags(s, grepPrefixAt = false) {
   if (!s) {
     return []
   }
@@ -120,6 +134,15 @@ function getMentionedTags(s) {
     // remove any "-" at the start of the tag
     // because these are to signal inverted tags
     .map((s) => (s.startsWith('-') ? s.slice(1) : s))
+    .map((tag) => {
+      if (grepPrefixAt) {
+        if (!tag.startsWith('@')) {
+          return '@' + tag
+        }
+      }
+
+      return tag
+    })
   const uniqueTags = [...new Set(tags)]
   return uniqueTags.sort()
 }
@@ -229,10 +252,10 @@ function shouldTestRun(
   )
 }
 
-function parseGrep(titlePart, tags) {
+function parseGrep(titlePart, tags, grepPrefixAt) {
   return {
     title: parseFullTitleGrep(titlePart),
-    tags: parseTagsGrep(tags),
+    tags: parseTagsGrep(tags, grepPrefixAt),
   }
 }