diff options
Diffstat (limited to 'deps/npm/man/man7')
-rw-r--r-- | deps/npm/man/man7/npm-coding-style.7 | 2 | ||||
-rw-r--r-- | deps/npm/man/man7/npm-config.7 | 18 | ||||
-rw-r--r-- | deps/npm/man/man7/npm-developers.7 | 2 | ||||
-rw-r--r-- | deps/npm/man/man7/npm-disputes.7 | 2 | ||||
-rw-r--r-- | deps/npm/man/man7/npm-faq.7 | 2 | ||||
-rw-r--r-- | deps/npm/man/man7/npm-index.7 | 2 | ||||
-rw-r--r-- | deps/npm/man/man7/npm-registry.7 | 2 | ||||
-rw-r--r-- | deps/npm/man/man7/npm-scope.7 | 2 | ||||
-rw-r--r-- | deps/npm/man/man7/npm-scripts.7 | 48 | ||||
-rw-r--r-- | deps/npm/man/man7/removing-npm.7 | 2 | ||||
-rw-r--r-- | deps/npm/man/man7/semver.7 | 2 |
11 files changed, 41 insertions, 43 deletions
diff --git a/deps/npm/man/man7/npm-coding-style.7 b/deps/npm/man/man7/npm-coding-style.7 index 3607b86598..bbe6dcc498 100644 --- a/deps/npm/man/man7/npm-coding-style.7 +++ b/deps/npm/man/man7/npm-coding-style.7 @@ -1,4 +1,4 @@ -.TH "NPM\-CODING\-STYLE" "7" "February 2015" "" "" +.TH "NPM\-CODING\-STYLE" "7" "March 2015" "" "" .SH "NAME" \fBnpm-coding-style\fR \- npm's "funny" coding style .SH DESCRIPTION diff --git a/deps/npm/man/man7/npm-config.7 b/deps/npm/man/man7/npm-config.7 index 77e554f3eb..591da2c321 100644 --- a/deps/npm/man/man7/npm-config.7 +++ b/deps/npm/man/man7/npm-config.7 @@ -1,4 +1,4 @@ -.TH "NPM\-CONFIG" "7" "February 2015" "" "" +.TH "NPM\-CONFIG" "7" "March 2015" "" "" .SH "NAME" \fBnpm-config\fR \- More than you probably want to know about npm configuration .SH DESCRIPTION @@ -340,7 +340,7 @@ Type: Number .RE .P -The depth to go when recursing directories for \fBnpm ls\fR, +The depth to go when recursing directories for \fBnpm ls\fR, \fBnpm cache ls\fR, and \fBnpm outdated\fR\|\. .P For \fBnpm outdated\fR, a setting of \fBInfinity\fR will be treated as \fB0\fR @@ -545,6 +545,20 @@ Type: url A proxy to use for outgoing https requests\. If the \fBHTTPS_PROXY\fR or \fBhttps_proxy\fR or \fBHTTP_PROXY\fR or \fBhttp_proxy\fR environment variables are set, proxy settings will be honored by the underlying \fBrequest\fR library\. +.SS if\-present +.RS 0 +.IP \(bu 2 +Default: false +.IP \(bu 2 +Type: Boolean + +.RE +.P +If true, npm will not exit with an error code when \fBrun\-script\fR is invoked for +a script that isn't defined in the \fBscripts\fR section of \fBpackage\.json\fR\|\. This +option can be used when it's desirable to optionally run a script when it's +present and fail if the script fails\. This is useful, for example, when running +scripts that may only apply for some builds in an otherwise generic CI setup\. .SS ignore\-scripts .RS 0 .IP \(bu 2 diff --git a/deps/npm/man/man7/npm-developers.7 b/deps/npm/man/man7/npm-developers.7 index 76eda3cde2..9b55e2a921 100644 --- a/deps/npm/man/man7/npm-developers.7 +++ b/deps/npm/man/man7/npm-developers.7 @@ -1,4 +1,4 @@ -.TH "NPM\-DEVELOPERS" "7" "February 2015" "" "" +.TH "NPM\-DEVELOPERS" "7" "March 2015" "" "" .SH "NAME" \fBnpm-developers\fR \- Developer Guide .SH DESCRIPTION diff --git a/deps/npm/man/man7/npm-disputes.7 b/deps/npm/man/man7/npm-disputes.7 index 136d670b62..de9b873978 100644 --- a/deps/npm/man/man7/npm-disputes.7 +++ b/deps/npm/man/man7/npm-disputes.7 @@ -1,4 +1,4 @@ -.TH "NPM\-DISPUTES" "7" "February 2015" "" "" +.TH "NPM\-DISPUTES" "7" "March 2015" "" "" .SH "NAME" \fBnpm-disputes\fR \- Handling Module Name Disputes .SH SYNOPSIS diff --git a/deps/npm/man/man7/npm-faq.7 b/deps/npm/man/man7/npm-faq.7 index 45daad65db..39958c3f51 100644 --- a/deps/npm/man/man7/npm-faq.7 +++ b/deps/npm/man/man7/npm-faq.7 @@ -1,4 +1,4 @@ -.TH "NPM\-FAQ" "7" "February 2015" "" "" +.TH "NPM\-FAQ" "7" "March 2015" "" "" .SH "NAME" \fBnpm-faq\fR \- Frequently Asked Questions .SH Where can I find these docs in HTML? diff --git a/deps/npm/man/man7/npm-index.7 b/deps/npm/man/man7/npm-index.7 index c1491c918b..a923d53e88 100644 --- a/deps/npm/man/man7/npm-index.7 +++ b/deps/npm/man/man7/npm-index.7 @@ -1,4 +1,4 @@ -.TH "NPM\-INDEX" "7" "February 2015" "" "" +.TH "NPM\-INDEX" "7" "March 2015" "" "" .SH "NAME" \fBnpm-index\fR \- Index of all npm documentation .SS npm help README diff --git a/deps/npm/man/man7/npm-registry.7 b/deps/npm/man/man7/npm-registry.7 index 8e53a12a55..761248031e 100644 --- a/deps/npm/man/man7/npm-registry.7 +++ b/deps/npm/man/man7/npm-registry.7 @@ -1,4 +1,4 @@ -.TH "NPM\-REGISTRY" "7" "February 2015" "" "" +.TH "NPM\-REGISTRY" "7" "March 2015" "" "" .SH "NAME" \fBnpm-registry\fR \- The JavaScript Package Registry .SH DESCRIPTION diff --git a/deps/npm/man/man7/npm-scope.7 b/deps/npm/man/man7/npm-scope.7 index 5a32862abb..0a68fc3196 100644 --- a/deps/npm/man/man7/npm-scope.7 +++ b/deps/npm/man/man7/npm-scope.7 @@ -1,4 +1,4 @@ -.TH "NPM\-SCOPE" "7" "February 2015" "" "" +.TH "NPM\-SCOPE" "7" "March 2015" "" "" .SH "NAME" \fBnpm-scope\fR \- Scoped packages .SH DESCRIPTION diff --git a/deps/npm/man/man7/npm-scripts.7 b/deps/npm/man/man7/npm-scripts.7 index b90484d2f4..bdd0813287 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" "February 2015" "" "" +.TH "NPM\-SCRIPTS" "7" "March 2015" "" "" .SH "NAME" \fBnpm-scripts\fR \- How npm handles the "scripts" field .SH DESCRIPTION @@ -45,53 +45,31 @@ 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)\. -.SH NOTE: INSTALL SCRIPTS ARE AN ANTIPATTERN -.P -\fBtl;dr\fR Don't use \fBinstall\fR\|\. Use a \fB\|\.gyp\fR file for compilation, and -\fBprepublish\fR for anything else\. -.P -You should almost never have to explicitly set a \fBpreinstall\fR or -\fBinstall\fR script\. If you are doing this, please consider if there is -another option\. -.P -The only valid use of \fBinstall\fR or \fBpreinstall\fR scripts is for -compilation which must be done on the target architecture\. In early -versions of node, this was often done using the \fBnode\-waf\fR scripts, or -a standalone \fBMakefile\fR, and early versions of npm required that it be -explicitly set in package\.json\. This was not portable, and harder to -do properly\. -.P -In the current version of node, the standard way to do this is using a -\fB\|\.gyp\fR file\. If you have a file with a \fB\|\.gyp\fR extension in the root -of your package, then npm will run the appropriate \fBnode\-gyp\fR commands -automatically at install time\. This is the only officially supported -method for compiling binary addons, and does not require that you add -anything to your package\.json file\. -.P -If you have to do other things before your package is used, in a way +.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, then use a \fBprepublish\fR script instead\. This includes +target system, use a \fBprepublish\fR script\. This includes tasks such as: .RS 0 .IP \(bu 2 -Compile CoffeeScript source code into JavaScript\. +Compiling CoffeeScript source code into JavaScript\. .IP \(bu 2 -Create minified versions of JavaScript source code\. +Creating minified versions of JavaScript source code\. .IP \(bu 2 Fetching remote resources that your package will use\. .RE .P -The advantage of doing these things at \fBprepublish\fR time instead of -\fBpreinstall\fR or \fBinstall\fR time is that they can be done once, in a -single place, and thus greatly reduce complexity and variability\. +The advantage of doing these things at \fBprepublish\fR 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 your users don't need to have it installed\. .IP \(bu 2 -You don't need to include the minifiers in your package, reducing +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 @@ -275,6 +253,12 @@ probably set it up that way for a reason\. 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 +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 +scripts is for compilation which must be done on the target architecture\. .RE .SH SEE ALSO diff --git a/deps/npm/man/man7/removing-npm.7 b/deps/npm/man/man7/removing-npm.7 index e3f8b02760..a63c66b9b1 100644 --- a/deps/npm/man/man7/removing-npm.7 +++ b/deps/npm/man/man7/removing-npm.7 @@ -1,4 +1,4 @@ -.TH "NPM\-REMOVAL" "1" "February 2015" "" "" +.TH "NPM\-REMOVAL" "1" "March 2015" "" "" .SH "NAME" \fBnpm-removal\fR \- Cleaning the Slate .SH SYNOPSIS diff --git a/deps/npm/man/man7/semver.7 b/deps/npm/man/man7/semver.7 index d15e0de43e..7378be9862 100644 --- a/deps/npm/man/man7/semver.7 +++ b/deps/npm/man/man7/semver.7 @@ -1,4 +1,4 @@ -.TH "SEMVER" "7" "February 2015" "" "" +.TH "SEMVER" "7" "March 2015" "" "" .SH "NAME" \fBsemver\fR \- The semantic versioner for npm .SH Usage |