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 package manager list and installation instructions #6093

Conversation

MikeMcC399
Copy link
Contributor

@MikeMcC399 MikeMcC399 commented Jan 28, 2025

Issue

Get Started > Install Cypress information for using package managers: npm, Yarn and pnpm is scattered and not at the same level of detail for each package manager. Developments in package management usage, such as the introduction of Corepack, are not covered. When Yarn is mentioned there is no distinction made between Yarn 1 Classic and Yarn Modern. For the latter there is no indication about which nodeLinker modes are supported and which do not work.

Change

  • Generalize package manager installation and refer back to each package manager's own documentation.
  • For Yarn Modern prefer node-modules and exclude Yarn Plug'n'Play for Component Testing usage.

Corepack comment

  • Since Corepack is currently considered as experimental by the Node.js documentation site, do not refer to Corepack explicitly.
    • npm does not use Corepack.
    • Yarn Classic was released before Corepack and does not document its use at all.
    • Yarn Modern has its own separate Corepack page.
    • pnpm has a Corepack section as part of the Installation page

pnpm 10.x comment

  • Delay adding any specific information for pnpm 10.x until the documentation and releases have stabilized.

Copy link

netlify bot commented Jan 28, 2025

👷 Deploy request for cypress-docs pending review.

Visit the deploys page to approve it

Name Link
🔨 Latest commit 86286df

@cypress-app-bot
Copy link
Collaborator

@MikeMcC399

This comment was marked as outdated.

@jennifer-shehane jennifer-shehane merged commit 0920998 into cypress-io:main Jan 28, 2025
7 checks passed
@MikeMcC399 MikeMcC399 deleted the add/package-manager-support-installation branch January 29, 2025 06:45
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.

Add explicit package manager support list and installation instructions
3 participants