cypress-plugin-grep-boxes 1.0.4 → 1.1.0

package/README.md

@@ -18,6 +18,7 @@ A companion Cypress plugin for <code>cy-grep</code> that allows user to run spec
 - [Setup](#-setup)
 - [Open mode](#-open-mode)
   - [Use Required Test Tags Instead Of Skipping Tests](#use-required-test-tags-instead-of-skipping-tests)
+- [disableInitialAutoRun](#disableInitialAutoRun)
 - [Contributions](#contributions)
 
 ---
@@ -90,6 +91,32 @@ To run just those tests with the required tag `@skip` in interactive mode:
 npx cypress open --env grepTags=@skip
 ```
 
+## disableInitialAutoRun
+
+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`:
+
+![disableInitialAutoRun Demo](./assets/disableInitialAutoRun_demo.gif)
+
+```bash
+# Example via CLI
+npx cypress open --env 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:
+
+```js
+// config file
+{
+  "e2e": {
+    "env": {
+      "disableInitialAutoRun": true
+    }
+  }
+}
+```
+
 ## Contributions
 
 Feel free to open a pull request or drop any feature request or bug in the [issues](https://github.com/dennisbergevin/cypress-plugin-grep-boxes/issues).

package/index.js

@@ -291,6 +291,22 @@ if (Cypress.config('isInteractive')) {
   });
 }
 
+if (Cypress.config('isInteractive')) {
+  if (
+    // if the grep test toggle is not checked, do not run tests
+    Cypress.env('disableInitialAutoRun') &&
+    window.top?.document.querySelectorAll('#grepTestToggle:checked').length ===
+      0
+  ) {
+    const sidebarSpecLinkPage = window.top?.document.querySelector(
+      '[data-cy="sidebar-link-specs-page"]'
+    );
+
+    sidebarSpecLinkPage.setAttribute('data-url', window.top?.document.URL);
+    Cypress.runner.stop();
+  }
+}
+
 Cypress.on('test:before:run', () => {
   if (
     // if the grep test toggle is checked, do not show checkboxes on each runnable

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cypress-plugin-grep-boxes",
-  "version": "1.0.4",
+  "version": "1.1.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": "^1.9.17",
-    "cypress": "^13.10.0"
+    "@bahmutov/cy-grep": "^2.0.22",
+    "cypress": "^14.3.0"
   },
   "publishConfig": {
     "registry": "https://registry.npmjs.org/"