cypress-plugin-grep-boxes 2.4.0 → 3.0.0

package/README.md

@@ -54,11 +54,11 @@ registerCypressGrep();
 
 ## 🦺 Setup
 
-**Recommended**: Set two common environment variables tied to the `@bahmutov/cy-grep` package to enhance the experience utilizing the grep logic within the Cypress Test Runner UI using cypress open:
+**Recommended**: Set two common expose variables tied to the `@bahmutov/cy-grep` package to enhance the experience utilizing the grep logic within the Cypress Test Runner UI using cypress open:
 
 ```json
 {
-  "env": {
+  "expose": {
     "grepOmitFiltered": true,
     "grepFilterSpecs": true
   }
@@ -98,19 +98,19 @@ it('deletes an item', { requiredTags: '@skip' }, () => {
 });
 ```
 
-Now running or opening Cypress in interactive mode, **you will not see any tests with `requiredTags` including `@skip`** (unless setting environment variable `grepTags=@skip`).
+Now running or opening Cypress in interactive mode, **you will not see any tests with `requiredTags` including `@skip`** (unless setting expose variable `grepTags=@skip`).
 
 To run just those tests with the required tag `@skip` in interactive mode:
 
 ```bash
-npx cypress open --env grepTags=@skip
+npx cypress open --expose 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 tags from being displayed in 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.
+If for any reason you'd like to exclude tags from being displayed in the Cypress Test Runner, use the expose variable `hideSpecTags` set to an array of tags you do not want to be displayed in the Cypress Test Runner.
 
 ### Hide specific tags
 
@@ -118,7 +118,7 @@ Example:
 
 ```json
 {
-  "env": {
+  "expose": {
     "hideSpecTags": ["@smoke", "@sanity"]
   }
 }
@@ -132,7 +132,7 @@ If you'd like to exclude all tags from being displayed in the Cypress Test Runne
 
 ```json
 {
-  "env": {
+  "expose": {
     "hideSpecTags": ["*"]
   }
 }
@@ -146,7 +146,7 @@ If you'd like to ONLY display a specific subset of tags in the Cypress Test Runn
 
 ```json
 {
-  "env": {
+  "expose": {
     "hideSpecTags": ["*", "+@smoke", "+@sanity"]
   }
 }
@@ -158,22 +158,22 @@ The example above would hide all tags EXCEPT `@smoke` and `@sanity` tags in the
 
 Cypress Test Runner UI automatically runs available tests once a spec file is open.
 
-To prevent this behavior to have control of when and which tests to run, add the environment variable `disableInitialAutoRun=true`:
+To prevent this behavior to have control of when and which tests to run, add the expose variable `disableInitialAutoRun=true`:
 
 ![disableInitialAutoRun_demo](https://github.com/user-attachments/assets/95fc4807-847b-432e-9b03-dc4fbe9f955a)
 
 ```bash
 # Example via CLI
-npx cypress open --env disableInitialAutoRun=true
+npx cypress open --expose disableInitialAutoRun=true
 ```
 
-**Tip:** you can set this environment variable in the [config file](https://docs.cypress.io/guides/references/configuration) file to enable it by default and skip using the environment variable:
+**Tip:** you can set this expose variable in the [config file](https://docs.cypress.io/guides/references/configuration) file to enable it by default and skip using the expose variable:
 
 ```js
 // config file
 {
   "e2e": {
-    "env": {
+    "expose": {
       "disableInitialAutoRun": true
     }
   }

package/cypress.config.js

@@ -1,7 +1,8 @@
 const { defineConfig } = require('cypress');
 
 module.exports = defineConfig({
-  env: {
+  allowCypressEnv: false,
+  expose: {
     grepOmitFiltered: true,
     grepFilterSpecs: true,
   },

package/index.js

@@ -247,7 +247,7 @@ if (Cypress.config('isInteractive')) {
 if (Cypress.config('isInteractive')) {
   if (
     // if the grep test toggle is not checked, do not run tests
-    Cypress.env('disableInitialAutoRun') &&
+    Cypress.expose('disableInitialAutoRun') &&
     window.top?.document.querySelectorAll('#grepTestToggle:checked').length ===
       0
   ) {
@@ -368,7 +368,7 @@ export const addTags = () => {
     outline: none;
 }
 `;
-  if (Cypress.env('specTags')) {
+  if (Cypress.expose('specTags')) {
     const hasStyles = window.top?.document.querySelector('#tagPillStyle');
 
     if (!hasStyles) {
@@ -391,7 +391,7 @@ export const addTags = () => {
       }
       const title = header.querySelector('.runnable-title');
       const testName = title.innerText.split('\n')[0];
-      const allSpecTags = Cypress.env('specTags');
+      const allSpecTags = Cypress.expose('specTags');
       const testTag = getTagsForTitle(testName, allSpecTags);
       if (t.querySelectorAll('[data-attribute="test-tags"]').length === 0) {
         renderTagPills(testTag, title);
@@ -406,7 +406,7 @@ function getTagsForTitle(title, fullTagsObj) {
 
   const allTags = [...test.effectiveTestTags, ...test.requiredTestTags];
 
-  let raw = Cypress.env('hideSpecTags');
+  let raw = Cypress.expose('hideSpecTags');
   if (!raw) return allTags;
 
   let rules = Array.isArray(raw)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cypress-plugin-grep-boxes",
-  "version": "2.4.0",
+  "version": "3.0.0",
   "description": "Cypress plugin that allows user to run specific tests in open mode.",
   "main": "./index.js",
   "keywords": [
@@ -9,8 +9,8 @@
     "cypress-plugin"
   ],
   "devDependencies": {
-    "@bahmutov/cy-grep": "^2.1.0",
-    "cypress": "^15.11.0"
+    "@bahmutov/cy-grep": "^3.0.0",
+    "cypress": "^15.12.0"
   },
   "publishConfig": {
     "registry": "https://registry.npmjs.org/"