@bahmutov/cy-grep 1.10.0 → 1.11.0

package/README.md

@@ -1,4 +1,4 @@
-# @bahmutov/cy-grep ![cypress version](https://img.shields.io/badge/cypress-13.1.0-brightgreen)
+# @bahmutov/cy-grep ![cypress version](https://img.shields.io/badge/cypress-13.11.0-brightgreen)
 
 > Filter tests using substring or tag
 
@@ -60,6 +60,7 @@ Watch the video [intro to cypress-grep plugin](https://www.youtube.com/watch?v=H
   - [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)
@@ -505,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:

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bahmutov/cy-grep",
-  "version": "1.10.0",
+  "version": "1.11.0",
   "description": "Filter Cypress tests using title or tags",
   "main": "src/support.js",
   "scripts": {
@@ -16,7 +16,8 @@
     "cypress-plugin-config": "^1.2.0",
     "debug": "^4.3.2",
     "find-cypress-specs": "^1.35.1",
-    "find-test-names": "1.28.21"
+    "find-test-names": "1.28.21",
+    "globby": "^11.1.0"
   },
   "devDependencies": {
     "cypress": "13.11.0",

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

@@ -58,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)
@@ -125,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)