yarn workspaces foreach
Plugin
To use this command, first install the
workspace-toolsplugin:yarn plugin import workspace-tools
Run a command on all workspaces.
Usage
$> yarn workspaces foreach <commandName> ...Examples
Publish current and all descendant packages :
yarn workspaces foreach npm publish --tolerate-republishRun build script on current and all descendant packages :
yarn workspaces foreach run buildRun build script on current and all descendant packages in parallel, building package dependencies first :
yarn workspaces foreach -pt run buildRun build script on several packages and all their dependencies, building dependencies first :
yarn workspaces foreach -ptR --from '{workspace-a,workspace-b}' run buildOptions
Definition | Description |
|---|---|
| Find packages via dependencies/devDependencies instead of using the workspaces field |
| An array of glob pattern idents from which to base any recursion |
| Run the command on all workspaces of a project |
| Prefix each output line with the name of the originating workspace |
| Run the commands in parallel |
| Print the output of commands in real-time instead of buffering it |
| The maximum number of parallel tasks that the execution will be limited to; or unlimited |
| Run the command after all workspaces it depends on (regular) have finished |
| Run the command after all workspaces it depends on (regular + dev) have finished |
| An array of glob pattern idents; only matching workspaces will be traversed |
| An array of glob pattern idents; matching workspaces won't be traversed |
| Avoid running the command on private workspaces |
| Only include workspaces that have been changed since the specified ref. |
Details
This command will run a given sub-command on current and all its descendant workspaces. Various flags can alter the exact behavior of the command:
If
-p,--parallelis set, the commands will be ran in parallel; they'll by default be limited to a number of parallel tasks roughly equal to half your core number, but that can be overridden via-j,--jobs, or disabled by setting-j unlimited.If
-p,--paralleland-i,--interlacedare both set, Yarn will print the lines from the output as it receives them. If-i,--interlacedwasn't set, it would instead buffer the output from each process and print the resulting buffers only after their source processes have exited.If
-t,--topologicalis set, Yarn will only run the command after all workspaces that it depends on through thedependenciesfield have successfully finished executing. If--topological-devis set, both thedependenciesanddevDependenciesfields will be considered when figuring out the wait points.If
-A,--allis set, Yarn will run the command on all the workspaces of a project. By default yarn runs the command only on current and all its descendant workspaces.If
-R,--recursiveis set, Yarn will find workspaces to run the command on by recursively evaluatingdependenciesanddevDependenciesfields, instead of looking at theworkspacesfields.If
--fromis set, Yarn will use the packages matching the 'from' glob as the starting point for any recursive search.If
--sinceis set, Yarn will only run the command on workspaces that have been modified since the specified ref. By default Yarn will use the refs specified by thechangesetBaseRefsconfiguration option.The command may apply to only some workspaces through the use of
--includewhich acts as a whitelist. The--excludeflag will do the opposite and will be a list of packages that mustn't execute the script. Both flags accept glob patterns (if valid Idents and supported by micromatch). Make sure to escape the patterns, to prevent your own shell from trying to expand them.
Adding the -v,--verbose flag will cause Yarn to print more information; in
particular the name of the workspace that generated the output will be printed
at the front of each line.
If the command is run and the script being run does not exist the child
workspace will be skipped without error.