Tweak workspaces run doc to clarify gotcha with global scripts #6824
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
dobesv
force-pushed
the
workspaces-foreach-docs-tweak
branch
from
a596f6c to
37a00ae
Compare
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?
I was very confused when
yarn workspaces foreach run xxx:yyywas running in every workspace, even ones that do not define a script with that name. I imagine others may be similarly confused as the docs currently are a bit ambiguous about this point. Also many users are likely not even aware of the concept of "global scripts" using ":".How did you fix it?
I added a bit more to the docs to clarify that
yarn workspaces foreach run xxx:yyywill run in every workspace, even ones that do not define a script by that name.