@bahmutov/cy-grep 1.7.3 → 1.9.0

package/README.md

@@ -60,7 +60,9 @@ Watch the video [intro to cypress-grep plugin](https://www.youtube.com/watch?v=H
   - [Disable grep](#disable-grep)
   - [Burn (repeat) tests](#burn-repeat-tests)
   - [Required tags](#required-tags)
+  - [Negative grep](#negative-grep)
   - [TypeScript support](#typescript-support)
+  - [grepPrefixAt](#grepprefixat)
   - [General advice](#general-advice)
   - [DevTools console](#devtools-console)
     - [grepFailed](#grepfailed)
@@ -486,6 +488,26 @@ If `grepFilterSpecs=true` and a spec has only required tags, and you are running
 
 Read the blog post 📝 [Required Tags](https://glebbahmutov.com/blog/required-tags/).
 
+## Negative grep
+
+When grepping tests by title, the parent suite title is included. For example if this is the spec
+
+```js
+describe('users', () => {
+  it('works 1', () => {})
+  it('works 2', () => {})
+  it('works 3', () => {})
+})
+
+describe('projects', () => {
+  it('load 1', () => {})
+  it('load 2', () => {})
+  it('load 3', () => {})
+})
+```
+
+You can run the tests inside the suite "projects" by using `--env grep=projects` and you can skip the tests in the suite `projects` by using `--env grep=-projects`.
+
 ## TypeScript support
 
 Because the Cypress test config object type definition does not have the `tags` property we are using above, the TypeScript linter will show an error. Just add an ignore comment above the test:
@@ -517,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.7.3",
+  "version": "1.9.0",
   "description": "Filter Cypress tests using title or tags",
   "main": "src/support.js",
   "scripts": {

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,20 +81,20 @@ 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) => {
         const text = fs.readFileSync(specFile, { encoding: 'utf8' })
 
         try {
-          const names = getTestNames(text, false)
-          const testAndSuiteNames = names.suiteNames.concat(names.testNames)
+          const result = getTestNames(text, true)
+          const testNames = result.fullTestNames
 
           debug('spec file %s', specFile)
-          debug('suite and test names: %o', testAndSuiteNames)
+          debug('full test names: %o', testNames)
 
-          return testAndSuiteNames.some((name) => {
+          return testNames.some((name) => {
             const shouldRun = shouldTestRun(parsedGrep, name)
 
             return shouldRun
@@ -105,7 +112,7 @@ 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)
       debug('user mentioned tags %o', mentionedTags)

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
 }
 
@@ -229,10 +241,10 @@ function shouldTestRun(
   )
 }
 
-function parseGrep(titlePart, tags) {
+function parseGrep(titlePart, tags, grepPrefixAt) {
   return {
     title: parseFullTitleGrep(titlePart),
-    tags: parseTagsGrep(tags),
+    tags: parseTagsGrep(tags, grepPrefixAt),
   }
 }