cypress-plugin-grep-boxes 2.1.0 → 2.2.0

package/README.md

@@ -20,6 +20,7 @@ A companion Cypress plugin for <code>cy-grep</code> that allows user to run spec
 - [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)
 
@@ -105,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.

package/index.js

@@ -406,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.1.0",
+  "version": "2.2.0",
   "description": "Cypress plugin that allows user to run specific tests in open mode.",
   "main": "./index.js",
   "keywords": [