diff options
Diffstat (limited to 'deps/npm/html/doc/cli/npm-shrinkwrap.html')
| -rw-r--r-- | deps/npm/html/doc/cli/npm-shrinkwrap.html | 32 |
1 files changed, 16 insertions, 16 deletions
diff --git a/deps/npm/html/doc/cli/npm-shrinkwrap.html b/deps/npm/html/doc/cli/npm-shrinkwrap.html index e997a2cbe..9e2783e54 100644 --- a/deps/npm/html/doc/cli/npm-shrinkwrap.html +++ b/deps/npm/html/doc/cli/npm-shrinkwrap.html @@ -15,9 +15,9 @@ </code></pre><h2 id="description">DESCRIPTION</h2> <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 "package.json" file is still -required if you want to use "npm install".</p> -<p>By default, "npm install" recursively installs the target's +used when your package is installed. The <code>package.json</code> file is still +required if you want to use <code>npm install</code>.</p> +<p>By default, <code>npm install</code> recursively installs the target's dependencies (as specified in package.json), choosing the latest available version that satisfies the dependency's semver pattern. In some situations, particularly when shipping software where each change @@ -51,11 +51,11 @@ but that may be undesirable for other reasons.</p> "version": "0.0.1" } </code></pre><p>If these are the only versions of A, B, and C available in the -registry, then a normal "npm install A" will install:</p> +registry, then a normal <code>npm install A</code> will install:</p> <pre><code>A@0.1.0 `-- B@0.0.1 `-- C@0.0.1 -</code></pre><p>However, if B@0.0.2 is published, then a fresh "npm install A" will +</code></pre><p>However, if B@0.0.2 is published, then a fresh <code>npm install A</code> will install:</p> <pre><code>A@0.1.0 `-- B@0.0.2 @@ -85,7 +85,7 @@ when B hasn't changed at all.</p> } } </code></pre><p>The shrinkwrap command has locked down the dependencies based on -what's currently installed in node_modules. When "npm install" +what's currently installed in node_modules. When <code>npm install</code> installs a package with a npm-shrinkwrap.json file in the package root, the shrinkwrap file (rather than package.json files) completely drives the installation of that package and all of its dependencies @@ -95,41 +95,41 @@ dependencies and versions listed in A's, B's, and C's package.json files.</p> <h3 id="using-shrinkwrapped-packages">Using shrinkwrapped packages</h3> <p>Using a shrinkwrapped package is no different than using any other -package: you can "npm install" it by hand, or add a dependency to your -package.json file and "npm install" it.</p> +package: you can <code>npm install</code> it by hand, or add a dependency to your +package.json file and <code>npm install</code> it.</p> <h3 id="building-shrinkwrapped-packages">Building shrinkwrapped packages</h3> <p>To shrinkwrap an existing package:</p> <ol> -<li>Run "npm install" in the package root to install the current +<li>Run <code>npm install</code> in the package root to install the current versions of all dependencies.</li> <li>Validate that the package works as expected with these versions.</li> -<li>Run "npm shrinkwrap", add npm-shrinkwrap.json to git, and publish +<li>Run <code>npm shrinkwrap</code>, add npm-shrinkwrap.json to git, and publish your package.</li> </ol> <p>To add or update a dependency in a shrinkwrapped package:</p> <ol> -<li>Run "npm install" in the package root to install the current +<li>Run <code>npm install</code> in the package root to install the current versions of all dependencies.</li> -<li>Add or update dependencies. "npm install" each new or updated +<li>Add or update dependencies. <code>npm install</code> each new or updated package individually and then update package.json. Note that they must be explicitly named in order to be installed: running <code>npm install</code> with no arguments will merely reproduce the existing shrinkwrap.</li> <li>Validate that the package works as expected with the new dependencies.</li> -<li>Run "npm shrinkwrap", commit the new npm-shrinkwrap.json, and +<li>Run <code>npm shrinkwrap</code>, commit the new npm-shrinkwrap.json, and publish your package.</li> </ol> <p>You can use <a href="../cli/npm-outdated.html"><a href="../cli/npm-outdated.html">npm-outdated(1)</a></a> to view dependencies with newer versions available.</p> <h3 id="other-notes">Other Notes</h3> <p>A shrinkwrap file must be consistent with the package's package.json -file. "npm shrinkwrap" will fail if required dependencies are not +file. <code>npm shrinkwrap</code> 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 package.json), since that would indicate that package.json is not correct.</p> -<p>Since "npm shrinkwrap" is intended to lock down your dependencies for +<p>Since <code>npm shrinkwrap</code> is intended to lock down your dependencies for production use, <code>devDependencies</code> will not be included unless you explicitly set the <code>--dev</code> flag when you run <code>npm shrinkwrap</code>. If installed <code>devDependencies</code> are excluded, then npm will print a @@ -164,5 +164,5 @@ contents rather than versions.</p> <tr><td style="width:60px;height:10px;background:rgb(237,127,127)" colspan=6> </td><td colspan=10 style="width:10px;height:10px;background:rgb(237,127,127)"> </td></tr> <tr><td colspan=5 style="width:50px;height:10px;background:#fff"> </td><td style="width:40px;height:10px;background:rgb(237,127,127)" colspan=4> </td><td style="width:90px;height:10px;background:#fff" colspan=9> </td></tr> </table> -<p id="footer">npm-shrinkwrap — npm@2.8.4</p> +<p id="footer">npm-shrinkwrap — npm@2.9.1</p> |