diff options
Diffstat (limited to 'deps/npm/man/man1/npm-shrinkwrap.1')
| -rw-r--r-- | deps/npm/man/man1/npm-shrinkwrap.1 | 62 |
1 files changed, 31 insertions, 31 deletions
diff --git a/deps/npm/man/man1/npm-shrinkwrap.1 b/deps/npm/man/man1/npm-shrinkwrap.1 index 521634d13..39d910b54 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" "June 2015" "" "" +.TH "NPM\-SHRINKWRAP" "1" "August 2015" "" "" .SH "NAME" \fBnpm-shrinkwrap\fR \- Lock down dependency versions .SH SYNOPSIS @@ -12,18 +12,18 @@ npm shrinkwrap .P This command locks down the versions of a package's dependencies so that you can control exactly which versions of each dependency will be -used when your package is installed\. The \fBpackage\.json\fR file is still -required if you want to use \fBnpm install\fR\|\. +used when your package is installed\. The \fBpackage\.json\fP file is still +required if you want to use \fBnpm install\fP\|\. .P -By default, \fBnpm install\fR recursively installs the target's -dependencies (as specified in \fBpackage\.json\fR), choosing the latest +By default, \fBnpm install\fP recursively installs the target's +dependencies (as specified in \fBpackage\.json\fP), choosing the latest available version that satisfies the dependency's semver pattern\. In some situations, particularly when shipping software where each change is tightly managed, it's desirable to fully specify each version of each dependency recursively so that subsequent builds and deploys do not inadvertently pick up newer versions of a dependency that satisfy the semver pattern\. Specifying specific semver patterns in each -dependency's \fBpackage\.json\fR would facilitate this, but that's not always +dependency's \fBpackage\.json\fP would facilitate this, but that's not always possible or desirable, as when another author owns the npm package\. It's also possible to check dependencies directly into source control, but that may be undesirable for other reasons\. @@ -68,7 +68,7 @@ and package C: .RE .P If these are the only versions of A, B, and C available in the -registry, then a normal \fBnpm install A\fR will install: +registry, then a normal \fBnpm install A\fP will install: .P .RS 2 .nf @@ -78,7 +78,7 @@ A@0\.1\.0 .fi .RE .P -However, if B@0\.0\.2 is published, then a fresh \fBnpm install A\fR will +However, if B@0\.0\.2 is published, then a fresh \fBnpm install A\fP will install: .P .RS 2 @@ -105,7 +105,7 @@ npm shrinkwrap .fi .RE .P -This generates \fBnpm\-shrinkwrap\.json\fR, which will look something like this: +This generates \fBnpm\-shrinkwrap\.json\fP, which will look something like this: .P .RS 2 .nf @@ -127,30 +127,30 @@ This generates \fBnpm\-shrinkwrap\.json\fR, which will look something like this: .RE .P The shrinkwrap command has locked down the dependencies based on -what's currently installed in node_modules\. When \fBnpm install\fR -installs a package with an \fBnpm\-shrinkwrap\.json\fR in the package -root, the shrinkwrap file (rather than \fBpackage\.json\fR files) completely +what's currently installed in node_modules\. When \fBnpm install\fP +installs a package with an \fBnpm\-shrinkwrap\.json\fP in the package +root, the shrinkwrap file (rather than \fBpackage\.json\fP files) completely drives the installation of that package and all of its dependencies (recursively)\. So now the author publishes A@0\.1\.0, and subsequent installs of this package will use B@0\.0\.1 and C@0\.0\.1, regardless the -dependencies and versions listed in A's, B's, and C's \fBpackage\.json\fR +dependencies and versions listed in A's, B's, and C's \fBpackage\.json\fP files\. .SS Using shrinkwrapped packages .P Using a shrinkwrapped package is no different than using any other -package: you can \fBnpm install\fR it by hand, or add a dependency to your -\fBpackage\.json\fR file and \fBnpm install\fR it\. +package: you can \fBnpm install\fP it by hand, or add a dependency to your +\fBpackage\.json\fP file and \fBnpm install\fP it\. .SS Building shrinkwrapped packages .P To shrinkwrap an existing package: .RS 0 .IP 1. 3 -Run \fBnpm install\fR in the package root to install the current +Run \fBnpm install\fP in the package root to install the current versions of all dependencies\. .IP 2. 3 Validate that the package works as expected with these versions\. .IP 3. 3 -Run \fBnpm shrinkwrap\fR, add \fBnpm\-shrinkwrap\.json\fR to git, and publish +Run \fBnpm shrinkwrap\fP, add \fBnpm\-shrinkwrap\.json\fP to git, and publish your package\. .RE @@ -158,19 +158,19 @@ your package\. To add or update a dependency in a shrinkwrapped package: .RS 0 .IP 1. 3 -Run \fBnpm install\fR in the package root to install the current +Run \fBnpm install\fP in the package root to install the current versions of all dependencies\. .IP 2. 3 -Add or update dependencies\. \fBnpm install\fR each new or updated -package individually and then update \fBpackage\.json\fR\|\. Note that they +Add or update dependencies\. \fBnpm install\fP each new or updated +package individually and then update \fBpackage\.json\fP\|\. Note that they must be explicitly named in order to be installed: running \fBnpm -install\fR with no arguments will merely reproduce the existing +install\fP with no arguments will merely reproduce the existing shrinkwrap\. .IP 3. 3 Validate that the package works as expected with the new dependencies\. .IP 4. 3 -Run \fBnpm shrinkwrap\fR, commit the new \fBnpm\-shrinkwrap\.json\fR, and +Run \fBnpm shrinkwrap\fP, commit the new \fBnpm\-shrinkwrap\.json\fP, and publish your package\. .RE @@ -179,19 +179,19 @@ You can use npm help outdated to view dependencies with newer versions available\. .SS Other Notes .P -A shrinkwrap file must be consistent with the package's \fBpackage\.json\fR -file\. \fBnpm shrinkwrap\fR will fail if required dependencies are not +A shrinkwrap file must be consistent with the package's \fBpackage\.json\fP +file\. \fBnpm shrinkwrap\fP will fail if required dependencies are not already installed, since that would result in a shrinkwrap that wouldn't actually work\. Similarly, the command will fail if there are -extraneous packages (not referenced by \fBpackage\.json\fR), since that would -indicate that \fBpackage\.json\fR is not correct\. +extraneous packages (not referenced by \fBpackage\.json\fP), since that would +indicate that \fBpackage\.json\fP is not correct\. .P -Since \fBnpm shrinkwrap\fR is intended to lock down your dependencies for -production use, \fBdevDependencies\fR will not be included unless you -explicitly set the \fB\-\-dev\fR flag when you run \fBnpm shrinkwrap\fR\|\. If -installed \fBdevDependencies\fR are excluded, then npm will print a +Since \fBnpm shrinkwrap\fP is intended to lock down your dependencies for +production use, \fBdevDependencies\fP will not be included unless you +explicitly set the \fB\-\-dev\fP flag when you run \fBnpm shrinkwrap\fP\|\. If +installed \fBdevDependencies\fP are excluded, then npm will print a warning\. If you want them to be installed with your module by -default, please consider adding them to \fBdependencies\fR instead\. +default, please consider adding them to \fBdependencies\fP instead\. .P If shrinkwrapped package A depends on shrinkwrapped package B, B's shrinkwrap will not be used as part of the installation of A\. However, |