mirror of https://github.com/lukechilds/node.git
You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
74 lines
2.4 KiB
74 lines
2.4 KiB
.TH "NPM\-RUN\-SCRIPT" "1" "May 2016" "" ""
|
|
.SH "NAME"
|
|
\fBnpm-run-script\fR \- Run arbitrary package scripts
|
|
.SH SYNOPSIS
|
|
.P
|
|
.RS 2
|
|
.nf
|
|
npm run\-script <command> [\-\- <args>\.\.\.]
|
|
|
|
alias: npm run
|
|
.fi
|
|
.RE
|
|
.SH DESCRIPTION
|
|
.P
|
|
This runs an arbitrary command from a package's \fB"scripts"\fP object\. If no
|
|
\fB"command"\fP is provided, it will list the available scripts\. \fBrun[\-script]\fP is
|
|
used by the test, start, restart, and stop commands, but can be called
|
|
directly, as well\. When the scripts in the package are printed out, they're
|
|
separated into lifecycle (test, start, restart) and directly\-run scripts\.
|
|
.P
|
|
As of \fBnpm@2\.0\.0\fP \fIhttp://blog\.npmjs\.org/post/98131109725/npm\-2\-0\-0\fR, you can
|
|
use custom arguments when executing scripts\. The special option \fB\-\-\fP is used by
|
|
getopt \fIhttp://goo\.gl/KxMmtG\fR to delimit the end of the options\. npm will pass
|
|
all the arguments after the \fB\-\-\fP directly to your script:
|
|
.P
|
|
.RS 2
|
|
.nf
|
|
npm run test \-\- \-\-grep="pattern"
|
|
.fi
|
|
.RE
|
|
.P
|
|
The arguments will only be passed to the script specified after \fBnpm run\fP
|
|
and not to any pre or post script\.
|
|
.P
|
|
The \fBenv\fP script is a special built\-in command that can be used to list
|
|
environment variables that will be available to the script at runtime\. If an
|
|
"env" command is defined in your package it will take precedence over the
|
|
built\-in\.
|
|
.P
|
|
In addition to the shell's pre\-existing \fBPATH\fP, \fBnpm run\fP adds
|
|
\fBnode_modules/\.bin\fP to the \fBPATH\fP provided to scripts\. Any binaries provided by
|
|
locally\-installed dependencies can be used without the \fBnode_modules/\.bin\fP
|
|
prefix\. For example, if there is a \fBdevDependency\fP on \fBtap\fP in your package,
|
|
you should write:
|
|
.P
|
|
.RS 2
|
|
.nf
|
|
"scripts": {"test": "tap test/\\*\.js"}
|
|
.fi
|
|
.RE
|
|
.P
|
|
instead of \fB"scripts": {"test": "node_modules/\.bin/tap test/\\*\.js"}\fP to run your tests\.
|
|
.P
|
|
\fBnpm run\fP sets the \fBNODE\fP environment variable to the \fBnode\fP executable with
|
|
which \fBnpm\fP is executed, and adds the directory within which it resides to the
|
|
\fBPATH\fP, too\.
|
|
.P
|
|
If you try to run a script without having a \fBnode_modules\fP directory and it fails,
|
|
you will be given a warning to run \fBnpm install\fP, just in case you've forgotten\.
|
|
.SH SEE ALSO
|
|
.RS 0
|
|
.IP \(bu 2
|
|
npm help 7 scripts
|
|
.IP \(bu 2
|
|
npm help test
|
|
.IP \(bu 2
|
|
npm help start
|
|
.IP \(bu 2
|
|
npm help restart
|
|
.IP \(bu 2
|
|
npm help stop
|
|
|
|
.RE
|
|
|
|
|