@bahmutov/cy-grep 1.9.17 → 1.11.0

package/README.md

@@ -1,4 +1,4 @@
-# @bahmutov/cy-grep ![cypress version](https://img.shields.io/badge/cypress-12.15.0-brightgreen)
+# @bahmutov/cy-grep ![cypress version](https://img.shields.io/badge/cypress-13.11.0-brightgreen)
 
 > Filter tests using substring or tag
 
@@ -55,10 +55,12 @@ Watch the video [intro to cypress-grep plugin](https://www.youtube.com/watch?v=H
     - [NOT tags](#not-tags)
     - [Tags in test suites](#tags-in-test-suites)
     - [Grep untagged tests](#grep-untagged-tests)
+    - [Access the tags in the test](#access-the-tags-in-the-test)
   - [Pre-filter specs (grepFilterSpecs)](#pre-filter-specs-grepfilterspecs)
   - [Omit filtered tests (grepOmitFiltered)](#omit-filtered-tests-grepomitfiltered)
   - [Disable grep](#disable-grep)
   - [Burn (repeat) tests](#burn-repeat-tests)
+  - [grepExtraSpecs](#grepextraspecs)
   - [Required tags](#required-tags)
   - [Negative grep](#negative-grep)
   - [TypeScript support](#typescript-support)
@@ -407,6 +409,22 @@ Sometimes you want to run only the tests without any tags, and these tests are i
 $ npx cypress run --env grepUntagged=true
 ```
 
+### Access the tags in the test
+
+You can check the current test's tags (including its parent suites) by checking the `Cypress.env('testTags')` list
+
+```js
+describe('parent', { tags: ['@p1', '@p2'] }, () => {
+  describe('child', { tags: '@c1' }, () => {
+    it('has all effective test tags', { tags: '@t1' }, () => {
+      const tags = Cypress.env('testTags')
+      // includes tags from the parent suites and the test itself
+      expect(tags, 'tags').to.deep.equal(['@p1', '@p2', '@c1', '@t1'])
+    })
+  })
+})
+```
+
 ## Pre-filter specs (grepFilterSpecs)
 
 By default, when using `grep` and `grepTags` all specs are executed, and inside each the filters are applied. This can be very wasteful, if only a few specs contain the `grep` in the test titles. Thus when doing the positive `grep`, you can pre-filter specs using the `grepFilterSpecs=true` parameter.
@@ -488,6 +506,14 @@ You can pass the number of times to run the tests via environment name `burn` or
 
 If you do not specify the "grep" or "grep tags" option, the "burn" will repeat _every_ test.
 
+## grepExtraSpecs
+
+Sometimes you want to pre-filter specs using tags AND then run extra specs without any filtering. You can set the list of specs / patterns using the `grepExtraSpecs` env string. For example, to filter specs using tag `@a` plus run the spec "b.cy.js":
+
+```
+npx cypress run --env grepTags=@a,grepExtraSpecs=cypress/e2e/b.cy.js
+```
+
 ## Required tags
 
 Sometimes you might want to run a test or a suite of tests _only_ if a specific tag or tags are present. For example, you might have a test that cleans the data. This test is meant to run nightly, not on every test run. Thus you can set a `required` tag:
@@ -708,6 +734,7 @@ 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)
 - 📝 Read the blog post [Cypress GitHub Actions Slash Command](https://glebbahmutov.com/blog/cypress-slash-command/)
+- plugin [dennisbergevin/cypress-plugin-last-failed](https://github.com/dennisbergevin/cypress-plugin-last-failed)
 
 ## cy-grep vs cypress-grep vs @cypress/grep
 

package/package.json

@@ -1,11 +1,12 @@
 {
   "name": "@bahmutov/cy-grep",
-  "version": "1.9.17",
+  "version": "1.11.0",
   "description": "Filter Cypress tests using title or tags",
   "main": "src/support.js",
   "scripts": {
     "cy:run": "cypress run --config specPattern='**/unit.js'",
     "cy:open": "cypress open --e2e -b electron --config specPattern='**/unit.js'",
+    "cy:open:tags": "cypress open --e2e -b electron --config specPattern='cypress/e2e/test-tags/*.cy.js'",
     "badges": "npx -p dependency-version-badge update-badge cypress",
     "semantic-release": "semantic-release",
     "deps": "npm audit --report --omit dev",
@@ -15,16 +16,17 @@
     "cypress-plugin-config": "^1.2.0",
     "debug": "^4.3.2",
     "find-cypress-specs": "^1.35.1",
-    "find-test-names": "1.28.13"
+    "find-test-names": "1.28.21",
+    "globby": "^11.1.0"
   },
   "devDependencies": {
-    "cypress": "13.1.0",
+    "cypress": "13.11.0",
     "cypress-each": "^1.11.0",
     "cypress-expect": "^3.1.0",
-    "prettier": "^2.8.1",
-    "semantic-release": "^21.1.1",
+    "prettier": "^3.0.0",
+    "semantic-release": "^24.0.0",
     "stop-only": "^3.3.1",
-    "typescript": "^4.7.4"
+    "typescript": "^5.0.0"
   },
   "peerDependencies": {
     "cypress": ">=8"

package/src/file-utils.js

@@ -0,0 +1,35 @@
+// @ts-check
+
+const globby = require('globby')
+const debug = require('debug')('cy-grep')
+
+function resolveFilePattern(pattern) {
+  if (pattern.includes('*')) {
+    const globbyOptions = {
+      sort: true,
+      objectMode: false,
+    }
+    debug('globby options "%s" %o', pattern, globbyOptions)
+
+    const files = globby.sync(pattern, globbyOptions)
+    debug('found %d file(s) %o', files.length, files)
+    return files
+  } else {
+    return pattern
+  }
+}
+
+function resolveFilePatterns(patterns) {
+  const extraSpecsList = patterns
+    .split(',')
+    .map((s) => s.trim())
+    .filter(Boolean)
+  debug('extra specs list %o', extraSpecsList)
+
+  return extraSpecsList.flatMap(resolveFilePattern)
+}
+
+module.exports = {
+  resolveFilePattern,
+  resolveFilePatterns,
+}

package/src/plugin.js

@@ -7,6 +7,7 @@ const fs = require('fs')
 const path = require('path')
 const { version } = require('../package.json')
 const { parseGrep, shouldTestRun, getMentionedTags } = require('./utils')
+const { resolveFilePatterns } = require('./file-utils')
 const minimatch = require('minimatch')
 
 const MINIMATCH_OPTIONS = { dot: true, matchBase: true }
@@ -224,6 +225,23 @@ function cypressGrepPlugin(config) {
       })
     }
 
+    const extraSpecsPattern = config.env.grepExtraSpecs
+    if (extraSpecsPattern) {
+      debug('processing the extra specs pattern "%s"', extraSpecsPattern)
+      const extraSpecs = resolveFilePatterns(extraSpecsPattern)
+      // update the config env object with resolved extra specs
+      const resolvedExtraSpecs = []
+      extraSpecs.forEach((specFilename) => {
+        if (!greppedSpecs.includes(specFilename)) {
+          greppedSpecs.push(specFilename)
+          resolvedExtraSpecs.push(specFilename)
+          debug('added extra spec %s', specFilename)
+        }
+      })
+
+      config.env.grepExtraSpecs = resolvedExtraSpecs
+    }
+
     if (greppedSpecs.length) {
       if (isCypressV9(config)) {
         debug('setting selected %d specs (< v10)', greppedSpecs.length)

package/src/support.js

@@ -16,6 +16,22 @@ debug.log = console.info.bind(console)
 // preserve the real "it" function
 const _it = it
 const _describe = describe
+// keeps all collected test tags by the full test title
+// includes both the test tags and the suite tags
+// and the required test tags
+const testTree = {}
+
+beforeEach(() => {
+  // set the test tags for the current test
+  const testTitle = Cypress.currentTest.titlePath.join(' ')
+  const info = testTree[testTitle]
+  if (info) {
+    const allTags = info.effectiveTestTags.concat(info.requiredTestTags)
+    Cypress.env('testTags', allTags)
+  } else {
+    Cypress.env('testTags', null)
+  }
+})
 
 /**
  * Wraps the "it" and "describe" functions that support tags.
@@ -42,6 +58,8 @@ function registerCyGrep() {
     getPluginConfigValue('grepUntagged') ||
     getPluginConfigValue('grep-untagged')
 
+  const extraSpecs = getPluginConfigValue('grepExtraSpecs')
+
   // if (!grep && !grepTags && !burnSpecified && !grepUntagged) {
   // nothing to do, the user has no specified the "grep" string
   // debug('Nothing to grep, version %s', version)
@@ -109,6 +127,11 @@ function registerCyGrep() {
       configRequiredTags = [configRequiredTags]
     }
 
+    if (extraSpecs?.length && extraSpecs.includes(Cypress.spec.relative)) {
+      // the user wants to run all tests in this extra spec file
+      return _it(name, options, callback)
+    }
+
     const nameToGrep = suiteStack
       .map((item) => item.name)
       .concat(name)
@@ -122,6 +145,7 @@ function registerCyGrep() {
       .concat(configRequiredTags)
       .filter(Boolean)
     debug({ nameToGrep, effectiveTestTags, requiredTestTags })
+    testTree[nameToGrep] = { effectiveTestTags, requiredTestTags }
 
     const shouldRun = shouldTestRun(
       parsedGrep,