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

Conversation

MikeMcC399
Copy link
Contributor

Issue

Instructions for installing cypress and other npm modules are shown inconsistently throughout the website for npm, pnpm and Yarn package managers.

  1. The examples vary; sometimes using a short-form optional flag and sometimes an equivalent long-form:

    npm install cypress -D
    npm install cypress --save-dev
  2. Similarly varied is the positioning of an optional flag:

    npm install --save-dev cypress
    npm install cypress --save-dev

Although the different variations are correct, it can be confusing to have examples which are arbitrarily different.

Changes

  1. The long-form is used for optional flags, e.g. --save-dev. This makes for better comprehension for readers unfamiliar with the meaning of the alternative short-form optional flag, e.g.

    npm install cypress --save-dev
  2. The positioning of optional flags is aligned to the package manager documentation, e.g.

    npm install cypress --save-dev
    yarn add cypress --dev
    pnpm add --save-dev cypress

Historical entries in the Changelog are left unchanged.

References

Copy link

netlify bot commented Mar 25, 2024

👷 Deploy request for cypress-docs pending review.

Visit the deploys page to approve it

Name Link
🔨 Latest commit 7045154

Copy link

netlify bot commented Mar 25, 2024

Deploy Preview for benevolent-cat-040f48 ready!

Name Link
🔨 Latest commit 7045154
🔍 Latest deploy log https://app.netlify.com/sites/benevolent-cat-040f48/deploys/66019c37c1392900084a9025
😎 Deploy Preview https://deploy-preview-5765--benevolent-cat-040f48.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@cypress-app-bot
Copy link
Collaborator

@MikeMcC399

This comment was marked as outdated.

@MikeMcC399 MikeMcC399 marked this pull request as ready for review March 25, 2024 15:58
@jennifer-shehane jennifer-shehane merged commit efee4a3 into cypress-io:main Mar 25, 2024
9 checks passed
@MikeMcC399 MikeMcC399 deleted the pm-install-instructions branch March 25, 2024 17:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Inconsistent package manager install / add instructions
3 participants