cypress-plugin-grep-boxes 2.0.1 → 2.2.0

package/README.md

@@ -18,7 +18,9 @@ A companion Cypress plugin for <code>cy-grep</code> that allows user to run spec
 - [Installation](#-installation)
 - [Setup](#-setup)
 - [Open mode](#-open-mode)
+  - [Using cypress-plugin-filter-runnables](#using-cypress-plugin-filter-runnables)
   - [Use Required Test Tags Instead Of Skipping Tests](#use-required-test-tags-instead-of-skipping-tests)
+- [hideSpecTags](#hideSpecTags)
 - [disableInitialAutoRun](#disableInitialAutoRun)
 - [Contributions](#contributions)
 
@@ -75,6 +77,11 @@ Within each spec in Cypress `open` mode:
 
 <img width="295" height="182" alt="grep-boxes-ui" src="https://github.com/user-attachments/assets/fad9ebc9-e417-41aa-9f31-519855113d17" />
 
+### Using cypress-plugin-filter-runnables
+
+**NEW** in v2.1.0: If filtering tests using [cypress-plugin-filter-runnables](https://github.com/dennisbergevin/cypress-plugin-filter-runnables), simply click the filter toggle located on the reporter above to only run those tests.
+
+No need to check each checkbox of each test you see after filtering by test title!
 
 ### Use Required Test Tags Instead Of Skipping Tests
 
@@ -99,6 +106,24 @@ To run just those tests with the required tag `@skip` in interactive mode:
 npx cypress open --env grepTags=@skip
 ```
 
+## hideSpecTags
+
+The `cypress-plugin-grep-boxes` plugin (new in v2.0.0) displays all available `effectiveTestTags` in the Cypress Test Runner for each test.
+
+If for any reason you'd like to exclude specific tags from being added to the Cypress Test Runner, use the environment variable `hideSpecTags` set to an array of tags you do not want to be displayed in the Cypress Test Runner.
+
+Example:
+
+```json
+{
+  "env": {
+    "hideSpecTags": ["@smoke", "@sanity"]
+  }
+}
+```
+
+The example above would not add any tags to Cypress Test Runner titled `@smoke` and `@sanity`.
+
 ## disableInitialAutoRun
 
 Cypress Test Runner UI automatically runs available tests once a spec file is open.
@@ -107,7 +132,6 @@ To prevent this behavior to have control of when and which tests to run, add the
 
 ![disableInitialAutoRun_demo](https://github.com/user-attachments/assets/95fc4807-847b-432e-9b03-dc4fbe9f955a)
 
-
 ```bash
 # Example via CLI
 npx cypress open --env disableInitialAutoRun=true

package/index.js

@@ -177,12 +177,37 @@ grepTestToggleElement?.addEventListener('change', (e) => {
       });
     });
 
+    // run all tests displayed in the spec if none are checked
+    // this enables cohesion with this plugin and cypress-plugin-filter-runnables
+    // the display: none is used to hide runnables not matching a filter
+    if (tests.length === 0) {
+      const checkboxes = [
+        ...window.top?.document.querySelectorAll('.grep-test-checkbox'),
+      ].filter((box) => {
+        const runnable = box.closest('.runnable');
+        return runnable && window.getComputedStyle(runnable).display !== 'none';
+      });
+
+      checkboxes.forEach((box) => tests.push(box.value));
+    }
+
     Cypress.grep(tests.join(';'));
 
     // when checked, grep only selected tests in spec
     grepTestToggleLabelElement.innerHTML = turnOngrepTestToggleIcon;
     grepTestToggleTooltipElement.innerHTML = turnOngrepTestToggleDescription;
   } else {
+    // for cypress-plugin-filter-runnables to clear search when grepTestToggle is unchecked
+    const searchInput = window.top?.document.querySelector(
+      '#test-suite-filter-search'
+    );
+    const clearBtn = window.top?.document.querySelector(
+      '#clear-test-suite-filter-search'
+    );
+    if (searchInput != '') {
+      clearBtn?.click();
+    }
+
     if (stopBtn) {
       stopBtn.click();
     }
@@ -381,7 +406,13 @@ function getTagsForTitle(title, fullTagsObj) {
     return []; // Title not found
   }
 
-  return [...test.effectiveTestTags, ...test.requiredTestTags];
+  const allTags = [...test.effectiveTestTags, ...test.requiredTestTags];
+  const tagsToExclude = Cypress.env('hideSpecTags');
+
+  if (!tagsToExclude?.length) return allTags;
+
+  // Filter out excluded tags
+  return allTags.filter((tag) => !tagsToExclude?.includes(tag));
 }
 
 function renderTagPills(tags, container) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cypress-plugin-grep-boxes",
-  "version": "2.0.1",
+  "version": "2.2.0",
   "description": "Cypress plugin that allows user to run specific tests in open mode.",
   "main": "./index.js",
   "keywords": [