diff options
author | claudiahdz <cghr1990@gmail.com> | 2019-11-18 21:01:39 +0200 |
---|---|---|
committer | Myles Borins <mylesborins@google.com> | 2019-11-20 19:16:47 -0500 |
commit | a7c7c703aff362f06ef5d49451a0f79fd289910f (patch) | |
tree | 48f9d01b32d55d420f229c4889a5a61178419223 /deps/npm/man/man7 | |
parent | a30a9f8193ddd61dfadc2d5d79784b682027b319 (diff) | |
download | node-new-a7c7c703aff362f06ef5d49451a0f79fd289910f.tar.gz |
deps: upgrade npm to 6.13.1
PR-URL: https://github.com/nodejs/node/pull/30533
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Reviewed-By: Jiawen Geng <technicalcute@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Diffstat (limited to 'deps/npm/man/man7')
-rw-r--r-- | deps/npm/man/man7/coding-style.7 | 222 | ||||
-rw-r--r-- | deps/npm/man/man7/config.7 | 6 | ||||
-rw-r--r-- | deps/npm/man/man7/developers.7 | 23 | ||||
-rw-r--r-- | deps/npm/man/man7/disputes.7 | 7 | ||||
-rw-r--r-- | deps/npm/man/man7/orgs.7 | 13 | ||||
-rw-r--r-- | deps/npm/man/man7/registry.7 | 15 | ||||
-rw-r--r-- | deps/npm/man/man7/removal.7 | 11 | ||||
-rw-r--r-- | deps/npm/man/man7/scope.7 | 13 | ||||
-rw-r--r-- | deps/npm/man/man7/scripts.7 | 21 | ||||
-rw-r--r-- | deps/npm/man/man7/semver.7 | 4 |
10 files changed, 52 insertions, 283 deletions
diff --git a/deps/npm/man/man7/coding-style.7 b/deps/npm/man/man7/coding-style.7 deleted file mode 100644 index 90faff3f9d..0000000000 --- a/deps/npm/man/man7/coding-style.7 +++ /dev/null @@ -1,222 +0,0 @@ -.TH "CODING\-STYLE" "" "November 2019" "" "" -.SH "NAME" -\fBcoding-style\fR -.SH npm's "funny" coding style -.SS Description -.P -npm's coding style is a bit unconventional\. It is not different for -difference's sake, but rather a carefully crafted style that is -designed to reduce visual clutter and make bugs more apparent\. -.P -If you want to contribute to npm (which is very encouraged), you should -make your code conform to npm's style\. -.P -Note: this concerns npm's code not the specific packages that you can download from the npm registry\. -.SS Line Length -.P -Keep lines shorter than 80 characters\. It's better for lines to be -too short than to be too long\. Break up long lists, objects, and other -statements onto multiple lines\. -.SS Indentation -.P -Two\-spaces\. Tabs are better, but they look like hell in web browsers -(and on GitHub), and node uses 2 spaces, so that's that\. -.P -Configure your editor appropriately\. -.SS Curly braces -.P -Curly braces belong on the same line as the thing that necessitates them\. -.P -Bad: -.P -.RS 2 -.nf -function () -{ -.fi -.RE -.P -Good: -.P -.RS 2 -.nf -function () { -.fi -.RE -.P -If a block needs to wrap to the next line, use a curly brace\. Don't -use it if it doesn't\. -.P -Bad: -.P -.RS 2 -.nf -if (foo) { bar() } -while (foo) - bar() -.fi -.RE -.P -Good: -.P -.RS 2 -.nf -if (foo) bar() -while (foo) { - bar() -} -.fi -.RE -.SS Semicolons -.P -Don't use them except in four situations: -.RS 0 -.IP \(bu 2 -\fBfor (;;)\fP loops\. They're actually required\. -.IP \(bu 2 -null loops like: \fBwhile (something) ;\fP (But you'd better have a good -reason for doing that\.) -.IP \(bu 2 -\fBcase 'foo': doSomething(); break\fP -.IP \(bu 2 -In front of a leading \fB(\fP or \fB[\fP at the start of the line\. -This prevents the expression from being interpreted -as a function call or property access, respectively\. - -.RE -.P -Some examples of good semicolon usage: -.P -.RS 2 -.nf -;(x || y)\.doSomething() -;[a, b, c]\.forEach(doSomething) -for (var i = 0; i < 10; i ++) { - switch (state) { - case 'begin': start(); continue - case 'end': finish(); break - default: throw new Error('unknown state') - } - end() -} -.fi -.RE -.P -Note that starting lines with \fB\-\fP and \fB+\fP also should be prefixed -with a semicolon, but this is much less common\. -.SS Comma First -.P -If there is a list of things separated by commas, and it wraps -across multiple lines, put the comma at the start of the next -line, directly below the token that starts the list\. Put the -final token in the list on a line by itself\. For example: -.P -.RS 2 -.nf -var magicWords = [ 'abracadabra' - , 'gesundheit' - , 'ventrilo' - ] - , spells = { 'fireball' : function () { setOnFire() } - , 'water' : function () { putOut() } - } - , a = 1 - , b = 'abc' - , etc - , somethingElse -.fi -.RE -.SS Quotes -.P -Use single quotes for strings except to avoid escaping\. -.P -Bad: -.P -.RS 2 -.nf -var notOk = "Just double quotes" -.fi -.RE -.P -Good: -.P -.RS 2 -.nf -var ok = 'String contains "double" quotes' -var alsoOk = "String contains 'single' quotes or apostrophe" -.fi -.RE -.SS Whitespace -.P -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 -lines\. Don't use more spaces than are helpful\. -.SS Functions -.P -Use named functions\. They make stack traces a lot easier to read\. -.SS Callbacks, Sync/async Style -.P -Use the asynchronous/non\-blocking versions of things as much as possible\. -It might make more sense for npm to use the synchronous fs APIs, but this -way, the fs and http and child process stuff all uses the same callback\-passing -methodology\. -.P -The callback should always be the last argument in the list\. Its first -argument is the Error or null\. -.P -Be very careful never to ever ever throw anything\. It's worse than useless\. -Just send the error message back as the first argument to the callback\. -.SS Errors -.P -Always create a new Error object with your message\. Don't just return a -string message to the callback\. Stack traces are handy\. -.SS Logging -.P -Logging is done using the npmlog \fIhttps://github\.com/npm/npmlog\fR -utility\. -.P -Please clean up logs when they are no longer helpful\. In particular, -logging the same object over and over again is not helpful\. Logs should -report what's happening so that it's easier to track down where a fault -occurs\. -.P -Use appropriate log levels\. See \fBnpm\-config\fP \fI/docs/using\-npm/config\fR and search for -"loglevel"\. -.SS Case, naming, etc\. -.P -Use \fBlowerCamelCase\fP for multiword identifiers when they refer to objects, -functions, methods, properties, or anything not specified in this section\. -.P -Use \fBUpperCamelCase\fP for class names (things that you'd pass to "new")\. -.P -Use \fBall\-lower\-hyphen\-css\-case\fP for multiword filenames and config keys\. -.P -Use named functions\. They make stack traces easier to follow\. -.P -Use \fBCAPS_SNAKE_CASE\fP for constants, things that should never change -and are rarely used\. -.P -Use a single uppercase letter for function names where the function -would normally be anonymous, but needs to call itself recursively\. It -makes it clear that it's a "throwaway" function\. -.SS null, undefined, false, 0 -.P -Boolean variables and functions should always be either \fBtrue\fP or -\fBfalse\fP\|\. Don't set it to 0 unless it's supposed to be a number\. -.P -When something is intentionally missing or removed, set it to \fBnull\fP\|\. -.P -Don't set things to \fBundefined\fP\|\. Reserve that value to mean "not yet -set to anything\." -.P -Boolean objects are forbidden\. -.SS See Also -.RS 0 -.IP \(bu 2 -npm help developers -.IP \(bu 2 -npm help npm - -.RE diff --git a/deps/npm/man/man7/config.7 b/deps/npm/man/man7/config.7 index c03745a3da..617b5354c1 100644 --- a/deps/npm/man/man7/config.7 +++ b/deps/npm/man/man7/config.7 @@ -301,7 +301,7 @@ for updates immediately even for fresh package data\. .SS prefix .RS 0 .IP \(bu 2 -Default: see npm\-folders \fI/docs/configuring\-npm/folders\fR +Default: see npm help folders .IP \(bu 2 Type: path @@ -793,7 +793,7 @@ Type: Boolean .RE .P Set to show short usage output (like the \-H output) -instead of complete help when doing \fBnpm\-help\fP \fI/docs/cli\-commands/npm\-help\fR\|\. +instead of complete help when doing npm help \fBhelp\fP\|\. .SS user .RS 0 .IP \(bu 2 @@ -879,7 +879,7 @@ Set to \fB"browser"\fP to view html help content in the default web browser\. .SS See also .RS 0 .IP \(bu 2 -npm help npm\-config +npm help config .IP \(bu 2 npm help npmrc .IP \(bu 2 diff --git a/deps/npm/man/man7/developers.7 b/deps/npm/man/man7/developers.7 index cfce9ce46f..2f24215d26 100644 --- a/deps/npm/man/man7/developers.7 +++ b/deps/npm/man/man7/developers.7 @@ -1,7 +1,6 @@ -.TH "DEVELOPERS" "" "November 2019" "" "" +.TH "DEVELOPERS" "7" "November 2019" "" "" .SH "NAME" -\fBdevelopers\fR -.SH Developer Guide +\fBdevelopers\fR \- Developer Guide .SS Description .P So, you've decided to use npm to develop (and maybe publish/deploy) @@ -60,7 +59,7 @@ an argument to \fBgit checkout\fP\|\. The default is \fBmaster\fP\|\. You need to have a \fBpackage\.json\fP file in the root of your project to do much of anything with npm\. That is basically the whole interface\. .P -See \fBpackage\.json\fP \fI/docs/configuring\-npm/package\-json\fR for details about what goes in that file\. At the very +See npm help \fBpackage\.json\fP for details about what goes in that file\. At the very least, you need: .RS 0 .IP \(bu 2 @@ -88,7 +87,7 @@ scripts: If you have a special compilation or installation script, then you should put it in the \fBscripts\fP object\. You should definitely have at least a basic smoke\-test command as the "scripts\.test" field\. -See npm\-scripts \fI/docs/using\-npm/scripts\fR\|\. +See npm help scripts\. .IP \(bu 2 main: If you have a single module that serves as the entry point to your @@ -103,7 +102,7 @@ they'll get installed just like these ones\. .RE .P You can use \fBnpm init\fP in the root of your package in order to get you -started with a pretty basic package\.json file\. See \fBnpm\-init\fP \fI/docs/cli\-commands/npm\-init\fR for +started with a pretty basic package\.json file\. See npm help \fBinit\fP for more info\. .SS Keeping files \fIout\fR of your package .P @@ -195,7 +194,7 @@ changes in real time without having to keep re\-installing it\. (You do need to either re\-link or \fBnpm rebuild \-g\fP to update compiled packages, of course\.) .P -More info at \fBnpm\-link\fP \fI/docs/cli\-commands/npm\-link\fR\|\. +More info at npm help \fBlink\fP\|\. .SS Before Publishing: Make Sure Your Package Installs and Works .P \fBThis is important\.\fR @@ -249,7 +248,7 @@ npm adduser .P and then follow the prompts\. .P -This is documented better in npm\-adduser \fI/docs/cli\-commands/npm\-adduser\fR\|\. +This is documented better in npm help adduser\. .SS Publish your package .P This part's easy\. In the root of your folder, do this: @@ -277,15 +276,15 @@ Tell the world how easy it is to install your program! .IP \(bu 2 npm help npm .IP \(bu 2 -npm help npm\-init +npm help init .IP \(bu 2 -npm help package\-json +npm help package\.json .IP \(bu 2 npm help scripts .IP \(bu 2 -npm help npm\-publish +npm help publish .IP \(bu 2 -npm help npm\-adduser +npm help adduser .IP \(bu 2 npm help registry diff --git a/deps/npm/man/man7/disputes.7 b/deps/npm/man/man7/disputes.7 index 4e4e87df33..c815d20635 100644 --- a/deps/npm/man/man7/disputes.7 +++ b/deps/npm/man/man7/disputes.7 @@ -1,7 +1,6 @@ -.TH "DISPUTES" "" "November 2019" "" "" +.TH "DISPUTES" "7" "November 2019" "" "" .SH "NAME" -\fBdisputes\fR -.SH Handling Module Name Disputes +\fBdisputes\fR \- Handling Module Name Disputes .P This document describes the steps that you should take to resolve module name disputes with other npm publishers\. It also describes special steps you should @@ -145,6 +144,6 @@ License\. .IP \(bu 2 npm help registry .IP \(bu 2 -npm help npm\-owner +npm help owner .RE diff --git a/deps/npm/man/man7/orgs.7 b/deps/npm/man/man7/orgs.7 index 072979eb80..2c52a2db46 100644 --- a/deps/npm/man/man7/orgs.7 +++ b/deps/npm/man/man7/orgs.7 @@ -1,7 +1,6 @@ -.TH "ORGS" "" "November 2019" "" "" +.TH "ORGS" "7" "November 2019" "" "" .SH "NAME" -\fBorgs\fR -.SH Working with Teams & Orgs +\fBorgs\fR \- Working with Teams & Orgs .SS Description .P There are three levels of org users: @@ -24,9 +23,9 @@ The developer will be able to access packages based on the teams they are on\. A There are two main commands: .RS 0 .IP 1. 3 -\fBnpm team\fP see npm\-team \fI/docs/cli\-commands/npm\-team\fR for more details +\fBnpm team\fP see npm help team for more details .IP 2. 3 -\fBnpm access\fP see npm\-access \fI/docs/cli\-commands/npm\-access\fR for more details +\fBnpm access\fP see npm help access for more details .RE .SS Team Admins create teams @@ -138,9 +137,9 @@ npm access ls\-collaborators <pkg> .SS See also .RS 0 .IP \(bu 2 -npm help npm\-team +npm help team .IP \(bu 2 -npm help npm\-access +npm help access .IP \(bu 2 npm help scope diff --git a/deps/npm/man/man7/registry.7 b/deps/npm/man/man7/registry.7 index 11ba7b6b27..bbb5e802bf 100644 --- a/deps/npm/man/man7/registry.7 +++ b/deps/npm/man/man7/registry.7 @@ -1,7 +1,6 @@ -.TH "REGISTRY" "" "November 2019" "" "" +.TH "REGISTRY" "7" "November 2019" "" "" .SH "NAME" -\fBregistry\fR -.SH The JavaScript Package Registry +\fBregistry\fR \- The JavaScript Package Registry .SS Description .P To resolve packages by name and version, npm talks to a registry website @@ -26,9 +25,9 @@ https://skimdb\.npmjs\.com/registry\|\. The code for the couchapp is available at https://github\.com/npm/npm\-registry\-couchapp\|\. .P The registry URL used is determined by the scope of the package (see -\fBnpm\-scope\fP \fIscope\fR\|\. If no scope is specified, the default registry is used, which is -supplied by the \fBregistry\fP config parameter\. See \fBnpm\-config\fP \fI/docs/cli\-commands/npm\-config\fR, -\fBnpmrc\fP \fI/docs/configuring\-npm/npmrc\fR, and \fBnpm\-config\fP \fI/docs/using\-npm/config\fR for more on managing npm's configuration\. +npm help \fBscope\fP\|\. If no scope is specified, the default registry is used, which is +supplied by the \fBregistry\fP config parameter\. See npm help \fBconfig\fP, +npm help \fBnpmrc\fP, and npm help \fBconfig\fP for more on managing npm's configuration\. .SS Does npm send any information about me back to the registry? .P Yes\. @@ -76,7 +75,7 @@ published at all, or \fB"publishConfig":{"registry":"http://my\-internal\-registry\.local"}\fP to force it to be published only to your internal registry\. .P -See \fBpackage\.json\fP \fI/docs/configuring\-npm/package\-json\fR for more info on what goes in the package\.json file\. +See npm help \fBpackage\.json\fP for more info on what goes in the package\.json file\. .SS Will you replicate from my registry into the public one? .P No\. If you want things to be public, then publish them into the public @@ -92,7 +91,7 @@ Yes, head over to https://www\.npmjs\.com/ .SS See also .RS 0 .IP \(bu 2 -npm help npm\-config +npm help config .IP \(bu 2 npm help config .IP \(bu 2 diff --git a/deps/npm/man/man7/removal.7 b/deps/npm/man/man7/removal.7 index 8c4e70c953..a4df8b4461 100644 --- a/deps/npm/man/man7/removal.7 +++ b/deps/npm/man/man7/removal.7 @@ -1,7 +1,6 @@ -.TH "REMOVAL" "" "November 2019" "" "" +.TH "REMOVAL" "7" "November 2019" "" "" .SH "NAME" -\fBremoval\fR -.SH Cleaning the Slate +\fBremoval\fR \- Cleaning the Slate .SS Synopsis .P So sad to see you go\. @@ -69,10 +68,8 @@ find /usr/local/{lib/node,bin} \-exec grep \-l npm \\{\\} \\; ; .SS See also .RS 0 .IP \(bu 2 -README +npm help uninstall .IP \(bu 2 -npm help npm\-uninstall -.IP \(bu 2 -npm help npm\-prune +npm help prune .RE diff --git a/deps/npm/man/man7/scope.7 b/deps/npm/man/man7/scope.7 index e1c8b3f9f1..ffe5570ae8 100644 --- a/deps/npm/man/man7/scope.7 +++ b/deps/npm/man/man7/scope.7 @@ -1,7 +1,6 @@ -.TH "SCOPE" "" "November 2019" "" "" +.TH "SCOPE" "7" "November 2019" "" "" .SH "NAME" -\fBscope\fR -.SH Scoped packages +\fBscope\fR \- Scoped packages .SS Description .P All npm packages have a name\. Some package names also have a scope\. A scope @@ -55,7 +54,7 @@ Or in \fBpackage\.json\fP: .RE .P Note that if the \fB@\fP symbol is omitted, in either case, npm will instead attempt to -install from GitHub; see \fBnpm\-install\fP \fI/docs/cli\-commands/npm\-install\fR\|\. +install from GitHub; see npm help \fBinstall\fP\|\. .SS Requiring scoped packages .P Because scoped packages are installed into a scope folder, you have to @@ -126,11 +125,11 @@ that registry instead\. .SS See also .RS 0 .IP \(bu 2 -npm help npm\-install +npm help install .IP \(bu 2 -npm help npm\-publish +npm help publish .IP \(bu 2 -npm help npm\-access +npm help access .IP \(bu 2 npm help registry diff --git a/deps/npm/man/man7/scripts.7 b/deps/npm/man/man7/scripts.7 index 7301652987..7517c59975 100644 --- a/deps/npm/man/man7/scripts.7 +++ b/deps/npm/man/man7/scripts.7 @@ -1,14 +1,13 @@ -.TH "SCRIPTS" "" "November 2019" "" "" +.TH "SCRIPTS" "7" "November 2019" "" "" .SH "NAME" -\fBscripts\fR -.SH How npm handles the "scripts" field +\fBscripts\fR \- How npm handles the "scripts" field .SS Description .P npm supports the "scripts" property of the package\.json file, for the following scripts: .RS 0 .IP \(bu 2 -\fBprepublish\fR: +\fBprepublish\fR (\fIas of npm@5, \fBprepublish\fP is deprecated\. Use \fBprepare\fP for build steps and \fBprepublishOnly\fP for upload\-only\.\fR): Run BEFORE the package is packed and published, as well as on local \fBnpm install\fP without any arguments\. (See below) .IP \(bu 2 @@ -73,7 +72,7 @@ Run by the \fBnpm shrinkwrap\fP command\. Additionally, arbitrary scripts can be executed by running \fBnpm run\-script <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)\. Scripts from dependencies can be run with +\fBpostmyscript\fP)\. Scripts from dependencies can be run with \fBnpm explore <pkg> \-\- npm run <stage>\fP\|\. .SS Prepublish and Prepare .SS Deprecation Note @@ -170,8 +169,8 @@ 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\fP environment variable set to "foo", and the -\fBnpm_package_version\fP set to "1\.2\.5"\. You can access these variables -in your code with \fBprocess\.env\.npm_package_name\fP and +\fBnpm_package_version\fP set to "1\.2\.5"\. You can access these variables +in your code with \fBprocess\.env\.npm_package_name\fP and \fBprocess\.env\.npm_package_version\fP, and so on for other fields\. .SS configuration .P @@ -290,7 +289,7 @@ 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 -\fBpackage\.json\fP \fI/docs/configuring\-npm/package\-json\fR to see all the things that you can specify and enable +npm help \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 @@ -313,12 +312,12 @@ scripts is for compilation which must be done on the target architecture\. .SS See Also .RS 0 .IP \(bu 2 -npm help npm\-run\-script +npm help run\-script .IP \(bu 2 -npm help package\-json +npm help package\.json .IP \(bu 2 npm help developers .IP \(bu 2 -npm help npm\-install +npm help install .RE diff --git a/deps/npm/man/man7/semver.7 b/deps/npm/man/man7/semver.7 index 0db8cda6e1..b65c475f6e 100644 --- a/deps/npm/man/man7/semver.7 +++ b/deps/npm/man/man7/semver.7 @@ -1,6 +1,6 @@ -.TH "NPM" "" "November 2019" "" "" +.TH "SEMVER" "7" "November 2019" "" "" .SH "NAME" -\fBnpm\fR +\fBsemver\fR \- The semantic versioner for npm .SH Install .P .RS 2 |