@bahmutov/cy-grep 2.0.37 → 2.1.0

package/README.md

@@ -1,4 +1,4 @@
-# @bahmutov/cy-grep ![cypress version](https://img.shields.io/badge/cypress-15.3.0-brightgreen)
+# @bahmutov/cy-grep ![cypress version](https://img.shields.io/badge/cypress-15.4.0-brightgreen)
 
 > Filter tests using substring or tag
 
@@ -434,6 +434,44 @@ describe('parent', { tags: ['@p1', '@p2'] }, () => {
 })
 ```
 
+Additionally, you can check both tags and required tags for each test within the current spec by checking the `Cypress.env('specTags')` object
+
+See [spec.js](./cypress/e2e/spec.js) for practical test spec example.
+
+Example output:
+
+```js
+{
+    "hello world": {
+        "effectiveTestTags": [],
+        "requiredTestTags": []
+    },
+    "works": {
+        "effectiveTestTags": [],
+        "requiredTestTags": []
+    },
+    "works 2 @tag1": {
+        "effectiveTestTags": [
+            "@tag1"
+        ],
+        "requiredTestTags": []
+    },
+    "works 2 @tag1 @tag2": {
+        "effectiveTestTags": [
+            "@tag1",
+            "@tag2"
+        ],
+        "requiredTestTags": []
+    },
+    "works @tag2": {
+        "effectiveTestTags": [
+            "@tag2"
+        ],
+        "requiredTestTags": []
+    }
+}
+```
+
 ## 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.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bahmutov/cy-grep",
-  "version": "2.0.37",
+  "version": "2.1.0",
   "description": "Filter Cypress tests using title or tags",
   "main": "src/support.js",
   "scripts": {
@@ -20,7 +20,7 @@
     "globby": "^11.1.0"
   },
   "devDependencies": {
-    "cypress": "15.3.0",
+    "cypress": "15.4.0",
     "cypress-each": "^1.11.0",
     "cypress-expect": "^3.1.0",
     "prettier": "^3.0.0",

package/src/support.js

@@ -20,6 +20,10 @@ const _describe = describe
 // includes both the test tags and the suite tags
 // and the required test tags
 const testTree = {}
+// keeps all collected test tags by the individual test title
+// includes both the test tags and the suite tags
+// used to expose within a Cypress environment variable
+const modifiedTestTree = {}
 
 beforeEach(() => {
   // set the test tags for the current test
@@ -136,6 +140,10 @@ function registerCyGrep() {
       .map((item) => item.name)
       .concat(name)
       .join(' ')
+    const nameOfTest = suiteStack
+      .map((item) => item.name)
+      .concat(name)
+      .pop()
     const effectiveTestTags = suiteStack
       .flatMap((item) => item.tags)
       .concat(configTags)
@@ -147,6 +155,11 @@ function registerCyGrep() {
     debug({ nameToGrep, effectiveTestTags, requiredTestTags })
     testTree[nameToGrep] = { effectiveTestTags, requiredTestTags }
 
+    // Store the tags by individual name of test
+    // Expose the object within the Cypress environment variables
+    modifiedTestTree[nameOfTest] = { effectiveTestTags, requiredTestTags }
+    Cypress.env('specTags', modifiedTestTree)
+
     const shouldRun = shouldTestRun(
       parsedGrep,
       nameToGrep,