Skip to content

Commit a67c812

Browse files
authored
docs: update Cypress branding (cypress-io#4583)
1 parent 0a82f79 commit a67c812

Some content is hidden

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

49 files changed

+290
-305
lines changed

Diff for: .textlintrc

-2
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,7 @@
1010
// Cypress product
1111
["^Cypress\.io", "Cypress"],
1212
["Cypress' ", "Cypress's "],
13-
["the command log", "the Command Log"],
1413
["Cypress dashboard", "Cypress Dashboard"],
15-
["test runner", "Test Runner"],
1614

1715
// Brands and Technologies
1816
["ansi", "ANSI"],

Diff for: content/api/commands/fixture.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -289,8 +289,8 @@ describe('User page', () => {
289289
### Loaded just once
290290

291291
Please keep in mind that fixture files are assumed to be unchanged during the
292-
test, and thus the Cypress App loads them just once. Even if you overwrite the
293-
fixture file itself, the already loaded fixture data remains the same.
292+
test, and thus Cypress loads them just once. Even if you overwrite the fixture
293+
file itself, the already loaded fixture data remains the same.
294294

295295
If you wish to dynamically change the contents of a file during your tests,
296296
consider [`cy.readFile()`](/api/commands/readFile) instead.

Diff for: content/api/commands/intercept.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1453,7 +1453,7 @@ cy.intercept('/users?_limit=+(3|5)')
14531453
Under the hood, `cy.intercept` uses the [minimatch](/api/utilities/minimatch)
14541454
library with the `{ matchBase: true }` option applied for glob matching and
14551455
provides access to it via the `Cypress` global. This enables you to test your
1456-
pattern in your spec or in the Cypress App browser console.
1456+
pattern in your spec or in the Cypress browser console.
14571457

14581458
You can invoke the `Cypress.minimatch` with just two arguments - the URL
14591459
(`string`) and the pattern (`string`), respectively - and if it yields `true`,

Diff for: content/api/commands/invoke.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -156,7 +156,7 @@ Our input field
156156
<input type="text" name="text" data-cy="my-text-input" />
157157
```
158158

159-
The Cypress Test with `cy.invoke()` awaiting the promise:
159+
The Cypress test with `cy.invoke()` awaiting the promise:
160160

161161
```javascript
162162
function disableElementAsync(element) {

Diff for: content/api/commands/mount.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ componentSpecific: true
66
<CtBetaAlert></CtBetaAlert>
77

88
Cypress does not have a built-in `cy.mount()` command. The command must be set
9-
up in your support file. By default, when you use the Cypress app to
9+
up in your support file. By default, when you use Cypress to
1010
[configure](guides/component-testing/component-framework-configuration#Automatic-Configuration-Recommended)
1111
your project, one will be automatically scaffolded for you.
1212

Diff for: content/api/commands/request.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -327,8 +327,8 @@ cy
327327
#### Request is not displayed in the Network Tab of Developer Tools
328328

329329
Cypress does not _actually_ make an XHR request from the browser. We are
330-
actually making the HTTP request from the Cypress App (in Node). So, you won't
331-
see the request inside of your Developer Tools.
330+
actually making the HTTP request from Cypress (in Node). So, you won't see the
331+
request inside of your Developer Tools.
332332

333333
### CORS
334334

Diff for: content/api/commands/screenshot.md

+13-13
Large diffs are not rendered by default.

Diff for: content/api/commands/session.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -652,14 +652,14 @@ Once created, a session for a given `id` is cached for the duration of the spec
652652
file. You can't modify a stored session after it has been cached, but you can
653653
always create a new session with a different `id`.
654654

655-
In order to reduce development time, when running the Cypress App in "open"
656-
mode, sessions will be cached _for spec file reruns_.
655+
In order to reduce development time, when running Cypress in "open" mode,
656+
sessions will be cached _for spec file reruns_.
657657

658658
### Explicitly clearing sessions
659659

660-
When running the Cypress App in "open" mode, you can explicitly clear all
661-
sessions and re-run the spec file by clicking the "Clear All Sessions" button in
662-
the [Instrument Panel](#The-Instrument-Panel).
660+
When running Cypress in "open" mode, you can explicitly clear all sessions and
661+
re-run the spec file by clicking the "Clear All Sessions" button in the
662+
[Instrument Panel](#The-Instrument-Panel).
663663

664664
<DocsImage src="/img/api/session/sessions-panel.png" alt="Sessions Instrument Panel" ></DocsImage>
665665

Diff for: content/api/commands/visit.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ If the `baseUrl` has not been set, you will need to specify a fully qualified
5252
URL or Cypress will attempt to act as your web server. See the
5353
[prefixes notes](#Prefixes) for more details.
5454

55-
**Note:** visiting a new domain requires the Cypress App window to reload. You
55+
**Note:** visiting a new domain requires the Cypress window to reload. You
5656
cannot visit different super domains in a single test.
5757

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

Diff for: content/api/commands/window.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -127,8 +127,8 @@ if (window.Cypress) {
127127
}
128128
```
129129

130-
The Cypress App can wait for the property `window.appReady` to be `true` before
131-
every test
130+
Cypress can wait for the property `window.appReady` to be `true` before every
131+
test
132132

133133
```js
134134
// spec.cy.js
@@ -145,8 +145,8 @@ beforeEach(() => {
145145
[This blog post](https://www.cypress.io/blog/2018/02/05/when-can-the-test-start/)
146146
explains how to use `cy.window()` to spy on the DOM `prototype` to detect when
147147
the application starts adding event listeners to the DOM elements. When this
148-
happens for the first time, the Cypress App knows that the application under
149-
test has started and the tests can begin.
148+
happens for the first time, Cypress knows that the application under test has
149+
started and the tests can begin.
150150

151151
See
152152
[Set flag to start tests](https://glebbahmutov.com/blog/set-flag-to-start-tests/)
@@ -187,8 +187,8 @@ it('test', (done) => {
187187
It fails. But the interesting thing is that the type of `event` is
188188
`KeyboardEvent` when you `console.log(event)`.
189189

190-
It's because the Cypress App uses an `iframe` to load the application under
191-
test. In other words, the `KeyboardEvent` used in the the code above and the
190+
It's because Cypress uses an `iframe` to load the application under test. In
191+
other words, the `KeyboardEvent` used in the the code above and the
192192
`KeyboardEvent` class from which the `event` variable is constructed are
193193
different `KeyboardEvent`s.
194194

Diff for: content/api/cypress-api/browser.md

+12-12
Original file line numberDiff line numberDiff line change
@@ -12,18 +12,18 @@ Cypress.browser // returns browser object
1212

1313
The object has the following properties:
1414

15-
| Property | Type | Description |
16-
| -------------- | --------- | --------------------------------------------------------------------------- |
17-
| `channel` | `string` | Release channel of the browser, such as `stable`, `dev`, or `canary`. |
18-
| `displayName` | `string` | Human-readable display name for the browser. |
19-
| `family` | `string` | Rendering engine being used. `chromium` or `firefox`. |
20-
| `isChosen` | `boolean` | Whether the browser is selected in the browser selector of the Cypress App. |
21-
| `majorVersion` | `number` | The major version number of the browser. |
22-
| `name` | `string` | Machine-friendly name, like `chrome`, `electron`, or `firefox`. |
23-
| `path` | `string` | Path to the browser on disk. Blank for Electron. |
24-
| `version` | `string` | Full version. |
25-
| `isHeadless` | `boolean` | Whether the browser is running headlessly. |
26-
| `isHeaded` | `boolean` | Whether the browser displays headed. |
15+
| Property | Type | Description |
16+
| -------------- | --------- | --------------------------------------------------------------------- |
17+
| `channel` | `string` | Release channel of the browser, such as `stable`, `dev`, or `canary`. |
18+
| `displayName` | `string` | Human-readable display name for the browser. |
19+
| `family` | `string` | Rendering engine being used. `chromium` or `firefox`. |
20+
| `isChosen` | `boolean` | Whether the browser is selected in the browser selector of Cypress. |
21+
| `majorVersion` | `number` | The major version number of the browser. |
22+
| `name` | `string` | Machine-friendly name, like `chrome`, `electron`, or `firefox`. |
23+
| `path` | `string` | Path to the browser on disk. Blank for Electron. |
24+
| `version` | `string` | Full version. |
25+
| `isHeadless` | `boolean` | Whether the browser is running headlessly. |
26+
| `isHeaded` | `boolean` | Whether the browser displays headed. |
2727

2828
## Examples
2929

Diff for: content/api/cypress-api/custom-commands.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -453,7 +453,7 @@ For more complex use cases feel free to overwrite existing commands.
453453

454454
If you are typing into a password field, the password input is masked
455455
automatically within your application. But [.type()](/api/commands/type)
456-
automatically logs any typed content into the Cypress App's Command Log.
456+
automatically logs any typed content into the Cypress Command Log.
457457

458458
```js
459459
cy.get('#username').type('[email protected]')
@@ -465,7 +465,7 @@ cy.get('#password').type('superSecret123')
465465
You may want to mask some values passed to the [.type()](/api/commands/type)
466466
command so that sensitive data does not display in screenshots or videos of your
467467
test run. This example overwrites the [.type()](/api/commands/type) command to
468-
allow you to mask sensitive data in the Cypress App's Command Log.
468+
allow you to mask sensitive data in the Cypress Command Log.
469469

470470
```js
471471
Cypress.Commands.overwrite('type', (originalFn, element, text, options) => {
@@ -489,7 +489,7 @@ cy.get('#username').type('[email protected]')
489489
cy.get('#password').type('superSecret123', { sensitive: true })
490490
```
491491

492-
Now our sensitive password is not printed to the Cypress App's Command Log when
492+
Now our sensitive password is not printed to the Cypress Command Log when
493493
`sensitive: true` is passed as an option to [.type()](/api/commands/type).
494494

495495
<DocsImage src="/img/api/custom-commands/custom-command-type-masked-password.png"></DocsImage>

0 commit comments

Comments
 (0)