feat: grep untagged tests to run (#78)

* start working on grep untagged

* feat: implement untagged

* update the readme

.github/workflows/ci.yml

@@ -225,7 +225,21 @@ jobs:
           npx cypress-expect \
             --config testFiles="**/*.js" \
             --env grep="outside any suites",grepFilterSpecs=true \
-            --expect expects/grep-filter-specs.json
+            --expect-exactly expects/grep-filter-specs.json
+
+      - name: run untagged tests 🧪
+        run: |
+          npx cypress-expect \
+            --config testFiles="**/spec.js" \
+            --env grepUntagged=true \
+            --expect-exactly expects/grep-untagged.json
+
+      - name: run untagged tests in blocks 🧪
+        run: |
+          npx cypress-expect \
+            --config testFiles="**/describe-tags-spec.js" \
+            --env grepUntagged=true \
+            --expect-exactly expects/describe-tags-spec-untagged.json
 
       - name: Semantic Release 🚀
         uses: cycjimmy/semantic-release-action@v2

README.md

@@ -81,6 +81,11 @@ $ npx cypress run --env grepTags=@fast
 # run only the tests tagged "smoke"
 # that have "login" in their titles
 $ npx cypress run --env grep=login,grepTags=smoke
+# only run the specs that have any tests with "user" in their titles
+$ npx cypress run --env grep=user,grepFilterSpecs=true
+# run only tests that do not have any tags
+# and are not inside suites that have any tags
+$ npx cypress run --env grepUntagged=true
 ```
 
 ## Videos
@@ -192,6 +197,14 @@ Note: this requires installing this plugin in your project's plugin file, see th
 
 Note 2: the `grepFilterSpecs` option is only compatible with the `grep` option, and not with `grepTags` option.
 
+### grep untagged tests
+
+Sometimes you want to run only the tests without any tags, and these tests are inside the describe blocks without any tags.
+
+```
+$ npx cypress run --env grepUntagged=true
+```
+
 ### TypeScript users
 
 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:

expects/describe-tags-spec-untagged.json

@@ -0,0 +1,14 @@
+{
+  "block with no tags": {
+    "inside describe 1": "passing",
+    "inside describe 2": "passing"
+  },
+  "block with tag smoke": {
+    "inside describe 3": "pending",
+    "inside describe 4": "pending"
+  },
+  "block without any tags": {
+    "test with tag smoke": "pending"
+  },
+  "is a test outside any suites": "passing"
+}

expects/grep-untagged.json

@@ -0,0 +1,7 @@
+{
+  "hello world": "passing",
+  "works": "passing",
+  "works 2 @tag1": "pending",
+  "works 2 @tag1 @tag2": "pending",
+  "works @tag2": "pending"
+}

package.json

@@ -18,7 +18,7 @@
   "devDependencies": {
     "cypress": "8.7.0",
     "cypress-each": "^1.5.0",
-    "cypress-expect": "2.4.1",
+    "cypress-expect": "2.5.0",
     "prettier": "2.3.1",
     "semantic-release": "17.4.3"
   },

src/index.d.ts

@@ -1,3 +1,5 @@
+/// <reference types="cypress" />
+
 declare namespace Cypress {
   // specify additional properties in the TestConfig object
   // in our case we will add "tags" property

src/plugin.js

@@ -30,6 +30,11 @@ function cypressGrepPlugin(config) {
     console.log('cypress-grep: running filtered tests %d times', grepBurn)
   }
 
+  const grepUntagged = config.env.grepUntagged || config.env['grep-untagged']
+  if (grepUntagged) {
+    console.log('cypress-grep: running untagged tests')
+  }
+
   const grepFilterSpecs = config.env.grepFilterSpecs === true
   if (grepFilterSpecs && grep) {
     console.log('cypress-grep: filtering specs using "%s" in the title', grep)

src/support.js

@@ -26,7 +26,10 @@ function cypressGrep() {
   const burnSpecified =
     Cypress.env('grepBurn') || Cypress.env('grep-burn') || Cypress.env('burn')
 
-  if (!grep && !grepTags && !burnSpecified) {
+  const grepUntagged =
+    Cypress.env('grepUntagged') || Cypress.env('grep-untagged')
+
+  if (!grep && !grepTags && !burnSpecified && !grepUntagged) {
     // nothing to do, the user has no specified the "grep" string
     debug('Nothing to grep')
     return
@@ -78,8 +81,14 @@ function cypressGrep() {
     const tagsToGrep = suiteStack
       .flatMap((item) => item.tags)
       .concat(configTags)
-
-    const shouldRun = shouldTestRun(parsedGrep, nameToGrep, tagsToGrep)
+      .filter(Boolean)
+
+    const shouldRun = shouldTestRun(
+      parsedGrep,
+      nameToGrep,
+      tagsToGrep,
+      grepUntagged,
+    )
 
     if (tagsToGrep && tagsToGrep.length) {
       debug(

src/utils.js

@@ -125,7 +125,11 @@ function shouldTestRunTitle(parsedGrep, testName) {
 }
 
 // note: tags take precedence over the test name
-function shouldTestRun(parsedGrep, testName, tags = []) {
+function shouldTestRun(parsedGrep, testName, tags = [], grepUntagged = false) {
+  if (grepUntagged) {
+    return !tags.length
+  }
+
   if (Array.isArray(testName)) {
     // the caller passed tags only, no test name
     tags = testName