diff options
author | Gar <gar+gh@danger.computer> | 2021-05-14 17:00:06 +0300 |
---|---|---|
committer | isaacs <i@izs.me> | 2021-05-20 20:24:53 +0300 |
commit | fde35466915b5ac5958c827fa7e919e1f186db51 (patch) | |
tree | 7a1dd32079e09059ad3f9f1d2c518bdacd2bdcb0 /docs | |
parent | faa12ccc26b5f0790f79b2589780e536f4284491 (diff) |
feat(unpublish): add workspace/dry-run support
PR-URL: https://github.com/npm/cli/pull/3251
Credit: @wraithgar
Close: #3251
Reviewed-by: @ruyadorno, @isaacs
Diffstat (limited to 'docs')
-rw-r--r-- | docs/content/commands/npm-unpublish.md | 45 |
1 files changed, 45 insertions, 0 deletions
diff --git a/docs/content/commands/npm-unpublish.md b/docs/content/commands/npm-unpublish.md index 3f7b31b4e..bc8fbc7a5 100644 --- a/docs/content/commands/npm-unpublish.md +++ b/docs/content/commands/npm-unpublish.md @@ -49,6 +49,19 @@ passed. <!-- AUTOGENERATED CONFIG DESCRIPTIONS START --> <!-- automatically generated, do not edit manually --> +#### `dry-run` + +* Default: false +* Type: Boolean + +Indicates that you don't want npm to make any changes and that it should +only report what it would have done. This can be passed into any of the +commands that modify your local installation, eg, `install`, `update`, +`dedupe`, `uninstall`, as well as `pack` and `publish`. + +Note: This is NOT honored by other network related commands, eg `dist-tags`, +`owner`, etc. + #### `force` * Default: false @@ -73,6 +86,38 @@ mistakes, unnecessary performance degradation, and malicious input. If you don't have a clear idea of what you want to do, it is strongly recommended that you do not use this option! +#### `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 |