diff options
author | Gar <gar+gh@danger.computer> | 2021-06-02 19:47:11 +0300 |
---|---|---|
committer | Gar <gar+gh@danger.computer> | 2021-06-10 20:17:01 +0300 |
commit | ef668ab57b15789c6e2971ac39d8ecb3757629fa (patch) | |
tree | 8d9df4e2c28ead9b7375f76a80016a701ca09650 /docs | |
parent | 992799cd8c4427ed8c57270b399b2d6bbc94f2a8 (diff) |
feat(diff): add workspace support
Refactored a bit so that we can more easily change the `top` and
`prefix` params that were being used, and are different under the
workspace context.
PR-URL: https://github.com/npm/cli/pull/3368
Credit: @wraithgar
Close: #3368
Reviewed-by: @ruyadorno
Diffstat (limited to 'docs')
-rw-r--r-- | docs/content/commands/npm-diff.md | 32 |
1 files changed, 32 insertions, 0 deletions
diff --git a/docs/content/commands/npm-diff.md b/docs/content/commands/npm-diff.md index 57d20727a..479cb63b1 100644 --- a/docs/content/commands/npm-diff.md +++ b/docs/content/commands/npm-diff.md @@ -242,6 +242,38 @@ command, if no explicit tag is given. When used by the `npm diff` command, this is the tag used to fetch the tarball that will be compared with the local files by default. +#### `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 |