171 lines
5.9 KiB
Groff
171 lines
5.9 KiB
Groff
|
.TH "NPM-PRUNE" "1" "February 2023" "" ""
|
||
|
|
.SH "NAME"
|
||
|
|
\fBnpm-prune\fR - Remove extraneous packages
|
||
|
|
.SS "Synopsis"
|
||
|
|
.P
|
||
|
|
.RS 2
|
||
|
|
.nf
|
||
|
|
npm prune \[lB]\[lB]<@scope>/\[rB]<pkg>...\[rB]
|
||
|
|
.fi
|
||
|
|
.RE
|
||
|
|
.SS "Description"
|
||
|
|
.P
|
||
|
|
This command removes "extraneous" packages. If a package name is provided, then only packages matching one of the supplied names are removed.
|
||
|
|
.P
|
||
|
|
Extraneous packages are those present in the \fBnode_modules\fR folder that are not listed as any package's dependency list.
|
||
|
|
.P
|
||
|
|
If the \fB--production\fR flag is specified or the \fBNODE_ENV\fR environment variable is set to \fBproduction\fR, this command will remove the packages specified in your \fBdevDependencies\fR. Setting \fB--no-production\fR will negate \fBNODE_ENV\fR being set to \fBproduction\fR.
|
||
|
|
.P
|
||
|
|
If the \fB--dry-run\fR flag is used then no changes will actually be made.
|
||
|
|
.P
|
||
|
|
If the \fB--json\fR flag is used, then the changes \fBnpm prune\fR made (or would have made with \fB--dry-run\fR) are printed as a JSON object.
|
||
|
|
.P
|
||
|
|
In normal operation, extraneous modules are pruned automatically, so you'll only need this command with the \fB--production\fR flag. However, in the real world, operation is not always "normal". When crashes or mistakes happen, this command can help clean up any resulting garbage.
|
||
|
|
.SS "Configuration"
|
||
|
|
.SS "\fBomit\fR"
|
||
|
|
.RS 0
|
||
|
|
.IP \(bu 4
|
||
|
|
Default: 'dev' if the \fBNODE_ENV\fR environment variable is set to 'production', otherwise empty.
|
||
|
|
.IP \(bu 4
|
||
|
|
Type: "dev", "optional", or "peer" (can be set multiple times)
|
||
|
|
.RE 0
|
||
|
|
|
||
|
|
.P
|
||
|
|
Dependency types to omit from the installation tree on disk.
|
||
|
|
.P
|
||
|
|
Note that these dependencies \fIare\fR still resolved and added to the \fBpackage-lock.json\fR or \fBnpm-shrinkwrap.json\fR file. They are just not physically installed on disk.
|
||
|
|
.P
|
||
|
|
If a package type appears in both the \fB--include\fR and \fB--omit\fR lists, then it will be included.
|
||
|
|
.P
|
||
|
|
If the resulting omit list includes \fB'dev'\fR, then the \fBNODE_ENV\fR environment variable will be set to \fB'production'\fR for all lifecycle scripts.
|
||
|
|
.SS "\fBdry-run\fR"
|
||
|
|
.RS 0
|
||
|
|
.IP \(bu 4
|
||
|
|
Default: false
|
||
|
|
.IP \(bu 4
|
||
|
|
Type: Boolean
|
||
|
|
.RE 0
|
||
|
|
|
||
|
|
.P
|
||
|
|
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, \fBinstall\fR, \fBupdate\fR, \fBdedupe\fR, \fBuninstall\fR, as well as \fBpack\fR and \fBpublish\fR.
|
||
|
|
.P
|
||
|
|
Note: This is NOT honored by other network related commands, eg \fBdist-tags\fR, \fBowner\fR, etc.
|
||
|
|
.SS "\fBjson\fR"
|
||
|
|
.RS 0
|
||
|
|
.IP \(bu 4
|
||
|
|
Default: false
|
||
|
|
.IP \(bu 4
|
||
|
|
Type: Boolean
|
||
|
|
.RE 0
|
||
|
|
|
||
|
|
.P
|
||
|
|
Whether or not to output JSON data, rather than the normal output.
|
||
|
|
.RS 0
|
||
|
|
.IP \(bu 4
|
||
|
|
In \fBnpm pkg set\fR it enables parsing set values with JSON.parse() before saving them to your \fBpackage.json\fR.
|
||
|
|
.RE 0
|
||
|
|
|
||
|
|
.P
|
||
|
|
Not supported by all npm commands.
|
||
|
|
.SS "\fBforeground-scripts\fR"
|
||
|
|
.RS 0
|
||
|
|
.IP \(bu 4
|
||
|
|
Default: false
|
||
|
|
.IP \(bu 4
|
||
|
|
Type: Boolean
|
||
|
|
.RE 0
|
||
|
|
|
||
|
|
.P
|
||
|
|
Run all build scripts (ie, \fBpreinstall\fR, \fBinstall\fR, and \fBpostinstall\fR) scripts for installed packages in the foreground process, sharing standard input, output, and error with the main npm process.
|
||
|
|
.P
|
||
|
|
Note that this will generally make installs run slower, and be much noisier, but can be useful for debugging.
|
||
|
|
.SS "\fBignore-scripts\fR"
|
||
|
|
.RS 0
|
||
|
|
.IP \(bu 4
|
||
|
|
Default: false
|
||
|
|
.IP \(bu 4
|
||
|
|
Type: Boolean
|
||
|
|
.RE 0
|
||
|
|
|
||
|
|
.P
|
||
|
|
If true, npm does not run scripts specified in package.json files.
|
||
|
|
.P
|
||
|
|
Note that commands explicitly intended to run a particular script, such as \fBnpm start\fR, \fBnpm stop\fR, \fBnpm restart\fR, \fBnpm test\fR, and \fBnpm run-script\fR will still run their intended script if \fBignore-scripts\fR is set, but they will \fInot\fR run any pre- or post-scripts.
|
||
|
|
.SS "\fBworkspace\fR"
|
||
|
|
.RS 0
|
||
|
|
.IP \(bu 4
|
||
|
|
Default:
|
||
|
|
.IP \(bu 4
|
||
|
|
Type: String (can be set multiple times)
|
||
|
|
.RE 0
|
||
|
|
|
||
|
|
.P
|
||
|
|
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.
|
||
|
|
.P
|
||
|
|
Valid values for the \fBworkspace\fR config are either:
|
||
|
|
.RS 0
|
||
|
|
.IP \(bu 4
|
||
|
|
Workspace names
|
||
|
|
.IP \(bu 4
|
||
|
|
Path to a workspace directory
|
||
|
|
.IP \(bu 4
|
||
|
|
Path to a parent workspace directory (will result in selecting all workspaces within that folder)
|
||
|
|
.RE 0
|
||
|
|
|
||
|
|
.P
|
||
|
|
When set for the \fBnpm init\fR 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.
|
||
|
|
.P
|
||
|
|
This value is not exported to the environment for child processes.
|
||
|
|
.SS "\fBworkspaces\fR"
|
||
|
|
.RS 0
|
||
|
|
.IP \(bu 4
|
||
|
|
Default: null
|
||
|
|
.IP \(bu 4
|
||
|
|
Type: null or Boolean
|
||
|
|
.RE 0
|
||
|
|
|
||
|
|
.P
|
||
|
|
Set to true to run the command in the context of \fBall\fR configured workspaces.
|
||
|
|
.P
|
||
|
|
Explicitly setting this to false will cause commands like \fBinstall\fR to ignore workspaces altogether. When not set explicitly:
|
||
|
|
.RS 0
|
||
|
|
.IP \(bu 4
|
||
|
|
Commands that operate on the \fBnode_modules\fR tree (install, update, etc.) will link workspaces into the \fBnode_modules\fR folder. - Commands that do other things (test, exec, publish, etc.) will operate on the root project, \fIunless\fR one or more workspaces are specified in the \fBworkspace\fR config.
|
||
|
|
.RE 0
|
||
|
|
|
||
|
|
.P
|
||
|
|
This value is not exported to the environment for child processes.
|
||
|
|
.SS "\fBinclude-workspace-root\fR"
|
||
|
|
.RS 0
|
||
|
|
.IP \(bu 4
|
||
|
|
Default: false
|
||
|
|
.IP \(bu 4
|
||
|
|
Type: Boolean
|
||
|
|
.RE 0
|
||
|
|
|
||
|
|
.P
|
||
|
|
Include the workspace root when workspaces are enabled for a command.
|
||
|
|
.P
|
||
|
|
When false, specifying individual workspaces via the \fBworkspace\fR config, or all workspaces via the \fBworkspaces\fR flag, will cause npm to operate only on the specified workspaces, and not on the root project.
|
||
|
|
.P
|
||
|
|
This value is not exported to the environment for child processes.
|
||
|
|
.SS "\fBinstall-links\fR"
|
||
|
|
.RS 0
|
||
|
|
.IP \(bu 4
|
||
|
|
Default: false
|
||
|
|
.IP \(bu 4
|
||
|
|
Type: Boolean
|
||
|
|
.RE 0
|
||
|
|
|
||
|
|
.P
|
||
|
|
When set file: protocol dependencies will be packed and installed as regular dependencies instead of creating a symlink. This option has no effect on workspaces.
|
||
|
|
.SS "See Also"
|
||
|
|
.RS 0
|
||
|
|
.IP \(bu 4
|
||
|
|
npm help uninstall
|
||
|
|
.IP \(bu 4
|
||
|
|
npm help folders
|
||
|
|
.IP \(bu 4
|
||
|
|
npm help ls
|
||
|
|
.RE 0
|