Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Harmonize cypress script example names cy: #5787

Merged
merged 2 commits into from
Apr 19, 2024
Merged

Harmonize cypress script example names cy: #5787

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8e59218
Harmonize cypress script example names cy:
MikeMcC399 Apr 5, 2024
36eeddb
Merge branch 'main' into harmonize-script-example-name
MikeMcC399 Apr 19, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions docs/guides/getting-started/opening-the-app.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,15 +63,15 @@ the `scripts` field in your `package.json` file.
```javascript
{
"scripts": {
"cypress:open": "cypress open"
"cy:open": "cypress open"
}
}
```

Now you can invoke the command from your project root like so:

```shell
npm run cypress:open
npm run cy:open
```

...and Cypress will open right up for you.
Expand All @@ -83,7 +83,7 @@ npm run cypress:open
Don't use `cypress` as the exact name of a script, especially if you use Yarn as package manager.
When running commands on the Cypress binary (e.g. `yarn cypress verify`), Yarn will reference the
script of the same name instead and [Cypress CLI commands](/guides/guides/command-line) may not work as expected.
Use instead a descriptive and non-ambiguous script name such as `cypress:open` or `cypress:run`.
Use instead a descriptive and non-ambiguous script name such as `cy:open` or `cy:run`.

:::

Expand Down