diff options
Diffstat (limited to 'deps/npm/man')
78 files changed, 731 insertions, 229 deletions
diff --git a/deps/npm/man/man1/npm-README.1 b/deps/npm/man/man1/npm-README.1 index a878813f91..fd188b0c39 100644 --- a/deps/npm/man/man1/npm-README.1 +++ b/deps/npm/man/man1/npm-README.1 @@ -1,4 +1,4 @@ -.TH "NPM" "1" "December 2017" "" "" +.TH "NPM" "1" "May 2018" "" "" .SH "NAME" \fBnpm\fR \- a JavaScript package manager .P @@ -10,9 +10,9 @@ This is just enough info to get you up and running\. Much more info available via \fBnpm help\fP once it's installed\. .SH IMPORTANT .P -\fBYou need node v4 or higher to run this program\.\fR +\fBYou need node v6 or higher to run this program\.\fR .P -To install an old \fBand unsupported\fR version of npm that works on node v0\.12 +To install an old \fBand unsupported\fR version of npm that works on node v5 and prior, clone the git repo and dig through the old tags and branches\. .P \fBnpm is configured to use npm, Inc\.'s public package registry at @@ -162,7 +162,7 @@ https://github\.com/npm/npm/issues Be sure to include \fIall\fR of the output from the npm command that didn't work as expected\. The \fBnpm\-debug\.log\fP file is also helpful to provide\. .P -You can also find npm people in \fB#npm\fP on https://package\.community/ or +You can also find npm people in \fB#npm\fP on https:// or on Twitter \fIhttps://twitter\.com/npm_support\fR\|\. Whoever responds will no doubt tell you to put the output in a gist or email\. .SH SEE ALSO diff --git a/deps/npm/man/man1/npm-access.1 b/deps/npm/man/man1/npm-access.1 index 124fb542ef..58fdf36de1 100644 --- a/deps/npm/man/man1/npm-access.1 +++ b/deps/npm/man/man1/npm-access.1 @@ -1,4 +1,4 @@ -.TH "NPM\-ACCESS" "1" "December 2017" "" "" +.TH "NPM\-ACCESS" "1" "May 2018" "" "" .SH "NAME" \fBnpm-access\fR \- Set access level on published packages .SH SYNOPSIS diff --git a/deps/npm/man/man1/npm-adduser.1 b/deps/npm/man/man1/npm-adduser.1 index 1d0dc7d63f..a8d27d0736 100644 --- a/deps/npm/man/man1/npm-adduser.1 +++ b/deps/npm/man/man1/npm-adduser.1 @@ -1,4 +1,4 @@ -.TH "NPM\-ADDUSER" "1" "December 2017" "" "" +.TH "NPM\-ADDUSER" "1" "May 2018" "" "" .SH "NAME" \fBnpm-adduser\fR \- Add a registry user account .SH SYNOPSIS @@ -31,7 +31,7 @@ your existing record\. .SH CONFIGURATION .SS registry .P -Default: https://registry\.npmjs\.org/ +Default: https:// .P The base URL of the npm package registry\. If \fBscope\fP is also specified, this registry will only be used for packages with that scope\. \fBscope\fP defaults diff --git a/deps/npm/man/man1/npm-audit.1 b/deps/npm/man/man1/npm-audit.1 new file mode 100644 index 0000000000..8a4283d4cf --- /dev/null +++ b/deps/npm/man/man1/npm-audit.1 @@ -0,0 +1,132 @@ +.TH "NPM\-AUDIT" "1" "May 2018" "" "" +.SH "NAME" +\fBnpm-audit\fR \- Run a security audit +.SH SYNOPSIS +.P +.RS 2 +.nf +npm audit [\-\-json] +npm audit fix [\-\-force|\-\-package\-lock\-only|\-\-dry\-run|\-\-production|\-\-only=dev] +.fi +.RE +.SH EXAMPLES +.P +Scan your project for vulnerabilities and automatically install any compatible +updates to vulnerable dependencies: +.P +.RS 2 +.nf +$ npm audit fix +.fi +.RE +.P +Run \fBaudit fix\fP without modifying \fBnode_modules\fP, but still updating the +pkglock: +.P +.RS 2 +.nf +$ npm audit fix \-\-package\-lock\-only +.fi +.RE +.P +Skip updating \fBdevDependencies\fP: +.P +.RS 2 +.nf +$ npm audit fix \-\-only=prod +.fi +.RE +.P +Have \fBaudit fix\fP install semver\-major updates to toplevel dependencies, not just +semver\-compatible ones: +.P +.RS 2 +.nf +$ npm audit fix \-\-force +.fi +.RE +.P +Do a dry run to get an idea of what \fBaudit fix\fP will do, and \fIalso\fR output +install information in JSON format: +.P +.RS 2 +.nf +$ npm audit fix \-\-dry\-run \-\-json +.fi +.RE +.P +Scan your project for vulnerabilities and just show the details, without fixing +anything: +.P +.RS 2 +.nf +$ npm audit +.fi +.RE +.P +Get the detailed audit report in JSON format: +.P +.RS 2 +.nf +$ npm audit \-\-json +.fi +.RE +.SH DESCRIPTION +.P +The audit command submits a description of the dependencies configured in +your project to your default registry and asks for a report of known +vulnerabilities\. The report returned includes instructions on how to act on +this information\. +.P +You can also have npm automatically fix the vulnerabilities by running \fBnpm +audit fix\fP\|\. Note that some vulnerabilities cannot be fixed automatically and +will require manual intervention or review\. Also note that since \fBnpm audit fix\fP +runs a full\-fledged \fBnpm install\fP under the hood, all configs that apply to the +installer will also apply to \fBnpm install\fP \-\- so things like \fBnpm audit fix +\-\-package\-lock\-only\fP will work as expected\. +.SH CONTENT SUBMITTED +.RS 0 +.IP \(bu 2 +npm_version +.IP \(bu 2 +node_version +.IP \(bu 2 +platform +.IP \(bu 2 +node_env +.IP \(bu 2 +A scrubbed version of your package\-lock\.json or npm\-shrinkwrap\.json + +.RE +.SS SCRUBBING +.P +In order to ensure that potentially sensitive information is not included in +the audit data bundle, some dependencies may have their names (and sometimes +versions) replaced with opaque non\-reversible identifiers\. It is done for +the following dependency types: +.RS 0 +.IP \(bu 2 +Any module referencing a scope that is configured for a non\-default +registry has its name scrubbed\. (That is, a scope you did a \fBnpm login \-\-scope=@ourscope\fP for\.) +.IP \(bu 2 +All git dependencies have their names and specifiers scrubbed\. +.IP \(bu 2 +All remote tarball dependencies have their names and specifiers scrubbed\. +.IP \(bu 2 +All local directory and tarball dependencies have their names and specifiers scrubbed\. + +.RE +.P +The non\-reversible identifiers are a sha256 of a session\-specific UUID and the +value being replaced, ensuring a consistent value within the payload that is +different between runs\. +.SH SEE ALSO +.RS 0 +.IP \(bu 2 +npm help install +.IP \(bu 2 +npm help 5 package\-locks +.IP \(bu 2 +npm help 7 config + +.RE diff --git a/deps/npm/man/man1/npm-bin.1 b/deps/npm/man/man1/npm-bin.1 index a146ed8ce2..402d1de096 100644 --- a/deps/npm/man/man1/npm-bin.1 +++ b/deps/npm/man/man1/npm-bin.1 @@ -1,4 +1,4 @@ -.TH "NPM\-BIN" "1" "December 2017" "" "" +.TH "NPM\-BIN" "1" "May 2018" "" "" .SH "NAME" \fBnpm-bin\fR \- Display npm bin folder .SH SYNOPSIS diff --git a/deps/npm/man/man1/npm-bugs.1 b/deps/npm/man/man1/npm-bugs.1 index e4a7489178..c7ee3cb52b 100644 --- a/deps/npm/man/man1/npm-bugs.1 +++ b/deps/npm/man/man1/npm-bugs.1 @@ -1,4 +1,4 @@ -.TH "NPM\-BUGS" "1" "December 2017" "" "" +.TH "NPM\-BUGS" "1" "May 2018" "" "" .SH "NAME" \fBnpm-bugs\fR \- Bugs for a package in a web browser maybe .SH SYNOPSIS @@ -30,7 +30,7 @@ The browser that is called by the \fBnpm bugs\fP command to open websites\. .SS registry .RS 0 .IP \(bu 2 -Default: https://registry\.npmjs\.org/ +Default: https:// .IP \(bu 2 Type: url diff --git a/deps/npm/man/man1/npm-build.1 b/deps/npm/man/man1/npm-build.1 index 6ea78934f1..fe947c9707 100644 --- a/deps/npm/man/man1/npm-build.1 +++ b/deps/npm/man/man1/npm-build.1 @@ -1,4 +1,4 @@ -.TH "NPM\-BUILD" "1" "December 2017" "" "" +.TH "NPM\-BUILD" "1" "May 2018" "" "" .SH "NAME" \fBnpm-build\fR \- Build a package .SH SYNOPSIS diff --git a/deps/npm/man/man1/npm-bundle.1 b/deps/npm/man/man1/npm-bundle.1 index 6eb57d7c10..2730fbf80b 100644 --- a/deps/npm/man/man1/npm-bundle.1 +++ b/deps/npm/man/man1/npm-bundle.1 @@ -1,4 +1,4 @@ -.TH "NPM\-BUNDLE" "1" "December 2017" "" "" +.TH "NPM\-BUNDLE" "1" "May 2018" "" "" .SH "NAME" \fBnpm-bundle\fR \- REMOVED .SH DESCRIPTION diff --git a/deps/npm/man/man1/npm-cache.1 b/deps/npm/man/man1/npm-cache.1 index 133b61730f..9cf603114c 100644 --- a/deps/npm/man/man1/npm-cache.1 +++ b/deps/npm/man/man1/npm-cache.1 @@ -1,4 +1,4 @@ -.TH "NPM\-CACHE" "1" "December 2017" "" "" +.TH "NPM\-CACHE" "1" "May 2018" "" "" .SH "NAME" \fBnpm-cache\fR \- Manipulates packages cache .SH SYNOPSIS @@ -88,9 +88,9 @@ npm help publish .IP \(bu 2 npm help pack .IP \(bu 2 -https://npm\.im/cacache +https:// .IP \(bu 2 -https://npm\.im/pacote +https:// .RE diff --git a/deps/npm/man/man1/npm-ci.1 b/deps/npm/man/man1/npm-ci.1 new file mode 100644 index 0000000000..02d4c07538 --- /dev/null +++ b/deps/npm/man/man1/npm-ci.1 @@ -0,0 +1,76 @@ +.TH "NPM\-CI" "1" "May 2018" "" "" +.SH "NAME" +\fBnpm-ci\fR \- Install a project with a clean slate +.SH SYNOPSIS +.P +.RS 2 +.nf +npm ci +.fi +.RE +.SH EXAMPLE +.P +Make sure you have a package\-lock and an up\-to\-date install: +.P +.RS 2 +.nf +$ cd \./my/npm/project +$ npm install +added 154 packages in 10s +$ ls | grep package\-lock +.fi +.RE +.P +Run \fBnpm ci\fP in that project +.P +.RS 2 +.nf +$ npm ci +added 154 packages in 5s +.fi +.RE +.P +Configure Travis to build using \fBnpm ci\fP instead of \fBnpm install\fP: +.P +.RS 2 +.nf +# \.travis\.yml +install: +\- npm ci +# keep the npm cache around to speed up installs +cache: + directories: + \- "$HOME/\.npm" +.fi +.RE +.SH DESCRIPTION +.P +This command is similar to npm help \fBnpm\-install\fP, except it's meant to be used in +automated environments such as test platforms, continuous integration, and +deployment\. It can be significantly faster than a regular npm install by +skipping certain user\-oriented features\. It is also more strict than a regular +install, which can help catch errors or inconsistencies caused by the +incrementally\-installed local environments of most npm users\. +.P +In short, the main differences between using \fBnpm install\fP and \fBnpm ci\fP are: +.RS 0 +.IP \(bu 2 +The project \fBmust\fR have an existing \fBpackage\-lock\.json\fP or \fBnpm\-shrinkwrap\.json\fP\|\. +.IP \(bu 2 +If dependencies in the package lock do not match those in \fBpackage\.json\fP, \fBnpm ci\fP will exit with an error, instead of updating the package lock\. +.IP \(bu 2 +\fBnpm ci\fP can only install entire projects at a time: individual dependencies cannot be added with this command\. +.IP \(bu 2 +If a \fBnode_modules\fP is already present, it will be automatically removed before \fBnpm ci\fP begins its install\. +.IP \(bu 2 +It will never write to \fBpackage\.json\fP or any of the package\-locks: installs are essentially frozen\. + +.RE +.SH SEE ALSO +.RS 0 +.IP \(bu 2 +npm help install +.IP \(bu 2 +npm help 5 package\-locks + +.RE diff --git a/deps/npm/man/man1/npm-completion.1 b/deps/npm/man/man1/npm-completion.1 index 131cd3f0d6..a26740f617 100644 --- a/deps/npm/man/man1/npm-completion.1 +++ b/deps/npm/man/man1/npm-completion.1 @@ -1,4 +1,4 @@ -.TH "NPM\-COMPLETION" "1" "December 2017" "" "" +.TH "NPM\-COMPLETION" "1" "May 2018" "" "" .SH "NAME" \fBnpm-completion\fR \- Tab Completion for npm .SH SYNOPSIS diff --git a/deps/npm/man/man1/npm-config.1 b/deps/npm/man/man1/npm-config.1 index c284370d3f..228ff1d397 100644 --- a/deps/npm/man/man1/npm-config.1 +++ b/deps/npm/man/man1/npm-config.1 @@ -1,4 +1,4 @@ -.TH "NPM\-CONFIG" "1" "December 2017" "" "" +.TH "NPM\-CONFIG" "1" "May 2018" "" "" .SH "NAME" \fBnpm-config\fR \- Manage the npm configuration files .SH SYNOPSIS diff --git a/deps/npm/man/man1/npm-dedupe.1 b/deps/npm/man/man1/npm-dedupe.1 index c1ccfc6bf2..c4b47d6477 100644 --- a/deps/npm/man/man1/npm-dedupe.1 +++ b/deps/npm/man/man1/npm-dedupe.1 @@ -1,4 +1,4 @@ -.TH "NPM\-DEDUPE" "1" "December 2017" "" "" +.TH "NPM\-DEDUPE" "1" "May 2018" "" "" .SH "NAME" \fBnpm-dedupe\fR \- Reduce duplication .SH SYNOPSIS diff --git a/deps/npm/man/man1/npm-deprecate.1 b/deps/npm/man/man1/npm-deprecate.1 index d50b3eb39a..9bf53cdae4 100644 --- a/deps/npm/man/man1/npm-deprecate.1 +++ b/deps/npm/man/man1/npm-deprecate.1 @@ -1,4 +1,4 @@ -.TH "NPM\-DEPRECATE" "1" "December 2017" "" "" +.TH "NPM\-DEPRECATE" "1" "May 2018" "" "" .SH "NAME" \fBnpm-deprecate\fR \- Deprecate a version of a package .SH SYNOPSIS diff --git a/deps/npm/man/man1/npm-dist-tag.1 b/deps/npm/man/man1/npm-dist-tag.1 index ba49d77fa8..adf8cb1b80 100644 --- a/deps/npm/man/man1/npm-dist-tag.1 +++ b/deps/npm/man/man1/npm-dist-tag.1 @@ -1,4 +1,4 @@ -.TH "NPM\-DIST\-TAG" "1" "December 2017" "" "" +.TH "NPM\-DIST\-TAG" "1" "May 2018" "" "" .SH "NAME" \fBnpm-dist-tag\fR \- Modify package distribution tags .SH SYNOPSIS diff --git a/deps/npm/man/man1/npm-docs.1 b/deps/npm/man/man1/npm-docs.1 index f913d4ee51..66ef57a79e 100644 --- a/deps/npm/man/man1/npm-docs.1 +++ b/deps/npm/man/man1/npm-docs.1 @@ -1,4 +1,4 @@ -.TH "NPM\-DOCS" "1" "December 2017" "" "" +.TH "NPM\-DOCS" "1" "May 2018" "" "" .SH "NAME" \fBnpm-docs\fR \- Docs for a package in a web browser maybe .SH SYNOPSIS @@ -32,7 +32,7 @@ The browser that is called by the \fBnpm docs\fP command to open websites\. .SS registry .RS 0 .IP \(bu 2 -Default: https://registry\.npmjs\.org/ +Default: https:// .IP \(bu 2 Type: url diff --git a/deps/npm/man/man1/npm-doctor.1 b/deps/npm/man/man1/npm-doctor.1 index 649b81f2e7..fe8a185f42 100644 --- a/deps/npm/man/man1/npm-doctor.1 +++ b/deps/npm/man/man1/npm-doctor.1 @@ -1,4 +1,4 @@ -.TH "NPM\-DOCTOR" "1" "December 2017" "" "" +.TH "NPM\-DOCTOR" "1" "May 2018" "" "" .SH "NAME" \fBnpm-doctor\fR \- Check your environments .SH SYNOPSIS diff --git a/deps/npm/man/man1/npm-edit.1 b/deps/npm/man/man1/npm-edit.1 index 96275a8d9a..c3c0d8ad62 100644 --- a/deps/npm/man/man1/npm-edit.1 +++ b/deps/npm/man/man1/npm-edit.1 @@ -1,4 +1,4 @@ -.TH "NPM\-EDIT" "1" "December 2017" "" "" +.TH "NPM\-EDIT" "1" "May 2018" "" "" .SH "NAME" \fBnpm-edit\fR \- Edit an installed package .SH SYNOPSIS diff --git a/deps/npm/man/man1/npm-explore.1 b/deps/npm/man/man1/npm-explore.1 index 9ed823aeef..bda151d67a 100644 --- a/deps/npm/man/man1/npm-explore.1 +++ b/deps/npm/man/man1/npm-explore.1 @@ -1,4 +1,4 @@ -.TH "NPM\-EXPLORE" "1" "December 2017" "" "" +.TH "NPM\-EXPLORE" "1" "May 2018" "" "" .SH "NAME" \fBnpm-explore\fR \- Browse an installed package .SH SYNOPSIS diff --git a/deps/npm/man/man1/npm-help-search.1 b/deps/npm/man/man1/npm-help-search.1 index 4252dff698..e31049e657 100644 --- a/deps/npm/man/man1/npm-help-search.1 +++ b/deps/npm/man/man1/npm-help-search.1 @@ -1,4 +1,4 @@ -.TH "NPM\-HELP\-SEARCH" "1" "December 2017" "" "" +.TH "NPM\-HELP\-SEARCH" "1" "May 2018" "" "" .SH "NAME" \fBnpm-help-search\fR \- Search npm help documentation .SH SYNOPSIS diff --git a/deps/npm/man/man1/npm-help.1 b/deps/npm/man/man1/npm-help.1 index dea51fb5dc..bfdf384a5b 100644 --- a/deps/npm/man/man1/npm-help.1 +++ b/deps/npm/man/man1/npm-help.1 @@ -1,4 +1,4 @@ -.TH "NPM\-HELP" "1" "December 2017" "" "" +.TH "NPM\-HELP" "1" "May 2018" "" "" .SH "NAME" \fBnpm-help\fR \- Get help on npm .SH SYNOPSIS diff --git a/deps/npm/man/man1/npm-hook.1 b/deps/npm/man/man1/npm-hook.1 new file mode 100644 index 0000000000..c4844c5a53 --- /dev/null +++ b/deps/npm/man/man1/npm-hook.1 @@ -0,0 +1,97 @@ +.TH "NPM\-HOOK" "1" "May 2018" "" "" +.SH "NAME" +\fBnpm-hook\fR \- Manage registry hooks +.SH SYNOPSIS +.P +.RS 2 +.nf +npm hook ls [pkg] +npm hook add <entity> <url> <secret> +npm hook update <id> <url> [secret] +npm hook rm <id> +.fi +.RE +.SH EXAMPLE +.P +Add a hook to watch a package for changes: +.P +.RS 2 +.nf +$ npm hook add lodash https://example\.com/ my\-shared\-secret +.fi +.RE +.P +Add a hook to watch packages belonging to the user \fBsubstack\fP: +.P +.RS 2 +.nf +$ npm hook add ~substack https://example\.com/ my\-shared\-secret +.fi +.RE +.P +Add a hook to watch packages in the scope \fB@npm\fP +.P +.RS 2 +.nf +$ npm hook add @npm https://example\.com/ my\-shared\-secret +.fi +.RE +.P +List all your active hooks: +.P +.RS 2 +.nf +$ npm hook ls +.fi +.RE +.P +List your active hooks for the \fBlodash\fP package: +.P +.RS 2 +.nf +$ npm hook ls lodash +.fi +.RE +.P +Update an existing hook's url: +.P +.RS 2 +.nf +$ npm hook update id\-deadbeef https://my\-new\-website\.here/ +.fi +.RE +.P +Remove a hook: +.P +.RS 2 +.nf +$ npm hook rm id\-deadbeef +.fi +.RE +.SH DESCRIPTION +.P +Allows you to manage npm +hooks \fIhttp://blog\.npmjs\.org/post/145260155635/introducing\-hooks\-get\-notifications\-of\-npm\fR, +including adding, removing, listing, and updating\. +.P +Hooks allow you to configure URL endpoints that will be notified whenever a +change happens to any of the supported entity types\. Three different types of +entities can be watched by hooks: packages, owners, and scopes\. +.P +To create a package hook, simply reference the package name\. +.P +To create an owner hook, prefix the owner name with \fB~\fP (as in, \fB~youruser\fP)\. +.P +To create a scope hook, prefix the scope name with \fB@\fP (as in, \fB@yourscope\fP)\. +.P +The hook \fBid\fP used by \fBupdate\fP and \fBrm\fP are the IDs listed in \fBnpm hook ls\fP for +that particular hook\. +.P +The shared secret will be sent along to the URL endpoint so you can verify the +request came from your own configured hook\. +.SH SEE ALSO +.RS 0 +.IP \(bu 2 +"Introducing Hooks" blog post \fIhttp://blog\.npmjs\.org/post/145260155635/introducing\-hooks\-get\-notifications\-of\-npm\fR + +.RE diff --git a/deps/npm/man/man1/npm-init.1 b/deps/npm/man/man1/npm-init.1 index 3395281ac7..91562d6421 100644 --- a/deps/npm/man/man1/npm-init.1 +++ b/deps/npm/man/man1/npm-init.1 @@ -1,39 +1,81 @@ -.TH "NPM\-INIT" "1" "December 2017" "" "" +.TH "NPM\-INIT" "1" "May 2018" "" "" .SH "NAME" -\fBnpm-init\fR \- Interactively create a package\.json file +\fBnpm-init\fR \- create a package\.json file .SH SYNOPSIS .P .RS 2 .nf -npm init [\-f|\-\-force|\-y|\-\-yes] +npm init [\-\-force|\-f|\-\-yes|\-y|\-\-scope] +npm init <@scope> (same as `npx <@scope>/create`) +npm init [<@scope>/]<name> (same as `npx [<@scope>/]create\-<name>`) +.fi +.RE +.SH EXAMPLES +.P +Create a new React\-based project using \fBcreate\-react\-app\fP \fIhttps://npm\.im/create\-react\-app\fR: +.P +.RS 2 +.nf +$ npm init react\-app \./my\-react\-app +.fi +.RE +.P +Create a new \fBesm\fP\-compatible package using \fBcreate\-esm\fP \fIhttps://npm\.im/create\-esm\fR: +.P +.RS 2 +.nf +$ mkdir my\-esm\-lib && cd my\-esm\-lib +$ npm init esm \-\-yes .fi .RE -.SH DESCRIPTION .P -This will ask you a bunch of questions, and then write a package\.json for you\. +Generate a plain old package\.json using legacy init: .P -It attempts to make reasonable guesses about what you want things to be set to, -and then writes a package\.json file with the options you've selected\. +.RS 2 +.nf +$ mkdir my\-npm\-pkg && cd my\-npm\-pkg +$ git init +$ npm init +.fi +.RE .P -If you already have a package\.json file, it'll read that first, and default to -the options in there\. +Generate it without having it ask any questions: .P -It is strictly additive, so it does not delete options from your package\.json -without a really good reason to do so\. +.RS 2 +.nf +$ npm init \-y +.fi +.RE +.SH DESCRIPTION +.P +\fBnpm init <initializer>\fP can be used to set up a new or existing npm package\. .P -If you invoke it with \fB\-f\fP, \fB\-\-force\fP, \fB\-y\fP, or \fB\-\-yes\fP, it will use only -defaults and not prompt you for any options\. -.SH CONFIGURATION -.SS scope +\fBinitializer\fP in this case is an npm package named \fBcreate\-<initializer>\fP, which +will be installed by npm help \fBnpx\fP \fIhttps://npm\.im/npx\fR, and then have its main bin +executed \-\- presumably creating or updating \fBpackage\.json\fP and running any other +initialization\-related operations\. +.P +The init command is transformed to a corresponding \fBnpx\fP operation as follows: .RS 0 .IP \(bu 2 -Default: none +\fBnpm init foo\fP \-> \fBnpx create\-foo\fP +.IP \(bu 2 +\fBnpm init @usr/foo\fP \-> \fBnpx @usr/create\-foo\fP .IP \(bu 2 -Type: String +\fBnpm init @usr\fP \-> \fBnpx @usr/create\fP .RE .P -The scope under which the new module should be created\. +Any additional options will be passed directly to the command, so \fBnpm init foo +\-\-hello\fP will map to \fBnpx create\-foo \-\-hello\fP\|\. +.P +If the initializer is omitted (by just calling \fBnpm init\fP), init will fall back +to legacy init behavior\. It will ask you a bunch of questions, and then write a +package\.json for you\. It will attempt to make reasonable guesses based on +existing fields, dependencies, and options selected\. It is strictly additive, so +it will keep any fields and values that were already set\. You can also use +\fB\-y\fP/\fB\-\-yes\fP to skip the questionnaire altogether\. If you pass \fB\-\-scope\fP, it +will create a scoped package\. .SH SEE ALSO .RS 0 .IP \(bu 2 diff --git a/deps/npm/man/man1/npm-install-ci-test.1 b/deps/npm/man/man1/npm-install-ci-test.1 new file mode 100644 index 0000000000..29171fe5c6 --- /dev/null +++ b/deps/npm/man/man1/npm-install-ci-test.1 @@ -0,0 +1,23 @@ +.TH "NPM" "" "May 2018" "" "" +.SH "NAME" +\fBnpm\fR +.SH SYNOPSIS +.P +.RS 2 +.nf +npm install\-ci\-test + +alias: npm cit +.fi +.RE +.SH DESCRIPTION +.P +This command runs an \fBnpm ci\fP followed immediately by an \fBnpm test\fP\|\. +.SH SEE ALSO +.RS 0 +.IP \(bu 2 +npm help ci +.IP \(bu 2 +npm help test + +.RE diff --git a/deps/npm/man/man1/npm-install-test.1 b/deps/npm/man/man1/npm-install-test.1 index 34a306b520..2aef6db229 100644 --- a/deps/npm/man/man1/npm-install-test.1 +++ b/deps/npm/man/man1/npm-install-test.1 @@ -1,4 +1,4 @@ -.TH "NPM" "" "December 2017" "" "" +.TH "NPM" "" "May 2018" "" "" .SH "NAME" \fBnpm\fR .SH SYNOPSIS diff --git a/deps/npm/man/man1/npm-install.1 b/deps/npm/man/man1/npm-install.1 index bdbc6794c9..cd5dc40941 100644 --- a/deps/npm/man/man1/npm-install.1 +++ b/deps/npm/man/man1/npm-install.1 @@ -1,4 +1,4 @@ -.TH "NPM\-INSTALL" "1" "December 2017" "" "" +.TH "NPM\-INSTALL" "1" "May 2018" "" "" .SH "NAME" \fBnpm-install\fR \- Install a package .SH SYNOPSIS @@ -62,6 +62,11 @@ after packing it up into a tarball (b)\. With the \fB\-\-production\fP flag (or when the \fBNODE_ENV\fP environment variable is set to \fBproduction\fP), npm will not install modules listed in \fBdevDependencies\fP\|\. +.QP +NOTE: The \fB\-\-production\fP flag has no particular meaning when adding a + dependency to a project\. + +. .IP \(bu 2 \fBnpm install <folder>\fP: Install the package in the directory as a symlink in the current project\. @@ -397,7 +402,8 @@ The \fB\-\-no\-shrinkwrap\fP argument, which will ignore an available package lock or shrinkwrap file and use the package\.json instead\. .P The \fB\-\-no\-package\-lock\fP argument will prevent npm from creating a -\fBpackage\-lock\.json\fP file\. +\fBpackage\-lock\.json\fP file\. When running with package\-lock's disabled npm +will not automatically prune your node modules when installing\. .P The \fB\-\-nodedir=/path/to/node/source\fP argument will allow npm to find the node source code so that npm can compile native modules\. @@ -405,6 +411,9 @@ node source code so that npm can compile native modules\. The \fB\-\-only={prod[uction]|dev[elopment]}\fP argument will cause either only \fBdevDependencies\fP or only non\-\fBdevDependencies\fP to be installed regardless of the \fBNODE_ENV\fP\|\. .P +The \fB\-\-no\-audit\fP argument can be used to disable sending of audit reports to +the configured registries\. See npm help \fBnpm\-audit\fP for details on what is sent\. +.P See npm help 7 \fBnpm\-config\fP\|\. Many of the configuration params have some effect on installation, since that's most of what npm does\. .SH ALGORITHM @@ -496,6 +505,8 @@ npm help 5 folders .IP \(bu 2 npm help update .IP \(bu 2 +npm help audit +.IP \(bu 2 npm help link .IP \(bu 2 npm help rebuild diff --git a/deps/npm/man/man1/npm-link.1 b/deps/npm/man/man1/npm-link.1 index 471db86d33..218ccadeb3 100644 --- a/deps/npm/man/man1/npm-link.1 +++ b/deps/npm/man/man1/npm-link.1 @@ -1,4 +1,4 @@ -.TH "NPM\-LINK" "1" "December 2017" "" "" +.TH "NPM\-LINK" "1" "May 2018" "" "" .SH "NAME" \fBnpm-link\fR \- Symlink a package folder .SH SYNOPSIS diff --git a/deps/npm/man/man1/npm-logout.1 b/deps/npm/man/man1/npm-logout.1 index fab4c6c135..c0e282b053 100644 --- a/deps/npm/man/man1/npm-logout.1 +++ b/deps/npm/man/man1/npm-logout.1 @@ -1,4 +1,4 @@ -.TH "NPM\-LOGOUT" "1" "December 2017" "" "" +.TH "NPM\-LOGOUT" "1" "May 2018" "" "" .SH "NAME" \fBnpm-logout\fR \- Log out of the registry .SH SYNOPSIS @@ -23,7 +23,7 @@ connected to that scope, if set\. .SH CONFIGURATION .SS registry .P -Default: https://registry\.npmjs\.org/ +Default: https:// .P The base URL of the npm package registry\. If \fBscope\fP is also specified, it takes precedence\. diff --git a/deps/npm/man/man1/npm-ls.1 b/deps/npm/man/man1/npm-ls.1 index c28056f2d0..5c9a3578d0 100644 --- a/deps/npm/man/man1/npm-ls.1 +++ b/deps/npm/man/man1/npm-ls.1 @@ -1,4 +1,4 @@ -.TH "NPM\-LS" "1" "December 2017" "" "" +.TH "NPM\-LS" "1" "May 2018" "" "" .SH "NAME" \fBnpm-ls\fR \- List installed packages .SH SYNOPSIS @@ -22,7 +22,7 @@ For example, running \fBnpm ls promzard\fP in npm's source tree will show: .P .RS 2 .nf -npm@5.6.0 /path/to/npm +npm@6.1.0 /path/to/npm └─┬ init\-package\-json@0\.0\.4 └── promzard@0\.1\.5 .fi @@ -98,7 +98,7 @@ Default: false .RE .P Display only the dependency tree for packages in \fBdependencies\fP\|\. -.SS dev +.SS dev / development .RS 0 .IP \(bu 2 Type: Boolean diff --git a/deps/npm/man/man1/npm-outdated.1 b/deps/npm/man/man1/npm-outdated.1 index e301f08e44..8938e45db6 100644 --- a/deps/npm/man/man1/npm-outdated.1 +++ b/deps/npm/man/man1/npm-outdated.1 @@ -1,4 +1,4 @@ -.TH "NPM\-OUTDATED" "1" "December 2017" "" "" +.TH "NPM\-OUTDATED" "1" "May 2018" "" "" .SH "NAME" \fBnpm-outdated\fR \- Check for outdated packages .SH SYNOPSIS @@ -34,6 +34,10 @@ always be seeing only top\-level dependencies that are outdated\. \fBpackage type\fP (when using \fB\-\-long\fP / \fB\-l\fP) tells you whether this package is a \fBdependency\fP or a \fBdevDependency\fP\|\. Packages not included in \fBpackage\.json\fP are always marked \fBdependencies\fP\|\. +.IP \(bu 2 +Red means there's a newer version matching your semver requirements, so you should update now\. +.IP \(bu 2 +Yellow indicates that there's a newer version above your semver requirements (usually new major, or new 0\.x minor) so proceed with caution\. .RE .SS An example @@ -75,10 +79,9 @@ something immutable, like a commit SHA), or it might not, so \fBnpm outdated\fP \fBnpm update\fP have to fetch Git repos to check\. This is why currently doing a reinstall of a Git dependency always forces a new clone and install\. .IP \(bu 2 -\fBnpm@3\.5\.2\fP is marked as "wanted", but "latest" is \fBnpm@3\.5\.1\fP because npm -uses dist\-tags to manage its \fBlatest\fP and \fBnext\fP release channels\. \fBnpm update\fP -will install the \fInewest\fR version, but \fBnpm install npm\fP (with no semver range) -will install whatever's tagged as \fBlatest\fP\|\. +\fBis marked as "wanted", but "latest" is\fP\fBbecause npm +uses dist\-tags to manage its\fPlatest\fBand\fPnext\fBrelease channels\.\fPnpm update\fBwill install the _newest_ version, but\fPnpm install npm\fB(with no semver range) +will install whatever's tagged as\fPlatest`\. .IP \(bu 2 \fBonce\fP is just plain out of date\. Reinstalling \fBnode_modules\fP from scratch or running \fBnpm update\fP will bring it up to spec\. diff --git a/deps/npm/man/man1/npm-owner.1 b/deps/npm/man/man1/npm-owner.1 index 8e0617d6e7..6c910db02b 100644 --- a/deps/npm/man/man1/npm-owner.1 +++ b/deps/npm/man/man1/npm-owner.1 @@ -1,4 +1,4 @@ -.TH "NPM\-OWNER" "1" "December 2017" "" "" +.TH "NPM\-OWNER" "1" "May 2018" "" "" .SH "NAME" \fBnpm-owner\fR \- Manage package owners .SH SYNOPSIS diff --git a/deps/npm/man/man1/npm-pack.1 b/deps/npm/man/man1/npm-pack.1 index 633ceac020..b2a23ec1f9 100644 --- a/deps/npm/man/man1/npm-pack.1 +++ b/deps/npm/man/man1/npm-pack.1 @@ -1,4 +1,4 @@ -.TH "NPM\-PACK" "1" "December 2017" "" "" +.TH "NPM\-PACK" "1" "May 2018" "" "" .SH "NAME" \fBnpm-pack\fR \- Create a tarball from a package .SH SYNOPSIS diff --git a/deps/npm/man/man1/npm-ping.1 b/deps/npm/man/man1/npm-ping.1 index 3c5a3ed999..3d861b66fd 100644 --- a/deps/npm/man/man1/npm-ping.1 +++ b/deps/npm/man/man1/npm-ping.1 @@ -1,4 +1,4 @@ -.TH "NPM\-PING" "1" "December 2017" "" "" +.TH "NPM\-PING" "1" "May 2018" "" "" .SH "NAME" \fBnpm-ping\fR \- Ping npm registry .SH SYNOPSIS diff --git a/deps/npm/man/man1/npm-prefix.1 b/deps/npm/man/man1/npm-prefix.1 index f69b65b9ca..9243d892c2 100644 --- a/deps/npm/man/man1/npm-prefix.1 +++ b/deps/npm/man/man1/npm-prefix.1 @@ -1,4 +1,4 @@ -.TH "NPM\-PREFIX" "1" "December 2017" "" "" +.TH "NPM\-PREFIX" "1" "May 2018" "" "" .SH "NAME" \fBnpm-prefix\fR \- Display prefix .SH SYNOPSIS diff --git a/deps/npm/man/man1/npm-profile.1 b/deps/npm/man/man1/npm-profile.1 index 37252a530e..0bf0ba4464 100644 --- a/deps/npm/man/man1/npm-profile.1 +++ b/deps/npm/man/man1/npm-profile.1 @@ -1,4 +1,4 @@ -.TH "NPM\-PROFILE" "1" "December 2017" "" "" +.TH "NPM\-PROFILE" "1" "May 2018" "" "" .SH "NAME" \fBnpm-profile\fR \- Change settings on your registry profile .SH SYNOPSIS diff --git a/deps/npm/man/man1/npm-prune.1 b/deps/npm/man/man1/npm-prune.1 index f84d2e41ec..7b0a438ed7 100644 --- a/deps/npm/man/man1/npm-prune.1 +++ b/deps/npm/man/man1/npm-prune.1 @@ -1,11 +1,11 @@ -.TH "NPM\-PRUNE" "1" "December 2017" "" "" +.TH "NPM\-PRUNE" "1" "May 2018" "" "" .SH "NAME" \fBnpm-prune\fR \- Remove extraneous packages .SH SYNOPSIS .P .RS 2 .nf -npm prune [[<@scope>/]<pkg>\.\.\.] [\-\-production] +npm prune [[<@scope>/]<pkg>\.\.\.] [\-\-production] [\-\-dry\-run] [\-\-json] .fi .RE .SH DESCRIPTION @@ -19,8 +19,20 @@ package's dependencies list\. .P If the \fB\-\-production\fP flag is specified or the \fBNODE_ENV\fP environment variable is set to \fBproduction\fP, this command will remove the packages -specified in your \fBdevDependencies\fP\|\. Setting \fB\-\-production=false\fP will +specified in your \fBdevDependencies\fP\|\. Setting \fB\-\-no\-production\fP will negate \fBNODE_ENV\fP being set to \fBproduction\fP\|\. +.P +If the \fB\-\-dry\-run\fP flag is used then no changes will actually be made\. +.P +If the \fB\-\-json\fP flag is used then the changes \fBnpm prune\fP made (or would +have made with \fB\-\-dry\-run\fP) are printed as a JSON object\. +.P +In normal operation with package\-locks enabled, extraneous modules are +pruned automatically when modules are installed and you'll only need +this command with the \fB\-\-production\fP flag\. +.P +If you've disabled package\-locks then extraneous modules will not be removed +and it's up to you to run \fBnpm prune\fP from time\-to\-time to remove them\. .SH SEE ALSO .RS 0 .IP \(bu 2 diff --git a/deps/npm/man/man1/npm-publish.1 b/deps/npm/man/man1/npm-publish.1 index 2764e9e4c4..536ca1fe07 100644 --- a/deps/npm/man/man1/npm-publish.1 +++ b/deps/npm/man/man1/npm-publish.1 @@ -1,4 +1,4 @@ -.TH "NPM\-PUBLISH" "1" "December 2017" "" "" +.TH "NPM\-PUBLISH" "1" "May 2018" "" "" .SH "NAME" \fBnpm-publish\fR \- Publish a package .SH SYNOPSIS diff --git a/deps/npm/man/man1/npm-rebuild.1 b/deps/npm/man/man1/npm-rebuild.1 index ab2b80391a..29b14b4ce1 100644 --- a/deps/npm/man/man1/npm-rebuild.1 +++ b/deps/npm/man/man1/npm-rebuild.1 @@ -1,4 +1,4 @@ -.TH "NPM\-REBUILD" "1" "December 2017" "" "" +.TH "NPM\-REBUILD" "1" "May 2018" "" "" .SH "NAME" \fBnpm-rebuild\fR \- Rebuild a package .SH SYNOPSIS diff --git a/deps/npm/man/man1/npm-repo.1 b/deps/npm/man/man1/npm-repo.1 index 85b22ead2d..bd09d42531 100644 --- a/deps/npm/man/man1/npm-repo.1 +++ b/deps/npm/man/man1/npm-repo.1 @@ -1,4 +1,4 @@ -.TH "NPM\-REPO" "1" "December 2017" "" "" +.TH "NPM\-REPO" "1" "May 2018" "" "" .SH "NAME" \fBnpm-repo\fR \- Open package repository page in the browser .SH SYNOPSIS diff --git a/deps/npm/man/man1/npm-restart.1 b/deps/npm/man/man1/npm-restart.1 index b269a5fb75..cd564b0b11 100644 --- a/deps/npm/man/man1/npm-restart.1 +++ b/deps/npm/man/man1/npm-restart.1 @@ -1,4 +1,4 @@ -.TH "NPM\-RESTART" "1" "December 2017" "" "" +.TH "NPM\-RESTART" "1" "May 2018" "" "" .SH "NAME" \fBnpm-restart\fR \- Restart a package .SH SYNOPSIS diff --git a/deps/npm/man/man1/npm-root.1 b/deps/npm/man/man1/npm-root.1 index 63901eef3c..623e947741 100644 --- a/deps/npm/man/man1/npm-root.1 +++ b/deps/npm/man/man1/npm-root.1 @@ -1,4 +1,4 @@ -.TH "NPM\-ROOT" "1" "December 2017" "" "" +.TH "NPM\-ROOT" "1" "May 2018" "" "" .SH "NAME" \fBnpm-root\fR \- Display npm root .SH SYNOPSIS diff --git a/deps/npm/man/man1/npm-run-script.1 b/deps/npm/man/man1/npm-run-script.1 index 2cdde2a46c..8b124e91e5 100644 --- a/deps/npm/man/man1/npm-run-script.1 +++ b/deps/npm/man/man1/npm-run-script.1 @@ -1,4 +1,4 @@ -.TH "NPM\-RUN\-SCRIPT" "1" "December 2017" "" "" +.TH "NPM\-RUN\-SCRIPT" "1" "May 2018" "" "" .SH "NAME" \fBnpm-run-script\fR \- Run arbitrary package scripts .SH SYNOPSIS @@ -18,7 +18,7 @@ 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 +As of ` \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: @@ -62,7 +62,7 @@ to run your tests\. The actual shell your script is run within is platform dependent\. By default, on Unix\-like systems it is the \fB/bin/sh\fP command, on Windows it is the \fBcmd\.exe\fP\|\. The actual shell referred to by \fB/bin/sh\fP also depends on the system\. -As of \fBnpm@5\.1\.0\fP \fIhttps://github\.com/npm/npm/releases/tag/v5\.1\.0\fR you can +As of ` \fIhttps://github\.com/npm/npm/releases/tag/v5\.1\.0\fR you can customize the shell with the \fBscript\-shell\fP configuration\. .P Scripts are run from the root of the module, regardless of what your current @@ -82,6 +82,10 @@ If you try to run a script without having a \fBnode_modules\fP directory and it you will be given a warning to run \fBnpm install\fP, just in case you've forgotten\. .P You can use the \fB\-\-silent\fP flag to prevent showing \fBnpm ERR!\fP output on error\. +.P +You can use the \fB\-\-if\-present\fP flag to avoid exiting with a non\-zero exit code +when the script is undefined\. This lets you run potentially undefined scripts +without breaking the execution chain\. .SH SEE ALSO .RS 0 .IP \(bu 2 diff --git a/deps/npm/man/man1/npm-search.1 b/deps/npm/man/man1/npm-search.1 index f175c8628c..af6924f0d3 100644 --- a/deps/npm/man/man1/npm-search.1 +++ b/deps/npm/man/man1/npm-search.1 @@ -1,4 +1,4 @@ -.TH "NPM\-SEARCH" "1" "December 2017" "" "" +.TH "NPM\-SEARCH" "1" "May 2018" "" "" .SH "NAME" \fBnpm-search\fR \- Search for packages .SH SYNOPSIS @@ -110,7 +110,7 @@ The age of the cache, in seconds, before another registry request is made\. .SS registry .RS 0 .IP \(bu 2 -Default: https://registry\.npmjs\.org/ +Default: https:// .IP \(bu 2 Type: url diff --git a/deps/npm/man/man1/npm-shrinkwrap.1 b/deps/npm/man/man1/npm-shrinkwrap.1 index 00347defa6..4554851803 100644 --- a/deps/npm/man/man1/npm-shrinkwrap.1 +++ b/deps/npm/man/man1/npm-shrinkwrap.1 @@ -1,4 +1,4 @@ -.TH "NPM\-SHRINKWRAP" "1" "December 2017" "" "" +.TH "NPM\-SHRINKWRAP" "1" "May 2018" "" "" .SH "NAME" \fBnpm-shrinkwrap\fR \- Lock down dependency versions for publication .SH SYNOPSIS diff --git a/deps/npm/man/man1/npm-star.1 b/deps/npm/man/man1/npm-star.1 index 44e5147205..7186e4b596 100644 --- a/deps/npm/man/man1/npm-star.1 +++ b/deps/npm/man/man1/npm-star.1 @@ -1,4 +1,4 @@ -.TH "NPM\-STAR" "1" "December 2017" "" "" +.TH "NPM\-STAR" "1" "May 2018" "" "" .SH "NAME" \fBnpm-star\fR \- Mark your favorite packages .SH SYNOPSIS diff --git a/deps/npm/man/man1/npm-stars.1 b/deps/npm/man/man1/npm-stars.1 index c5a7de3cc3..a28881489c 100644 --- a/deps/npm/man/man1/npm-stars.1 +++ b/deps/npm/man/man1/npm-stars.1 @@ -1,4 +1,4 @@ -.TH "NPM\-STARS" "1" "December 2017" "" "" +.TH "NPM\-STARS" "1" "May 2018" "" "" .SH "NAME" \fBnpm-stars\fR \- View packages marked as favorites .SH SYNOPSIS diff --git a/deps/npm/man/man1/npm-start.1 b/deps/npm/man/man1/npm-start.1 index 57b75de5b8..37039b5f66 100644 --- a/deps/npm/man/man1/npm-start.1 +++ b/deps/npm/man/man1/npm-start.1 @@ -1,4 +1,4 @@ -.TH "NPM\-START" "1" "December 2017" "" "" +.TH "NPM\-START" "1" "May 2018" "" "" .SH "NAME" \fBnpm-start\fR \- Start a package .SH SYNOPSIS @@ -14,7 +14,7 @@ This runs an arbitrary command specified in the package's \fB"start"\fP property its \fB"scripts"\fP object\. If no \fB"start"\fP property is specified on the \fB"scripts"\fP object, it will run \fBnode server\.js\fP\|\. .P -As of \fBnpm@2\.0\.0\fP \fIhttp://blog\.npmjs\.org/post/98131109725/npm\-2\-0\-0\fR, you can +As of ` \fIhttp://blog\.npmjs\.org/post/98131109725/npm\-2\-0\-0\fR, you can use custom arguments when executing scripts\. Refer to npm help run\-script for more details\. .SH SEE ALSO diff --git a/deps/npm/man/man1/npm-stop.1 b/deps/npm/man/man1/npm-stop.1 index 674ed9a530..94f2e16800 100644 --- a/deps/npm/man/man1/npm-stop.1 +++ b/deps/npm/man/man1/npm-stop.1 @@ -1,4 +1,4 @@ -.TH "NPM\-STOP" "1" "December 2017" "" "" +.TH "NPM\-STOP" "1" "May 2018" "" "" .SH "NAME" \fBnpm-stop\fR \- Stop a package .SH SYNOPSIS diff --git a/deps/npm/man/man1/npm-team.1 b/deps/npm/man/man1/npm-team.1 index cb75eeeec9..405595ebf7 100644 --- a/deps/npm/man/man1/npm-team.1 +++ b/deps/npm/man/man1/npm-team.1 @@ -1,4 +1,4 @@ -.TH "NPM\-TEAM" "1" "December 2017" "" "" +.TH "NPM\-TEAM" "1" "May 2018" "" "" .SH "NAME" \fBnpm-team\fR \- Manage organization teams and team memberships .SH SYNOPSIS @@ -37,6 +37,9 @@ ls: If performed on an organization name, will return a list of existing teams under that organization\. If performed on a team, it will instead return a list of all users belonging to that particular team\. +.IP \(bu 2 +edit: +Edit a current team\. .RE .SH DETAILS diff --git a/deps/npm/man/man1/npm-test.1 b/deps/npm/man/man1/npm-test.1 index 2b03620434..f345ab2c9a 100644 --- a/deps/npm/man/man1/npm-test.1 +++ b/deps/npm/man/man1/npm-test.1 @@ -1,4 +1,4 @@ -.TH "NPM\-TEST" "1" "December 2017" "" "" +.TH "NPM\-TEST" "1" "May 2018" "" "" .SH "NAME" \fBnpm-test\fR \- Test a package .SH SYNOPSIS diff --git a/deps/npm/man/man1/npm-token.1 b/deps/npm/man/man1/npm-token.1 index 8eb645e9fa..b47fe1da35 100644 --- a/deps/npm/man/man1/npm-token.1 +++ b/deps/npm/man/man1/npm-token.1 @@ -1,4 +1,4 @@ -.TH "NPM\-TOKEN" "1" "December 2017" "" "" +.TH "NPM\-TOKEN" "1" "May 2018" "" "" .SH "NAME" \fBnpm-token\fR \- Manage your authentication tokens .SH SYNOPSIS diff --git a/deps/npm/man/man1/npm-uninstall.1 b/deps/npm/man/man1/npm-uninstall.1 index be83b3f7a8..ade2aa770a 100644 --- a/deps/npm/man/man1/npm-uninstall.1 +++ b/deps/npm/man/man1/npm-uninstall.1 @@ -1,4 +1,4 @@ -.TH "NPM\-UNINSTALL" "1" "December 2017" "" "" +.TH "NPM\-UNINSTALL" "1" "May 2018" "" "" .SH "NAME" \fBnpm-uninstall\fR \- Remove a package .SH SYNOPSIS diff --git a/deps/npm/man/man1/npm-unpublish.1 b/deps/npm/man/man1/npm-unpublish.1 index 224e04f1bb..cd4dd2bcfa 100644 --- a/deps/npm/man/man1/npm-unpublish.1 +++ b/deps/npm/man/man1/npm-unpublish.1 @@ -1,4 +1,4 @@ -.TH "NPM\-UNPUBLISH" "1" "December 2017" "" "" +.TH "NPM\-UNPUBLISH" "1" "May 2018" "" "" .SH "NAME" \fBnpm-unpublish\fR \- Remove a package from the registry .SH SYNOPSIS @@ -32,7 +32,7 @@ package again, a new version number must be used\. With the default registry (\fBregistry\.npmjs\.org\fP), unpublish is only allowed with versions published in the last 24 hours\. If you are trying to unpublish a version published longer ago than that, -contact support@npmjs\.com\. +contact \|\. .P The scope is optional and follows the usual rules for npm help 7 \fBnpm\-scope\fP\|\. .SH SEE ALSO diff --git a/deps/npm/man/man1/npm-update.1 b/deps/npm/man/man1/npm-update.1 index d8ae500df0..70e7d7676c 100644 --- a/deps/npm/man/man1/npm-update.1 +++ b/deps/npm/man/man1/npm-update.1 @@ -1,4 +1,4 @@ -.TH "NPM\-UPDATE" "1" "December 2017" "" "" +.TH "NPM\-UPDATE" "1" "May 2018" "" "" .SH "NAME" \fBnpm-update\fR \- Update a package .SH SYNOPSIS @@ -25,13 +25,17 @@ packages\. If no package name is specified, all packages in the specified location (global or local) will be updated\. .P -As of \fBnpm@2\.6\.1\fP, the \fBnpm update\fP will only inspect top\-level packages\. -Prior versions of \fBnpm\fP would also recursively inspect all dependencies\. -To get the old behavior, use \fBnpm \-\-depth 9999 update\fP\|\. +As of \fB, the\fPnpm update\fBwill only inspect top\-level packages\. +Prior versions of\fPnpm\fBwould also recursively inspect all dependencies\. +To get the old behavior, use\fPnpm \-\-depth 9999 update`\. +.P +As of \fB, the\fPnpm update\fBwill change\fPpackage\.json\fBto save the +new version as the minimum required dependency\. To get the old behavior, +use\fPnpm update \-\-no\-save`\. .SH EXAMPLES .P -IMPORTANT VERSION NOTE: these examples assume \fBnpm@2\.6\.1\fP or later\. For -older versions of \fBnpm\fP, you must specify \fB\-\-depth 0\fP to get the behavior +IMPORTANT VERSION NOTE: these examples assume \fBor later\. For +older versions of\fPnpm\fB, you must specify\fP\-\-depth 0` to get the behavior described below\. .P For the examples below, assume that the current package is \fBapp\fP and it depends @@ -67,8 +71,7 @@ If \fBapp\fP\|'s \fBpackage\.json\fP contains: .fi .RE .P -Then \fBnpm update\fP will install \fBdep1@1\.2\.2\fP, because \fB1\.2\.2\fP is \fBlatest\fP and -\fB1\.2\.2\fP satisfies \fB^1\.1\.1\fP\|\. +Then \fBnpm update\fP will install \fB, because\fP1\.2\.2\fBis\fPlatest\fBand\fP1\.2\.2\fBsatisfies\fP^1\.1\.1`\. .SS Tilde Dependencies .P However, if \fBapp\fP\|'s \fBpackage\.json\fP contains: @@ -81,10 +84,9 @@ However, if \fBapp\fP\|'s \fBpackage\.json\fP contains: .fi .RE .P -In this case, running \fBnpm update\fP will install \fBdep1@1\.1\.2\fP\|\. Even though the \fBlatest\fP -tag points to \fB1\.2\.2\fP, this version does not satisfy \fB~1\.1\.1\fP, which is equivalent -to \fB>=1\.1\.1 <1\.2\.0\fP\|\. So the highest\-sorting version that satisfies \fB~1\.1\.1\fP is used, -which is \fB1\.1\.2\fP\|\. +In this case, running \fBnpm update\fP will install \fB\|\. Even though the\fPlatest\fBtag points to\fP1\.2\.2\fB, this version does not satisfy\fP~1\.1\.1\fB, which is equivalent +to\fP>=1\.1\.1 <1\.2\.0\fB\|\. So the highest\-sorting version that satisfies\fP~1\.1\.1\fBis used, +which is\fP1\.1\.2`\. .SS Caret Dependencies below 1\.0\.0 .P Suppose \fBapp\fP has a caret dependency on a version below \fB1\.0\.0\fP, for example: @@ -97,8 +99,8 @@ Suppose \fBapp\fP has a caret dependency on a version below \fB1\.0\.0\fP, for e .fi .RE .P -\fBnpm update\fP will install \fBdep1@0\.2\.0\fP, because there are no other -versions which satisfy \fB^0\.2\.0\fP\|\. +\fBnpm update\fP will install \fB, because there are no other +versions which satisfy\fP^0\.2\.0`\. .P If the dependence were on \fB^0\.4\.0\fP: .P @@ -110,36 +112,8 @@ If the dependence were on \fB^0\.4\.0\fP: .fi .RE .P -Then \fBnpm update\fP will install \fBdep1@0\.4\.1\fP, because that is the highest\-sorting -version that satisfies \fB^0\.4\.0\fP (\fB>= 0\.4\.0 <0\.5\.0\fP) -.SS Recording Updates with \fB\-\-save\fP -.P -When you want to update a package and save the new version as -the minimum required dependency in \fBpackage\.json\fP, you can use -\fBnpm update \-S\fP or \fBnpm update \-\-save\fP\|\. For example if -\fBpackage\.json\fP contains: -.P -.RS 2 -.nf -"dependencies": { - "dep1": "^1\.1\.1" -} -.fi -.RE -.P -Then \fBnpm update \-\-save\fP will install \fBdep1@1\.2\.2\fP (i\.e\., \fBlatest\fP), -and \fBpackage\.json\fP will be modified: -.P -.RS 2 -.nf -"dependencies": { - "dep1": "^1\.2\.2" -} -.fi -.RE -.P -Note that \fBnpm\fP will only write an updated version to \fBpackage\.json\fP -if it installs a new package\. +Then \fBnpm update\fP will install \fB, because that is the highest\-sorting +version that satisfies\fP^0\.4\.0\fB(\fP>= 0\.4\.0 <0\.5\.0`) .SS Updating Globally\-Installed Packages .P \fBnpm update \-g\fP will apply the \fBupdate\fP action to each globally installed diff --git a/deps/npm/man/man1/npm-version.1 b/deps/npm/man/man1/npm-version.1 index 9601e4f188..c86e8e5d0b 100644 --- a/deps/npm/man/man1/npm-version.1 +++ b/deps/npm/man/man1/npm-version.1 @@ -1,4 +1,4 @@ -.TH "NPM\-VERSION" "1" "December 2017" "" "" +.TH "NPM\-VERSION" "1" "May 2018" "" "" .SH "NAME" \fBnpm-version\fR \- Bump a package version .SH SYNOPSIS @@ -15,7 +15,7 @@ npm version [<newversion> | major | minor | patch | premajor | preminor | prepat .SH DESCRIPTION .P Run this in a package directory to bump the version and write the new -data back to \fBpackage\.json\fP and, if present, \fBnpm\-shrinkwrap\.json\fP\|\. +data back to \fBpackage\.json\fP, \fBpackage\-lock\.json\fP, and, if present, \fBnpm\-shrinkwrap\.json\fP\|\. .P The \fBnewversion\fP argument should be a valid semver string, a valid second argument to semver\.inc \fIhttps://github\.com/npm/node\-semver#functions\fR (one of \fBpatch\fP, \fBminor\fP, \fBmajor\fP, diff --git a/deps/npm/man/man1/npm-view.1 b/deps/npm/man/man1/npm-view.1 index 2c18268271..b17739904f 100644 --- a/deps/npm/man/man1/npm-view.1 +++ b/deps/npm/man/man1/npm-view.1 @@ -1,4 +1,4 @@ -.TH "NPM\-VIEW" "1" "December 2017" "" "" +.TH "NPM\-VIEW" "1" "May 2018" "" "" .SH "NAME" \fBnpm-view\fR \- View registry info .SH SYNOPSIS diff --git a/deps/npm/man/man1/npm-whoami.1 b/deps/npm/man/man1/npm-whoami.1 index 2f096ac2a0..4e375a9ab7 100644 --- a/deps/npm/man/man1/npm-whoami.1 +++ b/deps/npm/man/man1/npm-whoami.1 @@ -1,4 +1,4 @@ -.TH "NPM\-WHOAMI" "1" "December 2017" "" "" +.TH "NPM\-WHOAMI" "1" "May 2018" "" "" .SH "NAME" \fBnpm-whoami\fR \- Display npm username .SH SYNOPSIS diff --git a/deps/npm/man/man1/npm.1 b/deps/npm/man/man1/npm.1 index 42eb296250..c77fae3a3c 100644 --- a/deps/npm/man/man1/npm.1 +++ b/deps/npm/man/man1/npm.1 @@ -1,4 +1,4 @@ -.TH "NPM" "1" "December 2017" "" "" +.TH "NPM" "1" "May 2018" "" "" .SH "NAME" \fBnpm\fR \- javascript package manager .SH SYNOPSIS @@ -10,7 +10,7 @@ npm <command> [args] .RE .SH VERSION .P -5.6.0 +6.1.0 .SH DESCRIPTION .P npm is the package manager for the Node JavaScript platform\. It puts @@ -105,7 +105,7 @@ Command line switches: .br Set a config with \fB\-\-key val\fP\|\. All keys take a value, even if they are booleans (the config parser doesn't know what the options are at -the time of parsing\.) If no value is provided, then the option is set +the time of parsing)\. If no value is provided, then the option is set to boolean \fBtrue\fP\|\. .IP \(bu 2 Environment Variables: @@ -156,7 +156,7 @@ If you would like to contribute, but don't know what to work on, read the contributing guidelines and check the issues list\. .RS 0 .IP \(bu 2 -https://github\.com/npm/npm/wiki/Contributing\-Guidelines +https:// .IP \(bu 2 https://github\.com/npm/npm/issues diff --git a/deps/npm/man/man1/npx.1 b/deps/npm/man/man1/npx.1 index 912effdc3b..d00c489c39 100644 --- a/deps/npm/man/man1/npx.1 +++ b/deps/npm/man/man1/npx.1 @@ -1,4 +1,4 @@ -.TH "NPX" "1" "October 2017" "npx@9.7.0" "User Commands" +.TH "NPX" "1" "April 2018" "npx@10.1.1" "User Commands" .SH "NAME" \fBnpx\fR \- execute npm package binaries .SH SYNOPSIS @@ -101,6 +101,13 @@ $ npx \-\-node\-arg=\-\-inspect cowsay Debugger listening on ws://127\.0\.0\.1:9229/\.\.\.\. .fi .RE +.SS Specify a node version to run npm scripts (or anything else!) +.P +.RS 2 +.nf +npx \-p node@8 npm run build +.fi +.RE .SH SHELL AUTO FALLBACK .P You can configure \fBnpx\fP to run as your default fallback command when you type something in the command line with an \fB@\fP but the command is not found\. This includes installing packages that were not found in the local prefix either\. diff --git a/deps/npm/man/man5/npm-folders.5 b/deps/npm/man/man5/npm-folders.5 index a252685bd0..32abfe6956 100644 --- a/deps/npm/man/man5/npm-folders.5 +++ b/deps/npm/man/man5/npm-folders.5 @@ -1,4 +1,4 @@ -.TH "NPM\-FOLDERS" "5" "December 2017" "" "" +.TH "NPM\-FOLDERS" "5" "May 2018" "" "" .SH "NAME" \fBnpm-folders\fR \- Folder Structures Used by npm .SH DESCRIPTION @@ -69,7 +69,7 @@ Man pages are not installed on Windows systems\. .SS Cache .P See npm help \fBnpm\-cache\fP\|\. Cache files are stored in \fB~/\.npm\fP on Posix, or -\fB~/npm\-cache\fP on Windows\. +\fB%AppData%/npm\-cache\fP on Windows\. .P This is controlled by the \fBcache\fP configuration param\. .SS Temp Files @@ -173,17 +173,17 @@ foo .fi .RE .P -Since foo depends directly on \fBbar@1\.2\.3\fP and \fBbaz@1\.2\.3\fP, those are -installed in foo's \fBnode_modules\fP folder\. +Since foo depends directly on \fBand\fP\fB, those are +installed in foo's\fPnode_modules` folder\. .P Even though the latest copy of blerg is 1\.3\.7, foo has a specific dependency on version 1\.2\.5\. So, that gets installed at [A]\. Since the -parent installation of blerg satisfies bar's dependency on \fBblerg@1\.x\fP, +parent installation of blerg satisfies bar's dependency on `, it does not install another copy under [B]\. .P Bar [B] also has dependencies on baz and asdf, so those are installed in -bar's \fBnode_modules\fP folder\. Because it depends on \fBbaz@2\.x\fP, it cannot -re\-use the \fBbaz@1\.2\.3\fP installed in the parent \fBnode_modules\fP folder [D], +bar's \fBnode_modules\fP folder\. Because it depends on \fB, it cannot +re\-use the\fP\fBinstalled in the parent\fPnode_modules` folder [D], and must install its own copy [C]\. .P Underneath bar, the \fBbaz \-> quux \-> bar\fP dependency creates a cycle\. diff --git a/deps/npm/man/man5/npm-global.5 b/deps/npm/man/man5/npm-global.5 index a252685bd0..32abfe6956 100644 --- a/deps/npm/man/man5/npm-global.5 +++ b/deps/npm/man/man5/npm-global.5 @@ -1,4 +1,4 @@ -.TH "NPM\-FOLDERS" "5" "December 2017" "" "" +.TH "NPM\-FOLDERS" "5" "May 2018" "" "" .SH "NAME" \fBnpm-folders\fR \- Folder Structures Used by npm .SH DESCRIPTION @@ -69,7 +69,7 @@ Man pages are not installed on Windows systems\. .SS Cache .P See npm help \fBnpm\-cache\fP\|\. Cache files are stored in \fB~/\.npm\fP on Posix, or -\fB~/npm\-cache\fP on Windows\. +\fB%AppData%/npm\-cache\fP on Windows\. .P This is controlled by the \fBcache\fP configuration param\. .SS Temp Files @@ -173,17 +173,17 @@ foo .fi .RE .P -Since foo depends directly on \fBbar@1\.2\.3\fP and \fBbaz@1\.2\.3\fP, those are -installed in foo's \fBnode_modules\fP folder\. +Since foo depends directly on \fBand\fP\fB, those are +installed in foo's\fPnode_modules` folder\. .P Even though the latest copy of blerg is 1\.3\.7, foo has a specific dependency on version 1\.2\.5\. So, that gets installed at [A]\. Since the -parent installation of blerg satisfies bar's dependency on \fBblerg@1\.x\fP, +parent installation of blerg satisfies bar's dependency on `, it does not install another copy under [B]\. .P Bar [B] also has dependencies on baz and asdf, so those are installed in -bar's \fBnode_modules\fP folder\. Because it depends on \fBbaz@2\.x\fP, it cannot -re\-use the \fBbaz@1\.2\.3\fP installed in the parent \fBnode_modules\fP folder [D], +bar's \fBnode_modules\fP folder\. Because it depends on \fB, it cannot +re\-use the\fP\fBinstalled in the parent\fPnode_modules` folder [D], and must install its own copy [C]\. .P Underneath bar, the \fBbaz \-> quux \-> bar\fP dependency creates a cycle\. diff --git a/deps/npm/man/man5/npm-json.5 b/deps/npm/man/man5/npm-json.5 index 0a4328f73f..2c24a01ab7 100644 --- a/deps/npm/man/man5/npm-json.5 +++ b/deps/npm/man/man5/npm-json.5 @@ -1,4 +1,4 @@ -.TH "PACKAGE\.JSON" "5" "December 2017" "" "" +.TH "PACKAGE\.JSON" "5" "May 2018" "" "" .SH "NAME" \fBpackage.json\fR \- Specifics of npm's package\.json handling .SH DESCRIPTION @@ -10,11 +10,11 @@ A lot of the behavior described in this document is affected by the config settings described in npm help 7 \fBnpm\-config\fP\|\. .SH name .P -The \fImost\fR important things in your package\.json are the name and version fields\. -Those are actually required, and your package won't install without -them\. The name and version together form an identifier that is assumed -to be completely unique\. Changes to the package should come along with -changes to the version\. +If you plan to publish your package, the \fImost\fR important things in your +package\.json are the name and version fields as they will be required\. The name +and version together form an identifier that is assumed to be completely unique\. +Changes to the package should come along with changes to the version\. If you don't +plan to publish your package, the name and version fields are optional\. .P The name is what your thing is called\. .P @@ -54,11 +54,11 @@ A name can be optionally prefixed by a scope, e\.g\. \fB@myorg/mypackage\fP\|\. npm help 7 \fBnpm\-scope\fP for more detail\. .SH version .P -The \fImost\fR important things in your package\.json are the name and version fields\. -Those are actually required, and your package won't install without -them\. The name and version together form an identifier that is assumed -to be completely unique\. Changes to the package should come along with -changes to the version\. +If you plan to publish your package, the \fImost\fR important things in your +package\.json are the name and version fields as they will be required\. The name +and version together form an identifier that is assumed to be completely unique\. +Changes to the package should come along with changes to the version\. If you don't +plan to publish your package, the name and version fields are optional\. .P Version must be parseable by node\-semver \fIhttps://github\.com/isaacs/node\-semver\fR, which is bundled @@ -76,6 +76,14 @@ discover your package as it's listed in \fBnpm search\fP\|\. .SH homepage .P The url to the project homepage\. +.P +Example: +.P +.RS 2 +.nf +"homepage": "https://github\.com/owner/project#readme" +.fi +.RE .SH bugs .P The url to your project's issue tracker and / or the email address to which @@ -207,13 +215,15 @@ Both email and url are optional either way\. npm also sets a top\-level "maintainers" field with your npm user info\. .SH files .P -The optional "files" field is an array of file patterns that describes +The optional \fBfiles\fP field is an array of file patterns that describes the entries to be included when your package is installed as a -dependency\. If the files array is omitted, everything except -automatically\-excluded files will be included in your publish\. If you -name a folder in the array, then it will also include the files inside -that folder (unless they would be ignored by another rule in this -section\.)\. +dependency\. File patterns follow a similar syntax to \fB\|\.gitignore\fP, but +reversed: including a file, directory, or glob pattern (\fB*\fP, \fB**/*\fP, and such) +will make it so that file is included in the tarball when it's packed\. Omitting +the field will make it default to \fB["*"]\fP, which means it will include all files\. +.P +Some special files and directories are also included or excluded regardless of +whether they exist in the \fBfiles\fP array (see below)\. .P You can also provide a \fB\|\.npmignore\fP file in the root of your package or in subdirectories, which will keep files from being included\. At the @@ -288,6 +298,11 @@ This should be a module ID relative to the root of your package folder\. .P For most modules, it makes the most sense to have a main script and often not much else\. +.SH browser +.P +If your module is meant to be used client\-side the browser field should be +used instead of the main field\. This is helpful to hint users that it might +rely on primitives that aren't available in Node\.js modules\. (e\.g\. \fBwindow\fP) .SH bin .P A lot of packages have one or more executable files that they'd like to @@ -901,8 +916,8 @@ especially handy if you want to set the tag, registry or access, so that you can ensure that a given package is not tagged with "latest", published to the global public registry or that a scoped module is private by default\. .P -Any config values can be overridden, but of course only "tag", "registry" and -"access" probably matter for the purposes of publishing\. +Any config values can be overridden, but only "tag", "registry" and "access" +probably matter for the purposes of publishing\. .P See npm help 7 \fBnpm\-config\fP to see the list of config options that can be overridden\. diff --git a/deps/npm/man/man5/npm-package-locks.5 b/deps/npm/man/man5/npm-package-locks.5 index 241a45d9bb..91f43b921c 100644 --- a/deps/npm/man/man5/npm-package-locks.5 +++ b/deps/npm/man/man5/npm-package-locks.5 @@ -1,4 +1,4 @@ -.TH "NPM\-PACKAGE\-LOCKS" "5" "December 2017" "" "" +.TH "NPM\-PACKAGE\-LOCKS" "5" "May 2018" "" "" .SH "NAME" \fBnpm-package-locks\fR \- An explanation of npm lockfiles .SH DESCRIPTION @@ -71,7 +71,7 @@ A@0\.1\.0 .fi .RE .P -However, if B@0\.0\.2 is published, then a fresh \fBnpm install A\fP will +However, if is published, then a fresh \fBnpm install A\fP will install: .P .RS 2 @@ -85,7 +85,7 @@ A@0\.1\.0 assuming the new version did not modify B's dependencies\. Of course, the new version of B could include a new version of C and any number of new dependencies\. If such changes are undesirable, the author of A -could specify a dependency on B@0\.0\.1\. However, if A's author and B's +could specify a dependency on \|\. However, if A's author and B's author are not the same person, there's no way for A's author to say that he or she does not want to pull in newly published versions of C when B hasn't changed at all\. @@ -167,10 +167,25 @@ package source to get the exact same dependency tree that you were developing on\. Additionally, the diffs from these changes are human\-readable and will inform you of any changes npm has made to your \fBnode_modules\fP, so you can notice if any transitive dependencies were updated, hoisted, etc\. +.SS Resolving lockfile conflicts +.P +Occasionally, two separate npm install will create package locks that cause +merge conflicts in source control systems\. As of \fB, these conflicts +can be resolved by manually fixing any\fPpackage\.json\fBconflicts, and then +running\fPnpm install [\-\-package\-lock\-only]\fBagain\. npm will automatically +resolve any conflicts for you and write a merged package lock that includes all +the dependencies from both branches in a reasonable tree\. If\fP\-\-package\-lock\-only\fBis provided, it will do this without also modifying your +local\fPnode_modules/`\. +.P +To make this process seamless on git, consider installing +\fBnpm\-merge\-driver\fP \fIhttps://npm\.im/npm\-merge\-driver\fR, which will teach git how +to do this itself without any user interaction\. In short: \fB$ npx +npm\-merge\-driver install \-g\fP will let you do this, and even works with +\fBversions of npm 5, albeit a bit more noisily\. Note that if\fPpackage\.json\fBitself conflicts, you will have to resolve that by hand and run\fPnpm install` manually, even with the merge driver\. .SH SEE ALSO .RS 0 .IP \(bu 2 -https://medium\.com/@sdboyer/so\-you\-want\-to\-write\-a\-package\-manager\-4ae9c17d9527 +https:// .IP \(bu 2 npm help 5 package\.json .IP \(bu 2 diff --git a/deps/npm/man/man5/npm-shrinkwrap.json.5 b/deps/npm/man/man5/npm-shrinkwrap.json.5 index a832963dc6..6efde4a7d9 100644 --- a/deps/npm/man/man5/npm-shrinkwrap.json.5 +++ b/deps/npm/man/man5/npm-shrinkwrap.json.5 @@ -1,4 +1,4 @@ -.TH "NPM\-SHRINKWRAP\.JSON" "5" "December 2017" "" "" +.TH "NPM\-SHRINKWRAP\.JSON" "5" "May 2018" "" "" .SH "NAME" \fBnpm-shrinkwrap.json\fR \- A publishable lockfile .SH DESCRIPTION diff --git a/deps/npm/man/man5/npmrc.5 b/deps/npm/man/man5/npmrc.5 index 26d65c2598..d9d90e1465 100644 --- a/deps/npm/man/man5/npmrc.5 +++ b/deps/npm/man/man5/npmrc.5 @@ -1,4 +1,4 @@ -.TH "NPMRC" "5" "December 2017" "" "" +.TH "NPMRC" "5" "May 2018" "" "" .SH "NAME" \fBnpmrc\fR \- The npm config files .SH DESCRIPTION diff --git a/deps/npm/man/man5/package-lock.json.5 b/deps/npm/man/man5/package-lock.json.5 index 0196cc87e6..c67cd1f0cc 100644 --- a/deps/npm/man/man5/package-lock.json.5 +++ b/deps/npm/man/man5/package-lock.json.5 @@ -1,4 +1,4 @@ -.TH "PACKAGE\-LOCK\.JSON" "5" "December 2017" "" "" +.TH "PACKAGE\-LOCK\.JSON" "5" "May 2018" "" "" .SH "NAME" \fBpackage-lock.json\fR \- A manifestation of the manifest .SH DESCRIPTION @@ -127,6 +127,12 @@ transitive dependency of a non\-optional dependency of the top level\. .P All optional dependencies should be included even if they're uninstallable on the current platform\. +.SS requires +.P +This is a mapping of module name to version\. This is a list of everything +this module requires, regardless of where it will be installed\. The version +should match via normal matching rules a dependency either in our +\fBdependencies\fP or in a level higher than us\. .SS dependencies .P The dependencies of this dependency, exactly as at the top level\. @@ -137,6 +143,8 @@ npm help shrinkwrap .IP \(bu 2 npm help 5 shrinkwrap\.json .IP \(bu 2 +npm help 5 package\-locks +.IP \(bu 2 npm help 5 package\.json .IP \(bu 2 npm help install diff --git a/deps/npm/man/man5/package.json.5 b/deps/npm/man/man5/package.json.5 index 0a4328f73f..2c24a01ab7 100644 --- a/deps/npm/man/man5/package.json.5 +++ b/deps/npm/man/man5/package.json.5 @@ -1,4 +1,4 @@ -.TH "PACKAGE\.JSON" "5" "December 2017" "" "" +.TH "PACKAGE\.JSON" "5" "May 2018" "" "" .SH "NAME" \fBpackage.json\fR \- Specifics of npm's package\.json handling .SH DESCRIPTION @@ -10,11 +10,11 @@ A lot of the behavior described in this document is affected by the config settings described in npm help 7 \fBnpm\-config\fP\|\. .SH name .P -The \fImost\fR important things in your package\.json are the name and version fields\. -Those are actually required, and your package won't install without -them\. The name and version together form an identifier that is assumed -to be completely unique\. Changes to the package should come along with -changes to the version\. +If you plan to publish your package, the \fImost\fR important things in your +package\.json are the name and version fields as they will be required\. The name +and version together form an identifier that is assumed to be completely unique\. +Changes to the package should come along with changes to the version\. If you don't +plan to publish your package, the name and version fields are optional\. .P The name is what your thing is called\. .P @@ -54,11 +54,11 @@ A name can be optionally prefixed by a scope, e\.g\. \fB@myorg/mypackage\fP\|\. npm help 7 \fBnpm\-scope\fP for more detail\. .SH version .P -The \fImost\fR important things in your package\.json are the name and version fields\. -Those are actually required, and your package won't install without -them\. The name and version together form an identifier that is assumed -to be completely unique\. Changes to the package should come along with -changes to the version\. +If you plan to publish your package, the \fImost\fR important things in your +package\.json are the name and version fields as they will be required\. The name +and version together form an identifier that is assumed to be completely unique\. +Changes to the package should come along with changes to the version\. If you don't +plan to publish your package, the name and version fields are optional\. .P Version must be parseable by node\-semver \fIhttps://github\.com/isaacs/node\-semver\fR, which is bundled @@ -76,6 +76,14 @@ discover your package as it's listed in \fBnpm search\fP\|\. .SH homepage .P The url to the project homepage\. +.P +Example: +.P +.RS 2 +.nf +"homepage": "https://github\.com/owner/project#readme" +.fi +.RE .SH bugs .P The url to your project's issue tracker and / or the email address to which @@ -207,13 +215,15 @@ Both email and url are optional either way\. npm also sets a top\-level "maintainers" field with your npm user info\. .SH files .P -The optional "files" field is an array of file patterns that describes +The optional \fBfiles\fP field is an array of file patterns that describes the entries to be included when your package is installed as a -dependency\. If the files array is omitted, everything except -automatically\-excluded files will be included in your publish\. If you -name a folder in the array, then it will also include the files inside -that folder (unless they would be ignored by another rule in this -section\.)\. +dependency\. File patterns follow a similar syntax to \fB\|\.gitignore\fP, but +reversed: including a file, directory, or glob pattern (\fB*\fP, \fB**/*\fP, and such) +will make it so that file is included in the tarball when it's packed\. Omitting +the field will make it default to \fB["*"]\fP, which means it will include all files\. +.P +Some special files and directories are also included or excluded regardless of +whether they exist in the \fBfiles\fP array (see below)\. .P You can also provide a \fB\|\.npmignore\fP file in the root of your package or in subdirectories, which will keep files from being included\. At the @@ -288,6 +298,11 @@ This should be a module ID relative to the root of your package folder\. .P For most modules, it makes the most sense to have a main script and often not much else\. +.SH browser +.P +If your module is meant to be used client\-side the browser field should be +used instead of the main field\. This is helpful to hint users that it might +rely on primitives that aren't available in Node\.js modules\. (e\.g\. \fBwindow\fP) .SH bin .P A lot of packages have one or more executable files that they'd like to @@ -901,8 +916,8 @@ especially handy if you want to set the tag, registry or access, so that you can ensure that a given package is not tagged with "latest", published to the global public registry or that a scoped module is private by default\. .P -Any config values can be overridden, but of course only "tag", "registry" and -"access" probably matter for the purposes of publishing\. +Any config values can be overridden, but only "tag", "registry" and "access" +probably matter for the purposes of publishing\. .P See npm help 7 \fBnpm\-config\fP to see the list of config options that can be overridden\. 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)\. |