Skip to content

Commit b2992fe

Browse files
authored
docs: update cspell config and fix spelling issues (#32190)
* fix: update cspell config and fix spelling issues in changelog * revert: undo extensions config change
1 parent 03b073b commit b2992fe

File tree

3 files changed

+89
-37
lines changed

3 files changed

+89
-37
lines changed

.vscode/cspell.json

Lines changed: 22 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,21 +4,32 @@
44
"dictionaryDefinitions": [],
55
"dictionaries": [],
66
"words": [
7+
"BABELTRAVERSE",
78
"Chainable",
9+
"clippable",
10+
"codeframes",
811
"composables",
912
"dedup",
13+
"dockerized",
14+
"duplexify",
15+
"EMFILE",
16+
"ENFILE",
1017
"ERRORED",
1118
"esbuild",
1219
"execa",
1320
"Fetchable",
1421
"Fetchables",
1522
"forcedefault",
23+
"framebusting",
24+
"geckodriver",
1625
"getenv",
1726
"GIBIBYTES",
1827
"graphcache",
28+
"headlessly",
1929
"headlessui",
2030
"Iconify",
2131
"intlify",
32+
"keyup",
2233
"KIBIBYTE",
2334
"kibibytes",
2435
"Lachlan",
@@ -27,16 +38,23 @@
2738
"msapplication",
2839
"norewrite",
2940
"NOTESTS",
41+
"Nuxt",
3042
"OVERLIMIT",
3143
"overscan",
3244
"packherd",
45+
"pagehide",
3346
"pidusage",
3447
"Pinia",
3548
"pnpm",
49+
"prerequests",
3650
"pseudoclass",
51+
"PULLREQUEST",
52+
"PULLREQUESTNUMBER",
53+
"retryable",
3754
"revparse",
3855
"Screenshotting",
3956
"semibold",
57+
"setuid",
4058
"shiki",
4159
"snapbuild",
4260
"snapgen",
@@ -50,6 +68,8 @@
5068
"TIMEDOUT",
5169
"titleize",
5270
"topnav",
71+
"Transpiling",
72+
"uncategorized",
5373
"unconfigured",
5474
"unplugin",
5575
"unref",
@@ -59,7 +79,8 @@
5979
"viewports",
6080
"vite",
6181
"vitejs",
62-
"vueuse"
82+
"vueuse",
83+
"xulstore"
6384
],
6485
"ignoreWords": [],
6586
"import": []

CONTRIBUTING.md

Lines changed: 61 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -17,27 +17,62 @@ Thanks for taking the time to contribute! :smile:
1717

1818
## Table of Contents
1919

20-
- [Code of Conduct](#code-of-conduct)
21-
- [Opening Issues](#opening-issues)
22-
- [Writing Documentation](#writing-documentation)
23-
- [Writing Code](#writing-code)
24-
- [What you need to know before getting started](#what-you-need-to-know-before-getting-started)
25-
- [Requirements](#requirements)
26-
- [Getting Started](#getting-started)
27-
- [Coding Style](#coding-style)
28-
- [Adding links within code](#adding-links-within-code)
29-
- [Tests](#tests)
30-
- [Packages](#packages)
31-
- [Committing Code](#committing-code)
32-
- [Branches](#branches)
33-
- [Pull Requests](#pull-requests)
34-
- [Dependencies](#dependencies)
35-
- [Reviewing Code](#reviewing-code)
36-
- [Some rules about Code Review](#some-rules-about-code-review)
37-
- [Steps to take during Code Review](#steps-to-take-during-code-review)
38-
- [Code Review Checklist](#code-review-checklist)
39-
- [Code Review of Dependency Updates](#code-review-of-dependency-updates)
40-
- [Releases](#releases)
20+
- [Contributing to Cypress](#contributing-to-cypress)
21+
- [Table of Contents](#table-of-contents)
22+
- [Code of Conduct](#code-of-conduct)
23+
- [Opening Issues](#opening-issues)
24+
- [Update Cypress](#update-cypress)
25+
- [Getting more information](#getting-more-information)
26+
- [Fill out our Issue Template](#fill-out-our-issue-template)
27+
- [Describe Problems](#describe-problems)
28+
- [Reproducibility](#reproducibility)
29+
- [Common issues](#common-issues)
30+
- [Writing Documentation](#writing-documentation)
31+
- [Writing code](#writing-code)
32+
- [What you need to know before getting started](#what-you-need-to-know-before-getting-started)
33+
- [Cypress and Packages](#cypress-and-packages)
34+
- [Requirements](#requirements)
35+
- [Debian/Ubuntu](#debianubuntu)
36+
- [Windows](#windows)
37+
- [Corepack](#corepack)
38+
- [Getting Started](#getting-started)
39+
- [Adding new Dependencies](#adding-new-dependencies)
40+
- [Tasks](#tasks)
41+
- [Common Top Level Tasks](#common-top-level-tasks)
42+
- [Package-Level Scripts](#package-level-scripts)
43+
- [Internal Vite Options](#internal-vite-options)
44+
- [`CYPRESS_INTERNAL_VITE_DEV`](#cypress_internal_vite_dev)
45+
- [`CYPRESS_INTERNAL_VITE_INSPECT`](#cypress_internal_vite_inspect)
46+
- [`CYPRESS_INTERNAL_VITE_OPEN_MODE_TESTING`](#cypress_internal_vite_open_mode_testing)
47+
- [`CYPRESS_INTERNAL_VITE_APP_PORT`](#cypress_internal_vite_app_port)
48+
- [`CYPRESS_INTERNAL_VITE_LAUNCHPAD_PORT`](#cypress_internal_vite_launchpad_port)
49+
- [Debug Logs](#debug-logs)
50+
- [Coding Style](#coding-style)
51+
- [Adding links within code](#adding-links-within-code)
52+
- [Tests](#tests)
53+
- [Docker](#docker)
54+
- [Docker as a performance constrained environment](#docker-as-a-performance-constrained-environment)
55+
- [Packages](#packages)
56+
- [Committing Code](#committing-code)
57+
- [Branches](#branches)
58+
- [Pull Requests](#pull-requests)
59+
- [Write Some Tests](#write-some-tests)
60+
- [Dependencies](#dependencies)
61+
- [Reviewing Code](#reviewing-code)
62+
- [Some rules about Code Review](#some-rules-about-code-review)
63+
- [Steps to take during Code Review](#steps-to-take-during-code-review)
64+
- [Code Review Checklist](#code-review-checklist)
65+
- [User Experience](#user-experience)
66+
- [Functionality](#functionality)
67+
- [Maintainability](#maintainability)
68+
- [Quality](#quality)
69+
- [Code Review of Dependency Updates](#code-review-of-dependency-updates)
70+
- [Dependency Update Instructions](#dependency-update-instructions)
71+
- [Dependency Updates Checklist](#dependency-updates-checklist)
72+
- [Releases](#releases)
73+
- [Known problems](#known-problems)
74+
- [ENFILE or EMFILE](#enfile-or-emfile)
75+
- [lock file](#lock-file)
4176

4277
## Code of Conduct
4378

@@ -109,7 +144,6 @@ test execution | Running tests inside a single spec | [open](https://github.com/
109144
typescript | Transpiling or bundling TypeScript | [open](https://github.com/cypress-io/cypress/labels/topic%3A%20typescript), [closed](https://github.com/cypress-io/cypress/issues?q=label%3A%22topic%3A+typescript%22+is%3Aclosed)
110145
video | Problems with video recordings | [open](https://github.com/cypress-io/cypress/labels/topic%3A%20video%20%F0%9F%93%B9), [closed](https://github.com/cypress-io/cypress/issues?q=label%3A%22topic%3A+video+%F0%9F%93%B9%22+is%3Aclosed)
111146

112-
113147
## Writing Documentation
114148

115149
Cypress documentation lives in a separate repository with its own dependencies and build tools.
@@ -329,15 +363,15 @@ Each package is responsible for building itself and testing itself and can do so
329363

330364
#### Internal Vite Options
331365
When executing top or package level scripts, [Vite](https://vitejs.dev/) may be used to build/host parts of the application. This section is to serve as a general reference for these environment variables that may be leverage throughout the repository.
332-
###### `CYPRESS_INTERNAL_VITE_DEV`
366+
##### `CYPRESS_INTERNAL_VITE_DEV`
333367
Set to `1` if wanting to leverage [vite's](https://vitejs.dev/guide/#command-line-interface) `vite dev` over `vite build` to avoid a full [production build](https://vitejs.dev/guide/build.html).
334-
###### `CYPRESS_INTERNAL_VITE_INSPECT`
368+
##### `CYPRESS_INTERNAL_VITE_INSPECT`
335369
Used internally to leverage [vite-plugin-inspect](https://github.com/antfu/vite-plugin-inspect) to view intermediary vite plugin state. The `CYPRESS_INTERNAL_VITE_DEV` is required for this to be applied correctly. Set to `1` to enable.
336-
###### `CYPRESS_INTERNAL_VITE_OPEN_MODE_TESTING`
370+
##### `CYPRESS_INTERNAL_VITE_OPEN_MODE_TESTING`
337371
Leveraged only for internal cy-in-cy type tests to access the Cypress instance from the parent frame. Please see the [E2E Open Mode Testing](./guides/e2e-open-testing.md) Guide. Set to `true` when doing
338-
###### `CYPRESS_INTERNAL_VITE_APP_PORT`
372+
##### `CYPRESS_INTERNAL_VITE_APP_PORT`
339373
Leveraged only when `CYPRESS_INTERNAL_VITE_DEV` is set to spawn the vite dev server for the app on the specified port. The default port is `3333`.
340-
###### `CYPRESS_INTERNAL_VITE_LAUNCHPAD_PORT`
374+
##### `CYPRESS_INTERNAL_VITE_LAUNCHPAD_PORT`
341375
Leveraged only when `CYPRESS_INTERNAL_VITE_DEV` is set to spawn the vite dev server for the launchpad on the specified port. The default port is `3001`.
342376
#### Debug Logs
343377

cli/CHANGELOG.md

Lines changed: 6 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -167,7 +167,6 @@ _Released 5/6/2025_
167167

168168
- Downgraded `cli-table3` to 0.6.1. Addressed in [31631](https://github.com/cypress-io/cypress/pull/31631).
169169

170-
171170
## 14.3.2
172171

173172
_Released 4/22/2025_
@@ -327,7 +326,7 @@ _Released 1/28/2025_
327326

328327
- Fixed an issue where Cypress would incorrectly navigate to `about:blank` when test isolation was disabled and the last test would fail and then retry. Fixes [#28527](https://github.com/cypress-io/cypress/issues/28527).
329328
- Fixed a regression introduced in [`14.0.0`](https://docs.cypress.io/guides/references/changelog#14-0-0) where an element would not return the correct visibility if its offset parent was within the clipping element. Fixes [#30922](https://github.com/cypress-io/cypress/issues/30922).
330-
- Fixed a regression introduced in [`14.0.0`](https://docs.cypress.io/guides/references/changelog#14-0-0) where the incorrect visiblity would be returned when either `overflow-x` or `overflow-y` was visible but the other one was clipping. Fixed in [#30934](https://github.com/cypress-io/cypress/pull/30934).
329+
- Fixed a regression introduced in [`14.0.0`](https://docs.cypress.io/guides/references/changelog#14-0-0) where the incorrect visibility would be returned when either `overflow-x` or `overflow-y` was visible but the other one was clipping. Fixed in [#30934](https://github.com/cypress-io/cypress/pull/30934).
331330
- Fixed an issue where an `option` element would not return the correct visibility if its parent element has a clipping overflow. Fixed in [#30934](https://github.com/cypress-io/cypress/pull/30934).
332331
- Fixed an issue where non-HTMLElement(s) may fail during assertions. Fixes [#30944](https://github.com/cypress-io/cypress/issues/30944)
333332

@@ -683,8 +682,7 @@ _Released 6/4/2024_
683682
**Bugfixes:**
684683

685684
- Fixed a situation where the Launchpad would hang if the project config had not been loaded when the Launchpad first queries the current project. Fixes [#29486](https://github.com/cypress-io/cypress/issues/29486).
686-
- Pre-emptively fix behavior with Chrome for when `unload` events are forcefully deprecated by using `pagehide` as a proxy. Fixes [#29241](https://github.com/cypress-io/cypress/issues/29241).
687-
685+
- Preemptively fix behavior with Chrome for when `unload` events are forcefully deprecated by using `pagehide` as a proxy. Fixes [#29241](https://github.com/cypress-io/cypress/issues/29241).
688686

689687
**Misc:**
690688

@@ -935,7 +933,6 @@ _Released 1/16/2024_
935933
- Improved accessibility of some areas of the Cypress App. Addressed in [#28628](https://github.com/cypress-io/cypress/pull/28628).
936934
- Updated some documentation links to go through on.cypress.io. Addressed in [#28623](https://github.com/cypress-io/cypress/pull/28623).
937935

938-
939936
## 13.6.2
940937

941938
_Released 12/26/2023_
@@ -1044,7 +1041,7 @@ _Released 10/24/2023_
10441041
**Bugfixes:**
10451042

10461043
- Fixed a performance regression in `13.3.1` with proxy correlation timeouts and requests issued from web and shared workers. Fixes [#28104](https://github.com/cypress-io/cypress/issues/28104).
1047-
- Fixed a performance problem with proxy correlation when requests get aborted and then get miscorrelated with follow up requests. Addressed in [#28094](https://github.com/cypress-io/cypress/pull/28094).
1044+
- Fixed a performance problem with proxy correlation when requests are aborted and then incorrectly correlated with follow-up requests. Addressed in [#28094](https://github.com/cypress-io/cypress/pull/28094).
10481045
- Fixed a regression in [10.0.0](#10.0.0), where search would not find a spec if the file name contains "-" or "\_", but search prompt contains " " instead (e.g. search file "spec-file.cy.ts" with prompt "spec file"). Fixes [#25303](https://github.com/cypress-io/cypress/issues/25303).
10491046

10501047
## 13.3.2
@@ -1173,7 +1170,7 @@ _Released 08/15/2023_
11731170

11741171
**Dependency Updates:**
11751172

1176-
- Upgraded [`webpack`](https://www.npmjs.com/package/webpack) from `v4` to `v5`. This means that we are now bundling your `e2e` tests with webpack 5. We don't anticipate this causing any noticeable changes. However, if you'd like to keep bundling your `e2e` tests with wepback 4 you can use the same process as before by pinning [@cypress/webpack-batteries-included-preprocessor](https://www.npmjs.com/package/@cypress/webpack-batteries-included-preprocessor) to `v2.x.x` and hooking into the [file:preprocessor](https://docs.cypress.io/api/plugins/preprocessors-api#Usage) plugin event. This will restore the previous bundling process. Additionally, if you're using [@cypress/webpack-batteries-included-preprocessor](https://www.npmjs.com/package/@cypress/webpack-batteries-included-preprocessor) already, a new version has been published to support webpack `v5`.
1173+
- Upgraded [`webpack`](https://www.npmjs.com/package/webpack) from `v4` to `v5`. This means that we are now bundling your `e2e` tests with webpack 5. We don't anticipate this causing any noticeable changes. However, if you'd like to keep bundling your `e2e` tests with webpack 4 you can use the same process as before by pinning [@cypress/webpack-batteries-included-preprocessor](https://www.npmjs.com/package/@cypress/webpack-batteries-included-preprocessor) to `v2.x.x` and hooking into the [file:preprocessor](https://docs.cypress.io/api/plugins/preprocessors-api#Usage) plugin event. This will restore the previous bundling process. Additionally, if you're using [@cypress/webpack-batteries-included-preprocessor](https://www.npmjs.com/package/@cypress/webpack-batteries-included-preprocessor) already, a new version has been published to support webpack `v5`.
11771174
- Upgraded [`tough-cookie`](https://www.npmjs.com/package/tough-cookie) from `4.0` to `4.1.3`, [`@cypress/request`](https://www.npmjs.com/package/@cypress/request) from `2.88.11` to `2.88.12` and [`@cypress/request-promise`](https://www.npmjs.com/package/@cypress/request-promise) from `4.2.6` to `4.2.7` to address a [security vulnerability](https://security.snyk.io/vuln/SNYK-JS-TOUGHCOOKIE-5672873). Fixes [#27261](https://github.com/cypress-io/cypress/issues/27261).
11781175

11791176
## 12.17.3
@@ -1284,7 +1281,7 @@ during Component Testing onboarding. Addresses [#26852](https://github.com/cypre
12841281

12851282
**Dependency Updates:**
12861283

1287-
- Upgraded [`find-process`](https://www.npmjs.com/package/find-process) from `1.4.1` to `1.4.7` to address this [Synk](https://security.snyk.io/vuln/SNYK-JS-FINDPROCESS-1090284) security vulnerability. Addressed in [#26906](https://github.com/cypress-io/cypress/pull/26906).
1284+
- Upgraded [`find-process`](https://www.npmjs.com/package/find-process) from `1.4.1` to `1.4.7` to address this [Snyk](https://security.snyk.io/vuln/SNYK-JS-FINDPROCESS-1090284) security vulnerability. Addressed in [#26906](https://github.com/cypress-io/cypress/pull/26906).
12881285
- Upgraded [`firefox-profile`](https://www.npmjs.com/package/firefox-profile) from `4.0.0` to `4.3.2` to address security vulnerabilities within sub-dependencies. Addressed in [#26912](https://github.com/cypress-io/cypress/pull/26912).
12891286

12901287
## 12.13.0
@@ -1364,7 +1361,7 @@ _Released 04/17/2023_
13641361

13651362
- Capture the [Azure](https://azure.microsoft.com/) CI provider's environment variable [`SYSTEM_PULLREQUEST_PULLREQUESTNUMBER`](https://learn.microsoft.com/en-us/azure/devops/pipelines/build/variables?view=azure-devops&tabs=yaml#system-variables-devops-services) to display the linked PR number in the Cloud. Addressed in [#26215](https://github.com/cypress-io/cypress/pull/26215).
13661363
- Fixed an issue in the onboarding wizard where project framework & bundler would not be auto-detected when opening directly into component testing mode using the `--component` CLI flag. Fixes [#22777](https://github.com/cypress-io/cypress/issues/22777) and [#26388](https://github.com/cypress-io/cypress/issues/26388).
1367-
- Updated to use the `SEMAPHORE_GIT_WORKING_BRANCH` [Semphore](https://docs.semaphoreci.com) CI environment variable to correctly associate a Cloud run to the current branch. Previously this was incorrectly associating a run to the target branch. Fixes [#26309](https://github.com/cypress-io/cypress/issues/26309).
1364+
- Updated to use the `SEMAPHORE_GIT_WORKING_BRANCH` [Semaphore](https://docs.semaphoreci.com) CI environment variable to correctly associate a Cloud run to the current branch. Previously this was incorrectly associating a run to the target branch. Fixes [#26309](https://github.com/cypress-io/cypress/issues/26309).
13681365
- Fix an edge case in Component Testing where a custom `baseUrl` in `tsconfig.json` for Next.js 13.2.0+ is not respected. This was partially fixed in [#26005](https://github.com/cypress-io/cypress/pull/26005), but an edge case was missed. Fixes [#25951](https://github.com/cypress-io/cypress/issues/25951).
13691366
- Fixed an issue where `click` events fired on `.type('{enter}')` did not propagate through shadow roots. Fixes [#26392](https://github.com/cypress-io/cypress/issues/26392).
13701367

0 commit comments

Comments
 (0)