diff options
Diffstat (limited to 'deps/npm/man/man7')
-rw-r--r-- | deps/npm/man/man7/npm-coding-style.7 | 4 | ||||
-rw-r--r-- | deps/npm/man/man7/npm-config.7 | 39 | ||||
-rw-r--r-- | deps/npm/man/man7/npm-developers.7 | 4 | ||||
-rw-r--r-- | deps/npm/man/man7/npm-disputes.7 | 6 | ||||
-rw-r--r-- | deps/npm/man/man7/npm-index.7 | 16 | ||||
-rw-r--r-- | deps/npm/man/man7/npm-orgs.7 | 2 | ||||
-rw-r--r-- | deps/npm/man/man7/npm-registry.7 | 2 | ||||
-rw-r--r-- | deps/npm/man/man7/npm-scope.7 | 4 | ||||
-rw-r--r-- | deps/npm/man/man7/npm-scripts.7 | 16 | ||||
-rw-r--r-- | deps/npm/man/man7/removing-npm.7 | 2 | ||||
-rw-r--r-- | deps/npm/man/man7/semver.7 | 26 |
11 files changed, 93 insertions, 28 deletions
diff --git a/deps/npm/man/man7/npm-coding-style.7 b/deps/npm/man/man7/npm-coding-style.7 index 508198722d..5af2d71a04 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" "December 2017" "" "" +.TH "NPM\-CODING\-STYLE" "7" "May 2018" "" "" .SH "NAME" \fBnpm-coding-style\fR \- npm's "funny" coding style .SH DESCRIPTION @@ -147,7 +147,7 @@ var alsoOk = "String contains 'single' quotes or apostrophe" .RE .SH Whitespace .P -Put a single space in front of ( for anything other than a function call\. +Put a single space in front of \fB(\fP for anything other than a function call\. Also use a single space wherever it makes things more readable\. .P Don't leave trailing whitespace at the end of lines\. Don't indent empty diff --git a/deps/npm/man/man7/npm-config.7 b/deps/npm/man/man7/npm-config.7 index aec6d8014c..c2e7748798 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" "December 2017" "" "" +.TH "NPM\-CONFIG" "7" "May 2018" "" "" .SH "NAME" \fBnpm-config\fR \- More than you probably want to know about npm configuration .SH DESCRIPTION @@ -211,6 +211,18 @@ Type: String .P When "dev" or "development" and running local \fBnpm shrinkwrap\fP, \fBnpm outdated\fP, or \fBnpm update\fP, is an alias for \fB\-\-dev\fP\|\. +.SS audit +.RS 0 +.IP \(bu 2 +Default: true +.IP \(bu 2 +Type: Boolean + +.RE +.P +When "true" submit audit reports alongside \fBnpm install\fP runs to the default +registry and all registries configured for scopes\. See the documentation +for npm help audit for details on what is submitted\. .SS auth\-type .RS 0 .IP \(bu 2 @@ -394,6 +406,9 @@ Type: Boolean or \fB"always"\fP .P If false, never shows colors\. If \fB"always"\fP then always shows colors\. If true, then only prints color codes for tty file descriptors\. +.P +This option can also be changed using the environment: colors are +disabled when the environment variable \fBNO_COLOR\fP is set to any value\. .SS depth .RS 0 .IP \(bu 2 @@ -902,7 +917,7 @@ Any "%s" in the message will be replaced with the version number\. .SS metrics\-registry .RS 0 .IP \(bu 2 -Default: The value of \fBregistry\fP (which defaults to "https://registry\.npmjs\.org/") +Default: The value of \fBregistry\fP (which defaults to "https:// .IP \(bu 2 Type: String @@ -931,6 +946,16 @@ Type: semver or false .RE .P The node version to use when checking a package's \fBengines\fP map\. +.SS no\-proxy +.RS 0 +.IP \(bu 2 +Default: null +.IP \(bu 2 +Type: String or Array + +.RE +.P +A comma\-separated string or an array of domain extensions that a proxy should not be used for\. .SS offline .RS 0 .IP \(bu 2 @@ -1009,6 +1034,10 @@ Type: Boolean If set to false, then ignore \fBpackage\-lock\.json\fP files when installing\. This will also prevent \fIwriting\fR \fBpackage\-lock\.json\fP if \fBsave\fP is true\. .P +When package package\-locks are disabled, automatic pruning of extraneous +modules will also be disabled\. To remove extraneous modules with +package\-locks disabled use \fBnpm prune\fP\|\. +.P This option is an alias for \fB\-\-shrinkwrap\fP\|\. .SS package\-lock\-only .RS 0 @@ -1019,7 +1048,7 @@ Type: Boolean .RE .P -If set to true, it will update only the \fBpackage\-json\fP, +If set to true, it will update only the \fBpackage\-lock\.json\fP, instead of checking \fBnode_modules\fP and downloading dependencies\. .SS parseable .RS 0 @@ -1133,7 +1162,7 @@ Rebuild bundled dependencies after installation\. .SS registry .RS 0 .IP \(bu 2 -Default: https://registry\.npmjs\.org/ +Default: https:// .IP \(bu 2 Type: url @@ -1153,7 +1182,7 @@ Remove failed installs\. .SS save .RS 0 .IP \(bu 2 -Default: false +Default: true .IP \(bu 2 Type: Boolean diff --git a/deps/npm/man/man7/npm-developers.7 b/deps/npm/man/man7/npm-developers.7 index d9e483206a..9d10c9cc4d 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" "December 2017" "" "" +.TH "NPM\-DEVELOPERS" "7" "May 2018" "" "" .SH "NAME" \fBnpm-developers\fR \- Developer Guide .SH DESCRIPTION @@ -68,7 +68,7 @@ This should be a string that identifies your project\. Please do not use the name to specify that it runs on node, or is in JavaScript\. You can use the "engines" field to explicitly state the versions of node (or whatever else) that your program requires, and it's pretty -well assumed that it's javascript\. +well assumed that it's JavaScript\. It does not necessarily need to match your github repository name\. So, \fBnode\-foo\fP and \fBbar\-js\fP are bad names\. \fBfoo\fP or \fBbar\fP are better\. .IP \(bu 2 diff --git a/deps/npm/man/man7/npm-disputes.7 b/deps/npm/man/man7/npm-disputes.7 index 642abcf178..ccdaed5975 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" "December 2017" "" "" +.TH "NPM\-DISPUTES" "7" "May 2018" "" "" .SH "NAME" \fBnpm-disputes\fR \- Handling Module Name Disputes .P @@ -46,7 +46,7 @@ publishes it to the npm registry\. Being a simple little thing, it never really has to be updated\. Alice works for Foo Inc, the makers of the critically acclaimed and widely\-marketed \fBfoo\fP JavaScript toolkit framework\. They publish it to npm as \fBfoojs\fP, but people are routinely confused when -\fBnpm install\fPfoo`` is some different thing\. +\fBnpm install\fPfoo\fB\fP is some different thing\. .IP 4. 3 Yusuf writes a parser for the widely\-known \fBfoo\fP file format, because he needs it for work\. Then, he gets a new job, and never updates the prototype\. @@ -120,7 +120,7 @@ here to help\.\fR .P If you think another npm publisher is infringing your trademark, such as by using a confusingly similar package name, email abuse@npmjs\.com with a link to -the package or user account on \fIhttps://npmjs\.com\fR\|\. Attach a +the package or user account on https:// \fIhttps://npmjs\.com\fR\|\. Attach a copy of your trademark registration certificate\. .P If we see that the package's publisher is intentionally misleading others by diff --git a/deps/npm/man/man7/npm-index.7 b/deps/npm/man/man7/npm-index.7 index 77a70e6cc6..23327c713c 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" "December 2017" "" "" +.TH "NPM\-INDEX" "7" "May 2018" "" "" .SH "NAME" \fBnpm-index\fR \- Index of all npm documentation .SS npm help README @@ -16,6 +16,9 @@ Set access level on published packages .SS npm help adduser .P Add a registry user account +.SS npm help audit +.P +Run a security audit .SS npm help bin .P Display npm bin folder @@ -31,6 +34,9 @@ REMOVED .SS npm help cache .P Manipulates packages cache +.SS npm help ci +.P +Install a project with a clean slate .SS npm help completion .P Tab Completion for npm @@ -64,9 +70,15 @@ Search npm help documentation .SS npm help help .P Get help on npm +.SS npm help hook +.P +Manage registry hooks .SS npm help init .P -Interactively create a package\.json file +create a package\.json file +.SS npm help install\-ci\-test +.P +Install a project with a clean slate and run tests .SS npm help install\-test .P Install package(s) and run tests diff --git a/deps/npm/man/man7/npm-orgs.7 b/deps/npm/man/man7/npm-orgs.7 index d1c3588ad8..fa4d2aa0d6 100644 --- a/deps/npm/man/man7/npm-orgs.7 +++ b/deps/npm/man/man7/npm-orgs.7 @@ -1,4 +1,4 @@ -.TH "NPM\-ORGS" "7" "December 2017" "" "" +.TH "NPM\-ORGS" "7" "May 2018" "" "" .SH "NAME" \fBnpm-orgs\fR \- Working with Teams & Orgs .SH DESCRIPTION diff --git a/deps/npm/man/man7/npm-registry.7 b/deps/npm/man/man7/npm-registry.7 index a51170a387..e04928610f 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" "December 2017" "" "" +.TH "NPM\-REGISTRY" "7" "May 2018" "" "" .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 16e42f4bf0..9a7a1809bd 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" "December 2017" "" "" +.TH "NPM\-SCOPE" "7" "May 2018" "" "" .SH "NAME" \fBnpm-scope\fR \- Scoped packages .SH DESCRIPTION @@ -86,7 +86,7 @@ to \fBpublic\fP as if you had run \fBnpm access public\fP after publishing\. .SS Publishing private scoped packages to the npm registry .P To publish a private scoped package to the npm registry, you must have -an npm Private Modules \fIhttps://www\.npmjs\.com/private\-modules\fR +an npm Private Modules \fIhttps://docs\.npmjs\.com/private\-modules/intro\fR account\. .P You can then publish the module with \fBnpm publish\fP or \fBnpm publish diff --git a/deps/npm/man/man7/npm-scripts.7 b/deps/npm/man/man7/npm-scripts.7 index bd0383116b..4b9e666bae 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" "December 2017" "" "" +.TH "NPM\-SCRIPTS" "7" "May 2018" "" "" .SH "NAME" \fBnpm-scripts\fR \- How npm handles the "scripts" field .SH DESCRIPTION @@ -78,15 +78,15 @@ names will be run for those as well (e\.g\. \fBpremyscript\fP, \fBmyscript\fP, .SH PREPUBLISH AND PREPARE .SS DEPRECATION NOTE .P -Since \fBnpm@1\.1\.71\fP, the npm CLI has run the \fBprepublish\fP script for both \fBnpm -publish\fP and \fBnpm install\fP, because it's a convenient way to prepare a package +Since \fB, the npm CLI has run the\fPprepublish\fBscript for both\fPnpm +publish\fBand\fPnpm install\fB, because it's a convenient way to prepare a package for use (some common use cases are described in the section below)\. It has -also turned out to be, in practice, very -confusing \fIhttps://github\.com/npm/npm/issues/10074\fR\|\. As of \fBnpm@4\.0\.0\fP, a new -event has been introduced, \fBprepare\fP, that preserves this existing behavior\. A -\fInew\fR event, \fBprepublishOnly\fP has been added as a transitional strategy to +also turned out to be, in practice, [very +confusing](https://github\.com/npm/npm/issues/10074)\. As of\fP\fB, a new +event has been introduced,\fPprepare\fB, that preserves this existing behavior\. A +_new_ event,\fPprepublishOnly\fBhas been added as a transitional strategy to allow users to avoid the confusing behavior of existing npm versions and only -run on \fBnpm publish\fP (for instance, running the tests one last time to ensure +run on\fPnpm publish` (for instance, running the tests one last time to ensure they're in good shape)\. .P See https://github\.com/npm/npm/issues/10074 for a much lengthier diff --git a/deps/npm/man/man7/removing-npm.7 b/deps/npm/man/man7/removing-npm.7 index 62c5ae4261..46bf9bbf9a 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" "December 2017" "" "" +.TH "NPM\-REMOVAL" "1" "May 2018" "" "" .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 23c1e018d5..dcb3b0f330 100644 --- a/deps/npm/man/man7/semver.7 +++ b/deps/npm/man/man7/semver.7 @@ -1,4 +1,4 @@ -.TH "SEMVER" "7" "December 2017" "" "" +.TH "SEMVER" "7" "May 2018" "" "" .SH "NAME" \fBsemver\fR \- The semantic versioner for npm .SH Install @@ -23,6 +23,8 @@ semver\.clean(' =v1\.2\.3 ') // '1\.2\.3' semver\.satisfies('1\.2\.3', '1\.x || >=2\.5\.0 || 5\.0\.0 \- 7\.2\.3') // true semver\.gt('1\.2\.3', '9\.8\.7') // false semver\.lt('1\.2\.3', '9\.8\.7') // true +semver\.valid(semver\.coerce('v2')) // '2\.0\.0' +semver\.valid(semver\.coerce('42\.6\.7\.9\.3\-alpha')) // '42\.6\.7' .fi .RE .P @@ -57,6 +59,10 @@ Options: \-l \-\-loose Interpret versions and ranges loosely +\-c \-\-coerce + Coerce a string into SemVer if possible + (does not imply \-\-loose) + Program exits successfully if any valid version satisfies all supplied ranges, and prints all satisfying versions\. @@ -455,4 +461,22 @@ satisfy the range\. .P If you want to know if a version satisfies or does not satisfy a range, use the \fBsatisfies(version, range)\fP function\. +.SS Coercion +.RS 0 +.IP \(bu 2 +\fBcoerce(version)\fP: Coerces a string to semver if possible + +.RE +.P +This aims to provide a very forgiving translation of a non\-semver +string to semver\. It looks for the first digit in a string, and +consumes all remaining characters which satisfy at least a partial semver +(e\.g\., \fB1\fP, \fB1\.2\fP, \fB1\.2\.3\fP) up to the max permitted length (256 characters)\. +Longer versions are simply truncated (\fB4\.6\.3\.9\.2\-alpha2\fP becomes \fB4\.6\.3\fP)\. +All surrounding text is simply ignored (\fBv3\.4 replaces v3\.3\.1\fP becomes \fB3\.4\.0\fP)\. +Only text which lacks digits will fail coercion (\fBversion one\fP is not valid)\. +The maximum length for any semver component considered for coercion is 16 characters; +longer components will be ignored (\fB10000000000000000\.4\.7\.4\fP becomes \fB4\.7\.4\fP)\. +The maximum value for any semver component is \fBInteger\.MAX_SAFE_INTEGER || (2**53 \- 1)\fP; +higher value components are invalid (\fB9999999999999999\.4\.7\.4\fP is likely invalid)\. |