diff options
Diffstat (limited to 'deps/npm/doc/cli/npm-prune.md')
| -rw-r--r-- | deps/npm/doc/cli/npm-prune.md | 16 |
1 files changed, 14 insertions, 2 deletions
diff --git a/deps/npm/doc/cli/npm-prune.md b/deps/npm/doc/cli/npm-prune.md index c7f340ca7b..0dde244251 100644 --- a/deps/npm/doc/cli/npm-prune.md +++ b/deps/npm/doc/cli/npm-prune.md @@ -3,7 +3,7 @@ npm-prune(1) -- Remove extraneous packages ## SYNOPSIS - npm prune [[<@scope>/]<pkg>...] [--production] + npm prune [[<@scope>/]<pkg>...] [--production] [--dry-run] [--json] ## DESCRIPTION @@ -16,9 +16,21 @@ package's dependencies list. If the `--production` flag is specified or the `NODE_ENV` environment variable is set to `production`, this command will remove the packages -specified in your `devDependencies`. Setting `--production=false` will +specified in your `devDependencies`. Setting `--no-production` will negate `NODE_ENV` being set to `production`. +If the `--dry-run` flag is used then no changes will actually be made. + +If the `--json` flag is used then the changes `npm prune` made (or would +have made with `--dry-run`) are printed as a JSON object. + +In normal operation with package-locks enabled, extraneous modules are +pruned automatically when modules are installed and you'll only need +this command with the `--production` flag. + +If you've disabled package-locks then extraneous modules will not be removed +and it's up to you to run `npm prune` from time-to-time to remove them. + ## SEE ALSO * npm-uninstall(1) |