@bahmutov/cy-grep 1.3.0 → 1.4.0

package/README.md

@@ -1,4 +1,4 @@
-# @bahmutov/cy-grep ![cypress version](https://img.shields.io/badge/cypress-12.3.0-brightgreen)
+# @bahmutov/cy-grep ![cypress version](https://img.shields.io/badge/cypress-12.4.0-brightgreen)
 
 > Filter tests using substring or tag
 
@@ -119,6 +119,15 @@ registerCypressGrep()
 
 Installing the plugin via `setupNodeEvents()` is required to enable the [grepFilterSpecs](#pre-filter-specs-grepfilterspecs) feature.
 
+**Tip:** you probably want to set these `env` settings in your config file
+
+```js
+module.exports = defineConfig({
+  env: { grepFilterSpecs: true, grepOmitFiltered: true },
+  ...
+})
+```
+
 ## Usage Overview
 
 You can filter tests to run using part of their title via `grep`, and via explicit tags via `grepTags` Cypress environment variables.
@@ -421,6 +430,10 @@ it('cleans up the data', { requiredTags: '@nightly' }, () => {...})
 
 When you run the tests now, this test will be skipped, as if it were `it.skip`. It will only run if you use the tag `@nightly`, for example: `npx cypress run --env grepTags=@nightly`.
 
+If `grepFilterSpecs=true` and a spec has only required tags, and you are running without any tags, the the spec will be skipped completely.
+
+Read the blog post 📝 [Required Tags](https://glebbahmutov.com/blog/required-tags/).
+
 ## 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:

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bahmutov/cy-grep",
-  "version": "1.3.0",
+  "version": "1.4.0",
   "description": "Filter Cypress tests using title or tags",
   "main": "src/support.js",
   "scripts": {
@@ -16,11 +16,11 @@
     "globby": "^11.0.4"
   },
   "devDependencies": {
-    "cypress": "12.3.0",
+    "cypress": "12.4.0",
     "cypress-each": "^1.11.0",
-    "cypress-expect": "^2.5.3",
+    "cypress-expect": "^3.1.0",
     "prettier": "^2.8.1",
-    "semantic-release": "^20.0.3",
+    "semantic-release": "^20.0.4",
     "typescript": "^4.7.4"
   },
   "peerDependencies": {

package/src/plugin.js

@@ -124,7 +124,14 @@ function cypressGrepPlugin(config) {
           debug('effective test tags %o', testTags)
           return Object.keys(testTags).some((testTitle) => {
             const effectiveTags = testTags[testTitle].effectiveTags
-            return shouldTestRun(parsedGrep, null, effectiveTags)
+            const requiredTags = testTags[testTitle].requiredTags
+            return shouldTestRun(
+              parsedGrep,
+              null,
+              effectiveTags,
+              false,
+              requiredTags,
+            )
           })
         } catch (err) {
           console.error('Could not determine test names in file: %s', specFile)
@@ -136,6 +143,33 @@ function cypressGrepPlugin(config) {
 
       debug('found grep tags "%s" in %d specs', grepTags, greppedSpecs.length)
       debug('%o', greppedSpecs)
+    } else {
+      // we have no tags to grep
+      debug('will try eliminating specs with required tags')
+
+      greppedSpecs = specFiles.filter((specFile) => {
+        const text = fs.readFileSync(specFile, { encoding: 'utf8' })
+
+        try {
+          const testTags = findEffectiveTestTags(text)
+          debug('spec file %s', specFile)
+          debug('effective test tags %o', testTags)
+          // eliminate all tests with required tags, since we have no tags right now
+          const testsWithoutRequiredTags = Object.keys(testTags).filter(
+            (testTitle) => {
+              return testTags[testTitle].requiredTags.length === 0
+            },
+          )
+          // if there are any tests remaining, we should run this spec
+          // (we should not run empty specs where all tests have required tags)
+          return testsWithoutRequiredTags.length
+        } catch (err) {
+          console.error('Could not determine test names in file: %s', specFile)
+          console.error('Will run it to let the grep filter the tests')
+
+          return true
+        }
+      })
     }
 
     if (greppedSpecs.length) {