From edbebd299e955f2b84afd5bb9f4cf5bae30fd8a0 Mon Sep 17 00:00:00 2001 From: Alex Schwartz Date: Thu, 7 Nov 2024 15:11:00 -0500 Subject: [PATCH 01/10] docs: add defaultBrowser config option --- docs/app/references/configuration.mdx | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/app/references/configuration.mdx b/docs/app/references/configuration.mdx index ddc9f06e5b..25c53ad9d0 100644 --- a/docs/app/references/configuration.mdx +++ b/docs/app/references/configuration.mdx @@ -72,7 +72,8 @@ default values. | Option | Default | Description | | ---------------------- | ------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `clientCertificates` | `[]` | An optional array of [client certificates](/app/references/client-certificates). | +| `clientCertificates` | `[]` | An optional array of [client certificates](/app/references/client-certificates). +| `defaultBrowser` | `null` | The default browser to launch if the "--browser" command line option is not provided. | `env` | `{}` | Any values to be set as [environment variables](/app/references/environment-variables). | | `includeShadowDom` | `false` | Whether to traverse shadow DOM boundaries and include elements within the shadow DOM in the results of query commands (e.g. [`cy.get()`](/api/commands/get)). | | `numTestsKeptInMemory` | Default based on `run` or `open` mode | The number of tests for which snapshots and command data are kept in memory. `numTestsKeptInMemory` is set to `50` by default during `cypress open` and set to `0` by default during `cypress run`. Reduce this number if you are experiencing high memory consumption in your browser during a test run. | From 6da02de2082bdc737abdca6b562bdae32df43788 Mon Sep 17 00:00:00 2001 From: Alex Schwartz Date: Tue, 12 Nov 2024 15:41:12 -0500 Subject: [PATCH 02/10] Update configuration.mdx --- docs/app/references/configuration.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/app/references/configuration.mdx b/docs/app/references/configuration.mdx index 25c53ad9d0..49372fbb80 100644 --- a/docs/app/references/configuration.mdx +++ b/docs/app/references/configuration.mdx @@ -72,7 +72,7 @@ default values. | Option | Default | Description | | ---------------------- | ------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `clientCertificates` | `[]` | An optional array of [client certificates](/app/references/client-certificates). +| `clientCertificates` | `[]` | An optional array of [client certificates](/app/references/client-certificates). | | `defaultBrowser` | `null` | The default browser to launch if the "--browser" command line option is not provided. | `env` | `{}` | Any values to be set as [environment variables](/app/references/environment-variables). | | `includeShadowDom` | `false` | Whether to traverse shadow DOM boundaries and include elements within the shadow DOM in the results of query commands (e.g. [`cy.get()`](/api/commands/get)). | From 176f547b100c32595ec60165a403279c3c310bd1 Mon Sep 17 00:00:00 2001 From: Alex Schwartz Date: Tue, 12 Nov 2024 15:42:14 -0500 Subject: [PATCH 03/10] Update configuration.mdx --- docs/app/references/configuration.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/app/references/configuration.mdx b/docs/app/references/configuration.mdx index 49372fbb80..80530b6019 100644 --- a/docs/app/references/configuration.mdx +++ b/docs/app/references/configuration.mdx @@ -72,7 +72,7 @@ default values. | Option | Default | Description | | ---------------------- | ------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `clientCertificates` | `[]` | An optional array of [client certificates](/app/references/client-certificates). | +| `clientCertificates` | `[]` | An optional array of [client certificates](/app/references/client-certificates). | | `defaultBrowser` | `null` | The default browser to launch if the "--browser" command line option is not provided. | `env` | `{}` | Any values to be set as [environment variables](/app/references/environment-variables). | | `includeShadowDom` | `false` | Whether to traverse shadow DOM boundaries and include elements within the shadow DOM in the results of query commands (e.g. [`cy.get()`](/api/commands/get)). | From 4c5fea9692e06deaa169ea43905c0ba2a966e77e Mon Sep 17 00:00:00 2001 From: Alex Schwartz Date: Tue, 12 Nov 2024 15:52:41 -0500 Subject: [PATCH 04/10] Update configuration.mdx --- docs/app/references/configuration.mdx | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/app/references/configuration.mdx b/docs/app/references/configuration.mdx index 80530b6019..579133a718 100644 --- a/docs/app/references/configuration.mdx +++ b/docs/app/references/configuration.mdx @@ -4,7 +4,7 @@ title: Configuration :::info -##### What you'll learn +##### What you'll learn - How to configure Cypress to change the default behavior of Cypress - Configuration options available in Cypress @@ -72,8 +72,8 @@ default values. | Option | Default | Description | | ---------------------- | ------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `clientCertificates` | `[]` | An optional array of [client certificates](/app/references/client-certificates). | -| `defaultBrowser` | `null` | The default browser to launch if the "--browser" command line option is not provided. +| `clientCertificates` | `[]` | An optional array of [client certificates](/app/references/client-certificates). | +| `defaultBrowser` | `null` | The default browser to launch if the "--browser" command line option is not provided. | | `env` | `{}` | Any values to be set as [environment variables](/app/references/environment-variables). | | `includeShadowDom` | `false` | Whether to traverse shadow DOM boundaries and include elements within the shadow DOM in the results of query commands (e.g. [`cy.get()`](/api/commands/get)). | | `numTestsKeptInMemory` | Default based on `run` or `open` mode | The number of tests for which snapshots and command data are kept in memory. `numTestsKeptInMemory` is set to `50` by default during `cypress open` and set to `0` by default during `cypress run`. Reduce this number if you are experiencing high memory consumption in your browser during a test run. | @@ -307,7 +307,7 @@ especially useful in working locally. This gives you the ability to change configuration options without modifying any code or build scripts. -For example, these enviroment variables in the command line will override any +For example, these environment variables in the command line will override any `viewportWidth` or `viewportHeight` options set in the Cypress configuration: ```shell From 6920630ae43c985ab2c1d856217259ef066c59a9 Mon Sep 17 00:00:00 2001 From: Alex Schwartz Date: Tue, 12 Nov 2024 15:53:41 -0500 Subject: [PATCH 05/10] Update configuration.mdx --- docs/app/references/configuration.mdx | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/app/references/configuration.mdx b/docs/app/references/configuration.mdx index 579133a718..2edcdf7ee0 100644 --- a/docs/app/references/configuration.mdx +++ b/docs/app/references/configuration.mdx @@ -4,7 +4,7 @@ title: Configuration :::info -##### What you'll learn +##### What you'll learn - How to configure Cypress to change the default behavior of Cypress - Configuration options available in Cypress @@ -307,7 +307,7 @@ especially useful in working locally. This gives you the ability to change configuration options without modifying any code or build scripts. -For example, these environment variables in the command line will override any +For example, these enviroment variables in the command line will override any `viewportWidth` or `viewportHeight` options set in the Cypress configuration: ```shell From 1916f5894d34f2aff39a55be033d7c519db92702 Mon Sep 17 00:00:00 2001 From: Alex Schwartz Date: Wed, 13 Nov 2024 10:05:04 -0500 Subject: [PATCH 06/10] Update configuration.mdx --- docs/app/references/configuration.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/app/references/configuration.mdx b/docs/app/references/configuration.mdx index 579133a718..31224207fd 100644 --- a/docs/app/references/configuration.mdx +++ b/docs/app/references/configuration.mdx @@ -73,7 +73,7 @@ default values. | Option | Default | Description | | ---------------------- | ------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `clientCertificates` | `[]` | An optional array of [client certificates](/app/references/client-certificates). | -| `defaultBrowser` | `null` | The default browser to launch if the "--browser" command line option is not provided. | +| `defaultBrowser` | `null` | The default browser to launch if the "--browser" command line option is not provided. This option only affects the first browser launched; changing this option after the browser is already launched will have no effect. | | `env` | `{}` | Any values to be set as [environment variables](/app/references/environment-variables). | | `includeShadowDom` | `false` | Whether to traverse shadow DOM boundaries and include elements within the shadow DOM in the results of query commands (e.g. [`cy.get()`](/api/commands/get)). | | `numTestsKeptInMemory` | Default based on `run` or `open` mode | The number of tests for which snapshots and command data are kept in memory. `numTestsKeptInMemory` is set to `50` by default during `cypress open` and set to `0` by default during `cypress run`. Reduce this number if you are experiencing high memory consumption in your browser during a test run. | From ba68739a7a8444a56cc4f515e8f3e6dd60e990bc Mon Sep 17 00:00:00 2001 From: Jennifer Shehane Date: Wed, 13 Nov 2024 11:05:15 -0500 Subject: [PATCH 07/10] lint fix --- docs/app/references/configuration.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/app/references/configuration.mdx b/docs/app/references/configuration.mdx index 31224207fd..479ddb436e 100644 --- a/docs/app/references/configuration.mdx +++ b/docs/app/references/configuration.mdx @@ -73,7 +73,7 @@ default values. | Option | Default | Description | | ---------------------- | ------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `clientCertificates` | `[]` | An optional array of [client certificates](/app/references/client-certificates). | -| `defaultBrowser` | `null` | The default browser to launch if the "--browser" command line option is not provided. This option only affects the first browser launched; changing this option after the browser is already launched will have no effect. | +| `defaultBrowser` | `null` | The default browser to launch if the "--browser" command line option is not provided. This option only affects the first browser launched; changing this option after the browser is already launched will have no effect. | | `env` | `{}` | Any values to be set as [environment variables](/app/references/environment-variables). | | `includeShadowDom` | `false` | Whether to traverse shadow DOM boundaries and include elements within the shadow DOM in the results of query commands (e.g. [`cy.get()`](/api/commands/get)). | | `numTestsKeptInMemory` | Default based on `run` or `open` mode | The number of tests for which snapshots and command data are kept in memory. `numTestsKeptInMemory` is set to `50` by default during `cypress open` and set to `0` by default during `cypress run`. Reduce this number if you are experiencing high memory consumption in your browser during a test run. | From 43954e3523f6bc7b25882a1dba1330f5b478ada0 Mon Sep 17 00:00:00 2001 From: Alex Schwartz Date: Wed, 13 Nov 2024 16:25:35 -0500 Subject: [PATCH 08/10] Update configuration.mdx --- docs/app/references/configuration.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/app/references/configuration.mdx b/docs/app/references/configuration.mdx index 479ddb436e..d33c79ed43 100644 --- a/docs/app/references/configuration.mdx +++ b/docs/app/references/configuration.mdx @@ -73,7 +73,6 @@ default values. | Option | Default | Description | | ---------------------- | ------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `clientCertificates` | `[]` | An optional array of [client certificates](/app/references/client-certificates). | -| `defaultBrowser` | `null` | The default browser to launch if the "--browser" command line option is not provided. This option only affects the first browser launched; changing this option after the browser is already launched will have no effect. | | `env` | `{}` | Any values to be set as [environment variables](/app/references/environment-variables). | | `includeShadowDom` | `false` | Whether to traverse shadow DOM boundaries and include elements within the shadow DOM in the results of query commands (e.g. [`cy.get()`](/api/commands/get)). | | `numTestsKeptInMemory` | Default based on `run` or `open` mode | The number of tests for which snapshots and command data are kept in memory. `numTestsKeptInMemory` is set to `50` by default during `cypress open` and set to `0` by default during `cypress run`. Reduce this number if you are experiencing high memory consumption in your browser during a test run. | @@ -147,6 +146,7 @@ For more options regarding screenshots, view the | Option | Default | Description | | ----------------------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `defaultBrowser` | `null` | The default browser to launch if the "--browser" command line option is not provided. This option only affects the first browser launched; changing this option after the browser is already launched will have no effect. | | `chromeWebSecurity` | `true` | Whether to enable Chromium-based browser's Web Security for same-origin policy and insecure mixed content. | | `blockHosts` | `null` | A String or Array of hosts that you wish to block traffic for. [Please read the notes for examples on using this.](#blockHosts) | | `modifyObstructiveCode` | `true` | Whether Cypress will search for and replace obstructive JS code in `.js` or `.html` files. [Please read the notes for more information on this setting.](#modifyObstructiveCode) | From 32a0ef3212c3999e13ee6b2691f5cd94aee14588 Mon Sep 17 00:00:00 2001 From: Alex Schwartz Date: Thu, 14 Nov 2024 10:17:25 -0500 Subject: [PATCH 09/10] lint --- docs/app/references/configuration.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/app/references/configuration.mdx b/docs/app/references/configuration.mdx index d33c79ed43..fbb100e03a 100644 --- a/docs/app/references/configuration.mdx +++ b/docs/app/references/configuration.mdx @@ -146,7 +146,7 @@ For more options regarding screenshots, view the | Option | Default | Description | | ----------------------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `defaultBrowser` | `null` | The default browser to launch if the "--browser" command line option is not provided. This option only affects the first browser launched; changing this option after the browser is already launched will have no effect. | +| `defaultBrowser` | `null` | The default browser to launch if the "--browser" command line option is not provided. This option only affects the first browser launched; changing this option after the browser is already launched will have no effect. | | `chromeWebSecurity` | `true` | Whether to enable Chromium-based browser's Web Security for same-origin policy and insecure mixed content. | | `blockHosts` | `null` | A String or Array of hosts that you wish to block traffic for. [Please read the notes for examples on using this.](#blockHosts) | | `modifyObstructiveCode` | `true` | Whether Cypress will search for and replace obstructive JS code in `.js` or `.html` files. [Please read the notes for more information on this setting.](#modifyObstructiveCode) | From ed1b991a84d7ef89e076788bf549300ebe0cb7c1 Mon Sep 17 00:00:00 2001 From: Matt Schile Date: Thu, 14 Nov 2024 15:15:12 -0700 Subject: [PATCH 10/10] Update docs/app/references/configuration.mdx --- docs/app/references/configuration.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/app/references/configuration.mdx b/docs/app/references/configuration.mdx index fbb100e03a..1ab8a59bf6 100644 --- a/docs/app/references/configuration.mdx +++ b/docs/app/references/configuration.mdx @@ -146,7 +146,7 @@ For more options regarding screenshots, view the | Option | Default | Description | | ----------------------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `defaultBrowser` | `null` | The default browser to launch if the "--browser" command line option is not provided. This option only affects the first browser launched; changing this option after the browser is already launched will have no effect. | +| `defaultBrowser` | `null` | The default browser to launch if the "--browser" command line option is not provided. This option only affects the first browser launch; changing this option after the browser is already launched will have no effect. | | `chromeWebSecurity` | `true` | Whether to enable Chromium-based browser's Web Security for same-origin policy and insecure mixed content. | | `blockHosts` | `null` | A String or Array of hosts that you wish to block traffic for. [Please read the notes for examples on using this.](#blockHosts) | | `modifyObstructiveCode` | `true` | Whether Cypress will search for and replace obstructive JS code in `.js` or `.html` files. [Please read the notes for more information on this setting.](#modifyObstructiveCode) |