diff options
Diffstat (limited to 'deps/npm/man/man7/npm-scripts.7')
| -rw-r--r-- | deps/npm/man/man7/npm-scripts.7 | 90 |
1 files changed, 45 insertions, 45 deletions
diff --git a/deps/npm/man/man7/npm-scripts.7 b/deps/npm/man/man7/npm-scripts.7 index cdd740396..dd58324d8 100644 --- a/deps/npm/man/man7/npm-scripts.7 +++ b/deps/npm/man/man7/npm-scripts.7 @@ -1,4 +1,4 @@ -.TH "NPM\-SCRIPTS" "7" "June 2015" "" "" +.TH "NPM\-SCRIPTS" "7" "August 2015" "" "" .SH "NAME" \fBnpm-scripts\fR \- How npm handles the "scripts" field .SH DESCRIPTION @@ -9,7 +9,7 @@ following scripts: .IP \(bu 2 prepublish: Run BEFORE the package is published\. (Also run on local \fBnpm -install\fR without any arguments\.) +install\fP without any arguments\.) .IP \(bu 2 publish, postpublish: Run AFTER the package is published\. @@ -33,29 +33,29 @@ postversion: Run AFTER bump the package version\. .IP \(bu 2 pretest, test, posttest: -Run by the \fBnpm test\fR command\. +Run by the \fBnpm test\fP command\. .IP \(bu 2 prestop, stop, poststop: -Run by the \fBnpm stop\fR command\. +Run by the \fBnpm stop\fP command\. .IP \(bu 2 prestart, start, poststart: -Run by the \fBnpm start\fR command\. +Run by the \fBnpm start\fP command\. .IP \(bu 2 prerestart, restart, postrestart: -Run by the \fBnpm restart\fR command\. Note: \fBnpm restart\fR will run the -stop and start scripts if no \fBrestart\fR script is provided\. +Run by the \fBnpm restart\fP command\. Note: \fBnpm restart\fP will run the +stop and start scripts if no \fBrestart\fP script is provided\. .RE .P Additionally, arbitrary scripts can be executed by running \fBnpm -run\-script <pkg> <stage>\fR\|\. \fIPre\fR and \fIpost\fR commands with matching -names will be run for those as well (e\.g\. \fBpremyscript\fR, \fBmyscript\fR, -\fBpostmyscript\fR)\. +run\-script <pkg> <stage>\fP\|\. \fIPre\fR and \fIpost\fR commands with matching +names will be run for those as well (e\.g\. \fBpremyscript\fP, \fBmyscript\fP, +\fBpostmyscript\fP)\. .SH COMMON USES .P If you need to perform operations on your package before it is used, in a way that is not dependent on the operating system or architecture of the -target system, use a \fBprepublish\fR script\. This includes +target system, use a \fBprepublish\fP script\. This includes tasks such as: .RS 0 .IP \(bu 2 @@ -67,18 +67,18 @@ Fetching remote resources that your package will use\. .RE .P -The advantage of doing these things at \fBprepublish\fR time is that they can be done once, in a +The advantage of doing these things at \fBprepublish\fP time is that they can be done once, in a single place, thus reducing complexity and variability\. Additionally, this means that: .RS 0 .IP \(bu 2 -You can depend on \fBcoffee\-script\fR as a \fBdevDependency\fR, and thus +You can depend on \fBcoffee\-script\fP as a \fBdevDependency\fP, and thus your users don't need to have it installed\. .IP \(bu 2 You don't need to include minifiers in your package, reducing the size for your users\. .IP \(bu 2 -You don't need to rely on your users having \fBcurl\fR or \fBwget\fR or +You don't need to rely on your users having \fBcurl\fP or \fBwget\fP or other system tools on the target machines\. .RE @@ -87,20 +87,20 @@ other system tools on the target machines\. npm will default some script values based on package contents\. .RS 0 .IP \(bu 2 -\fB"start": "node server\.js"\fR: -If there is a \fBserver\.js\fR file in the root of your package, then npm -will default the \fBstart\fR command to \fBnode server\.js\fR\|\. +\fB"start": "node server\.js"\fP: +If there is a \fBserver\.js\fP file in the root of your package, then npm +will default the \fBstart\fP command to \fBnode server\.js\fP\|\. .IP \(bu 2 -\fB"preinstall": "node\-waf clean || true; node\-waf configure build"\fR: -If there is a \fBwscript\fR file in the root of your package, npm will -default the \fBpreinstall\fR command to compile using node\-waf\. +\fB"preinstall": "node\-waf clean || true; node\-waf configure build"\fP: +If there is a \fBwscript\fP file in the root of your package, npm will +default the \fBpreinstall\fP command to compile using node\-waf\. .RE .SH USER .P If npm was invoked with root privileges, then it will change the uid -to the user account or uid specified by the \fBuser\fR config, which -defaults to \fBnobody\fR\|\. Set the \fBunsafe\-perm\fR flag to run scripts with +to the user account or uid specified by the \fBuser\fP config, which +defaults to \fBnobody\fP\|\. Set the \fBunsafe\-perm\fP flag to run scripts with root privileges\. .SH ENVIRONMENT .P @@ -110,7 +110,7 @@ the process\. .SS path .P If you depend on modules that define executable scripts, like test -suites, then those executables will be added to the \fBPATH\fR for +suites, then those executables will be added to the \fBPATH\fP for executing the scripts\. So, if your package\.json has this: .P .RS 2 @@ -121,24 +121,24 @@ executing the scripts\. So, if your package\.json has this: .fi .RE .P -then you could run \fBnpm start\fR to execute the \fBbar\fR script, which is -exported into the \fBnode_modules/\.bin\fR directory on \fBnpm install\fR\|\. +then you could run \fBnpm start\fP to execute the \fBbar\fP script, which is +exported into the \fBnode_modules/\.bin\fP directory on \fBnpm install\fP\|\. .SS package\.json vars .P -The package\.json fields are tacked onto the \fBnpm_package_\fR prefix\. So, -for instance, if you had \fB{"name":"foo", "version":"1\.2\.5"}\fR in your +The package\.json fields are tacked onto the \fBnpm_package_\fP prefix\. So, +for instance, if you had \fB{"name":"foo", "version":"1\.2\.5"}\fP in your package\.json file, then your package scripts would have the -\fBnpm_package_name\fR environment variable set to "foo", and the -\fBnpm_package_version\fR set to "1\.2\.5" +\fBnpm_package_name\fP environment variable set to "foo", and the +\fBnpm_package_version\fP set to "1\.2\.5" .SS configuration .P Configuration parameters are put in the environment with the -\fBnpm_config_\fR prefix\. For instance, you can view the effective \fBroot\fR -config by checking the \fBnpm_config_root\fR environment variable\. +\fBnpm_config_\fP prefix\. For instance, you can view the effective \fBroot\fP +config by checking the \fBnpm_config_root\fP environment variable\. .SS Special: package\.json "config" object .P The package\.json "config" keys are overwritten in the environment if -there is a config param of \fB<name>[@<version>]:<key>\fR\|\. For example, +there is a config param of \fB<name>[@<version>]:<key>\fP\|\. For example, if the package\.json has this: .P .RS 2 @@ -166,13 +166,13 @@ npm config set foo:port 80 .RE .SS current lifecycle event .P -Lastly, the \fBnpm_lifecycle_event\fR environment variable is set to +Lastly, the \fBnpm_lifecycle_event\fP environment variable is set to whichever stage of the cycle is being executed\. So, you could have a single script used for different parts of the process which switches based on what's currently happening\. .P Objects are flattened following this format, so if you had -\fB{"scripts":{"install":"foo\.js"}}\fR in your package\.json, then you'd +\fB{"scripts":{"install":"foo\.js"}}\fP in your package\.json, then you'd see this in the script: .P .RS 2 @@ -195,11 +195,11 @@ For example, if your package\.json contains this: .fi .RE .P -then the \fBscripts/install\.js\fR will be called for the install, -post\-install, stages of the lifecycle, and the \fBscripts/uninstall\.js\fR +then the \fBscripts/install\.js\fP will be called for the install, +post\-install, stages of the lifecycle, and the \fBscripts/uninstall\.js\fP would be called when the package is uninstalled\. Since -\fBscripts/install\.js\fR is running for three different phases, it would -be wise in this case to look at the \fBnpm_lifecycle_event\fR environment +\fBscripts/install\.js\fP is running for three different phases, it would +be wise in this case to look at the \fBnpm_lifecycle_event\fP environment variable\. .P If you want to run a make command, you can do so\. This works just @@ -217,7 +217,7 @@ fine: .RE .SH EXITING .P -Scripts are run by passing the line as a script argument to \fBsh\fR\|\. +Scripts are run by passing the line as a script argument to \fBsh\fP\|\. .P If the script exits with a code other than 0, then this will abort the process\. @@ -230,7 +230,7 @@ file\. If you want to run a specific script at a specific lifecycle event for ALL packages, then you can use a hook script\. .P -Place an executable file at \fBnode_modules/\.hooks/{eventname}\fR, and +Place an executable file at \fBnode_modules/\.hooks/{eventname}\fP, and it'll get run for all packages when they are going through that point in the package lifecycle for any packages installed in that root\. .P @@ -247,23 +247,23 @@ only will prevent some optional features, then it's better to just print a warning and exit successfully\. .IP \(bu 2 Try not to use scripts to do what npm can do for you\. Read through -npm help 5 \fBpackage\.json\fR to see all the things that you can specify and enable +npm help 5 \fBpackage\.json\fP to see all the things that you can specify and enable by simply describing your package appropriately\. In general, this will lead to a more robust and consistent state\. .IP \(bu 2 Inspect the env to determine where to put things\. For instance, if -the \fBnpm_config_binroot\fR environ is set to \fB/home/user/bin\fR, then -don't try to install executables into \fB/usr/local/bin\fR\|\. The user +the \fBnpm_config_binroot\fP environ is set to \fB/home/user/bin\fP, then +don't try to install executables into \fB/usr/local/bin\fP\|\. The user probably set it up that way for a reason\. .IP \(bu 2 Don't prefix your script commands with "sudo"\. If root permissions are required for some reason, then it'll fail with that error, and the user will sudo the npm command in question\. .IP \(bu 2 -Don't use \fBinstall\fR\|\. Use a \fB\|\.gyp\fR file for compilation, and \fBprepublish\fR +Don't use \fBinstall\fP\|\. Use a \fB\|\.gyp\fP file for compilation, and \fBprepublish\fP for anything else\. You should almost never have to explicitly set a preinstall or install script\. If you are doing this, please consider if -there is another option\. The only valid use of \fBinstall\fR or \fBpreinstall\fR +there is another option\. The only valid use of \fBinstall\fP or \fBpreinstall\fP scripts is for compilation which must be done on the target architecture\. .RE |