docs(essentials): elaborate on install process #4430
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- make it clear that packages are pruned (no need for "npm prune" or removing "node_modules", just running "yarn install" cleans up the repo) - make it clear that you don't need things like "lerna bootstrap", as yarn already handle the links between workspaces / creating symlinks
merceyz
requested changes
May 4, 2022
Comment on lines
+29
to
+31
| Packages present in the `node_modules` folder but not in the `package.json` will be automatically pruned. | ||
|
|
||
| If you are using workspaces, the installation process will respect their topology and create appropriate symlinks. |
There was a problem hiding this comment.
This is specific to the node-modules linker, not installs in general. We should instead reword This command sets up your project if needed to indicate that the linker might remove stuff.
We should also remove the Note that running this command is not part of the recommended workflow section as it was written a long time ago and isn't accurate anymore.
There was a problem hiding this comment.
Thanks! I'll have to dig a bit more the node-modules linker before being able to improve that or put it in the right place, I only had the chance to do a quick read of the "pnp" doc
merceyz
changed the title
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What's the problem this PR addresses?
Yarn install is doing a lot more in v2+ than it use to do in classic. It makes lerna bootstrap or npm prune obsolete. Yet the documentation is quite terse about that.
How did you fix it?
Checklist