Skip to content

Add note about Yarn 2 support. #21657

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

Merged
merged 1 commit into from
Jan 29, 2021
Merged

Add note about Yarn 2 support. #21657

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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: 2 additions & 0 deletions docs/getting-started.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,8 @@ npm install next react react-dom
yarn add next react react-dom
```

> **Note**: [Yarn 2](https://yarnpkg.com/getting-started/install) is supported as best-effort within Next.js. For best results, use NPM or Yarn 1.
Copy link
Contributor

@merceyz merceyz Jan 29, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yarn 2 !== Yarn PnP, just like with Yarn 1 you can use both PnP and node_modules so this should really be updated as this isn't accurate. The migration guide explicitly states to start with node_modules then enable PnP once ready

Copy link

@SleeplessByte SleeplessByte Jan 29, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The issue that sprung this PR was multiple place on GitHub it's "Yarn 2 is supported". By default Yarn 2 will enable PnP. So yes, I agree 100% with your statement, but that's not what in practice will happen when people try to use Yarn 2.

Copy link
Contributor

@merceyz merceyz Jan 29, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

but that's not what in practice will happen when people try to use Yarn 2.

If people skip the migration guide I'd argue that is their problem and not something that should cause Next.js to advise against Yarn 2

Copy link

@SleeplessByte SleeplessByte Jan 29, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In essence I agree with you, but that's not reality. Yarn 2 defaults to PnP. There is no call to action to migrate. Next.js just states "it works with Yarn 2", not "You must follow the migration guide".

It's very easy to say that it's other people's problem, but it's equally elitist to do so.


Open `package.json` and add the following `scripts`:

```json
Expand Down