Skip to content

Commit 5bf8503

Browse files
Barthélémy Ledouxjaffrepaul
Barthélémy Ledoux
and
jaffrepaul
authored
update dependencies (install Docusaurus 3) (#5601)
* update deps * remove patches * cleanup migration guides * fix typescript * visit is now a named export * fix plugins * removed a lot of things * fix parser for prettier * almost there * try to make changes to the code displayed * make sure the code samples follow js/ts * Now it works without a glisch * fix comments * use proper types in plugins * fix config * fix changelog broken links * a build that publishes * fix linter * docusaurus patches * remove all jsx/mdx render hacks * simplify weird args markdown bolding * lint * small fixes * fix changelog cache ussues * another round of render hack fixes --------- Co-authored-by: Paul Jaffre <[email protected]>
1 parent 840fd04 commit 5bf8503

File tree

183 files changed

+9562
-15926
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

183 files changed

+9562
-15926
lines changed

‎.prettierrc

+3-2
Original file line numberDiff line numberDiff line change
@@ -2,5 +2,6 @@
22
"semi": false,
33
"singleQuote": true,
44
"printWidth": 80,
5-
"proseWrap": "preserve"
6-
}
5+
"proseWrap": "preserve",
6+
"trailingComma": "es5"
7+
}

‎docs/api/actions/check.mdx

+5-5
Original file line numberDiff line numberDiff line change
@@ -27,14 +27,14 @@ This element must be an `<input>` with type `checkbox` or `radio`.
2727

2828
### Usage
2929

30-
**<Icon name="check-circle" color="green" /> Correct Usage**
30+
<Icon name="check-circle" color="green" /> **Correct Usage**
3131

3232
```javascript
3333
cy.get('[type="checkbox"]').check() // Check checkbox element
3434
cy.get('[type="radio"]').first().check() // Check first radio element
3535
```
3636

37-
**<Icon name="exclamation-triangle" color="red" /> Incorrect Usage**
37+
<Icon name="exclamation-triangle" color="red" /> **Incorrect Usage**
3838

3939
```javascript
4040
cy.check('[type="checkbox"]') // Errors, cannot be chained off 'cy'
@@ -43,15 +43,15 @@ cy.get('p:first').check() // Errors, '.get()' does not yield checkbox or radio
4343

4444
### Arguments
4545

46-
**<Icon name="angle-right" /> value** **_(String)_**
46+
<Icon name="angle-right" /> **value _(String)_**
4747

4848
Value of checkbox or radio that should be checked.
4949

50-
**<Icon name="angle-right" /> values** **_(Array)_**
50+
<Icon name="angle-right" /> **values _(Array)_**
5151

5252
Values of checkboxes or radios that should be checked.
5353

54-
**<Icon name="angle-right" /> options** **_(Object)_**
54+
<Icon name="angle-right" /> **options _(Object)_**
5555

5656
Pass in an options object to change the default behavior of `.check()`.
5757

‎docs/api/actions/clear.mdx

+3-3
Original file line numberDiff line numberDiff line change
@@ -23,15 +23,15 @@ An alias for [`.type('{selectall}{backspace}')`](/api/commands/type)
2323

2424
### Usage
2525

26-
**<Icon name="check-circle" color="green" /> Correct Usage**
26+
<Icon name="check-circle" color="green" /> **Correct Usage**
2727

2828
```javascript
2929
cy.get('[type="text"]').clear() // Clear text input
3030
cy.get('textarea').type('Hi!').clear() // Clear textarea
3131
cy.focused().clear() // Clear focused input/textarea
3232
```
3333

34-
**<Icon name="exclamation-triangle" color="red" /> Incorrect Usage**
34+
<Icon name="exclamation-triangle" color="red" /> **Incorrect Usage**
3535

3636
```javascript
3737
cy.clear() // Errors, cannot be chained off 'cy'
@@ -41,7 +41,7 @@ cy.clock().clear() // Errors, 'clock' does not yield DOM elements
4141

4242
### Arguments
4343

44-
**<Icon name="angle-right" /> options** **_(Object)_**
44+
<Icon name="angle-right" /> **options _(Object)_**
4545

4646
Pass in an options object to change the default behavior of `.clear()`.
4747

‎docs/api/actions/click.mdx

+16-16
Original file line numberDiff line numberDiff line change
@@ -21,15 +21,15 @@ chain further commands that rely on the subject after `.click()`.
2121

2222
### Usage
2323

24-
**<Icon name="check-circle" color="green" /> Correct Usage**
24+
<Icon name="check-circle" color="green" /> **Correct Usage**
2525

2626
```javascript
2727
cy.get('.btn').click() // Click on button
2828
cy.focused().click() // Click on el with focus
2929
cy.contains('Welcome').click() // Click on first el containing 'Welcome'
3030
```
3131

32-
**<Icon name="exclamation-triangle" color="red" /> Incorrect Usage**
32+
<Icon name="exclamation-triangle" color="red" /> **Incorrect Usage**
3333

3434
```javascript
3535
cy.click('.btn') // Errors, cannot be chained off 'cy'
@@ -38,7 +38,7 @@ cy.window().click() // Errors, 'window' does not yield DOM element
3838

3939
### Arguments
4040

41-
**<Icon name="angle-right" /> position** **_(String)_**
41+
<Icon name="angle-right" /> **position _(String)_**
4242

4343
The position where the click should be issued. The `center` position is the
4444
default position. Valid positions are `topLeft`, `top`, `topRight`, `left`,
@@ -49,26 +49,26 @@ default position. Valid positions are `topLeft`, `top`, `topRight`, `left`,
4949
alt="cypress-command-positions-diagram"
5050
/>
5151

52-
**<Icon name="angle-right" /> x** **_(Number)_**
52+
<Icon name="angle-right" /> **x _(Number)_**
5353

5454
The distance in pixels from the element's left to issue the click.
5555

56-
**<Icon name="angle-right" /> y** **_(Number)_**
56+
<Icon name="angle-right" /> **y _(Number)_**
5757

5858
The distance in pixels from the element's top to issue the click.
5959

60-
**<Icon name="angle-right" /> options** **_(Object)_**
60+
<Icon name="angle-right" /> **options _(Object)_**
6161

6262
Pass in an options object to change the default behavior of `.click()`.
6363

6464
| Option | Default | Description |
6565
| ---------------------------- | ------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------- |
66-
| `altKey` | `false` | Activates the alt key (option key for Mac). Aliases: <code>optionKey</code>. |
66+
| `altKey` | `false` | Activates the alt key (option key for Mac). Aliases: `optionKey`. |
6767
| `animationDistanceThreshold` | [`animationDistanceThreshold`](/guides/references/configuration#Actionability) | The distance in pixels an element must exceed over time to be [considered animating](/guides/core-concepts/interacting-with-elements#Animations). |
68-
| `ctrlKey` | `false` | Activates the control key. Aliases: <code>controlKey</code>. |
68+
| `ctrlKey` | `false` | Activates the control key. Aliases: `controlKey`. |
6969
| `log` | `true` | Displays the command in the [Command log](/guides/core-concepts/cypress-app#Command-Log) |
7070
| `force` | `false` | Forces the action, disables [waiting for actionability](#Assertions) |
71-
| `metaKey` | `false` | Activates the meta key (Windows key or command key for Mac). Aliases: <code>commandKey</code>, <code>cmdKey</code>. |
71+
| `metaKey` | `false` | Activates the meta key (Windows key or command key for Mac). Aliases: `commandKey`, `cmdKey`. |
7272
| `multiple` | `false` | Serially click multiple elements |
7373
| `scrollBehavior` | [`scrollBehavior`](/guides/references/configuration#Actionability) | Viewport position to where an element [should be scrolled](/guides/core-concepts/interacting-with-elements#Scrolling) before executing the command |
7474
| `shiftKey` | `false` | Activates the shift key. |
@@ -163,12 +163,12 @@ offers options to hold down keys across multiple commands. See
163163

164164
The following keys can be combined with `.click()` through the `options`.
165165

166-
| Option | Notes |
167-
| ---------- | ------------------------------------------------------------------------------------------------------------------- |
168-
| `altKey` | Activates the alt key (option key for Mac). Aliases: <code>optionKey</code>. |
169-
| `ctrlKey` | Activates the control key. Aliases: <code>controlKey</code>. |
170-
| `metaKey` | Activates the meta key (Windows key or command key for Mac). Aliases: <code>commandKey</code>, <code>cmdKey</code>. |
171-
| `shiftKey` | Activates the shift key. |
166+
| Option | Notes |
167+
| ---------- | --------------------------------------------------------------------------------------------- |
168+
| `altKey` | Activates the alt key (option key for Mac). Aliases: `optionKey`. |
169+
| `ctrlKey` | Activates the control key. Aliases: `controlKey`. |
170+
| `metaKey` | Activates the meta key (Windows key or command key for Mac). Aliases: `commandKey`, `cmdKey`. |
171+
| `shiftKey` | Activates the shift key. |
172172

173173
#### Shift click
174174

@@ -204,7 +204,7 @@ found the window is given focus instead (which matches real browser behavior).
204204

205205
#### Mousedown cancellation will not cause focus
206206

207-
If the mousedown event has its default action prevented (`e.preventDefault()`)
207+
If the mousedown event has its default action prevented ( `e.preventDefault()` )
208208
then the element will not receive focus as per the spec.
209209

210210
## Rules

‎docs/api/actions/dblclick.mdx

+15-15
Original file line numberDiff line numberDiff line change
@@ -21,15 +21,15 @@ chain further commands that rely on the subject after `.dblclick()`.
2121

2222
### Usage
2323

24-
**<Icon name="check-circle" color="green" /> Correct Usage**
24+
<Icon name="check-circle" color="green" /> **Correct Usage**
2525

2626
```javascript
2727
cy.get('button').dblclick() // Double click on button
2828
cy.focused().dblclick() // Double click on el with focus
2929
cy.contains('Welcome').dblclick() // Double click on first el containing 'Welcome'
3030
```
3131

32-
**<Icon name="exclamation-triangle" color="red" /> Incorrect Usage**
32+
<Icon name="exclamation-triangle" color="red" /> **Incorrect Usage**
3333

3434
```javascript
3535
cy.dblclick('button') // Errors, cannot be chained off 'cy'
@@ -38,7 +38,7 @@ cy.window().dblclick() // Errors, 'window' does not yield DOM element
3838

3939
### Arguments
4040

41-
**<Icon name="angle-right" /> position** **_(String)_**
41+
<Icon name="angle-right" /> **position _(String)_**
4242

4343
The position where the double click should be issued. The `center` position is
4444
the default position. Valid positions are `topLeft`, `top`, `topRight`, `left`,
@@ -49,26 +49,26 @@ the default position. Valid positions are `topLeft`, `top`, `topRight`, `left`,
4949
alt="cypress-command-positions-diagram"
5050
/>
5151

52-
**<Icon name="angle-right" /> x** **_(Number)_**
52+
<Icon name="angle-right" /> **x _(Number)_**
5353

5454
The distance in pixels from the element's left to issue the double click.
5555

56-
**<Icon name="angle-right" /> y** **_(Number)_**
56+
<Icon name="angle-right" /> **y _(Number)_**
5757

5858
The distance in pixels from the element's top to issue the double click.
5959

60-
**<Icon name="angle-right" /> options** **_(Object)_**
60+
<Icon name="angle-right" /> **options _(Object)_**
6161

6262
Pass in an options object to change the default behavior of `.dblclick()`.
6363

6464
| Option | Default | Description |
6565
| ---------------------------- | ------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------- |
66-
| `altKey` | `false` | Activates the alt key (option key for Mac). Aliases: <code>optionKey</code>. |
66+
| `altKey` | `false` | Activates the alt key (option key for Mac). Aliases: `optionKey`. |
6767
| `animationDistanceThreshold` | [`animationDistanceThreshold`](/guides/references/configuration#Actionability) | The distance in pixels an element must exceed over time to be [considered animating](/guides/core-concepts/interacting-with-elements#Animations). |
68-
| `ctrlKey` | `false` | Activates the control key. Aliases: <code>controlKey</code>. |
68+
| `ctrlKey` | `false` | Activates the control key. Aliases: `controlKey`. |
6969
| `log` | `true` | Displays the command in the [Command log](/guides/core-concepts/cypress-app#Command-Log) |
7070
| `force` | `false` | Forces the action, disables [waiting for actionability](#Assertions) |
71-
| `metaKey` | `false` | Activates the meta key (Windows key or command key for Mac). Aliases: <code>commandKey</code>, <code>cmdKey</code>. |
71+
| `metaKey` | `false` | Activates the meta key (Windows key or command key for Mac). Aliases: `commandKey`, `cmdKey`. |
7272
| `multiple` | `true` | Serially click multiple elements |
7373
| `scrollBehavior` | [`scrollBehavior`](/guides/references/configuration#Actionability) | Viewport position to where an element [should be scrolled](/guides/core-concepts/interacting-with-elements#Scrolling) before executing the command |
7474
| `shiftKey` | `false` | Activates the shift key. |
@@ -164,12 +164,12 @@ offers options to hold down keys across multiple commands. See
164164

165165
The following modifiers can be combined with `.dblclick()`.
166166

167-
| Option | Notes |
168-
| ---------- | ------------------------------------------------------------------------------------------------------------------- |
169-
| `altKey` | Activates the alt key (option key for Mac). Aliases: <code>optionKey</code>. |
170-
| `ctrlKey` | Activates the control key. Aliases: <code>controlKey</code>. |
171-
| `metaKey` | Activates the meta key (Windows key or command key for Mac). Aliases: <code>commandKey</code>, <code>cmdKey</code>. |
172-
| `shiftKey` | Activates the shift key. |
167+
| Option | Notes |
168+
| ---------- | --------------------------------------------------------------------------------------------- |
169+
| `altKey` | Activates the alt key (option key for Mac). Aliases: `optionKey`. |
170+
| `ctrlKey` | Activates the control key. Aliases: `controlKey`. |
171+
| `metaKey` | Activates the meta key (Windows key or command key for Mac). Aliases: `commandKey`, `cmdKey`. |
172+
| `shiftKey` | Activates the shift key. |
173173

174174
##### Alt click
175175

0 commit comments

Comments
 (0)