diff options
author | isaacs <i@izs.me> | 2021-05-11 01:10:25 +0300 |
---|---|---|
committer | isaacs <i@izs.me> | 2021-05-20 19:35:28 +0300 |
commit | 0d1a9d78779dc015242fc03d2dad2039004fa2df (patch) | |
tree | 73258681bc9df2a7ef16819c8590c32c1dd12603 /docs/content/commands/npm-rebuild.md | |
parent | 41099d3958d08f166313b7eb69b76458f8f9224c (diff) |
Add workspaces support to reify/rebuild commands
This adds `--workspace` support to:
- audit (including audit fix)
- ci
- dedupe
- find-dupes
- install
- install-ci-test
- install-test
- prune
- rebuild
- uninstall
- update
Also addresses missing error handling case, identified by @timoxley.
https://github.com/npm/cli/pull/3227#discussion_r631024491
PR-URL: https://github.com/npm/cli/pull/3227
Credit: @isaacs
Close: #3227
Reviewed-by: @ruyadorno
Diffstat (limited to 'docs/content/commands/npm-rebuild.md')
-rw-r--r-- | docs/content/commands/npm-rebuild.md | 32 |
1 files changed, 32 insertions, 0 deletions
diff --git a/docs/content/commands/npm-rebuild.md b/docs/content/commands/npm-rebuild.md index 144dd7b09..49c822d73 100644 --- a/docs/content/commands/npm-rebuild.md +++ b/docs/content/commands/npm-rebuild.md @@ -66,6 +66,38 @@ Note that commands explicitly intended to run a particular script, such as will still run their intended script if `ignore-scripts` is set, but they will *not* run any pre- or post-scripts. +#### `workspace` + +* Default: +* Type: String (can be set multiple times) + +Enable running a command in the context of the configured workspaces of the +current project while filtering by running only the workspaces defined by +this configuration option. + +Valid values for the `workspace` config are either: + +* Workspace names +* Path to a workspace directory +* Path to a parent workspace directory (will result to selecting all of the + nested workspaces) + +When set for the `npm init` command, this may be set to the folder of a +workspace which does not yet exist, to create the folder and set it up as a +brand new workspace within the project. + +This value is not exported to the environment for child processes. + +#### `workspaces` + +* Default: false +* Type: Boolean + +Enable running a command in the context of **all** the configured +workspaces. + +This value is not exported to the environment for child processes. + <!-- AUTOGENERATED CONFIG DESCRIPTIONS END --> ### See Also |