Installing dependencies.
This commit is contained in:
+180
@@ -0,0 +1,180 @@
|
||||
.TH "NPM\-REBUILD" "1" "August 2022" "" ""
|
||||
.SH "NAME"
|
||||
\fBnpm-rebuild\fR \- Rebuild a package
|
||||
.SS Synopsis
|
||||
.P
|
||||
.RS 2
|
||||
.nf
|
||||
npm rebuild [<package\-spec>] \.\.\.]
|
||||
|
||||
alias: rb
|
||||
.fi
|
||||
.RE
|
||||
.SS Description
|
||||
.P
|
||||
This command runs the \fBnpm build\fP command on the matched folders\. This is
|
||||
useful when you install a new version of node, and must recompile all your
|
||||
C++ addons with the new binary\. It is also useful when installing with
|
||||
\fB\-\-ignore\-scripts\fP and \fB\-\-no\-bin\-links\fP, to explicitly choose which
|
||||
packages to build and/or link bins\.
|
||||
.P
|
||||
If one or more package specs are provided, then only packages with a
|
||||
name and version matching one of the specifiers will be rebuilt\.
|
||||
.SS Configuration
|
||||
.SS \fBglobal\fP
|
||||
.RS 0
|
||||
.IP \(bu 2
|
||||
Default: false
|
||||
.IP \(bu 2
|
||||
Type: Boolean
|
||||
|
||||
.RE
|
||||
.P
|
||||
Operates in "global" mode, so that packages are installed into the \fBprefix\fP
|
||||
folder instead of the current working directory\. See
|
||||
npm help folders for more on the differences in behavior\.
|
||||
.RS 0
|
||||
.IP \(bu 2
|
||||
packages are installed into the \fB{prefix}/lib/node_modules\fP folder, instead
|
||||
of the current working directory\.
|
||||
.IP \(bu 2
|
||||
bin files are linked to \fB{prefix}/bin\fP
|
||||
.IP \(bu 2
|
||||
man pages are linked to \fB{prefix}/share/man\fP
|
||||
|
||||
.RE
|
||||
.SS \fBbin\-links\fP
|
||||
.RS 0
|
||||
.IP \(bu 2
|
||||
Default: true
|
||||
.IP \(bu 2
|
||||
Type: Boolean
|
||||
|
||||
.RE
|
||||
.P
|
||||
Tells npm to create symlinks (or \fB\|\.cmd\fP shims on Windows) for package
|
||||
executables\.
|
||||
.P
|
||||
Set to false to have it not do this\. This can be used to work around the
|
||||
fact that some file systems don't support symlinks, even on ostensibly Unix
|
||||
systems\.
|
||||
.SS \fBforeground\-scripts\fP
|
||||
.RS 0
|
||||
.IP \(bu 2
|
||||
Default: false
|
||||
.IP \(bu 2
|
||||
Type: Boolean
|
||||
|
||||
.RE
|
||||
.P
|
||||
Run all build scripts (ie, \fBpreinstall\fP, \fBinstall\fP, and \fBpostinstall\fP)
|
||||
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\fP
|
||||
.RS 0
|
||||
.IP \(bu 2
|
||||
Default: false
|
||||
.IP \(bu 2
|
||||
Type: Boolean
|
||||
|
||||
.RE
|
||||
.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\fP, \fBnpm stop\fP, \fBnpm restart\fP, \fBnpm test\fP, and \fBnpm run\-script\fP
|
||||
will still run their intended script if \fBignore\-scripts\fP is set, but they
|
||||
will \fInot\fR run any pre\- or post\-scripts\.
|
||||
.SS \fBworkspace\fP
|
||||
.RS 0
|
||||
.IP \(bu 2
|
||||
Default:
|
||||
.IP \(bu 2
|
||||
Type: String (can be set multiple times)
|
||||
|
||||
.RE
|
||||
.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\fP config are either:
|
||||
.RS 0
|
||||
.IP \(bu 2
|
||||
Workspace names
|
||||
.IP \(bu 2
|
||||
Path to a workspace directory
|
||||
.IP \(bu 2
|
||||
Path to a parent workspace directory (will result in selecting all
|
||||
workspaces within that folder)
|
||||
|
||||
.RE
|
||||
.P
|
||||
When set for the \fBnpm init\fP 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\fP
|
||||
.RS 0
|
||||
.IP \(bu 2
|
||||
Default: null
|
||||
.IP \(bu 2
|
||||
Type: null or Boolean
|
||||
|
||||
.RE
|
||||
.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\fP to
|
||||
ignore workspaces altogether\. When not set explicitly:
|
||||
.RS 0
|
||||
.IP \(bu 2
|
||||
Commands that operate on the \fBnode_modules\fP tree (install, update, etc\.)
|
||||
will link workspaces into the \fBnode_modules\fP 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\fP config\.
|
||||
|
||||
.RE
|
||||
.P
|
||||
This value is not exported to the environment for child processes\.
|
||||
.SS \fBinclude\-workspace\-root\fP
|
||||
.RS 0
|
||||
.IP \(bu 2
|
||||
Default: false
|
||||
.IP \(bu 2
|
||||
Type: Boolean
|
||||
|
||||
.RE
|
||||
.P
|
||||
Include the workspace root when workspaces are enabled for a command\.
|
||||
.P
|
||||
When false, specifying individual workspaces via the \fBworkspace\fP config, or
|
||||
all workspaces via the \fBworkspaces\fP 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\fP
|
||||
.RS 0
|
||||
.IP \(bu 2
|
||||
Default: false
|
||||
.IP \(bu 2
|
||||
Type: Boolean
|
||||
|
||||
.RE
|
||||
.P
|
||||
When set file: protocol dependencies that exist outside of the project root
|
||||
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 2
|
||||
npm help package spec
|
||||
.IP \(bu 2
|
||||
npm help install
|
||||
|
||||
.RE
|
||||
Reference in New Issue
Block a user