Skip to content

fix(crwa): shorten output, handle yarn 3#8261

Merged
jtoar merged 21 commits intomainfrom
ds-crwa/handle-yarn-3,shorten-output
May 9, 2023
Merged

fix(crwa): shorten output, handle yarn 3#8261
jtoar merged 21 commits intomainfrom
ds-crwa/handle-yarn-3,shorten-output

Conversation

@jtoar
Copy link
Copy Markdown
Contributor

@jtoar jtoar commented May 8, 2023

Kind of fixes #8164 by avoiding the problem: this PR disables the --yarn-install flag and prompting if the package manager is yarn berry. Just came up with this solution after talking to @thedavidprice.

The rationale here is simply that we'd rather provide a working experience than one with caveats. It's easy enough to cd into the new directory and run yarn install (which works because of the 'node-modules' nodeLinker configured in .yarnrc.yml). Other create experiences like vite (who to my knowledge would also suffer from the same bug) simply instruct the user to cd and yarn install before starting too.

We can add back the --yarn-install flag for yarn berry if the issues linked to in #8164 get fixed or we have the bandwidth to implement hackier solutions.

yarn 1

image

yarn 3

image

@jtoar jtoar added the release:fix This PR is a fix label May 8, 2023
Comment thread docs/docs/quick-start.md
Comment on lines -7 to -10
> **Prerequisites**
>
> - Redwood requires [Node.js](https://nodejs.org/en/) (>=16.19 <=18.x) and [Yarn](https://yarnpkg.com/) (>=1.15)
> - Are you on Windows? For best results, follow our [Windows development setup](how-to/windows-development-setup.md) guide
Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

These asides (with the >) render as a light red right now which isn't a great color for a quick start when you want to convey how well things are going to go go:

image

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Now that you pointed it out, I can't stop thinking "gross" 🤢

Good call. Doesn't need to be a part of this PR, to be clear.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

@thedavidprice this was a Rachel Nabors tip!

@@ -621,44 +652,6 @@ async function createRedwoodApp() {
'Get up and running fast with this Quick Start guide'
)}: https://redwoodjs.com/docs/quick-start`,
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

What do you think about making this https://redwoodjs.com/quick-start and adding a redirect? I can take care of that if you want.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Makes sense. Happy to change it here and just confirm the redirect's going before release

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I'll add it now ✅

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Done in e4c9f25

@jtoar jtoar merged commit 4f50643 into main May 9, 2023
@jtoar jtoar deleted the ds-crwa/handle-yarn-3,shorten-output branch May 9, 2023 00:09
@redwoodjs-bot redwoodjs-bot Bot added this to the next-release milestone May 9, 2023
jtoar added a commit that referenced this pull request May 9, 2023
* remove extraneous links

* handle yarn 1 vs yarn 3

* avoid lint warnings

* update telemetry ci

* update quick start

* continue updating quick start

* do install before cli

* try cd and install

* try cwd with path join

* import path

* move enable immutable installs

* backport quick start changes

* fix yarn install description

* rm needless type hint

* consistent spelling in output

* copy tweaks

* console relative path

* change quick start link

* tone down warning since user deliberately declined
@jtoar jtoar removed this from the next-release milestone May 9, 2023
@jtoar jtoar added this to the v5.1.0 milestone May 9, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

release:fix This PR is a fix

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Bug?]: yarn create redwood-app fails using yarn 3

2 participants