@bahmutov/cy-grep 1.9.16 → 1.10.0

package/README.md

@@ -1,4 +1,4 @@
-# @bahmutov/cy-grep ![cypress version](https://img.shields.io/badge/cypress-12.14.0-brightgreen)
+# @bahmutov/cy-grep ![cypress version](https://img.shields.io/badge/cypress-13.1.0-brightgreen)
 
 > Filter tests using substring or tag
 
@@ -55,6 +55,7 @@ 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)
@@ -145,6 +146,19 @@ module.exports = defineConfig({
 })
 ```
 
+Trying to call the plugin function without any arguments or with more than a single argument throws an error
+
+```js
+// ERROR: forgot the config file
+setupNodeEvents(on, config) {
+  require('@bahmutov/cy-grep/src/plugin')();
+}
+// ERROR: too many arguments
+setupNodeEvents(on, config) {
+  require('@bahmutov/cy-grep/src/plugin')(on, config);
+}
+```
+
 ### Install in Cypress versions before 10
 
 See [test-cy-v9](./test-cy-v9/) for example
@@ -394,6 +408,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.
@@ -695,6 +725,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.16",
+  "version": "1.10.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",
@@ -14,17 +15,17 @@
   "dependencies": {
     "cypress-plugin-config": "^1.2.0",
     "debug": "^4.3.2",
-    "find-cypress-specs": "^1.29.4",
-    "find-test-names": "1.28.12"
+    "find-cypress-specs": "^1.35.1",
+    "find-test-names": "1.28.21"
   },
   "devDependencies": {
-    "cypress": "12.14.0",
+    "cypress": "13.11.0",
     "cypress-each": "^1.11.0",
     "cypress-expect": "^3.1.0",
-    "prettier": "^2.8.1",
-    "semantic-release": "^21.0.5",
+    "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/plugin.js

@@ -68,6 +68,17 @@ function getGrepSettings(config) {
  * @param {Cypress.ConfigOptions} config
  */
 function cypressGrepPlugin(config) {
+  if (arguments.length === 0) {
+    throw new Error(
+      'ERROR: forgot the config file, see https://github.com/bahmutov/cy-grep',
+    )
+  }
+  if (arguments.length > 1) {
+    throw new Error(
+      'ERROR: too many arguments, see https://github.com/bahmutov/cy-grep',
+    )
+  }
+
   if (!config || !config.env) {
     return config
   }

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.
@@ -122,6 +138,7 @@ function registerCyGrep() {
       .concat(configRequiredTags)
       .filter(Boolean)
     debug({ nameToGrep, effectiveTestTags, requiredTestTags })
+    testTree[nameToGrep] = { effectiveTestTags, requiredTestTags }
 
     const shouldRun = shouldTestRun(
       parsedGrep,