feat(docs): replace npm@<7 with yarn #1260
Conversation
|
🙌 Thanks for opening this pull request! You're awesome. |
|
Does anyone still such old npm? Wouldn't we rather remove this altogether? |
|
Yeah not sure about that version of NPM. The reason I needed it was for Yarn since (unless I've missed something) it doesn't seem to install peer deps automatically either. How about keeping it and changing it to a Yarn command? |
|
Really? Yarn behaves this way? Well... soon some day we won't have plugins as peerDeps. So, if anything, I would remove this. |
|
Sorry, I didn't mean to close. Would you like to remove it? |
|
Yes, looks like this is Yarn's chosen behaviour for the present anyway @mightyiam: yarnpkg/yarn#1503 (comment) I do think it's useful for Yarn users right now even if you're planning to remove it later, so would you consider keeping it in Yarn form until the time peer deps aren't required at all? I think removing it entirely will make life harder for Yarn users, since we'd have to figure out the install command for the peer deps from scratch instead of just modifying the handy npm command you have there, so if you'd rather not switch it to a Yarn command I'd say I'd definitely vote for leaving it alone. |
|
Okay, so we should replace the existing section with a yarn specific one. |
|
Updated with a Yarn sample, does that look ok? |
readme.md
Outdated
| eslint-config-standard-with-typescript@latest | ||
| eslint-config-standard-with-typescript |
There was a problem hiding this comment.
If you specify a version explicitly, yarn add will put the literal version specified into your package.json, unlike npm which will resolve latest to a specific patch version range and write that. Leaving the version specifier off will implicitly request latest, so the result is the same.
|
Seems like a test needs to be amended. |
closes mightyiam#1254 Co-authored-by: jay-bulk <jay.bulk@proton.me> Co-authored-by: Shahar "Dawn" Or <mightyiampresence@gmail.com> Co-authored-by: Greg Poole <gpoole@users.noreply.github.com>
mightyiam
changed the title
|
🎉 Congrats on getting your first pull request landed! |
|
🎉 This PR is included in version 39.1.0 🎉 The release is available on: Your semantic-release bot 📦🚀 |
What is the purpose of this pull request? (put an "X" next to item)
[x] Documentation update
[ ] Bug fix
[ ] New feature
[ ] Other, please explain:
What changes did you make? (Give an overview)
Update the install command in the readme for peer dependencies to quote strings with characters interpreted by shells like bash and zsh.
Which issue (if any) does this pull request address?
The install command as currently given is not usable in zsh without escaping the
^s.