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

Add explicit package manager support list and installation instructions #6092

Closed
MikeMcC399 opened this issue Jan 28, 2025 · 2 comments · Fixed by #6093
Closed

Add explicit package manager support list and installation instructions #6092

MikeMcC399 opened this issue Jan 28, 2025 · 2 comments · Fixed by #6093

Comments

@MikeMcC399
Copy link
Contributor

MikeMcC399 commented Jan 28, 2025

Description

What would you like?

  1. Add a section for Package Manager in the Get Started > Install Cypress > System requirements section
  2. Add the following list of supported package managers:
  3. Move any generic installation instructions, which are not Cypress specific, down to this section.
  4. Separate out Cypress-specific installation instructions and keep these in the Get Started > Install Cypress section.

Why is this needed?

  1. Although npm, Yarn and pnpm are listed as supported, there is no information about which versions are supported.
  2. Descriptions in Get Started > Install Cypress mix up the reference to specific package managers. Generic and Cypress-specific instructions are put together instead of being clearly separated.
  3. Yarn Classic and Yarn Modern are different products with a combination of similarities and major incompatibilities, so it is not clear, when referring to Yarn, whether Yarn Classic or Yarn Modern or both are meant.
  4. Instructions for how to install Yarn are missing. If these instructions are added, they should take account of the fact that Yarn 1 Classic and Yarn Modern are to be installed differently from each other.
  5. Instructions for how to install pnpm using npm are incorrect if Corepack is enabled. Refer to pnpm Installation for full instructions.

Other

Related to:

@MikeMcC399
Copy link
Contributor Author

@jennifer-shehane

I plan to submit a PR to implement the above suggestions.

@MikeMcC399
Copy link
Contributor Author

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant