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.

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 package manager install / add instructions #5765

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion docs/guides/component-testing/angular/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ To get up and running with Cypress Component Testing in Angular, install Cypress
into your project:

```bash
npm install cypress -D
npm install cypress --save-dev
```

Open Cypress:
Expand Down
2 changes: 1 addition & 1 deletion docs/guides/component-testing/getting-started.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Getting started with Component Testing is super simple. Follow the guide below f
To begin we need to install Cypress in your project if you have not already done so.

```bash
npm install cypress -D
npm install cypress --save-dev
```

### Open Cypress
Expand Down
2 changes: 1 addition & 1 deletion docs/guides/component-testing/react/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ To get up and running with Cypress Component Testing in React, install Cypress
into your project:

```bash
npm install cypress -D
npm install cypress --save-dev
```

Open Cypress:
Expand Down
2 changes: 1 addition & 1 deletion docs/guides/component-testing/svelte/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ To get up and running with Cypress Component Testing in Svelte, install Cypress
into your project:

```bash
npm install cypress -D
npm install cypress --save-dev
```

Open Cypress:
Expand Down
2 changes: 1 addition & 1 deletion docs/guides/component-testing/vue/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ To get up and running with Cypress Component Testing in Vue, install Cypress
into your project:

```bash
npm install cypress -D
npm install cypress --save-dev
```

Open Cypress:
Expand Down
2 changes: 1 addition & 1 deletion docs/guides/continuous-integration/introduction.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -107,7 +107,7 @@ If the server takes a very long time to start, we recommend trying the
module.

```shell
npm install --save-dev start-server-and-test
npm install start-server-and-test --save-dev
```

In your `package.json` scripts, pass the command to boot your server, the url
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -252,14 +252,14 @@ Cypress manually.
<TabItem value="npm" active>

```bash
npm install --save-dev cypress
npm install cypress --save-dev
```

</TabItem>
<TabItem value="yarn">

```bash
yarn add --dev cypress
yarn add cypress --dev
```

</TabItem>
Expand All @@ -274,14 +274,14 @@ Angular app for Cypress to run tests against your application.
<TabItem value="npm" active>

```bash
npm install --save-dev concurrently
npm install concurrently --save-dev
```

</TabItem>
<TabItem value="yarn">

```bash
yarn add --dev concurrently
yarn add concurrently --dev
```

</TabItem>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -135,7 +135,7 @@ and install the [AWS Amazon Amplify CLI](https://docs.amplify.aws/cli) as
follows:

```jsx
npm install -g @aws-amplify/cli
npm install @aws-amplify/cli --global
```

The
Expand Down
4 changes: 2 additions & 2 deletions docs/guides/getting-started/installing-cypress.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -89,13 +89,13 @@ cd /your/project/path
```

```shell
pnpm add cypress -D
pnpm add --save-dev cypress
```

:::info

You need to make sure that you have the `pnpm` environment installed locally.
If not you need to install it: `npm install pnpm@latest -g`.
If not you need to install it: `npm install pnpm@latest --global`.

:::

Expand Down
2 changes: 1 addition & 1 deletion docs/guides/guides/launching-browsers.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -178,7 +178,7 @@ these steps:
1. Add `experimentalWebKitSupport: true` to your
[configuration](/guides/references/configuration) to enable the experiment.
2. Install the `playwright-webkit` npm package in your repo to acquire WebKit
itself: `npm install --save-dev playwright-webkit@1.34`.
itself: `npm install playwright-webkit@1.34 --save-dev`.
- We built this experiment on top of the Playwright WebKit browser as a
stepping stone towards creating a better UX with Cypress-provided browsers
in the future. Thank you, Playwright contributors.
Expand Down
2 changes: 1 addition & 1 deletion docs/guides/guides/test-retries.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -262,7 +262,7 @@ retry attempts or failures when using Cypress test retries.

```ts
// need to install these dependencies
// npm i lodash del --save-dev
// npm install lodash del --save-dev
import _ from 'lodash'
import del from 'del'
```
Expand Down
8 changes: 4 additions & 4 deletions docs/guides/references/migration-guide.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2023,7 +2023,7 @@ The Component Test Runner requires the following dependencies:
[installation steps](/guides/tooling/code-coverage)).

```shell
npm i cypress @cypress/react @cypress/webpack-dev-server -D
npm install cypress @cypress/react @cypress/webpack-dev-server --save-dev
```

**Install Vue 3 dependencies**
Expand All @@ -2034,7 +2034,7 @@ npm i cypress @cypress/react @cypress/webpack-dev-server -D
[`@cypress/webpack-dev-server`](https://www.npmjs.com/package/@cypress/webpack-dev-server).

```shell
npm i cypress @cypress/vue@next @cypress/webpack-dev-server -D
npm install cypress @cypress/vue@next @cypress/webpack-dev-server --save-dev
```

**Install Vue 2 dependencies**
Expand All @@ -2045,7 +2045,7 @@ npm i cypress @cypress/vue@next @cypress/webpack-dev-server -D
[`@cypress/webpack-dev-server`](https://www.npmjs.com/package/@cypress/webpack-dev-server).

```shell
npm i cypress @cypress/vue @cypress/webpack-dev-server -D
npm install cypress @cypress/vue @cypress/webpack-dev-server --save-dev
```

#### 3. Update plugins file to use `dev-server:start`
Expand Down Expand Up @@ -2299,7 +2299,7 @@ for the latest steps.

If you use `cy.react()` in your tests, you must manually install
[`cypress-react-selector`](https://www.npmjs.com/package/cypress-react-selector)
with `npm i cypress-react-selector -D`. You do not need to update your support
with `npm install cypress-react-selector --save-dev`. You do not need to update your support
file.

#### HTML Side effects
Expand Down
2 changes: 1 addition & 1 deletion docs/guides/tooling/code-coverage.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -298,7 +298,7 @@ documentation for up-to-date installation instructions.
:::

```shell
npm install -D @cypress/code-coverage
npm install @cypress/code-coverage --save-dev
```

Then add the code below to the
Expand Down
4 changes: 2 additions & 2 deletions docs/guides/tooling/reporters.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -194,7 +194,7 @@ We need to install additional dependencies:
with Cypress

```shell
npm install --save-dev cypress-multi-reporters mocha-junit-reporter
npm install cypress-multi-reporters mocha-junit-reporter --save-dev
```

Specify your reporter and reporterOptions in your Cypress configuration or via
Expand Down Expand Up @@ -280,7 +280,7 @@ JSON file per test file, and then combine all JSON reports into a single report.
We need to install some additional dependencies.

```shell
npm install --save-dev mochawesome mochawesome-merge mochawesome-report-generator
npm install mochawesome mochawesome-merge mochawesome-report-generator --save-dev
```

We need to configure the reporter in your
Expand Down
4 changes: 2 additions & 2 deletions docs/guides/tooling/typescript-support.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -17,14 +17,14 @@ install it:
<TabItem value='npm'>

```shell
npm install --save-dev typescript
npm install typescript --save-dev
```

</TabItem>
<TabItem value='yarn'>

```shell
yarn add --dev typescript
yarn add typescript --dev
```

</TabItem>
Expand Down
2 changes: 1 addition & 1 deletion docs/guides/tooling/visual-testing.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,7 @@ it('completes todo', () => {

cy.contains('.todo-list li', 'write tests').should('have.class', 'completed')

// run 'npm i cypress-plugin-snapshots -S'
// run 'npm install cypress-plugin-snapshots --save'
// capture the element screenshot and
// compare to the baseline image
cy.get('.todoapp').toMatchImageSnapshot({
Expand Down
Loading