diff options
Diffstat (limited to 'deps/npm/html/doc/files/npm-json.html')
| -rw-r--r-- | deps/npm/html/doc/files/npm-json.html | 25 |
1 files changed, 23 insertions, 2 deletions
diff --git a/deps/npm/html/doc/files/npm-json.html b/deps/npm/html/doc/files/npm-json.html index dfb15305fb..70d9c616bd 100644 --- a/deps/npm/html/doc/files/npm-json.html +++ b/deps/npm/html/doc/files/npm-json.html @@ -245,6 +245,9 @@ walking the folder.</p> maybe, someday.</p> <h3 id="directories-example">directories.example</h3> <p>Put example scripts in here. Someday, it might be exposed in some clever way.</p> +<h3 id="directories-test">directories.test</h3> +<p>Put your tests in here. It is currently not exposed, but it might be in the +future.</p> <h2 id="repository">repository</h2> <p>Specify the place where your code lives. This is helpful for people who want to contribute. If the git repo is on GitHub, then the <code>npm docs</code> @@ -435,7 +438,25 @@ the host package's major version will break your plugin. Thus, if you've with every 1.x version of the host package, use <code>"^1.0"</code> or <code>"1.x"</code> to express this. If you depend on features introduced in 1.5.2, use <code>">= 1.5.2 < 2"</code>.</p> <h2 id="bundleddependencies">bundledDependencies</h2> -<p>Array of package names that will be bundled when publishing the package.</p> +<p>This defines an array of package names that will be bundled when publishing +the package.</p> +<p>In cases where you need to preserve npm packages locally or have them +available through a single file download, you can bundle the packages in a +tarball file by specifying the package names in the <code>bundledDependencies</code> +array and executing <code>npm pack</code>.</p> +<p>For example:</p> +<p>If we define a package.json like this:</p> +<pre><code>{ + "name": "awesome-web-framework", + "version": "1.0.0", + "bundledDependencies": [ + 'renderized', 'super-streams' + ] +} +</code></pre><p>we can obtain <code>awesome-web-framework-1.0.0.tgz</code> file by running <code>npm pack</code>. +This file contains the dependencies <code>renderized</code> and <code>super-streams</code> which +can be installed in a new project by executing <code>npm install +awesome-web-framework-1.0.0.tgz</code>.</p> <p>If this is spelled <code>"bundleDependencies"</code>, then that is also honored.</p> <h2 id="optionaldependencies">optionalDependencies</h2> <p>If a dependency can be used, but you would like npm to proceed if it cannot be @@ -562,5 +583,5 @@ ignored.</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">package.json — npm@3.7.3</p> +<p id="footer">package.json — npm@3.8.3</p> |