npm: upgrade to 1.4.10
* Don't set referer if already set * fetch: Send referer and npm-session headers * run-script: Support --parseable and --json * list runnable scripts (Evan Lucas) * Use marked instead of ronn for html docs
This commit is contained in:
isaacs
parent
00890e43fb
commit
120f7cf55f
5
deps/npm/doc/cli/npm-run-script.md
vendored
5
deps/npm/doc/cli/npm-run-script.md
vendored
@ -3,13 +3,14 @@ npm-run-script(1) -- Run arbitrary package scripts
|
||||
|
||||
## SYNOPSIS
|
||||
|
||||
npm run-script [<pkg>] <command>
|
||||
npm run-script [<pkg>] [command]
|
||||
|
||||
## DESCRIPTION
|
||||
|
||||
This runs an arbitrary command from a package's `"scripts"` object.
|
||||
If no package name is provided, it will search for a `package.json`
|
||||
in the current folder and use its `"scripts"` object.
|
||||
in the current folder and use its `"scripts"` object. If no `"command"`
|
||||
is provided, it will list the available top level scripts.
|
||||
|
||||
It is used by the test, start, restart, and stop commands, but can be
|
||||
called directly, as well.
|
||||
|
||||
186
deps/npm/html/doc/README.html
vendored
186
deps/npm/html/doc/README.html
vendored
@ -10,153 +10,97 @@
|
||||
<div id="wrapper">
|
||||
|
||||
<h1><a href="cli/npm.html">npm</a></h1> <p>node package manager</p>
|
||||
|
||||
<p><a href="https://img.shields.io/travis/npm/npm/master.svg)](https://travis-ci.org/npm/npm"></code></pre>
|
||||
|
||||
<h2 id="DESCRIPTION">DESCRIPTION</h2>
|
||||
|
||||
<h2 id="synopsis">SYNOPSIS</h2>
|
||||
<pre><code>npm.commands[<command>](args, callback)
|
||||
</code></pre><h2 id="description">DESCRIPTION</h2>
|
||||
<p>npm comes with a full set of commands, and each of the commands takes a
|
||||
similar set of arguments.</p>
|
||||
|
||||
<p>In general, all commands on the command object take an <strong>array</strong> of positional
|
||||
argument <strong>strings</strong>. The last argument to any function is a callback. Some
|
||||
commands are special and take other optional arguments.</p>
|
||||
|
||||
<p>All commands have their own man page. See <code>man npm-<command></code> for command-line
|
||||
usage, or <code>man 3 npm-<command></code> for programmatic usage.</p>
|
||||
<h2 id="see-also">SEE ALSO</h2>
|
||||
<ul>
|
||||
<li><a href="../misc/npm-index.html">npm-index(7)</a></li>
|
||||
</ul>
|
||||
|
||||
<h2 id="SEE-ALSO">SEE ALSO</h2>
|
||||
|
||||
<ul><li><a href="../misc/npm-index.html">npm-index(7)</a></li></ul>
|
||||
</div>
|
||||
|
||||
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
|
||||
@ -41,5 +36,5 @@ usage, or <code>man 3 npm-<command></code> for programmatic usage.</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-commands — npm@1.4.9</p>
|
||||
<p id="footer">npm-commands — npm@1.4.10</p>
|
||||
|
||||
|
||||
47
deps/npm/html/doc/api/npm-config.html
vendored
47
deps/npm/html/doc/api/npm-config.html
vendored
@ -10,31 +10,42 @@
|
||||
<div id="wrapper">
|
||||
|
||||
<h1><a href="../api/npm-config.html">npm-config</a></h1> <p>Manage the npm configuration files</p>
|
||||
|
||||
<h2 id="SYNOPSIS">SYNOPSIS</h2>
|
||||
|
||||
<h2 id="synopsis">SYNOPSIS</h2>
|
||||
<pre><code>npm.commands.config(args, callback)
|
||||
var val = npm.config.get(key)
|
||||
npm.config.set(key, val)</code></pre>
|
||||
|
||||
<h2 id="DESCRIPTION">DESCRIPTION</h2>
|
||||
|
||||
npm.config.set(key, val)
|
||||
</code></pre><h2 id="description">DESCRIPTION</h2>
|
||||
<p>This function acts much the same way as the command-line version. The first
|
||||
element in the array tells config what to do. Possible values are:</p>
|
||||
|
||||
<ul><li><p><code>set</code></p><p>Sets a config parameter. The second element in <code>args</code> is interpreted as the
|
||||
key, and the third element is interpreted as the value.</p></li><li><p><code>get</code></p><p>Gets the value of a config parameter. The second element in <code>args</code> is the
|
||||
key to get the value of.</p></li><li><p><code>delete</code> (<code>rm</code> or <code>del</code>)</p><p>Deletes a parameter from the config. The second element in <code>args</code> is the
|
||||
key to delete.</p></li><li><p><code>list</code> (<code>ls</code>)</p><p>Show all configs that aren't secret. No parameters necessary.</p></li><li><p><code>edit</code>:</p><p>Opens the config file in the default editor. This command isn't very useful
|
||||
programmatically, but it is made available.</p></li></ul>
|
||||
|
||||
<ul>
|
||||
<li><p><code>set</code></p>
|
||||
<p> Sets a config parameter. The second element in <code>args</code> is interpreted as the
|
||||
key, and the third element is interpreted as the value.</p>
|
||||
</li>
|
||||
<li><p><code>get</code></p>
|
||||
<p> Gets the value of a config parameter. The second element in <code>args</code> is the
|
||||
key to get the value of.</p>
|
||||
</li>
|
||||
<li><p><code>delete</code> (<code>rm</code> or <code>del</code>)</p>
|
||||
<p> Deletes a parameter from the config. The second element in <code>args</code> is the
|
||||
key to delete.</p>
|
||||
</li>
|
||||
<li><p><code>list</code> (<code>ls</code>)</p>
|
||||
<p> Show all configs that aren't secret. No parameters necessary.</p>
|
||||
</li>
|
||||
<li><p><code>edit</code>:</p>
|
||||
<p> Opens the config file in the default editor. This command isn't very useful
|
||||
programmatically, but it is made available.</p>
|
||||
</li>
|
||||
</ul>
|
||||
<p>To programmatically access npm configuration settings, or set them for
|
||||
the duration of a program, use the <code>npm.config.set</code> and <code>npm.config.get</code>
|
||||
functions instead.</p>
|
||||
<h2 id="see-also">SEE ALSO</h2>
|
||||
<ul>
|
||||
<li><a href="../api/npm.html">npm(3)</a></li>
|
||||
</ul>
|
||||
|
||||
<h2 id="SEE-ALSO">SEE ALSO</h2>
|
||||
|
||||
<ul><li><a href="../api/npm.html">npm(3)</a></li></ul>
|
||||
</div>
|
||||
|
||||
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
|
||||
@ -46,5 +57,5 @@ functions instead.</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-config — npm@1.4.9</p>
|
||||
<p id="footer">npm-config — npm@1.4.10</p>
|
||||
|
||||
|
||||
38
deps/npm/html/doc/api/npm-deprecate.html
vendored
38
deps/npm/html/doc/api/npm-deprecate.html
vendored
@ -10,30 +10,32 @@
|
||||
<div id="wrapper">
|
||||
|
||||
<h1><a href="../api/npm-deprecate.html">npm-deprecate</a></h1> <p>Deprecate a version of a package</p>
|
||||
|
||||
<h2 id="SYNOPSIS">SYNOPSIS</h2>
|
||||
|
||||
<pre><code>npm.commands.deprecate(args, callback)</code></pre>
|
||||
|
||||
<h2 id="DESCRIPTION">DESCRIPTION</h2>
|
||||
|
||||
<h2 id="synopsis">SYNOPSIS</h2>
|
||||
<pre><code>npm.commands.deprecate(args, callback)
|
||||
</code></pre><h2 id="description">DESCRIPTION</h2>
|
||||
<p>This command will update the npm registry entry for a package, providing
|
||||
a deprecation warning to all who attempt to install it.</p>
|
||||
|
||||
<p>The 'args' parameter must have exactly two elements:</p>
|
||||
|
||||
<ul><li><p><code>package[@version]</code></p><p>The <code>version</code> portion is optional, and may be either a range, or a
|
||||
specific version, or a tag.</p></li><li><p><code>message</code></p><p>The warning message that will be printed whenever a user attempts to
|
||||
install the package.</p></li></ul>
|
||||
|
||||
<ul>
|
||||
<li><p><code>package[@version]</code></p>
|
||||
<p> The <code>version</code> portion is optional, and may be either a range, or a
|
||||
specific version, or a tag.</p>
|
||||
</li>
|
||||
<li><p><code>message</code></p>
|
||||
<p> The warning message that will be printed whenever a user attempts to
|
||||
install the package.</p>
|
||||
</li>
|
||||
</ul>
|
||||
<p>Note that you must be the package owner to deprecate something. See the
|
||||
<code>owner</code> and <code>adduser</code> help topics.</p>
|
||||
|
||||
<p>To un-deprecate a package, specify an empty string (<code>""</code>) for the <code>message</code> argument.</p>
|
||||
<h2 id="see-also">SEE ALSO</h2>
|
||||
<ul>
|
||||
<li><a href="../api/npm-publish.html">npm-publish(3)</a></li>
|
||||
<li><a href="../api/npm-unpublish.html">npm-unpublish(3)</a></li>
|
||||
<li><a href="../misc/npm-registry.html">npm-registry(7)</a></li>
|
||||
</ul>
|
||||
|
||||
<h2 id="SEE-ALSO">SEE ALSO</h2>
|
||||
|
||||
<ul><li><a href="../api/npm-publish.html">npm-publish(3)</a></li><li><a href="../api/npm-unpublish.html">npm-unpublish(3)</a></li><li><a href="../misc/npm-registry.html">npm-registry(7)</a></li></ul>
|
||||
</div>
|
||||
|
||||
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
|
||||
@ -45,5 +47,5 @@ install the package.</p></li></ul>
|
||||
<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-deprecate — npm@1.4.9</p>
|
||||
<p id="footer">npm-deprecate — npm@1.4.10</p>
|
||||
|
||||
|
||||
15
deps/npm/html/doc/api/npm-docs.html
vendored
15
deps/npm/html/doc/api/npm-docs.html
vendored
@ -10,23 +10,18 @@
|
||||
<div id="wrapper">
|
||||
|
||||
<h1><a href="../api/npm-docs.html">npm-docs</a></h1> <p>Docs for a package in a web browser maybe</p>
|
||||
|
||||
<h2 id="SYNOPSIS">SYNOPSIS</h2>
|
||||
|
||||
<pre><code>npm.commands.docs(package, callback)</code></pre>
|
||||
|
||||
<h2 id="DESCRIPTION">DESCRIPTION</h2>
|
||||
|
||||
<h2 id="synopsis">SYNOPSIS</h2>
|
||||
<pre><code>npm.commands.docs(package, callback)
|
||||
</code></pre><h2 id="description">DESCRIPTION</h2>
|
||||
<p>This command tries to guess at the likely location of a package's
|
||||
documentation URL, and then tries to open it using the <code>--browser</code>
|
||||
config param.</p>
|
||||
|
||||
<p>Like other commands, the first parameter is an array. This command only
|
||||
uses the first element, which is expected to be a package name with an
|
||||
optional version number.</p>
|
||||
|
||||
<p>This command will launch a browser, so this command may not be the most
|
||||
friendly for programmatic use.</p>
|
||||
|
||||
</div>
|
||||
|
||||
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
|
||||
@ -38,5 +33,5 @@ friendly for programmatic use.</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-docs — npm@1.4.9</p>
|
||||
<p id="footer">npm-docs — npm@1.4.10</p>
|
||||
|
||||
|
||||
17
deps/npm/html/doc/api/npm-edit.html
vendored
17
deps/npm/html/doc/api/npm-edit.html
vendored
@ -10,28 +10,21 @@
|
||||
<div id="wrapper">
|
||||
|
||||
<h1><a href="../api/npm-edit.html">npm-edit</a></h1> <p>Edit an installed package</p>
|
||||
|
||||
<h2 id="SYNOPSIS">SYNOPSIS</h2>
|
||||
|
||||
<pre><code>npm.commands.edit(package, callback)</code></pre>
|
||||
|
||||
<h2 id="DESCRIPTION">DESCRIPTION</h2>
|
||||
|
||||
<h2 id="synopsis">SYNOPSIS</h2>
|
||||
<pre><code>npm.commands.edit(package, callback)
|
||||
</code></pre><h2 id="description">DESCRIPTION</h2>
|
||||
<p>Opens the package folder in the default editor (or whatever you've
|
||||
configured as the npm <code>editor</code> config -- see <code>npm help config</code>.)</p>
|
||||
|
||||
<p>After it has been edited, the package is rebuilt so as to pick up any
|
||||
changes in compiled packages.</p>
|
||||
|
||||
<p>For instance, you can do <code>npm install connect</code> to install connect
|
||||
into your package, and then <code>npm.commands.edit(["connect"], callback)</code>
|
||||
to make a few changes to your locally installed copy.</p>
|
||||
|
||||
<p>The first parameter is a string array with a single element, the package
|
||||
to open. The package can optionally have a version number attached.</p>
|
||||
|
||||
<p>Since this command opens an editor in a new process, be careful about where
|
||||
and how this is used.</p>
|
||||
|
||||
</div>
|
||||
|
||||
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
|
||||
@ -43,5 +36,5 @@ and how this is used.</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-edit — npm@1.4.9</p>
|
||||
<p id="footer">npm-edit — npm@1.4.10</p>
|
||||
|
||||
|
||||
16
deps/npm/html/doc/api/npm-explore.html
vendored
16
deps/npm/html/doc/api/npm-explore.html
vendored
@ -10,22 +10,16 @@
|
||||
<div id="wrapper">
|
||||
|
||||
<h1><a href="../api/npm-explore.html">npm-explore</a></h1> <p>Browse an installed package</p>
|
||||
|
||||
<h2 id="SYNOPSIS">SYNOPSIS</h2>
|
||||
|
||||
<pre><code>npm.commands.explore(args, callback)</code></pre>
|
||||
|
||||
<h2 id="DESCRIPTION">DESCRIPTION</h2>
|
||||
|
||||
<h2 id="synopsis">SYNOPSIS</h2>
|
||||
<pre><code>npm.commands.explore(args, callback)
|
||||
</code></pre><h2 id="description">DESCRIPTION</h2>
|
||||
<p>Spawn a subshell in the directory of the installed package specified.</p>
|
||||
|
||||
<p>If a command is specified, then it is run in the subshell, which then
|
||||
immediately terminates.</p>
|
||||
|
||||
<p>Note that the package is <em>not</em> automatically rebuilt afterwards, so be
|
||||
sure to use <code>npm rebuild <pkg></code> if you make any changes.</p>
|
||||
|
||||
<p>The first element in the 'args' parameter must be a package name. After that is the optional command, which can be any number of strings. All of the strings will be combined into one, space-delimited command.</p>
|
||||
|
||||
</div>
|
||||
|
||||
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
|
||||
@ -37,5 +31,5 @@ sure to use <code>npm rebuild <pkg></code> if you make any changes.</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-explore — npm@1.4.9</p>
|
||||
<p id="footer">npm-explore — npm@1.4.10</p>
|
||||
|
||||
|
||||
35
deps/npm/html/doc/api/npm-help-search.html
vendored
35
deps/npm/html/doc/api/npm-help-search.html
vendored
@ -10,30 +10,29 @@
|
||||
<div id="wrapper">
|
||||
|
||||
<h1><a href="../api/npm-help-search.html">npm-help-search</a></h1> <p>Search the help pages</p>
|
||||
|
||||
<h2 id="SYNOPSIS">SYNOPSIS</h2>
|
||||
|
||||
<pre><code>npm.commands.helpSearch(args, [silent,] callback)</code></pre>
|
||||
|
||||
<h2 id="DESCRIPTION">DESCRIPTION</h2>
|
||||
|
||||
<h2 id="synopsis">SYNOPSIS</h2>
|
||||
<pre><code>npm.commands.helpSearch(args, [silent,] callback)
|
||||
</code></pre><h2 id="description">DESCRIPTION</h2>
|
||||
<p>This command is rarely useful, but it exists in the rare case that it is.</p>
|
||||
|
||||
<p>This command takes an array of search terms and returns the help pages that
|
||||
match in order of best match.</p>
|
||||
|
||||
<p>If there is only one match, then npm displays that help section. If there
|
||||
are multiple results, the results are printed to the screen formatted and the
|
||||
array of results is returned. Each result is an object with these properties:</p>
|
||||
|
||||
<ul><li>hits:
|
||||
A map of args to number of hits on that arg. For example, {"npm": 3}</li><li>found:
|
||||
Total number of unique args that matched.</li><li>totalHits:
|
||||
Total number of hits.</li><li>lines:
|
||||
An array of all matching lines (and some adjacent lines).</li><li>file:
|
||||
Name of the file that matched</li></ul>
|
||||
|
||||
<ul>
|
||||
<li>hits:
|
||||
A map of args to number of hits on that arg. For example, {"npm": 3}</li>
|
||||
<li>found:
|
||||
Total number of unique args that matched.</li>
|
||||
<li>totalHits:
|
||||
Total number of hits.</li>
|
||||
<li>lines:
|
||||
An array of all matching lines (and some adjacent lines).</li>
|
||||
<li>file:
|
||||
Name of the file that matched</li>
|
||||
</ul>
|
||||
<p>The silent parameter is not neccessary not used, but it may in the future.</p>
|
||||
|
||||
</div>
|
||||
|
||||
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
|
||||
@ -45,5 +44,5 @@ Name of the file that matched</li></ul>
|
||||
<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-help-search — npm@1.4.9</p>
|
||||
<p id="footer">npm-help-search — npm@1.4.10</p>
|
||||
|
||||
|
||||
21
deps/npm/html/doc/api/npm-init.html
vendored
21
deps/npm/html/doc/api/npm-init.html
vendored
@ -10,33 +10,24 @@
|
||||
<div id="wrapper">
|
||||
|
||||
<h1>npm <a href="../api/init.html">init</a></h1> <p>Interactively create a package.json file</p>
|
||||
|
||||
<h2 id="SYNOPSIS">SYNOPSIS</h2>
|
||||
|
||||
<pre><code>npm.commands.init(args, callback)</code></pre>
|
||||
|
||||
<h2 id="DESCRIPTION">DESCRIPTION</h2>
|
||||
|
||||
<h2 id="synopsis">SYNOPSIS</h2>
|
||||
<pre><code>npm.commands.init(args, callback)
|
||||
</code></pre><h2 id="description">DESCRIPTION</h2>
|
||||
<p>This will ask you a bunch of questions, and then write a package.json for you.</p>
|
||||
|
||||
<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.</p>
|
||||
|
||||
<p>If you already have a package.json file, it'll read that first, and default to
|
||||
the options in there.</p>
|
||||
|
||||
<p>It is strictly additive, so it does not delete options from your package.json
|
||||
without a really good reason to do so.</p>
|
||||
|
||||
<p>Since this function expects to be run on the command-line, it doesn't work very
|
||||
well as a programmatically. The best option is to roll your own, and since
|
||||
JavaScript makes it stupid simple to output formatted JSON, that is the
|
||||
preferred method. If you're sure you want to handle command-line prompting,
|
||||
then go ahead and use this programmatically.</p>
|
||||
|
||||
<h2 id="SEE-ALSO">SEE ALSO</h2>
|
||||
|
||||
<h2 id="see-also">SEE ALSO</h2>
|
||||
<p><a href="../files/package.json.html">package.json(5)</a></p>
|
||||
|
||||
</div>
|
||||
|
||||
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
|
||||
@ -48,5 +39,5 @@ then go ahead and use this programmatically.</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-init — npm@1.4.9</p>
|
||||
<p id="footer">npm-init — npm@1.4.10</p>
|
||||
|
||||
|
||||
16
deps/npm/html/doc/api/npm-install.html
vendored
16
deps/npm/html/doc/api/npm-install.html
vendored
@ -10,23 +10,17 @@
|
||||
<div id="wrapper">
|
||||
|
||||
<h1><a href="../api/npm-install.html">npm-install</a></h1> <p>install a package programmatically</p>
|
||||
|
||||
<h2 id="SYNOPSIS">SYNOPSIS</h2>
|
||||
|
||||
<pre><code>npm.commands.install([where,] packages, callback)</code></pre>
|
||||
|
||||
<h2 id="DESCRIPTION">DESCRIPTION</h2>
|
||||
|
||||
<h2 id="synopsis">SYNOPSIS</h2>
|
||||
<pre><code>npm.commands.install([where,] packages, callback)
|
||||
</code></pre><h2 id="description">DESCRIPTION</h2>
|
||||
<p>This acts much the same ways as installing on the command-line.</p>
|
||||
|
||||
<p>The 'where' parameter is optional and only used internally, and it specifies
|
||||
where the packages should be installed to.</p>
|
||||
|
||||
<p>The 'packages' parameter is an array of strings. Each element in the array is
|
||||
the name of a package to be installed.</p>
|
||||
|
||||
<p>Finally, 'callback' is a function that will be called when all packages have been
|
||||
installed or when an error has been encountered.</p>
|
||||
|
||||
</div>
|
||||
|
||||
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
|
||||
@ -38,5 +32,5 @@ installed or when an error has been encountered.</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-install — npm@1.4.9</p>
|
||||
<p id="footer">npm-install — npm@1.4.10</p>
|
||||
|
||||
|
||||
24
deps/npm/html/doc/api/npm-link.html
vendored
24
deps/npm/html/doc/api/npm-link.html
vendored
@ -10,37 +10,27 @@
|
||||
<div id="wrapper">
|
||||
|
||||
<h1><a href="../api/npm-link.html">npm-link</a></h1> <p>Symlink a package folder</p>
|
||||
|
||||
<h2 id="SYNOPSIS">SYNOPSIS</h2>
|
||||
|
||||
<h2 id="synopsis">SYNOPSIS</h2>
|
||||
<pre><code>npm.command.link(callback)
|
||||
npm.command.link(packages, callback)</code></pre>
|
||||
|
||||
<h2 id="DESCRIPTION">DESCRIPTION</h2>
|
||||
|
||||
npm.command.link(packages, callback)
|
||||
</code></pre><h2 id="description">DESCRIPTION</h2>
|
||||
<p>Package linking is a two-step process.</p>
|
||||
|
||||
<p>Without parameters, link will create a globally-installed
|
||||
symbolic link from <code>prefix/package-name</code> to the current folder.</p>
|
||||
|
||||
<p>With a parameters, link will create a symlink from the local <code>node_modules</code>
|
||||
folder to the global symlink.</p>
|
||||
|
||||
<p>When creating tarballs for <code>npm publish</code>, the linked packages are
|
||||
"snapshotted" to their current state by resolving the symbolic links.</p>
|
||||
|
||||
<p>This is
|
||||
handy for installing your own stuff, so that you can work on it and test it
|
||||
iteratively without having to continually rebuild.</p>
|
||||
|
||||
<p>For example:</p>
|
||||
|
||||
<pre><code>npm.commands.link(cb) # creates global link from the cwd
|
||||
# (say redis package)
|
||||
npm.commands.link('redis', cb) # link-install the package</code></pre>
|
||||
|
||||
<p>Now, any changes to the redis package will be reflected in
|
||||
npm.commands.link('redis', cb) # link-install the package
|
||||
</code></pre><p>Now, any changes to the redis package will be reflected in
|
||||
the package in the current working directory</p>
|
||||
|
||||
</div>
|
||||
|
||||
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
|
||||
@ -52,5 +42,5 @@ the package in the current working directory</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-link — npm@1.4.9</p>
|
||||
<p id="footer">npm-link — npm@1.4.10</p>
|
||||
|
||||
|
||||
20
deps/npm/html/doc/api/npm-load.html
vendored
20
deps/npm/html/doc/api/npm-load.html
vendored
@ -10,30 +10,22 @@
|
||||
<div id="wrapper">
|
||||
|
||||
<h1><a href="../api/npm-load.html">npm-load</a></h1> <p>Load config settings</p>
|
||||
|
||||
<h2 id="SYNOPSIS">SYNOPSIS</h2>
|
||||
|
||||
<pre><code>npm.load(conf, cb)</code></pre>
|
||||
|
||||
<h2 id="DESCRIPTION">DESCRIPTION</h2>
|
||||
|
||||
<h2 id="synopsis">SYNOPSIS</h2>
|
||||
<pre><code>npm.load(conf, cb)
|
||||
</code></pre><h2 id="description">DESCRIPTION</h2>
|
||||
<p>npm.load() must be called before any other function call. Both parameters are
|
||||
optional, but the second is recommended.</p>
|
||||
|
||||
<p>The first parameter is an object hash of command-line config params, and the
|
||||
second parameter is a callback that will be called when npm is loaded and
|
||||
ready to serve.</p>
|
||||
|
||||
<p>The first parameter should follow a similar structure as the package.json
|
||||
config object.</p>
|
||||
|
||||
<p>For example, to emulate the --dev flag, pass an object that looks like this:</p>
|
||||
|
||||
<pre><code>{
|
||||
"dev": true
|
||||
}</code></pre>
|
||||
}
|
||||
</code></pre><p>For a list of all the available command-line configs, see <code>npm help config</code></p>
|
||||
|
||||
<p>For a list of all the available command-line configs, see <code>npm help config</code></p>
|
||||
</div>
|
||||
|
||||
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
|
||||
@ -45,5 +37,5 @@ config object.</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-load — npm@1.4.9</p>
|
||||
<p id="footer">npm-load — npm@1.4.10</p>
|
||||
|
||||
|
||||
45
deps/npm/html/doc/api/npm-ls.html
vendored
45
deps/npm/html/doc/api/npm-ls.html
vendored
@ -10,57 +10,48 @@
|
||||
<div id="wrapper">
|
||||
|
||||
<h1><a href="../api/npm-ls.html">npm-ls</a></h1> <p>List installed packages</p>
|
||||
|
||||
<h2 id="SYNOPSIS">SYNOPSIS</h2>
|
||||
|
||||
<pre><code>npm.commands.ls(args, [silent,] callback)</code></pre>
|
||||
|
||||
<h2 id="DESCRIPTION">DESCRIPTION</h2>
|
||||
|
||||
<h2 id="synopsis">SYNOPSIS</h2>
|
||||
<pre><code>npm.commands.ls(args, [silent,] callback)
|
||||
</code></pre><h2 id="description">DESCRIPTION</h2>
|
||||
<p>This command will print to stdout all the versions of packages that are
|
||||
installed, as well as their dependencies, in a tree-structure. It will also
|
||||
return that data using the callback.</p>
|
||||
|
||||
<p>This command does not take any arguments, but args must be defined.
|
||||
Beyond that, if any arguments are passed in, npm will politely warn that it
|
||||
does not take positional arguments, though you may set config flags
|
||||
like with any other command, such as <code>global</code> to list global packages.</p>
|
||||
|
||||
<p>It will print out extraneous, missing, and invalid packages.</p>
|
||||
|
||||
<p>If the silent parameter is set to true, nothing will be output to the screen,
|
||||
but the data will still be returned.</p>
|
||||
|
||||
<p>Callback is provided an error if one occurred, the full data about which
|
||||
packages are installed and which dependencies they will receive, and a
|
||||
"lite" data object which just shows which versions are installed where.
|
||||
Note that the full data object is a circular structure, so care must be
|
||||
taken if it is serialized to JSON.</p>
|
||||
|
||||
<h2 id="CONFIGURATION">CONFIGURATION</h2>
|
||||
|
||||
<h2 id="configuration">CONFIGURATION</h2>
|
||||
<h3 id="long">long</h3>
|
||||
|
||||
<ul><li>Default: false</li><li>Type: Boolean</li></ul>
|
||||
|
||||
<ul>
|
||||
<li>Default: false</li>
|
||||
<li>Type: Boolean</li>
|
||||
</ul>
|
||||
<p>Show extended information.</p>
|
||||
|
||||
<h3 id="parseable">parseable</h3>
|
||||
|
||||
<ul><li>Default: false</li><li>Type: Boolean</li></ul>
|
||||
|
||||
<ul>
|
||||
<li>Default: false</li>
|
||||
<li>Type: Boolean</li>
|
||||
</ul>
|
||||
<p>Show parseable output instead of tree view.</p>
|
||||
|
||||
<h3 id="global">global</h3>
|
||||
|
||||
<ul><li>Default: false</li><li>Type: Boolean</li></ul>
|
||||
|
||||
<ul>
|
||||
<li>Default: false</li>
|
||||
<li>Type: Boolean</li>
|
||||
</ul>
|
||||
<p>List packages in the global install prefix instead of in the current
|
||||
project.</p>
|
||||
|
||||
<p>Note, if parseable is set or long isn't set, then duplicates will be trimmed.
|
||||
This means that if a submodule a same dependency as a parent module, then the
|
||||
dependency will only be output once.</p>
|
||||
|
||||
</div>
|
||||
|
||||
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
|
||||
@ -72,5 +63,5 @@ dependency will only be output once.</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-ls — npm@1.4.9</p>
|
||||
<p id="footer">npm-ls — npm@1.4.10</p>
|
||||
|
||||
|
||||
14
deps/npm/html/doc/api/npm-outdated.html
vendored
14
deps/npm/html/doc/api/npm-outdated.html
vendored
@ -10,17 +10,13 @@
|
||||
<div id="wrapper">
|
||||
|
||||
<h1><a href="../api/npm-outdated.html">npm-outdated</a></h1> <p>Check for outdated packages</p>
|
||||
|
||||
<h2 id="SYNOPSIS">SYNOPSIS</h2>
|
||||
|
||||
<pre><code>npm.commands.outdated([packages,] callback)</code></pre>
|
||||
|
||||
<h2 id="DESCRIPTION">DESCRIPTION</h2>
|
||||
|
||||
<h2 id="synopsis">SYNOPSIS</h2>
|
||||
<pre><code>npm.commands.outdated([packages,] callback)
|
||||
</code></pre><h2 id="description">DESCRIPTION</h2>
|
||||
<p>This command will check the registry to see if the specified packages are
|
||||
currently outdated.</p>
|
||||
|
||||
<p>If the 'packages' parameter is left out, npm will check all packages.</p>
|
||||
|
||||
</div>
|
||||
|
||||
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
|
||||
@ -32,5 +28,5 @@ currently outdated.</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-outdated — npm@1.4.9</p>
|
||||
<p id="footer">npm-outdated — npm@1.4.10</p>
|
||||
|
||||
|
||||
34
deps/npm/html/doc/api/npm-owner.html
vendored
34
deps/npm/html/doc/api/npm-owner.html
vendored
@ -10,32 +10,32 @@
|
||||
<div id="wrapper">
|
||||
|
||||
<h1><a href="../api/npm-owner.html">npm-owner</a></h1> <p>Manage package owners</p>
|
||||
|
||||
<h2 id="SYNOPSIS">SYNOPSIS</h2>
|
||||
|
||||
<pre><code>npm.commands.owner(args, callback)</code></pre>
|
||||
|
||||
<h2 id="DESCRIPTION">DESCRIPTION</h2>
|
||||
|
||||
<h2 id="synopsis">SYNOPSIS</h2>
|
||||
<pre><code>npm.commands.owner(args, callback)
|
||||
</code></pre><h2 id="description">DESCRIPTION</h2>
|
||||
<p>The first element of the 'args' parameter defines what to do, and the subsequent
|
||||
elements depend on the action. Possible values for the action are (order of
|
||||
parameters are given in parenthesis):</p>
|
||||
|
||||
<ul><li>ls (package):
|
||||
<ul>
|
||||
<li>ls (package):
|
||||
List all the users who have access to modify a package and push new versions.
|
||||
Handy when you need to know who to bug for help.</li><li>add (user, package):
|
||||
Handy when you need to know who to bug for help.</li>
|
||||
<li>add (user, package):
|
||||
Add a new user as a maintainer of a package. This user is enabled to modify
|
||||
metadata, publish new versions, and add other owners.</li><li>rm (user, package):
|
||||
metadata, publish new versions, and add other owners.</li>
|
||||
<li>rm (user, package):
|
||||
Remove a user from the package owner list. This immediately revokes their
|
||||
privileges.</li></ul>
|
||||
|
||||
privileges.</li>
|
||||
</ul>
|
||||
<p>Note that there is only one level of access. Either you can modify a package,
|
||||
or you can't. Future versions may contain more fine-grained access levels, but
|
||||
that is not implemented at this time.</p>
|
||||
<h2 id="see-also">SEE ALSO</h2>
|
||||
<ul>
|
||||
<li><a href="../api/npm-publish.html">npm-publish(3)</a></li>
|
||||
<li><a href="../misc/npm-registry.html">npm-registry(7)</a></li>
|
||||
</ul>
|
||||
|
||||
<h2 id="SEE-ALSO">SEE ALSO</h2>
|
||||
|
||||
<ul><li><a href="../api/npm-publish.html">npm-publish(3)</a></li><li><a href="../misc/npm-registry.html">npm-registry(7)</a></li></ul>
|
||||
</div>
|
||||
|
||||
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
|
||||
@ -47,5 +47,5 @@ that is not implemented at this time.</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-owner — npm@1.4.9</p>
|
||||
<p id="footer">npm-owner — npm@1.4.10</p>
|
||||
|
||||
|
||||
15
deps/npm/html/doc/api/npm-pack.html
vendored
15
deps/npm/html/doc/api/npm-pack.html
vendored
@ -10,23 +10,18 @@
|
||||
<div id="wrapper">
|
||||
|
||||
<h1><a href="../api/npm-pack.html">npm-pack</a></h1> <p>Create a tarball from a package</p>
|
||||
|
||||
<h2 id="SYNOPSIS">SYNOPSIS</h2>
|
||||
|
||||
<pre><code>npm.commands.pack([packages,] callback)</code></pre>
|
||||
|
||||
<h2 id="DESCRIPTION">DESCRIPTION</h2>
|
||||
|
||||
<h2 id="synopsis">SYNOPSIS</h2>
|
||||
<pre><code>npm.commands.pack([packages,] callback)
|
||||
</code></pre><h2 id="description">DESCRIPTION</h2>
|
||||
<p>For anything that's installable (that is, a package folder, tarball,
|
||||
tarball url, name@tag, name@version, or name), this command will fetch
|
||||
it to the cache, and then copy the tarball to the current working
|
||||
directory as <code><name>-<version>.tgz</code>, and then write the filenames out to
|
||||
stdout.</p>
|
||||
|
||||
<p>If the same package is specified multiple times, then the file will be
|
||||
overwritten the second time.</p>
|
||||
|
||||
<p>If no arguments are supplied, then npm packs the current package folder.</p>
|
||||
|
||||
</div>
|
||||
|
||||
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
|
||||
@ -38,5 +33,5 @@ overwritten the second time.</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-pack — npm@1.4.9</p>
|
||||
<p id="footer">npm-pack — npm@1.4.10</p>
|
||||
|
||||
|
||||
15
deps/npm/html/doc/api/npm-prefix.html
vendored
15
deps/npm/html/doc/api/npm-prefix.html
vendored
@ -10,19 +10,14 @@
|
||||
<div id="wrapper">
|
||||
|
||||
<h1><a href="../api/npm-prefix.html">npm-prefix</a></h1> <p>Display prefix</p>
|
||||
|
||||
<h2 id="SYNOPSIS">SYNOPSIS</h2>
|
||||
|
||||
<pre><code>npm.commands.prefix(args, callback)</code></pre>
|
||||
|
||||
<h2 id="DESCRIPTION">DESCRIPTION</h2>
|
||||
|
||||
<h2 id="synopsis">SYNOPSIS</h2>
|
||||
<pre><code>npm.commands.prefix(args, callback)
|
||||
</code></pre><h2 id="description">DESCRIPTION</h2>
|
||||
<p>Print the prefix to standard out.</p>
|
||||
|
||||
<p>'args' is never used and callback is never called with data.
|
||||
'args' must be present or things will break.</p>
|
||||
|
||||
<p>This function is not useful programmatically</p>
|
||||
|
||||
</div>
|
||||
|
||||
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
|
||||
@ -34,5 +29,5 @@
|
||||
<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-prefix — npm@1.4.9</p>
|
||||
<p id="footer">npm-prefix — npm@1.4.10</p>
|
||||
|
||||
|
||||
16
deps/npm/html/doc/api/npm-prune.html
vendored
16
deps/npm/html/doc/api/npm-prune.html
vendored
@ -10,21 +10,15 @@
|
||||
<div id="wrapper">
|
||||
|
||||
<h1><a href="../api/npm-prune.html">npm-prune</a></h1> <p>Remove extraneous packages</p>
|
||||
|
||||
<h2 id="SYNOPSIS">SYNOPSIS</h2>
|
||||
|
||||
<pre><code>npm.commands.prune([packages,] callback)</code></pre>
|
||||
|
||||
<h2 id="DESCRIPTION">DESCRIPTION</h2>
|
||||
|
||||
<h2 id="synopsis">SYNOPSIS</h2>
|
||||
<pre><code>npm.commands.prune([packages,] callback)
|
||||
</code></pre><h2 id="description">DESCRIPTION</h2>
|
||||
<p>This command removes "extraneous" packages.</p>
|
||||
|
||||
<p>The first parameter is optional, and it specifies packages to be removed.</p>
|
||||
|
||||
<p>No packages are specified, then all packages will be checked.</p>
|
||||
|
||||
<p>Extraneous packages are packages that are not listed on the parent
|
||||
package's dependencies list.</p>
|
||||
|
||||
</div>
|
||||
|
||||
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
|
||||
@ -36,5 +30,5 @@ package's dependencies list.</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-prune — npm@1.4.9</p>
|
||||
<p id="footer">npm-prune — npm@1.4.10</p>
|
||||
|
||||
|
||||
35
deps/npm/html/doc/api/npm-publish.html
vendored
35
deps/npm/html/doc/api/npm-publish.html
vendored
@ -10,30 +10,31 @@
|
||||
<div id="wrapper">
|
||||
|
||||
<h1><a href="../api/npm-publish.html">npm-publish</a></h1> <p>Publish a package</p>
|
||||
|
||||
<h2 id="SYNOPSIS">SYNOPSIS</h2>
|
||||
|
||||
<pre><code>npm.commands.publish([packages,] callback)</code></pre>
|
||||
|
||||
<h2 id="DESCRIPTION">DESCRIPTION</h2>
|
||||
|
||||
<h2 id="synopsis">SYNOPSIS</h2>
|
||||
<pre><code>npm.commands.publish([packages,] callback)
|
||||
</code></pre><h2 id="description">DESCRIPTION</h2>
|
||||
<p>Publishes a package to the registry so that it can be installed by name.
|
||||
Possible values in the 'packages' array are:</p>
|
||||
|
||||
<ul><li><p><code><folder></code>:
|
||||
A folder containing a package.json file</p></li><li><p><code><tarball></code>:
|
||||
<ul>
|
||||
<li><p><code><folder></code>:
|
||||
A folder containing a package.json file</p>
|
||||
</li>
|
||||
<li><p><code><tarball></code>:
|
||||
A url or file path to a gzipped tar archive containing a single folder
|
||||
with a package.json file inside.</p></li></ul>
|
||||
|
||||
with a package.json file inside.</p>
|
||||
</li>
|
||||
</ul>
|
||||
<p>If the package array is empty, npm will try to publish something in the
|
||||
current working directory.</p>
|
||||
|
||||
<p>This command could fails if one of the packages specified already exists in
|
||||
the registry. Overwrites when the "force" environment variable is set.</p>
|
||||
<h2 id="see-also">SEE ALSO</h2>
|
||||
<ul>
|
||||
<li><a href="../misc/npm-registry.html">npm-registry(7)</a></li>
|
||||
<li><a href="../cli/npm-adduser.html">npm-adduser(1)</a></li>
|
||||
<li><a href="../api/npm-owner.html">npm-owner(3)</a></li>
|
||||
</ul>
|
||||
|
||||
<h2 id="SEE-ALSO">SEE ALSO</h2>
|
||||
|
||||
<ul><li><a href="../misc/npm-registry.html">npm-registry(7)</a></li><li><a href="../cli/npm-adduser.html">npm-adduser(1)</a></li><li><a href="../api/npm-owner.html">npm-owner(3)</a></li></ul>
|
||||
</div>
|
||||
|
||||
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
|
||||
@ -45,5 +46,5 @@ the registry. Overwrites when the "force" environment variable is set
|
||||
<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-publish — npm@1.4.9</p>
|
||||
<p id="footer">npm-publish — npm@1.4.10</p>
|
||||
|
||||
|
||||
17
deps/npm/html/doc/api/npm-rebuild.html
vendored
17
deps/npm/html/doc/api/npm-rebuild.html
vendored
@ -10,20 +10,15 @@
|
||||
<div id="wrapper">
|
||||
|
||||
<h1><a href="../api/npm-rebuild.html">npm-rebuild</a></h1> <p>Rebuild a package</p>
|
||||
|
||||
<h2 id="SYNOPSIS">SYNOPSIS</h2>
|
||||
|
||||
<pre><code>npm.commands.rebuild([packages,] callback)</code></pre>
|
||||
|
||||
<h2 id="DESCRIPTION">DESCRIPTION</h2>
|
||||
|
||||
<h2 id="synopsis">SYNOPSIS</h2>
|
||||
<pre><code>npm.commands.rebuild([packages,] callback)
|
||||
</code></pre><h2 id="description">DESCRIPTION</h2>
|
||||
<p>This command runs the <code>npm build</code> command on each of the matched packages. This is useful
|
||||
when you install a new version of node, and must recompile all your C++ addons with
|
||||
the new binary. If no 'packages' parameter is specify, every package will be rebuilt.</p>
|
||||
|
||||
<h2 id="CONFIGURATION">CONFIGURATION</h2>
|
||||
|
||||
<h2 id="configuration">CONFIGURATION</h2>
|
||||
<p>See <code>npm help build</code></p>
|
||||
|
||||
</div>
|
||||
|
||||
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
|
||||
@ -35,5 +30,5 @@ the new binary. If no 'packages' parameter is specify, every package wil
|
||||
<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-rebuild — npm@1.4.9</p>
|
||||
<p id="footer">npm-rebuild — npm@1.4.10</p>
|
||||
|
||||
|
||||
15
deps/npm/html/doc/api/npm-repo.html
vendored
15
deps/npm/html/doc/api/npm-repo.html
vendored
@ -10,23 +10,18 @@
|
||||
<div id="wrapper">
|
||||
|
||||
<h1><a href="../api/npm-repo.html">npm-repo</a></h1> <p>Open package repository page in the browser</p>
|
||||
|
||||
<h2 id="SYNOPSIS">SYNOPSIS</h2>
|
||||
|
||||
<pre><code>npm.commands.repo(package, callback)</code></pre>
|
||||
|
||||
<h2 id="DESCRIPTION">DESCRIPTION</h2>
|
||||
|
||||
<h2 id="synopsis">SYNOPSIS</h2>
|
||||
<pre><code>npm.commands.repo(package, callback)
|
||||
</code></pre><h2 id="description">DESCRIPTION</h2>
|
||||
<p>This command tries to guess at the likely location of a package's
|
||||
repository URL, and then tries to open it using the <code>--browser</code>
|
||||
config param.</p>
|
||||
|
||||
<p>Like other commands, the first parameter is an array. This command only
|
||||
uses the first element, which is expected to be a package name with an
|
||||
optional version number.</p>
|
||||
|
||||
<p>This command will launch a browser, so this command may not be the most
|
||||
friendly for programmatic use.</p>
|
||||
|
||||
</div>
|
||||
|
||||
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
|
||||
@ -38,5 +33,5 @@ friendly for programmatic use.</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-repo — npm@1.4.9</p>
|
||||
<p id="footer">npm-repo — npm@1.4.10</p>
|
||||
|
||||
|
||||
22
deps/npm/html/doc/api/npm-restart.html
vendored
22
deps/npm/html/doc/api/npm-restart.html
vendored
@ -10,25 +10,21 @@
|
||||
<div id="wrapper">
|
||||
|
||||
<h1><a href="../api/npm-restart.html">npm-restart</a></h1> <p>Start a package</p>
|
||||
|
||||
<h2 id="SYNOPSIS">SYNOPSIS</h2>
|
||||
|
||||
<pre><code>npm.commands.restart(packages, callback)</code></pre>
|
||||
|
||||
<h2 id="DESCRIPTION">DESCRIPTION</h2>
|
||||
|
||||
<h2 id="synopsis">SYNOPSIS</h2>
|
||||
<pre><code>npm.commands.restart(packages, callback)
|
||||
</code></pre><h2 id="description">DESCRIPTION</h2>
|
||||
<p>This runs a package's "restart" script, if one was provided.
|
||||
Otherwise it runs package's "stop" script, if one was provided, and then
|
||||
the "start" script.</p>
|
||||
|
||||
<p>If no version is specified, then it restarts the "active" version.</p>
|
||||
|
||||
<p>npm can run tests on multiple packages. Just specify multiple packages
|
||||
in the <code>packages</code> parameter.</p>
|
||||
<h2 id="see-also">SEE ALSO</h2>
|
||||
<ul>
|
||||
<li><a href="../api/npm-start.html">npm-start(3)</a></li>
|
||||
<li><a href="../api/npm-stop.html">npm-stop(3)</a></li>
|
||||
</ul>
|
||||
|
||||
<h2 id="SEE-ALSO">SEE ALSO</h2>
|
||||
|
||||
<ul><li><a href="../api/npm-start.html">npm-start(3)</a></li><li><a href="../api/npm-stop.html">npm-stop(3)</a></li></ul>
|
||||
</div>
|
||||
|
||||
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
|
||||
@ -40,5 +36,5 @@ in the <code>packages</code> parameter.</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-restart — npm@1.4.9</p>
|
||||
<p id="footer">npm-restart — npm@1.4.10</p>
|
||||
|
||||
|
||||
15
deps/npm/html/doc/api/npm-root.html
vendored
15
deps/npm/html/doc/api/npm-root.html
vendored
@ -10,19 +10,14 @@
|
||||
<div id="wrapper">
|
||||
|
||||
<h1><a href="../api/npm-root.html">npm-root</a></h1> <p>Display npm root</p>
|
||||
|
||||
<h2 id="SYNOPSIS">SYNOPSIS</h2>
|
||||
|
||||
<pre><code>npm.commands.root(args, callback)</code></pre>
|
||||
|
||||
<h2 id="DESCRIPTION">DESCRIPTION</h2>
|
||||
|
||||
<h2 id="synopsis">SYNOPSIS</h2>
|
||||
<pre><code>npm.commands.root(args, callback)
|
||||
</code></pre><h2 id="description">DESCRIPTION</h2>
|
||||
<p>Print the effective <code>node_modules</code> folder to standard out.</p>
|
||||
|
||||
<p>'args' is never used and callback is never called with data.
|
||||
'args' must be present or things will break.</p>
|
||||
|
||||
<p>This function is not useful programmatically.</p>
|
||||
|
||||
</div>
|
||||
|
||||
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
|
||||
@ -34,5 +29,5 @@
|
||||
<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-root — npm@1.4.9</p>
|
||||
<p id="footer">npm-root — npm@1.4.10</p>
|
||||
|
||||
|
||||
25
deps/npm/html/doc/api/npm-run-script.html
vendored
25
deps/npm/html/doc/api/npm-run-script.html
vendored
@ -10,27 +10,26 @@
|
||||
<div id="wrapper">
|
||||
|
||||
<h1><a href="../api/npm-run-script.html">npm-run-script</a></h1> <p>Run arbitrary package scripts</p>
|
||||
|
||||
<h2 id="SYNOPSIS">SYNOPSIS</h2>
|
||||
|
||||
<pre><code>npm.commands.run-script(args, callback)</code></pre>
|
||||
|
||||
<h2 id="DESCRIPTION">DESCRIPTION</h2>
|
||||
|
||||
<h2 id="synopsis">SYNOPSIS</h2>
|
||||
<pre><code>npm.commands.run-script(args, callback)
|
||||
</code></pre><h2 id="description">DESCRIPTION</h2>
|
||||
<p>This runs an arbitrary command from a package's "scripts" object.</p>
|
||||
|
||||
<p>It is used by the test, start, restart, and stop commands, but can be
|
||||
called directly, as well.</p>
|
||||
|
||||
<p>The 'args' parameter is an array of strings. Behavior depends on the number
|
||||
of elements. If there is only one element, npm assumes that the element
|
||||
represents a command to be run on the local repository. If there is more than
|
||||
one element, then the first is assumed to be the package and the second is
|
||||
assumed to be the command to run. All other elements are ignored.</p>
|
||||
<h2 id="see-also">SEE ALSO</h2>
|
||||
<ul>
|
||||
<li><a href="../misc/npm-scripts.html">npm-scripts(7)</a></li>
|
||||
<li><a href="../api/npm-test.html">npm-test(3)</a></li>
|
||||
<li><a href="../api/npm-start.html">npm-start(3)</a></li>
|
||||
<li><a href="../api/npm-restart.html">npm-restart(3)</a></li>
|
||||
<li><a href="../api/npm-stop.html">npm-stop(3)</a></li>
|
||||
</ul>
|
||||
|
||||
<h2 id="SEE-ALSO">SEE ALSO</h2>
|
||||
|
||||
<ul><li><a href="../misc/npm-scripts.html">npm-scripts(7)</a></li><li><a href="../api/npm-test.html">npm-test(3)</a></li><li><a href="../api/npm-start.html">npm-start(3)</a></li><li><a href="../api/npm-restart.html">npm-restart(3)</a></li><li><a href="../api/npm-stop.html">npm-stop(3)</a></li></ul>
|
||||
</div>
|
||||
|
||||
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
|
||||
@ -42,5 +41,5 @@ assumed to be the command to run. All other elements are 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">npm-run-script — npm@1.4.9</p>
|
||||
<p id="footer">npm-run-script — npm@1.4.10</p>
|
||||
|
||||
|
||||
38
deps/npm/html/doc/api/npm-search.html
vendored
38
deps/npm/html/doc/api/npm-search.html
vendored
@ -10,30 +10,38 @@
|
||||
<div id="wrapper">
|
||||
|
||||
<h1><a href="../api/npm-search.html">npm-search</a></h1> <p>Search for packages</p>
|
||||
|
||||
<h2 id="SYNOPSIS">SYNOPSIS</h2>
|
||||
|
||||
<pre><code>npm.commands.search(searchTerms, [silent,] [staleness,] callback)</code></pre>
|
||||
|
||||
<h2 id="DESCRIPTION">DESCRIPTION</h2>
|
||||
|
||||
<h2 id="synopsis">SYNOPSIS</h2>
|
||||
<pre><code>npm.commands.search(searchTerms, [silent,] [staleness,] callback)
|
||||
</code></pre><h2 id="description">DESCRIPTION</h2>
|
||||
<p>Search the registry for packages matching the search terms. The available parameters are:</p>
|
||||
|
||||
<ul><li>searchTerms:
|
||||
Array of search terms. These terms are case-insensitive.</li><li>silent:
|
||||
If true, npm will not log anything to the console.</li><li>staleness:
|
||||
<ul>
|
||||
<li>searchTerms:
|
||||
Array of search terms. These terms are case-insensitive.</li>
|
||||
<li>silent:
|
||||
If true, npm will not log anything to the console.</li>
|
||||
<li>staleness:
|
||||
This is the threshold for stale packages. "Fresh" packages are not refreshed
|
||||
from the registry. This value is measured in seconds.</li><li><p>callback:
|
||||
from the registry. This value is measured in seconds.</li>
|
||||
<li><p>callback:
|
||||
Returns an object where each key is the name of a package, and the value
|
||||
is information about that package along with a 'words' property, which is
|
||||
a space-delimited string of all of the interesting words in that package.
|
||||
The only properties included are those that are searched, which generally include:</p><ul><li>name</li><li>description</li><li>maintainers</li><li>url</li><li>keywords</li></ul></li></ul>
|
||||
|
||||
The only properties included are those that are searched, which generally include:</p>
|
||||
<ul>
|
||||
<li>name</li>
|
||||
<li>description</li>
|
||||
<li>maintainers</li>
|
||||
<li>url</li>
|
||||
<li>keywords</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<p>A search on the registry excludes any result that does not match all of the
|
||||
search terms. It also removes any items from the results that contain an
|
||||
excluded term (the "searchexclude" config). The search is case insensitive
|
||||
and doesn't try to read your mind (it doesn't do any verb tense matching or the
|
||||
like).</p>
|
||||
|
||||
</div>
|
||||
|
||||
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
|
||||
@ -45,5 +53,5 @@ like).</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-search — npm@1.4.9</p>
|
||||
<p id="footer">npm-search — npm@1.4.10</p>
|
||||
|
||||
|
||||
16
deps/npm/html/doc/api/npm-shrinkwrap.html
vendored
16
deps/npm/html/doc/api/npm-shrinkwrap.html
vendored
@ -10,24 +10,18 @@
|
||||
<div id="wrapper">
|
||||
|
||||
<h1><a href="../api/npm-shrinkwrap.html">npm-shrinkwrap</a></h1> <p>programmatically generate package shrinkwrap file</p>
|
||||
|
||||
<h2 id="SYNOPSIS">SYNOPSIS</h2>
|
||||
|
||||
<pre><code>npm.commands.shrinkwrap(args, [silent,] callback)</code></pre>
|
||||
|
||||
<h2 id="DESCRIPTION">DESCRIPTION</h2>
|
||||
|
||||
<h2 id="synopsis">SYNOPSIS</h2>
|
||||
<pre><code>npm.commands.shrinkwrap(args, [silent,] callback)
|
||||
</code></pre><h2 id="description">DESCRIPTION</h2>
|
||||
<p>This acts much the same ways as shrinkwrapping on the command-line.</p>
|
||||
|
||||
<p>This command does not take any arguments, but 'args' must be defined.
|
||||
Beyond that, if any arguments are passed in, npm will politely warn that it
|
||||
does not take positional arguments.</p>
|
||||
|
||||
<p>If the 'silent' parameter is set to true, nothing will be output to the screen,
|
||||
but the shrinkwrap file will still be written.</p>
|
||||
|
||||
<p>Finally, 'callback' is a function that will be called when the shrinkwrap has
|
||||
been saved.</p>
|
||||
|
||||
</div>
|
||||
|
||||
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
|
||||
@ -39,5 +33,5 @@ been saved.</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@1.4.9</p>
|
||||
<p id="footer">npm-shrinkwrap — npm@1.4.10</p>
|
||||
|
||||
|
||||
14
deps/npm/html/doc/api/npm-start.html
vendored
14
deps/npm/html/doc/api/npm-start.html
vendored
@ -10,17 +10,13 @@
|
||||
<div id="wrapper">
|
||||
|
||||
<h1><a href="../api/npm-start.html">npm-start</a></h1> <p>Start a package</p>
|
||||
|
||||
<h2 id="SYNOPSIS">SYNOPSIS</h2>
|
||||
|
||||
<pre><code>npm.commands.start(packages, callback)</code></pre>
|
||||
|
||||
<h2 id="DESCRIPTION">DESCRIPTION</h2>
|
||||
|
||||
<h2 id="synopsis">SYNOPSIS</h2>
|
||||
<pre><code>npm.commands.start(packages, callback)
|
||||
</code></pre><h2 id="description">DESCRIPTION</h2>
|
||||
<p>This runs a package's "start" script, if one was provided.</p>
|
||||
|
||||
<p>npm can run tests on multiple packages. Just specify multiple packages
|
||||
in the <code>packages</code> parameter.</p>
|
||||
|
||||
</div>
|
||||
|
||||
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
|
||||
@ -32,5 +28,5 @@ in the <code>packages</code> parameter.</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-start — npm@1.4.9</p>
|
||||
<p id="footer">npm-start — npm@1.4.10</p>
|
||||
|
||||
|
||||
14
deps/npm/html/doc/api/npm-stop.html
vendored
14
deps/npm/html/doc/api/npm-stop.html
vendored
@ -10,17 +10,13 @@
|
||||
<div id="wrapper">
|
||||
|
||||
<h1><a href="../api/npm-stop.html">npm-stop</a></h1> <p>Stop a package</p>
|
||||
|
||||
<h2 id="SYNOPSIS">SYNOPSIS</h2>
|
||||
|
||||
<pre><code>npm.commands.stop(packages, callback)</code></pre>
|
||||
|
||||
<h2 id="DESCRIPTION">DESCRIPTION</h2>
|
||||
|
||||
<h2 id="synopsis">SYNOPSIS</h2>
|
||||
<pre><code>npm.commands.stop(packages, callback)
|
||||
</code></pre><h2 id="description">DESCRIPTION</h2>
|
||||
<p>This runs a package's "stop" script, if one was provided.</p>
|
||||
|
||||
<p>npm can run stop on multiple packages. Just specify multiple packages
|
||||
in the <code>packages</code> parameter.</p>
|
||||
|
||||
</div>
|
||||
|
||||
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
|
||||
@ -32,5 +28,5 @@ in the <code>packages</code> parameter.</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-stop — npm@1.4.9</p>
|
||||
<p id="footer">npm-stop — npm@1.4.10</p>
|
||||
|
||||
|
||||
22
deps/npm/html/doc/api/npm-submodule.html
vendored
22
deps/npm/html/doc/api/npm-submodule.html
vendored
@ -10,31 +10,27 @@
|
||||
<div id="wrapper">
|
||||
|
||||
<h1><a href="../api/npm-submodule.html">npm-submodule</a></h1> <p>Add a package as a git submodule</p>
|
||||
|
||||
<h2 id="SYNOPSIS">SYNOPSIS</h2>
|
||||
|
||||
<pre><code>npm.commands.submodule(packages, callback)</code></pre>
|
||||
|
||||
<h2 id="DESCRIPTION">DESCRIPTION</h2>
|
||||
|
||||
<h2 id="synopsis">SYNOPSIS</h2>
|
||||
<pre><code>npm.commands.submodule(packages, callback)
|
||||
</code></pre><h2 id="description">DESCRIPTION</h2>
|
||||
<p>For each package specified, npm will check if it has a git repository url
|
||||
in its package.json description then add it as a git submodule at
|
||||
<code>node_modules/<pkg name></code>.</p>
|
||||
|
||||
<p>This is a convenience only. From then on, it's up to you to manage
|
||||
updates by using the appropriate git commands. npm will stubbornly
|
||||
refuse to update, modify, or remove anything with a <code>.git</code> subfolder
|
||||
in it.</p>
|
||||
|
||||
<p>This command also does not install missing dependencies, if the package
|
||||
does not include them in its git repository. If <code>npm ls</code> reports that
|
||||
things are missing, you can either install, link, or submodule them yourself,
|
||||
or you can do <code>npm explore <pkgname> -- npm install</code> to install the
|
||||
dependencies into the submodule folder.</p>
|
||||
<h2 id="see-also">SEE ALSO</h2>
|
||||
<ul>
|
||||
<li>npm help json</li>
|
||||
<li>git help submodule</li>
|
||||
</ul>
|
||||
|
||||
<h2 id="SEE-ALSO">SEE ALSO</h2>
|
||||
|
||||
<ul><li>npm help json</li><li>git help submodule</li></ul>
|
||||
</div>
|
||||
|
||||
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
|
||||
@ -46,5 +42,5 @@ dependencies into the submodule folder.</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-submodule — npm@1.4.9</p>
|
||||
<p id="footer">npm-submodule — npm@1.4.10</p>
|
||||
|
||||
|
||||
16
deps/npm/html/doc/api/npm-tag.html
vendored
16
deps/npm/html/doc/api/npm-tag.html
vendored
@ -10,27 +10,21 @@
|
||||
<div id="wrapper">
|
||||
|
||||
<h1><a href="../api/npm-tag.html">npm-tag</a></h1> <p>Tag a published version</p>
|
||||
|
||||
<h2 id="SYNOPSIS">SYNOPSIS</h2>
|
||||
|
||||
<pre><code>npm.commands.tag(package@version, tag, callback)</code></pre>
|
||||
|
||||
<h2 id="DESCRIPTION">DESCRIPTION</h2>
|
||||
|
||||
<h2 id="synopsis">SYNOPSIS</h2>
|
||||
<pre><code>npm.commands.tag(package@version, tag, callback)
|
||||
</code></pre><h2 id="description">DESCRIPTION</h2>
|
||||
<p>Tags the specified version of the package with the specified tag, or the
|
||||
<code>--tag</code> config if not specified.</p>
|
||||
|
||||
<p>The 'package@version' is an array of strings, but only the first two elements are
|
||||
currently used.</p>
|
||||
|
||||
<p>The first element must be in the form package@version, where package
|
||||
is the package name and version is the version number (much like installing a
|
||||
specific version).</p>
|
||||
|
||||
<p>The second element is the name of the tag to tag this version with. If this
|
||||
parameter is missing or falsey (empty), the default froom the config will be
|
||||
used. For more information about how to set this config, check
|
||||
<code>man 3 npm-config</code> for programmatic usage or <code>man npm-config</code> for cli usage.</p>
|
||||
|
||||
</div>
|
||||
|
||||
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
|
||||
@ -42,5 +36,5 @@ used. For more information about how to set this config, check
|
||||
<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-tag — npm@1.4.9</p>
|
||||
<p id="footer">npm-tag — npm@1.4.10</p>
|
||||
|
||||
|
||||
15
deps/npm/html/doc/api/npm-test.html
vendored
15
deps/npm/html/doc/api/npm-test.html
vendored
@ -10,20 +10,15 @@
|
||||
<div id="wrapper">
|
||||
|
||||
<h1><a href="../api/npm-test.html">npm-test</a></h1> <p>Test a package</p>
|
||||
|
||||
<h2 id="SYNOPSIS">SYNOPSIS</h2>
|
||||
|
||||
<pre><code> npm.commands.test(packages, callback)</code></pre>
|
||||
|
||||
<h2 id="DESCRIPTION">DESCRIPTION</h2>
|
||||
|
||||
<h2 id="synopsis">SYNOPSIS</h2>
|
||||
<pre><code> npm.commands.test(packages, callback)
|
||||
</code></pre><h2 id="description">DESCRIPTION</h2>
|
||||
<p>This runs a package's "test" script, if one was provided.</p>
|
||||
|
||||
<p>To run tests as a condition of installation, set the <code>npat</code> config to
|
||||
true.</p>
|
||||
|
||||
<p>npm can run tests on multiple packages. Just specify multiple packages
|
||||
in the <code>packages</code> parameter.</p>
|
||||
|
||||
</div>
|
||||
|
||||
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
|
||||
@ -35,5 +30,5 @@ in the <code>packages</code> parameter.</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-test — npm@1.4.9</p>
|
||||
<p id="footer">npm-test — npm@1.4.10</p>
|
||||
|
||||
|
||||
15
deps/npm/html/doc/api/npm-uninstall.html
vendored
15
deps/npm/html/doc/api/npm-uninstall.html
vendored
@ -10,20 +10,15 @@
|
||||
<div id="wrapper">
|
||||
|
||||
<h1><a href="../api/npm-uninstall.html">npm-uninstall</a></h1> <p>uninstall a package programmatically</p>
|
||||
|
||||
<h2 id="SYNOPSIS">SYNOPSIS</h2>
|
||||
|
||||
<pre><code>npm.commands.uninstall(packages, callback)</code></pre>
|
||||
|
||||
<h2 id="DESCRIPTION">DESCRIPTION</h2>
|
||||
|
||||
<h2 id="synopsis">SYNOPSIS</h2>
|
||||
<pre><code>npm.commands.uninstall(packages, callback)
|
||||
</code></pre><h2 id="description">DESCRIPTION</h2>
|
||||
<p>This acts much the same ways as uninstalling on the command-line.</p>
|
||||
|
||||
<p>The 'packages' parameter is an array of strings. Each element in the array is
|
||||
the name of a package to be uninstalled.</p>
|
||||
|
||||
<p>Finally, 'callback' is a function that will be called when all packages have been
|
||||
uninstalled or when an error has been encountered.</p>
|
||||
|
||||
</div>
|
||||
|
||||
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
|
||||
@ -35,5 +30,5 @@ uninstalled or when an error has been encountered.</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-uninstall — npm@1.4.9</p>
|
||||
<p id="footer">npm-uninstall — npm@1.4.10</p>
|
||||
|
||||
|
||||
16
deps/npm/html/doc/api/npm-unpublish.html
vendored
16
deps/npm/html/doc/api/npm-unpublish.html
vendored
@ -10,24 +10,18 @@
|
||||
<div id="wrapper">
|
||||
|
||||
<h1><a href="../api/npm-unpublish.html">npm-unpublish</a></h1> <p>Remove a package from the registry</p>
|
||||
|
||||
<h2 id="SYNOPSIS">SYNOPSIS</h2>
|
||||
|
||||
<pre><code>npm.commands.unpublish(package, callback)</code></pre>
|
||||
|
||||
<h2 id="DESCRIPTION">DESCRIPTION</h2>
|
||||
|
||||
<h2 id="synopsis">SYNOPSIS</h2>
|
||||
<pre><code>npm.commands.unpublish(package, callback)
|
||||
</code></pre><h2 id="description">DESCRIPTION</h2>
|
||||
<p>This removes a package version from the registry, deleting its
|
||||
entry and removing the tarball.</p>
|
||||
|
||||
<p>The package parameter must be defined.</p>
|
||||
|
||||
<p>Only the first element in the package parameter is used. If there is no first
|
||||
element, then npm assumes that the package at the current working directory
|
||||
is what is meant.</p>
|
||||
|
||||
<p>If no version is specified, or if all versions are removed then
|
||||
the root package entry is removed from the registry entirely.</p>
|
||||
|
||||
</div>
|
||||
|
||||
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
|
||||
@ -39,5 +33,5 @@ the root package entry is removed from the registry entirely.</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-unpublish — npm@1.4.9</p>
|
||||
<p id="footer">npm-unpublish — npm@1.4.10</p>
|
||||
|
||||
|
||||
14
deps/npm/html/doc/api/npm-update.html
vendored
14
deps/npm/html/doc/api/npm-update.html
vendored
@ -10,16 +10,12 @@
|
||||
<div id="wrapper">
|
||||
|
||||
<h1><a href="../api/npm-update.html">npm-update</a></h1> <p>Update a package</p>
|
||||
|
||||
<h2 id="SYNOPSIS">SYNOPSIS</h2>
|
||||
|
||||
<pre><code>npm.commands.update(packages, callback)</code></pre>
|
||||
|
||||
<h1>DESCRIPTION</h1>
|
||||
|
||||
<h2 id="synopsis">SYNOPSIS</h2>
|
||||
<pre><code>npm.commands.update(packages, callback)
|
||||
</code></pre><h1 id="description">DESCRIPTION</h1>
|
||||
<p>Updates a package, upgrading it to the latest version. It also installs any missing packages.</p>
|
||||
|
||||
<p>The 'packages' argument is an array of packages to update. The 'callback' parameter will be called when done or when an error occurs.</p>
|
||||
|
||||
</div>
|
||||
|
||||
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
|
||||
@ -31,5 +27,5 @@
|
||||
<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-update — npm@1.4.9</p>
|
||||
<p id="footer">npm-update — npm@1.4.10</p>
|
||||
|
||||
|
||||
15
deps/npm/html/doc/api/npm-version.html
vendored
15
deps/npm/html/doc/api/npm-version.html
vendored
@ -10,22 +10,17 @@
|
||||
<div id="wrapper">
|
||||
|
||||
<h1><a href="../api/npm-version.html">npm-version</a></h1> <p>Bump a package version</p>
|
||||
|
||||
<h2 id="SYNOPSIS">SYNOPSIS</h2>
|
||||
|
||||
<pre><code>npm.commands.version(newversion, callback)</code></pre>
|
||||
|
||||
<h2 id="DESCRIPTION">DESCRIPTION</h2>
|
||||
|
||||
<h2 id="synopsis">SYNOPSIS</h2>
|
||||
<pre><code>npm.commands.version(newversion, callback)
|
||||
</code></pre><h2 id="description">DESCRIPTION</h2>
|
||||
<p>Run this in a package directory to bump the version and write the new
|
||||
data back to the package.json file.</p>
|
||||
|
||||
<p>If run in a git repo, it will also create a version commit and tag, and
|
||||
fail if the repo is not clean.</p>
|
||||
|
||||
<p>Like all other commands, this function takes a string array as its first
|
||||
parameter. The difference, however, is this function will fail if it does
|
||||
not have exactly one element. The only element should be a version number.</p>
|
||||
|
||||
</div>
|
||||
|
||||
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
|
||||
@ -37,5 +32,5 @@ not have exactly one element. The only element should be a version number.</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-version — npm@1.4.9</p>
|
||||
<p id="footer">npm-version — npm@1.4.10</p>
|
||||
|
||||
|
||||
77
deps/npm/html/doc/api/npm-view.html
vendored
77
deps/npm/html/doc/api/npm-view.html
vendored
@ -10,97 +10,66 @@
|
||||
<div id="wrapper">
|
||||
|
||||
<h1><a href="../api/npm-view.html">npm-view</a></h1> <p>View registry info</p>
|
||||
|
||||
<h2 id="SYNOPSIS">SYNOPSIS</h2>
|
||||
|
||||
<pre><code>npm.commands.view(args, [silent,] callback)</code></pre>
|
||||
|
||||
<h2 id="DESCRIPTION">DESCRIPTION</h2>
|
||||
|
||||
<h2 id="synopsis">SYNOPSIS</h2>
|
||||
<pre><code>npm.commands.view(args, [silent,] callback)
|
||||
</code></pre><h2 id="description">DESCRIPTION</h2>
|
||||
<p>This command shows data about a package and prints it to the stream
|
||||
referenced by the <code>outfd</code> config, which defaults to stdout.</p>
|
||||
|
||||
<p>The "args" parameter is an ordered list that closely resembles the command-line
|
||||
usage. The elements should be ordered such that the first element is
|
||||
the package and version (package@version). The version is optional. After that,
|
||||
the rest of the parameters are fields with optional subfields ("field.subfield")
|
||||
which can be used to get only the information desired from the registry.</p>
|
||||
|
||||
<p>The callback will be passed all of the data returned by the query.</p>
|
||||
|
||||
<p>For example, to get the package registry entry for the <code>connect</code> package,
|
||||
you can do this:</p>
|
||||
|
||||
<pre><code>npm.commands.view(["connect"], callback)</code></pre>
|
||||
|
||||
<p>If no version is specified, "latest" is assumed.</p>
|
||||
|
||||
<pre><code>npm.commands.view(["connect"], callback)
|
||||
</code></pre><p>If no version is specified, "latest" is assumed.</p>
|
||||
<p>Field names can be specified after the package descriptor.
|
||||
For example, to show the dependencies of the <code>ronn</code> package at version
|
||||
0.3.5, you could do the following:</p>
|
||||
|
||||
<pre><code>npm.commands.view(["ronn@0.3.5", "dependencies"], callback)</code></pre>
|
||||
|
||||
<p>You can view child field by separating them with a period.
|
||||
<pre><code>npm.commands.view(["ronn@0.3.5", "dependencies"], callback)
|
||||
</code></pre><p>You can view child field by separating them with a period.
|
||||
To view the git repository URL for the latest version of npm, you could
|
||||
do this:</p>
|
||||
|
||||
<pre><code>npm.commands.view(["npm", "repository.url"], callback)</code></pre>
|
||||
|
||||
<p>For fields that are arrays, requesting a non-numeric field will return
|
||||
<pre><code>npm.commands.view(["npm", "repository.url"], callback)
|
||||
</code></pre><p>For fields that are arrays, requesting a non-numeric field will return
|
||||
all of the values from the objects in the list. For example, to get all
|
||||
the contributor names for the "express" project, you can do this:</p>
|
||||
|
||||
<pre><code>npm.commands.view(["express", "contributors.email"], callback)</code></pre>
|
||||
|
||||
<p>You may also use numeric indices in square braces to specifically select
|
||||
<pre><code>npm.commands.view(["express", "contributors.email"], callback)
|
||||
</code></pre><p>You may also use numeric indices in square braces to specifically select
|
||||
an item in an array field. To just get the email address of the first
|
||||
contributor in the list, you can do this:</p>
|
||||
|
||||
<pre><code>npm.commands.view(["express", "contributors[0].email"], callback)</code></pre>
|
||||
|
||||
<p>Multiple fields may be specified, and will be printed one after another.
|
||||
<pre><code>npm.commands.view(["express", "contributors[0].email"], callback)
|
||||
</code></pre><p>Multiple fields may be specified, and will be printed one after another.
|
||||
For exampls, to get all the contributor names and email addresses, you
|
||||
can do this:</p>
|
||||
|
||||
<pre><code>npm.commands.view(["express", "contributors.name", "contributors.email"], callback)</code></pre>
|
||||
|
||||
<p>"Person" fields are shown as a string if they would be shown as an
|
||||
<pre><code>npm.commands.view(["express", "contributors.name", "contributors.email"], callback)
|
||||
</code></pre><p>"Person" fields are shown as a string if they would be shown as an
|
||||
object. So, for example, this will show the list of npm contributors in
|
||||
the shortened string format. (See <code>npm help json</code> for more on this.)</p>
|
||||
|
||||
<pre><code>npm.commands.view(["npm", "contributors"], callback)</code></pre>
|
||||
|
||||
<p>If a version range is provided, then data will be printed for every
|
||||
<pre><code>npm.commands.view(["npm", "contributors"], callback)
|
||||
</code></pre><p>If a version range is provided, then data will be printed for every
|
||||
matching version of the package. This will show which version of jsdom
|
||||
was required by each matching version of yui3:</p>
|
||||
|
||||
<pre><code>npm.commands.view(["yui3@'>0.5.4'", "dependencies.jsdom"], callback)</code></pre>
|
||||
|
||||
<h2 id="OUTPUT">OUTPUT</h2>
|
||||
|
||||
<pre><code>npm.commands.view(["yui3@'>0.5.4'", "dependencies.jsdom"], callback)
|
||||
</code></pre><h2 id="output">OUTPUT</h2>
|
||||
<p>If only a single string field for a single version is output, then it
|
||||
will not be colorized or quoted, so as to enable piping the output to
|
||||
another command.</p>
|
||||
|
||||
<p>If the version range matches multiple versions, than each printed value
|
||||
will be prefixed with the version it applies to.</p>
|
||||
|
||||
<p>If multiple fields are requested, than each of them are prefixed with
|
||||
the field name.</p>
|
||||
|
||||
<p>Console output can be disabled by setting the 'silent' parameter to true.</p>
|
||||
|
||||
<h2 id="RETURN-VALUE">RETURN VALUE</h2>
|
||||
|
||||
<h2 id="return-value">RETURN VALUE</h2>
|
||||
<p>The data returned will be an object in this formation:</p>
|
||||
|
||||
<pre><code>{ <version>:
|
||||
{ <field>: <value>
|
||||
, ... }
|
||||
, ... }</code></pre>
|
||||
, ... }
|
||||
</code></pre><p>corresponding to the list of fields selected.</p>
|
||||
|
||||
<p>corresponding to the list of fields selected.</p>
|
||||
</div>
|
||||
|
||||
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
|
||||
@ -112,5 +81,5 @@ the field name.</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-view — npm@1.4.9</p>
|
||||
<p id="footer">npm-view — npm@1.4.10</p>
|
||||
|
||||
|
||||
15
deps/npm/html/doc/api/npm-whoami.html
vendored
15
deps/npm/html/doc/api/npm-whoami.html
vendored
@ -10,19 +10,14 @@
|
||||
<div id="wrapper">
|
||||
|
||||
<h1><a href="../api/npm-whoami.html">npm-whoami</a></h1> <p>Display npm username</p>
|
||||
|
||||
<h2 id="SYNOPSIS">SYNOPSIS</h2>
|
||||
|
||||
<pre><code>npm.commands.whoami(args, callback)</code></pre>
|
||||
|
||||
<h2 id="DESCRIPTION">DESCRIPTION</h2>
|
||||
|
||||
<h2 id="synopsis">SYNOPSIS</h2>
|
||||
<pre><code>npm.commands.whoami(args, callback)
|
||||
</code></pre><h2 id="description">DESCRIPTION</h2>
|
||||
<p>Print the <code>username</code> config to standard output.</p>
|
||||
|
||||
<p>'args' is never used and callback is never called with data.
|
||||
'args' must be present or things will break.</p>
|
||||
|
||||
<p>This function is not useful programmatically</p>
|
||||
|
||||
</div>
|
||||
|
||||
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
|
||||
@ -34,5 +29,5 @@
|
||||
<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-whoami — npm@1.4.9</p>
|
||||
<p id="footer">npm-whoami — npm@1.4.10</p>
|
||||
|
||||
|
||||
87
deps/npm/html/doc/api/npm.html
vendored
87
deps/npm/html/doc/api/npm.html
vendored
@ -10,9 +10,7 @@
|
||||
<div id="wrapper">
|
||||
|
||||
<h1><a href="../api/npm.html">npm</a></h1> <p>node package manager</p>
|
||||
|
||||
<h2 id="SYNOPSIS">SYNOPSIS</h2>
|
||||
|
||||
<h2 id="synopsis">SYNOPSIS</h2>
|
||||
<pre><code>var npm = require("npm")
|
||||
npm.load([configObject, ]function (er, npm) {
|
||||
// use the npm object, now that it's loaded.
|
||||
@ -23,18 +21,13 @@ npm.load([configObject, ]function (er, npm) {
|
||||
console.log("prefix = %s", npm.prefix)
|
||||
|
||||
npm.commands.install(["package"], cb)
|
||||
})</code></pre>
|
||||
|
||||
<h2 id="VERSION">VERSION</h2>
|
||||
|
||||
<p>1.4.9</p>
|
||||
|
||||
<h2 id="DESCRIPTION">DESCRIPTION</h2>
|
||||
|
||||
})
|
||||
</code></pre><h2 id="version">VERSION</h2>
|
||||
<p>1.4.10</p>
|
||||
<h2 id="description">DESCRIPTION</h2>
|
||||
<p>This is the API documentation for npm.
|
||||
To find documentation of the command line
|
||||
client, see <code><a href="../cli/npm.html">npm(1)</a></code>.</p>
|
||||
|
||||
<p>Prior to using npm's commands, <code>npm.load()</code> must be called.
|
||||
If you provide <code>configObject</code> as an object hash of top-level
|
||||
configs, they override the values stored in the various config
|
||||
@ -42,58 +35,70 @@ locations. In the npm command line client, this set of configs
|
||||
is parsed from the command line options. Additional configuration
|
||||
params are loaded from two configuration files. See <code><a href="../cli/npm-config.html">npm-config(1)</a></code>,
|
||||
<code><a href="../misc/npm-config.html">npm-config(7)</a></code>, and <code><a href="../files/npmrc.html">npmrc(5)</a></code> for more information.</p>
|
||||
|
||||
<p>After that, each of the functions are accessible in the
|
||||
commands object: <code>npm.commands.<cmd></code>. See <code><a href="../misc/npm-index.html">npm-index(7)</a></code> for a list of
|
||||
all possible commands.</p>
|
||||
|
||||
<p>All commands on the command object take an <strong>array</strong> of positional argument
|
||||
<strong>strings</strong>. The last argument to any function is a callback. Some
|
||||
commands take other optional arguments.</p>
|
||||
|
||||
<p>Configs cannot currently be set on a per function basis, as each call to
|
||||
npm.config.set will change the value for <em>all</em> npm commands in that process.</p>
|
||||
|
||||
<p>To find API documentation for a specific command, run the <code>npm apihelp</code>
|
||||
command.</p>
|
||||
|
||||
<h2 id="METHODS-AND-PROPERTIES">METHODS AND PROPERTIES</h2>
|
||||
|
||||
<ul><li><p><code>npm.load(configs, cb)</code></p><p>Load the configuration params, and call the <code>cb</code> function once the
|
||||
globalconfig and userconfig files have been loaded as well, or on
|
||||
nextTick if they've already been loaded.</p></li><li><p><code>npm.config</code></p><p>An object for accessing npm configuration parameters.</p><ul><li><p><code>npm.config.get(key)</code></p></li><li><code>npm.config.set(key, val)</code></li><li><p><code>npm.config.del(key)</code></p></li></ul></li><li><p><code>npm.dir</code> or <code>npm.root</code></p><p>The <code>node_modules</code> directory where npm will operate.</p></li><li><p><code>npm.prefix</code></p><p>The prefix where npm is operating. (Most often the current working
|
||||
directory.)</p></li><li><p><code>npm.cache</code></p><p>The place where npm keeps JSON and tarballs it fetches from the
|
||||
registry (or uploads to the registry).</p></li><li><p><code>npm.tmp</code></p><p>npm's temporary working directory.</p></li><li><p><code>npm.deref</code></p><p>Get the "real" name for a command that has either an alias or
|
||||
abbreviation.</p></li></ul>
|
||||
|
||||
<h2 id="MAGIC">MAGIC</h2>
|
||||
|
||||
<h2 id="methods-and-properties">METHODS AND PROPERTIES</h2>
|
||||
<ul>
|
||||
<li><p><code>npm.load(configs, cb)</code></p>
|
||||
<p> Load the configuration params, and call the <code>cb</code> function once the
|
||||
globalconfig and userconfig files have been loaded as well, or on
|
||||
nextTick if they've already been loaded.</p>
|
||||
</li>
|
||||
<li><p><code>npm.config</code></p>
|
||||
<p> An object for accessing npm configuration parameters.</p>
|
||||
<ul>
|
||||
<li><code>npm.config.get(key)</code></li>
|
||||
<li><code>npm.config.set(key, val)</code></li>
|
||||
<li><code>npm.config.del(key)</code></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><p><code>npm.dir</code> or <code>npm.root</code></p>
|
||||
<p> The <code>node_modules</code> directory where npm will operate.</p>
|
||||
</li>
|
||||
<li><p><code>npm.prefix</code></p>
|
||||
<p> The prefix where npm is operating. (Most often the current working
|
||||
directory.)</p>
|
||||
</li>
|
||||
<li><p><code>npm.cache</code></p>
|
||||
<p> The place where npm keeps JSON and tarballs it fetches from the
|
||||
registry (or uploads to the registry).</p>
|
||||
</li>
|
||||
<li><p><code>npm.tmp</code></p>
|
||||
<p> npm's temporary working directory.</p>
|
||||
</li>
|
||||
<li><p><code>npm.deref</code></p>
|
||||
<p> Get the "real" name for a command that has either an alias or
|
||||
abbreviation.</p>
|
||||
</li>
|
||||
</ul>
|
||||
<h2 id="magic">MAGIC</h2>
|
||||
<p>For each of the methods in the <code>npm.commands</code> hash, a method is added to
|
||||
the npm object, which takes a set of positional string arguments rather
|
||||
than an array and a callback.</p>
|
||||
|
||||
<p>If the last argument is a callback, then it will use the supplied
|
||||
callback. However, if no callback is provided, then it will print out
|
||||
the error or results.</p>
|
||||
|
||||
<p>For example, this would work in a node repl:</p>
|
||||
|
||||
<pre><code>> npm = require("npm")
|
||||
> npm.load() // wait a sec...
|
||||
> npm.install("dnode", "express")</code></pre>
|
||||
|
||||
<p>Note that that <em>won't</em> work in a node program, since the <code>install</code>
|
||||
> npm.install("dnode", "express")
|
||||
</code></pre><p>Note that that <em>won't</em> work in a node program, since the <code>install</code>
|
||||
method will get called before the configuration load is completed.</p>
|
||||
|
||||
<h2 id="ABBREVS">ABBREVS</h2>
|
||||
|
||||
<h2 id="abbrevs">ABBREVS</h2>
|
||||
<p>In order to support <code>npm ins foo</code> instead of <code>npm install foo</code>, the
|
||||
<code>npm.commands</code> object has a set of abbreviations as well as the full
|
||||
method names. Use the <code>npm.deref</code> method to find the real name.</p>
|
||||
|
||||
<p>For example:</p>
|
||||
|
||||
<pre><code>var cmd = npm.deref("unp") // cmd === "unpublish"</code></pre>
|
||||
<pre><code>var cmd = npm.deref("unp") // cmd === "unpublish"
|
||||
</code></pre>
|
||||
</div>
|
||||
|
||||
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
|
||||
@ -105,5 +110,5 @@ method names. Use the <code>npm.deref</code> method to find the real name.</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 — npm@1.4.9</p>
|
||||
<p id="footer">npm — npm@1.4.10</p>
|
||||
|
||||
|
||||
36
deps/npm/html/doc/cli/npm-adduser.html
vendored
36
deps/npm/html/doc/cli/npm-adduser.html
vendored
@ -10,37 +10,31 @@
|
||||
<div id="wrapper">
|
||||
|
||||
<h1><a href="../cli/npm-adduser.html">npm-adduser</a></h1> <p>Add a registry user account</p>
|
||||
|
||||
<h2 id="SYNOPSIS">SYNOPSIS</h2>
|
||||
|
||||
<pre><code>npm adduser</code></pre>
|
||||
|
||||
<h2 id="DESCRIPTION">DESCRIPTION</h2>
|
||||
|
||||
<h2 id="synopsis">SYNOPSIS</h2>
|
||||
<pre><code>npm adduser
|
||||
</code></pre><h2 id="description">DESCRIPTION</h2>
|
||||
<p>Create or verify a user named <code><username></code> in the npm registry, and
|
||||
save the credentials to the <code>.npmrc</code> file.</p>
|
||||
|
||||
<p>The username, password, and email are read in from prompts.</p>
|
||||
|
||||
<p>You may use this command to change your email address, but not username
|
||||
or password.</p>
|
||||
|
||||
<p>To reset your password, go to <a href="https://npmjs.org/forgot">https://npmjs.org/forgot</a></p>
|
||||
|
||||
<p>You may use this command multiple times with the same user account to
|
||||
authorize on a new machine.</p>
|
||||
|
||||
<h2 id="CONFIGURATION">CONFIGURATION</h2>
|
||||
|
||||
<h2 id="configuration">CONFIGURATION</h2>
|
||||
<h3 id="registry">registry</h3>
|
||||
|
||||
<p>Default: http://registry.npmjs.org/</p>
|
||||
|
||||
<p>Default: <a href="http://registry.npmjs.org/">http://registry.npmjs.org/</a></p>
|
||||
<p>The base URL of the npm package registry.</p>
|
||||
<h2 id="see-also">SEE ALSO</h2>
|
||||
<ul>
|
||||
<li><a href="../misc/npm-registry.html">npm-registry(7)</a></li>
|
||||
<li><a href="../cli/npm-config.html">npm-config(1)</a></li>
|
||||
<li><a href="../misc/npm-config.html">npm-config(7)</a></li>
|
||||
<li><a href="../files/npmrc.html">npmrc(5)</a></li>
|
||||
<li><a href="../cli/npm-owner.html">npm-owner(1)</a></li>
|
||||
<li><a href="../cli/npm-whoami.html">npm-whoami(1)</a></li>
|
||||
</ul>
|
||||
|
||||
<h2 id="SEE-ALSO">SEE ALSO</h2>
|
||||
|
||||
<ul><li><a href="../misc/npm-registry.html">npm-registry(7)</a></li><li><a href="../cli/npm-config.html">npm-config(1)</a></li><li><a href="../misc/npm-config.html">npm-config(7)</a></li><li><a href="../files/npmrc.html">npmrc(5)</a></li><li><a href="../cli/npm-owner.html">npm-owner(1)</a></li><li><a href="../cli/npm-whoami.html">npm-whoami(1)</a></li></ul>
|
||||
</div>
|
||||
|
||||
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
|
||||
@ -52,5 +46,5 @@ authorize on a new machine.</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-adduser — npm@1.4.9</p>
|
||||
<p id="footer">npm-adduser — npm@1.4.10</p>
|
||||
|
||||
|
||||
24
deps/npm/html/doc/cli/npm-bin.html
vendored
24
deps/npm/html/doc/cli/npm-bin.html
vendored
@ -10,18 +10,20 @@
|
||||
<div id="wrapper">
|
||||
|
||||
<h1><a href="../cli/npm-bin.html">npm-bin</a></h1> <p>Display npm bin folder</p>
|
||||
|
||||
<h2 id="SYNOPSIS">SYNOPSIS</h2>
|
||||
|
||||
<pre><code>npm bin</code></pre>
|
||||
|
||||
<h2 id="DESCRIPTION">DESCRIPTION</h2>
|
||||
|
||||
<h2 id="synopsis">SYNOPSIS</h2>
|
||||
<pre><code>npm bin
|
||||
</code></pre><h2 id="description">DESCRIPTION</h2>
|
||||
<p>Print the folder where npm will install executables.</p>
|
||||
<h2 id="see-also">SEE ALSO</h2>
|
||||
<ul>
|
||||
<li><a href="../cli/npm-prefix.html">npm-prefix(1)</a></li>
|
||||
<li><a href="../cli/npm-root.html">npm-root(1)</a></li>
|
||||
<li><a href="../files/npm-folders.html">npm-folders(5)</a></li>
|
||||
<li><a href="../cli/npm-config.html">npm-config(1)</a></li>
|
||||
<li><a href="../misc/npm-config.html">npm-config(7)</a></li>
|
||||
<li><a href="../files/npmrc.html">npmrc(5)</a></li>
|
||||
</ul>
|
||||
|
||||
<h2 id="SEE-ALSO">SEE ALSO</h2>
|
||||
|
||||
<ul><li><a href="../cli/npm-prefix.html">npm-prefix(1)</a></li><li><a href="../cli/npm-root.html">npm-root(1)</a></li><li><a href="../files/npm-folders.html">npm-folders(5)</a></li><li><a href="../cli/npm-config.html">npm-config(1)</a></li><li><a href="../misc/npm-config.html">npm-config(7)</a></li><li><a href="../files/npmrc.html">npmrc(5)</a></li></ul>
|
||||
</div>
|
||||
|
||||
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
|
||||
@ -33,5 +35,5 @@
|
||||
<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-bin — npm@1.4.9</p>
|
||||
<p id="footer">npm-bin — npm@1.4.10</p>
|
||||
|
||||
|
||||
45
deps/npm/html/doc/cli/npm-bugs.html
vendored
45
deps/npm/html/doc/cli/npm-bugs.html
vendored
@ -10,36 +10,39 @@
|
||||
<div id="wrapper">
|
||||
|
||||
<h1><a href="../cli/npm-bugs.html">npm-bugs</a></h1> <p>Bugs for a package in a web browser maybe</p>
|
||||
|
||||
<h2 id="SYNOPSIS">SYNOPSIS</h2>
|
||||
|
||||
<h2 id="synopsis">SYNOPSIS</h2>
|
||||
<pre><code>npm bugs <pkgname>
|
||||
npm bugs (with no args in a package dir)</code></pre>
|
||||
|
||||
<h2 id="DESCRIPTION">DESCRIPTION</h2>
|
||||
|
||||
npm bugs (with no args in a package dir)
|
||||
</code></pre><h2 id="description">DESCRIPTION</h2>
|
||||
<p>This command tries to guess at the likely location of a package's
|
||||
bug tracker URL, and then tries to open it using the <code>--browser</code>
|
||||
config param. If no package name is provided, it will search for
|
||||
a <code>package.json</code> in the current folder and use the <code>name</code> property.</p>
|
||||
|
||||
<h2 id="CONFIGURATION">CONFIGURATION</h2>
|
||||
|
||||
<h2 id="configuration">CONFIGURATION</h2>
|
||||
<h3 id="browser">browser</h3>
|
||||
|
||||
<ul><li>Default: OS X: <code>"open"</code>, Windows: <code>"start"</code>, Others: <code>"xdg-open"</code></li><li>Type: String</li></ul>
|
||||
|
||||
<ul>
|
||||
<li>Default: OS X: <code>"open"</code>, Windows: <code>"start"</code>, Others: <code>"xdg-open"</code></li>
|
||||
<li>Type: String</li>
|
||||
</ul>
|
||||
<p>The browser that is called by the <code>npm bugs</code> command to open websites.</p>
|
||||
|
||||
<h3 id="registry">registry</h3>
|
||||
|
||||
<ul><li>Default: https://registry.npmjs.org/</li><li>Type: url</li></ul>
|
||||
|
||||
<ul>
|
||||
<li>Default: <a href="https://registry.npmjs.org/">https://registry.npmjs.org/</a></li>
|
||||
<li>Type: url</li>
|
||||
</ul>
|
||||
<p>The base URL of the npm package registry.</p>
|
||||
<h2 id="see-also">SEE ALSO</h2>
|
||||
<ul>
|
||||
<li><a href="../cli/npm-docs.html">npm-docs(1)</a></li>
|
||||
<li><a href="../cli/npm-view.html">npm-view(1)</a></li>
|
||||
<li><a href="../cli/npm-publish.html">npm-publish(1)</a></li>
|
||||
<li><a href="../misc/npm-registry.html">npm-registry(7)</a></li>
|
||||
<li><a href="../cli/npm-config.html">npm-config(1)</a></li>
|
||||
<li><a href="../misc/npm-config.html">npm-config(7)</a></li>
|
||||
<li><a href="../files/npmrc.html">npmrc(5)</a></li>
|
||||
<li><a href="../files/package.json.html">package.json(5)</a></li>
|
||||
</ul>
|
||||
|
||||
<h2 id="SEE-ALSO">SEE ALSO</h2>
|
||||
|
||||
<ul><li><a href="../cli/npm-docs.html">npm-docs(1)</a></li><li><a href="../cli/npm-view.html">npm-view(1)</a></li><li><a href="../cli/npm-publish.html">npm-publish(1)</a></li><li><a href="../misc/npm-registry.html">npm-registry(7)</a></li><li><a href="../cli/npm-config.html">npm-config(1)</a></li><li><a href="../misc/npm-config.html">npm-config(7)</a></li><li><a href="../files/npmrc.html">npmrc(5)</a></li><li><a href="../files/package.json.html">package.json(5)</a></li></ul>
|
||||
</div>
|
||||
|
||||
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
|
||||
@ -51,5 +54,5 @@ a <code>package.json</code> in the current folder and use the <code>name</code>
|
||||
<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-bugs — npm@1.4.9</p>
|
||||
<p id="footer">npm-bugs — npm@1.4.10</p>
|
||||
|
||||
|
||||
30
deps/npm/html/doc/cli/npm-build.html
vendored
30
deps/npm/html/doc/cli/npm-build.html
vendored
@ -10,23 +10,23 @@
|
||||
<div id="wrapper">
|
||||
|
||||
<h1><a href="../cli/npm-build.html">npm-build</a></h1> <p>Build a package</p>
|
||||
|
||||
<h2 id="SYNOPSIS">SYNOPSIS</h2>
|
||||
|
||||
<pre><code>npm build <package-folder></code></pre>
|
||||
|
||||
<ul><li><code><package-folder></code>:
|
||||
A folder containing a <code>package.json</code> file in its root.</li></ul>
|
||||
|
||||
<h2 id="DESCRIPTION">DESCRIPTION</h2>
|
||||
|
||||
<h2 id="synopsis">SYNOPSIS</h2>
|
||||
<pre><code>npm build <package-folder>
|
||||
</code></pre><ul>
|
||||
<li><code><package-folder></code>:
|
||||
A folder containing a <code>package.json</code> file in its root.</li>
|
||||
</ul>
|
||||
<h2 id="description">DESCRIPTION</h2>
|
||||
<p>This is the plumbing command called by <code>npm link</code> and <code>npm install</code>.</p>
|
||||
|
||||
<p>It should generally not be called directly.</p>
|
||||
<h2 id="see-also">SEE ALSO</h2>
|
||||
<ul>
|
||||
<li><a href="../cli/npm-install.html">npm-install(1)</a></li>
|
||||
<li><a href="../cli/npm-link.html">npm-link(1)</a></li>
|
||||
<li><a href="../misc/npm-scripts.html">npm-scripts(7)</a></li>
|
||||
<li><a href="../files/package.json.html">package.json(5)</a></li>
|
||||
</ul>
|
||||
|
||||
<h2 id="SEE-ALSO">SEE ALSO</h2>
|
||||
|
||||
<ul><li><a href="../cli/npm-install.html">npm-install(1)</a></li><li><a href="../cli/npm-link.html">npm-link(1)</a></li><li><a href="../misc/npm-scripts.html">npm-scripts(7)</a></li><li><a href="../files/package.json.html">package.json(5)</a></li></ul>
|
||||
</div>
|
||||
|
||||
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
|
||||
@ -38,5 +38,5 @@ A folder containing a <code>package.json</code> file in its root.</li></ul>
|
||||
<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-build — npm@1.4.9</p>
|
||||
<p id="footer">npm-build — npm@1.4.10</p>
|
||||
|
||||
|
||||
14
deps/npm/html/doc/cli/npm-bundle.html
vendored
14
deps/npm/html/doc/cli/npm-bundle.html
vendored
@ -10,18 +10,16 @@
|
||||
<div id="wrapper">
|
||||
|
||||
<h1><a href="../cli/npm-bundle.html">npm-bundle</a></h1> <p>REMOVED</p>
|
||||
|
||||
<h2 id="DESCRIPTION">DESCRIPTION</h2>
|
||||
|
||||
<h2 id="description">DESCRIPTION</h2>
|
||||
<p>The <code>npm bundle</code> command has been removed in 1.0, for the simple reason
|
||||
that it is no longer necessary, as the default behavior is now to
|
||||
install packages into the local space.</p>
|
||||
|
||||
<p>Just use <code>npm install</code> now to do what <code>npm bundle</code> used to do.</p>
|
||||
<h2 id="see-also">SEE ALSO</h2>
|
||||
<ul>
|
||||
<li><a href="../cli/npm-install.html">npm-install(1)</a></li>
|
||||
</ul>
|
||||
|
||||
<h2 id="SEE-ALSO">SEE ALSO</h2>
|
||||
|
||||
<ul><li><a href="../cli/npm-install.html">npm-install(1)</a></li></ul>
|
||||
</div>
|
||||
|
||||
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
|
||||
@ -33,5 +31,5 @@ install packages into the local space.</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-bundle — npm@1.4.9</p>
|
||||
<p id="footer">npm-bundle — npm@1.4.10</p>
|
||||
|
||||
|
||||
66
deps/npm/html/doc/cli/npm-cache.html
vendored
66
deps/npm/html/doc/cli/npm-cache.html
vendored
@ -10,9 +10,7 @@
|
||||
<div id="wrapper">
|
||||
|
||||
<h1><a href="../cli/npm-cache.html">npm-cache</a></h1> <p>Manipulates packages cache</p>
|
||||
|
||||
<h2 id="SYNOPSIS">SYNOPSIS</h2>
|
||||
|
||||
<h2 id="synopsis">SYNOPSIS</h2>
|
||||
<pre><code>npm cache add <tarball file>
|
||||
npm cache add <folder>
|
||||
npm cache add <tarball url>
|
||||
@ -20,54 +18,60 @@ npm cache add <name>@<version>
|
||||
|
||||
npm cache ls [<path>]
|
||||
|
||||
npm cache clean [<path>]</code></pre>
|
||||
|
||||
<h2 id="DESCRIPTION">DESCRIPTION</h2>
|
||||
|
||||
npm cache clean [<path>]
|
||||
</code></pre><h2 id="description">DESCRIPTION</h2>
|
||||
<p>Used to add, list, or clear the npm cache folder.</p>
|
||||
|
||||
<ul><li><p>add:
|
||||
<ul>
|
||||
<li><p>add:
|
||||
Add the specified package to the local cache. This command is primarily
|
||||
intended to be used internally by npm, but it can provide a way to
|
||||
add data to the local installation cache explicitly.</p></li><li><p>ls:
|
||||
add data to the local installation cache explicitly.</p>
|
||||
</li>
|
||||
<li><p>ls:
|
||||
Show the data in the cache. Argument is a path to show in the cache
|
||||
folder. Works a bit like the <code>find</code> program, but limited by the
|
||||
<code>depth</code> config.</p></li><li><p>clean:
|
||||
<code>depth</code> config.</p>
|
||||
</li>
|
||||
<li><p>clean:
|
||||
Delete data out of the cache folder. If an argument is provided, then
|
||||
it specifies a subpath to delete. If no argument is provided, then
|
||||
the entire cache is cleared.</p></li></ul>
|
||||
|
||||
<h2 id="DETAILS">DETAILS</h2>
|
||||
|
||||
the entire cache is cleared.</p>
|
||||
</li>
|
||||
</ul>
|
||||
<h2 id="details">DETAILS</h2>
|
||||
<p>npm stores cache data in the directory specified in <code>npm config get cache</code>.
|
||||
For each package that is added to the cache, three pieces of information are
|
||||
stored in <code>{cache}/{name}/{version}</code>:</p>
|
||||
|
||||
<ul><li>.../package/:
|
||||
A folder containing the package contents as they appear in the tarball.</li><li>.../package.json:
|
||||
The package.json file, as npm sees it, with overlays applied and a _id attribute.</li><li>.../package.tgz:
|
||||
The tarball for that version.</li></ul>
|
||||
|
||||
<ul>
|
||||
<li>.../package/:
|
||||
A folder containing the package contents as they appear in the tarball.</li>
|
||||
<li>.../package.json:
|
||||
The package.json file, as npm sees it, with overlays applied and a _id attribute.</li>
|
||||
<li>.../package.tgz:
|
||||
The tarball for that version.</li>
|
||||
</ul>
|
||||
<p>Additionally, whenever a registry request is made, a <code>.cache.json</code> file
|
||||
is placed at the corresponding URI, to store the ETag and the requested
|
||||
data.</p>
|
||||
|
||||
<p>Commands that make non-essential registry requests (such as <code>search</code> and
|
||||
<code>view</code>, or the completion scripts) generally specify a minimum timeout.
|
||||
If the <code>.cache.json</code> file is younger than the specified timeout, then
|
||||
they do not make an HTTP request to the registry.</p>
|
||||
|
||||
<h2 id="CONFIGURATION">CONFIGURATION</h2>
|
||||
|
||||
<h2 id="configuration">CONFIGURATION</h2>
|
||||
<h3 id="cache">cache</h3>
|
||||
|
||||
<p>Default: <code>~/.npm</code> on Posix, or <code>%AppData%/npm-cache</code> on Windows.</p>
|
||||
|
||||
<p>The root cache folder.</p>
|
||||
<h2 id="see-also">SEE ALSO</h2>
|
||||
<ul>
|
||||
<li><a href="../files/npm-folders.html">npm-folders(5)</a></li>
|
||||
<li><a href="../cli/npm-config.html">npm-config(1)</a></li>
|
||||
<li><a href="../misc/npm-config.html">npm-config(7)</a></li>
|
||||
<li><a href="../files/npmrc.html">npmrc(5)</a></li>
|
||||
<li><a href="../cli/npm-install.html">npm-install(1)</a></li>
|
||||
<li><a href="../cli/npm-publish.html">npm-publish(1)</a></li>
|
||||
<li><a href="../cli/npm-pack.html">npm-pack(1)</a></li>
|
||||
</ul>
|
||||
|
||||
<h2 id="SEE-ALSO">SEE ALSO</h2>
|
||||
|
||||
<ul><li><a href="../files/npm-folders.html">npm-folders(5)</a></li><li><a href="../cli/npm-config.html">npm-config(1)</a></li><li><a href="../misc/npm-config.html">npm-config(7)</a></li><li><a href="../files/npmrc.html">npmrc(5)</a></li><li><a href="../cli/npm-install.html">npm-install(1)</a></li><li><a href="../cli/npm-publish.html">npm-publish(1)</a></li><li><a href="../cli/npm-pack.html">npm-pack(1)</a></li></ul>
|
||||
</div>
|
||||
|
||||
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
|
||||
@ -79,5 +83,5 @@ they do not make an HTTP request to the registry.</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-cache — npm@1.4.9</p>
|
||||
<p id="footer">npm-cache — npm@1.4.10</p>
|
||||
|
||||
|
||||
24
deps/npm/html/doc/cli/npm-completion.html
vendored
24
deps/npm/html/doc/cli/npm-completion.html
vendored
@ -10,31 +10,27 @@
|
||||
<div id="wrapper">
|
||||
|
||||
<h1><a href="../cli/npm-completion.html">npm-completion</a></h1> <p>Tab Completion for npm</p>
|
||||
|
||||
<h2 id="SYNOPSIS">SYNOPSIS</h2>
|
||||
|
||||
<pre><code>. <(npm completion)</code></pre>
|
||||
|
||||
<h2 id="DESCRIPTION">DESCRIPTION</h2>
|
||||
|
||||
<h2 id="synopsis">SYNOPSIS</h2>
|
||||
<pre><code>. <(npm completion)
|
||||
</code></pre><h2 id="description">DESCRIPTION</h2>
|
||||
<p>Enables tab-completion in all npm commands.</p>
|
||||
|
||||
<p>The synopsis above
|
||||
loads the completions into your current shell. Adding it to
|
||||
your ~/.bashrc or ~/.zshrc will make the completions available
|
||||
everywhere.</p>
|
||||
|
||||
<p>You may of course also pipe the output of npm completion to a file
|
||||
such as <code>/usr/local/etc/bash_completion.d/npm</code> if you have a system
|
||||
that will read that file for you.</p>
|
||||
|
||||
<p>When <code>COMP_CWORD</code>, <code>COMP_LINE</code>, and <code>COMP_POINT</code> are defined in the
|
||||
environment, <code>npm completion</code> acts in "plumbing mode", and outputs
|
||||
completions based on the arguments.</p>
|
||||
<h2 id="see-also">SEE ALSO</h2>
|
||||
<ul>
|
||||
<li><a href="../misc/npm-developers.html">npm-developers(7)</a></li>
|
||||
<li><a href="../misc/npm-faq.html">npm-faq(7)</a></li>
|
||||
<li><a href="../cli/npm.html">npm(1)</a></li>
|
||||
</ul>
|
||||
|
||||
<h2 id="SEE-ALSO">SEE ALSO</h2>
|
||||
|
||||
<ul><li><a href="../misc/npm-developers.html">npm-developers(7)</a></li><li><a href="../misc/npm-faq.html">npm-faq(7)</a></li><li><a href="../cli/npm.html">npm(1)</a></li></ul>
|
||||
</div>
|
||||
|
||||
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
|
||||
@ -46,5 +42,5 @@ completions based on the arguments.</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-completion — npm@1.4.9</p>
|
||||
<p id="footer">npm-completion — npm@1.4.10</p>
|
||||
|
||||
|
||||
66
deps/npm/html/doc/cli/npm-config.html
vendored
66
deps/npm/html/doc/cli/npm-config.html
vendored
@ -10,9 +10,7 @@
|
||||
<div id="wrapper">
|
||||
|
||||
<h1><a href="../cli/npm-config.html">npm-config</a></h1> <p>Manage the npm configuration files</p>
|
||||
|
||||
<h2 id="SYNOPSIS">SYNOPSIS</h2>
|
||||
|
||||
<h2 id="synopsis">SYNOPSIS</h2>
|
||||
<pre><code>npm config set <key> <value> [--global]
|
||||
npm config get <key>
|
||||
npm config delete <key>
|
||||
@ -20,61 +18,43 @@ npm config list
|
||||
npm config edit
|
||||
npm c [set|get|delete|list]
|
||||
npm get <key>
|
||||
npm set <key> <value> [--global]</code></pre>
|
||||
|
||||
<h2 id="DESCRIPTION">DESCRIPTION</h2>
|
||||
|
||||
npm set <key> <value> [--global]
|
||||
</code></pre><h2 id="description">DESCRIPTION</h2>
|
||||
<p>npm gets its config settings from the command line, environment
|
||||
variables, <code>npmrc</code> files, and in some cases, the <code>package.json</code> file.</p>
|
||||
|
||||
<p>See <a href="../files/npmrc.html">npmrc(5)</a> for more information about the npmrc files.</p>
|
||||
|
||||
<p>See <code><a href="../misc/npm-config.html">npm-config(7)</a></code> for a more thorough discussion of the mechanisms
|
||||
involved.</p>
|
||||
|
||||
<p>The <code>npm config</code> command can be used to update and edit the contents
|
||||
of the user and global npmrc files.</p>
|
||||
|
||||
<h2 id="Sub-commands">Sub-commands</h2>
|
||||
|
||||
<h2 id="sub-commands">Sub-commands</h2>
|
||||
<p>Config supports the following sub-commands:</p>
|
||||
|
||||
<h3 id="set">set</h3>
|
||||
|
||||
<pre><code>npm config set key value</code></pre>
|
||||
|
||||
<p>Sets the config key to the value.</p>
|
||||
|
||||
<pre><code>npm config set key value
|
||||
</code></pre><p>Sets the config key to the value.</p>
|
||||
<p>If value is omitted, then it sets it to "true".</p>
|
||||
|
||||
<h3 id="get">get</h3>
|
||||
|
||||
<pre><code>npm config get key</code></pre>
|
||||
|
||||
<p>Echo the config value to stdout.</p>
|
||||
|
||||
<pre><code>npm config get key
|
||||
</code></pre><p>Echo the config value to stdout.</p>
|
||||
<h3 id="list">list</h3>
|
||||
|
||||
<pre><code>npm config list</code></pre>
|
||||
|
||||
<p>Show all the config settings.</p>
|
||||
|
||||
<pre><code>npm config list
|
||||
</code></pre><p>Show all the config settings.</p>
|
||||
<h3 id="delete">delete</h3>
|
||||
|
||||
<pre><code>npm config delete key</code></pre>
|
||||
|
||||
<p>Deletes the key from all configuration files.</p>
|
||||
|
||||
<pre><code>npm config delete key
|
||||
</code></pre><p>Deletes the key from all configuration files.</p>
|
||||
<h3 id="edit">edit</h3>
|
||||
|
||||
<pre><code>npm config edit</code></pre>
|
||||
|
||||
<p>Opens the config file in an editor. Use the <code>--global</code> flag to edit the
|
||||
<pre><code>npm config edit
|
||||
</code></pre><p>Opens the config file in an editor. Use the <code>--global</code> flag to edit the
|
||||
global config.</p>
|
||||
<h2 id="see-also">SEE ALSO</h2>
|
||||
<ul>
|
||||
<li><a href="../files/npm-folders.html">npm-folders(5)</a></li>
|
||||
<li><a href="../misc/npm-config.html">npm-config(7)</a></li>
|
||||
<li><a href="../files/package.json.html">package.json(5)</a></li>
|
||||
<li><a href="../files/npmrc.html">npmrc(5)</a></li>
|
||||
<li><a href="../cli/npm.html">npm(1)</a></li>
|
||||
</ul>
|
||||
|
||||
<h2 id="SEE-ALSO">SEE ALSO</h2>
|
||||
|
||||
<ul><li><a href="../files/npm-folders.html">npm-folders(5)</a></li><li><a href="../misc/npm-config.html">npm-config(7)</a></li><li><a href="../files/package.json.html">package.json(5)</a></li><li><a href="../files/npmrc.html">npmrc(5)</a></li><li><a href="../cli/npm.html">npm(1)</a></li></ul>
|
||||
</div>
|
||||
|
||||
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
|
||||
@ -86,5 +66,5 @@ global config.</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-config — npm@1.4.9</p>
|
||||
<p id="footer">npm-config — npm@1.4.10</p>
|
||||
|
||||
|
||||
40
deps/npm/html/doc/cli/npm-dedupe.html
vendored
40
deps/npm/html/doc/cli/npm-dedupe.html
vendored
@ -10,60 +10,48 @@
|
||||
<div id="wrapper">
|
||||
|
||||
<h1><a href="../cli/npm-dedupe.html">npm-dedupe</a></h1> <p>Reduce duplication</p>
|
||||
|
||||
<h2 id="SYNOPSIS">SYNOPSIS</h2>
|
||||
|
||||
<h2 id="synopsis">SYNOPSIS</h2>
|
||||
<pre><code>npm dedupe [package names...]
|
||||
npm ddp [package names...]</code></pre>
|
||||
|
||||
<h2 id="DESCRIPTION">DESCRIPTION</h2>
|
||||
|
||||
npm ddp [package names...]
|
||||
</code></pre><h2 id="description">DESCRIPTION</h2>
|
||||
<p>Searches the local package tree and attempts to simplify the overall
|
||||
structure by moving dependencies further up the tree, where they can
|
||||
be more effectively shared by multiple dependent packages.</p>
|
||||
|
||||
<p>For example, consider this dependency graph:</p>
|
||||
|
||||
<pre><code>a
|
||||
+-- b <-- depends on c@1.0.x
|
||||
| `-- c@1.0.3
|
||||
`-- d <-- depends on c@~1.0.9
|
||||
`-- c@1.0.10</code></pre>
|
||||
|
||||
<p>In this case, <code><a href="../cli/npm-dedupe.html">npm-dedupe(1)</a></code> will transform the tree to:</p>
|
||||
|
||||
`-- c@1.0.10
|
||||
</code></pre><p>In this case, <code><a href="../cli/npm-dedupe.html">npm-dedupe(1)</a></code> will transform the tree to:</p>
|
||||
<pre><code>a
|
||||
+-- b
|
||||
+-- d
|
||||
`-- c@1.0.10</code></pre>
|
||||
|
||||
<p>Because of the hierarchical nature of node's module lookup, b and d
|
||||
`-- c@1.0.10
|
||||
</code></pre><p>Because of the hierarchical nature of node's module lookup, b and d
|
||||
will both get their dependency met by the single c package at the root
|
||||
level of the tree.</p>
|
||||
|
||||
<p>If a suitable version exists at the target location in the tree
|
||||
already, then it will be left untouched, but the other duplicates will
|
||||
be deleted.</p>
|
||||
|
||||
<p>If no suitable version can be found, then a warning is printed, and
|
||||
nothing is done.</p>
|
||||
|
||||
<p>If any arguments are supplied, then they are filters, and only the
|
||||
named packages will be touched.</p>
|
||||
|
||||
<p>Note that this operation transforms the dependency tree, and may
|
||||
result in packages getting updated versions, perhaps from the npm
|
||||
registry.</p>
|
||||
|
||||
<p>This feature is experimental, and may change in future versions.</p>
|
||||
|
||||
<p>The <code>--tag</code> argument will apply to all of the affected dependencies. If a
|
||||
tag with the given name exists, the tagged version is preferred over newer
|
||||
versions.</p>
|
||||
<h2 id="see-also">SEE ALSO</h2>
|
||||
<ul>
|
||||
<li><a href="../cli/npm-ls.html">npm-ls(1)</a></li>
|
||||
<li><a href="../cli/npm-update.html">npm-update(1)</a></li>
|
||||
<li><a href="../cli/npm-install.html">npm-install(1)</a></li>
|
||||
</ul>
|
||||
|
||||
<h2 id="SEE-ALSO">SEE ALSO</h2>
|
||||
|
||||
<ul><li><a href="../cli/npm-ls.html">npm-ls(1)</a></li><li><a href="../cli/npm-update.html">npm-update(1)</a></li><li><a href="../cli/npm-install.html">npm-install(1)</a></li></ul>
|
||||
</div>
|
||||
|
||||
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
|
||||
@ -75,5 +63,5 @@ 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-dedupe — npm@1.4.9</p>
|
||||
<p id="footer">npm-dedupe — npm@1.4.10</p>
|
||||
|
||||
|
||||
28
deps/npm/html/doc/cli/npm-deprecate.html
vendored
28
deps/npm/html/doc/cli/npm-deprecate.html
vendored
@ -10,29 +10,23 @@
|
||||
<div id="wrapper">
|
||||
|
||||
<h1><a href="../cli/npm-deprecate.html">npm-deprecate</a></h1> <p>Deprecate a version of a package</p>
|
||||
|
||||
<h2 id="SYNOPSIS">SYNOPSIS</h2>
|
||||
|
||||
<pre><code>npm deprecate <name>[@<version>] <message></code></pre>
|
||||
|
||||
<h2 id="DESCRIPTION">DESCRIPTION</h2>
|
||||
|
||||
<h2 id="synopsis">SYNOPSIS</h2>
|
||||
<pre><code>npm deprecate <name>[@<version>] <message>
|
||||
</code></pre><h2 id="description">DESCRIPTION</h2>
|
||||
<p>This command will update the npm registry entry for a package, providing
|
||||
a deprecation warning to all who attempt to install it.</p>
|
||||
|
||||
<p>It works on version ranges as well as specific versions, so you can do
|
||||
something like this:</p>
|
||||
|
||||
<pre><code>npm deprecate my-thing@"< 0.2.3" "critical bug fixed in v0.2.3"</code></pre>
|
||||
|
||||
<p>Note that you must be the package owner to deprecate something. See the
|
||||
<pre><code>npm deprecate my-thing@"< 0.2.3" "critical bug fixed in v0.2.3"
|
||||
</code></pre><p>Note that you must be the package owner to deprecate something. See the
|
||||
<code>owner</code> and <code>adduser</code> help topics.</p>
|
||||
|
||||
<p>To un-deprecate a package, specify an empty string (<code>""</code>) for the <code>message</code> argument.</p>
|
||||
<h2 id="see-also">SEE ALSO</h2>
|
||||
<ul>
|
||||
<li><a href="../cli/npm-publish.html">npm-publish(1)</a></li>
|
||||
<li><a href="../misc/npm-registry.html">npm-registry(7)</a></li>
|
||||
</ul>
|
||||
|
||||
<h2 id="SEE-ALSO">SEE ALSO</h2>
|
||||
|
||||
<ul><li><a href="../cli/npm-publish.html">npm-publish(1)</a></li><li><a href="../misc/npm-registry.html">npm-registry(7)</a></li></ul>
|
||||
</div>
|
||||
|
||||
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
|
||||
@ -44,5 +38,5 @@ something like this:</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-deprecate — npm@1.4.9</p>
|
||||
<p id="footer">npm-deprecate — npm@1.4.10</p>
|
||||
|
||||
|
||||
44
deps/npm/html/doc/cli/npm-docs.html
vendored
44
deps/npm/html/doc/cli/npm-docs.html
vendored
@ -10,39 +10,41 @@
|
||||
<div id="wrapper">
|
||||
|
||||
<h1><a href="../cli/npm-docs.html">npm-docs</a></h1> <p>Docs for a package in a web browser maybe</p>
|
||||
|
||||
<h2 id="SYNOPSIS">SYNOPSIS</h2>
|
||||
|
||||
<h2 id="synopsis">SYNOPSIS</h2>
|
||||
<pre><code>npm docs [<pkgname> [<pkgname> ...]]
|
||||
npm docs (with no args in a package dir)
|
||||
npm home [<pkgname> [<pkgname> ...]]
|
||||
npm home (with no args in a package dir)</code></pre>
|
||||
|
||||
<h2 id="DESCRIPTION">DESCRIPTION</h2>
|
||||
|
||||
npm home (with no args in a package dir)
|
||||
</code></pre><h2 id="description">DESCRIPTION</h2>
|
||||
<p>This command tries to guess at the likely location of a package's
|
||||
documentation URL, and then tries to open it using the <code>--browser</code>
|
||||
config param. You can pass multiple package names at once. If no
|
||||
package name is provided, it will search for a <code>package.json</code> in
|
||||
the current folder and use the <code>name</code> property.</p>
|
||||
|
||||
<h2 id="CONFIGURATION">CONFIGURATION</h2>
|
||||
|
||||
<h2 id="configuration">CONFIGURATION</h2>
|
||||
<h3 id="browser">browser</h3>
|
||||
|
||||
<ul><li>Default: OS X: <code>"open"</code>, Windows: <code>"start"</code>, Others: <code>"xdg-open"</code></li><li>Type: String</li></ul>
|
||||
|
||||
<ul>
|
||||
<li>Default: OS X: <code>"open"</code>, Windows: <code>"start"</code>, Others: <code>"xdg-open"</code></li>
|
||||
<li>Type: String</li>
|
||||
</ul>
|
||||
<p>The browser that is called by the <code>npm docs</code> command to open websites.</p>
|
||||
|
||||
<h3 id="registry">registry</h3>
|
||||
|
||||
<ul><li>Default: https://registry.npmjs.org/</li><li>Type: url</li></ul>
|
||||
|
||||
<ul>
|
||||
<li>Default: <a href="https://registry.npmjs.org/">https://registry.npmjs.org/</a></li>
|
||||
<li>Type: url</li>
|
||||
</ul>
|
||||
<p>The base URL of the npm package registry.</p>
|
||||
<h2 id="see-also">SEE ALSO</h2>
|
||||
<ul>
|
||||
<li><a href="../cli/npm-view.html">npm-view(1)</a></li>
|
||||
<li><a href="../cli/npm-publish.html">npm-publish(1)</a></li>
|
||||
<li><a href="../misc/npm-registry.html">npm-registry(7)</a></li>
|
||||
<li><a href="../cli/npm-config.html">npm-config(1)</a></li>
|
||||
<li><a href="../misc/npm-config.html">npm-config(7)</a></li>
|
||||
<li><a href="../files/npmrc.html">npmrc(5)</a></li>
|
||||
<li><a href="../files/package.json.html">package.json(5)</a></li>
|
||||
</ul>
|
||||
|
||||
<h2 id="SEE-ALSO">SEE ALSO</h2>
|
||||
|
||||
<ul><li><a href="../cli/npm-view.html">npm-view(1)</a></li><li><a href="../cli/npm-publish.html">npm-publish(1)</a></li><li><a href="../misc/npm-registry.html">npm-registry(7)</a></li><li><a href="../cli/npm-config.html">npm-config(1)</a></li><li><a href="../misc/npm-config.html">npm-config(7)</a></li><li><a href="../files/npmrc.html">npmrc(5)</a></li><li><a href="../files/package.json.html">package.json(5)</a></li></ul>
|
||||
</div>
|
||||
|
||||
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
|
||||
@ -54,5 +56,5 @@ the current folder and use the <code>name</code> property.</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-docs — npm@1.4.9</p>
|
||||
<p id="footer">npm-docs — npm@1.4.10</p>
|
||||
|
||||
|
||||
39
deps/npm/html/doc/cli/npm-edit.html
vendored
39
deps/npm/html/doc/cli/npm-edit.html
vendored
@ -10,35 +10,34 @@
|
||||
<div id="wrapper">
|
||||
|
||||
<h1><a href="../cli/npm-edit.html">npm-edit</a></h1> <p>Edit an installed package</p>
|
||||
|
||||
<h2 id="SYNOPSIS">SYNOPSIS</h2>
|
||||
|
||||
<pre><code>npm edit <name>[@<version>]</code></pre>
|
||||
|
||||
<h2 id="DESCRIPTION">DESCRIPTION</h2>
|
||||
|
||||
<h2 id="synopsis">SYNOPSIS</h2>
|
||||
<pre><code>npm edit <name>[@<version>]
|
||||
</code></pre><h2 id="description">DESCRIPTION</h2>
|
||||
<p>Opens the package folder in the default editor (or whatever you've
|
||||
configured as the npm <code>editor</code> config -- see <code><a href="../misc/npm-config.html">npm-config(7)</a></code>.)</p>
|
||||
|
||||
<p>After it has been edited, the package is rebuilt so as to pick up any
|
||||
changes in compiled packages.</p>
|
||||
|
||||
<p>For instance, you can do <code>npm install connect</code> to install connect
|
||||
into your package, and then <code>npm edit connect</code> to make a few
|
||||
changes to your locally installed copy.</p>
|
||||
|
||||
<h2 id="CONFIGURATION">CONFIGURATION</h2>
|
||||
|
||||
<h2 id="configuration">CONFIGURATION</h2>
|
||||
<h3 id="editor">editor</h3>
|
||||
|
||||
<ul><li>Default: <code>EDITOR</code> environment variable if set, or <code>"vi"</code> on Posix,
|
||||
or <code>"notepad"</code> on Windows.</li><li>Type: path</li></ul>
|
||||
|
||||
<ul>
|
||||
<li>Default: <code>EDITOR</code> environment variable if set, or <code>"vi"</code> on Posix,
|
||||
or <code>"notepad"</code> on Windows.</li>
|
||||
<li>Type: path</li>
|
||||
</ul>
|
||||
<p>The command to run for <code>npm edit</code> or <code>npm config edit</code>.</p>
|
||||
<h2 id="see-also">SEE ALSO</h2>
|
||||
<ul>
|
||||
<li><a href="../files/npm-folders.html">npm-folders(5)</a></li>
|
||||
<li><a href="../cli/npm-explore.html">npm-explore(1)</a></li>
|
||||
<li><a href="../cli/npm-install.html">npm-install(1)</a></li>
|
||||
<li><a href="../cli/npm-config.html">npm-config(1)</a></li>
|
||||
<li><a href="../misc/npm-config.html">npm-config(7)</a></li>
|
||||
<li><a href="../files/npmrc.html">npmrc(5)</a></li>
|
||||
</ul>
|
||||
|
||||
<h2 id="SEE-ALSO">SEE ALSO</h2>
|
||||
|
||||
<ul><li><a href="../files/npm-folders.html">npm-folders(5)</a></li><li><a href="../cli/npm-explore.html">npm-explore(1)</a></li><li><a href="../cli/npm-install.html">npm-install(1)</a></li><li><a href="../cli/npm-config.html">npm-config(1)</a></li><li><a href="../misc/npm-config.html">npm-config(7)</a></li><li><a href="../files/npmrc.html">npmrc(5)</a></li></ul>
|
||||
</div>
|
||||
|
||||
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
|
||||
@ -50,5 +49,5 @@ or <code>"notepad"</code> on Windows.</li><li>Type: path</li></ul>
|
||||
<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-edit — npm@1.4.9</p>
|
||||
<p id="footer">npm-edit — npm@1.4.10</p>
|
||||
|
||||
|
||||
45
deps/npm/html/doc/cli/npm-explore.html
vendored
45
deps/npm/html/doc/cli/npm-explore.html
vendored
@ -10,38 +10,35 @@
|
||||
<div id="wrapper">
|
||||
|
||||
<h1><a href="../cli/npm-explore.html">npm-explore</a></h1> <p>Browse an installed package</p>
|
||||
|
||||
<h2 id="SYNOPSIS">SYNOPSIS</h2>
|
||||
|
||||
<pre><code>npm explore <name>[@<version>] [ -- <cmd>]</code></pre>
|
||||
|
||||
<h2 id="DESCRIPTION">DESCRIPTION</h2>
|
||||
|
||||
<h2 id="synopsis">SYNOPSIS</h2>
|
||||
<pre><code>npm explore <name>[@<version>] [ -- <cmd>]
|
||||
</code></pre><h2 id="description">DESCRIPTION</h2>
|
||||
<p>Spawn a subshell in the directory of the installed package specified.</p>
|
||||
|
||||
<p>If a command is specified, then it is run in the subshell, which then
|
||||
immediately terminates.</p>
|
||||
|
||||
<p>This is particularly handy in the case of git submodules in the
|
||||
<code>node_modules</code> folder:</p>
|
||||
|
||||
<pre><code>npm explore some-dependency -- git pull origin master</code></pre>
|
||||
|
||||
<p>Note that the package is <em>not</em> automatically rebuilt afterwards, so be
|
||||
<pre><code>npm explore some-dependency -- git pull origin master
|
||||
</code></pre><p>Note that the package is <em>not</em> automatically rebuilt afterwards, so be
|
||||
sure to use <code>npm rebuild <pkg></code> if you make any changes.</p>
|
||||
|
||||
<h2 id="CONFIGURATION">CONFIGURATION</h2>
|
||||
|
||||
<h2 id="configuration">CONFIGURATION</h2>
|
||||
<h3 id="shell">shell</h3>
|
||||
|
||||
<ul><li>Default: SHELL environment variable, or "bash" on Posix, or "cmd" on
|
||||
Windows</li><li>Type: path</li></ul>
|
||||
|
||||
<ul>
|
||||
<li>Default: SHELL environment variable, or "bash" on Posix, or "cmd" on
|
||||
Windows</li>
|
||||
<li>Type: path</li>
|
||||
</ul>
|
||||
<p>The shell to run for the <code>npm explore</code> command.</p>
|
||||
<h2 id="see-also">SEE ALSO</h2>
|
||||
<ul>
|
||||
<li><a href="../cli/npm-submodule.html">npm-submodule(1)</a></li>
|
||||
<li><a href="../files/npm-folders.html">npm-folders(5)</a></li>
|
||||
<li><a href="../cli/npm-edit.html">npm-edit(1)</a></li>
|
||||
<li><a href="../cli/npm-rebuild.html">npm-rebuild(1)</a></li>
|
||||
<li><a href="../cli/npm-build.html">npm-build(1)</a></li>
|
||||
<li><a href="../cli/npm-install.html">npm-install(1)</a></li>
|
||||
</ul>
|
||||
|
||||
<h2 id="SEE-ALSO">SEE ALSO</h2>
|
||||
|
||||
<ul><li><a href="../cli/npm-submodule.html">npm-submodule(1)</a></li><li><a href="../files/npm-folders.html">npm-folders(5)</a></li><li><a href="../cli/npm-edit.html">npm-edit(1)</a></li><li><a href="../cli/npm-rebuild.html">npm-rebuild(1)</a></li><li><a href="../cli/npm-build.html">npm-build(1)</a></li><li><a href="../cli/npm-install.html">npm-install(1)</a></li></ul>
|
||||
</div>
|
||||
|
||||
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
|
||||
@ -53,5 +50,5 @@ Windows</li><li>Type: path</li></ul>
|
||||
<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-explore — npm@1.4.9</p>
|
||||
<p id="footer">npm-explore — npm@1.4.10</p>
|
||||
|
||||
|
||||
35
deps/npm/html/doc/cli/npm-help-search.html
vendored
35
deps/npm/html/doc/cli/npm-help-search.html
vendored
@ -10,36 +10,31 @@
|
||||
<div id="wrapper">
|
||||
|
||||
<h1><a href="../cli/npm-help-search.html">npm-help-search</a></h1> <p>Search npm help documentation</p>
|
||||
|
||||
<h2 id="SYNOPSIS">SYNOPSIS</h2>
|
||||
|
||||
<pre><code>npm help-search some search terms</code></pre>
|
||||
|
||||
<h2 id="DESCRIPTION">DESCRIPTION</h2>
|
||||
|
||||
<h2 id="synopsis">SYNOPSIS</h2>
|
||||
<pre><code>npm help-search some search terms
|
||||
</code></pre><h2 id="description">DESCRIPTION</h2>
|
||||
<p>This command will search the npm markdown documentation files for the
|
||||
terms provided, and then list the results, sorted by relevance.</p>
|
||||
|
||||
<p>If only one result is found, then it will show that help topic.</p>
|
||||
|
||||
<p>If the argument to <code>npm help</code> is not a known help topic, then it will
|
||||
call <code>help-search</code>. It is rarely if ever necessary to call this
|
||||
command directly.</p>
|
||||
|
||||
<h2 id="CONFIGURATION">CONFIGURATION</h2>
|
||||
|
||||
<h2 id="configuration">CONFIGURATION</h2>
|
||||
<h3 id="long">long</h3>
|
||||
|
||||
<ul><li>Type: Boolean</li><li>Default false</li></ul>
|
||||
|
||||
<ul>
|
||||
<li>Type: Boolean</li>
|
||||
<li>Default false</li>
|
||||
</ul>
|
||||
<p>If true, the "long" flag will cause help-search to output context around
|
||||
where the terms were found in the documentation.</p>
|
||||
|
||||
<p>If false, then help-search will just list out the help topics found.</p>
|
||||
<h2 id="see-also">SEE ALSO</h2>
|
||||
<ul>
|
||||
<li><a href="../cli/npm.html">npm(1)</a></li>
|
||||
<li><a href="../misc/npm-faq.html">npm-faq(7)</a></li>
|
||||
<li><a href="../cli/npm-help.html">npm-help(1)</a></li>
|
||||
</ul>
|
||||
|
||||
<h2 id="SEE-ALSO">SEE ALSO</h2>
|
||||
|
||||
<ul><li><a href="../cli/npm.html">npm(1)</a></li><li><a href="../misc/npm-faq.html">npm-faq(7)</a></li><li><a href="../cli/npm-help.html">npm-help(1)</a></li></ul>
|
||||
</div>
|
||||
|
||||
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
|
||||
@ -51,5 +46,5 @@ where the terms were found in the documentation.</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-help-search — npm@1.4.9</p>
|
||||
<p id="footer">npm-help-search — npm@1.4.10</p>
|
||||
|
||||
|
||||
41
deps/npm/html/doc/cli/npm-help.html
vendored
41
deps/npm/html/doc/cli/npm-help.html
vendored
@ -10,34 +10,37 @@
|
||||
<div id="wrapper">
|
||||
|
||||
<h1><a href="../cli/npm-help.html">npm-help</a></h1> <p>Get help on npm</p>
|
||||
|
||||
<h2 id="SYNOPSIS">SYNOPSIS</h2>
|
||||
|
||||
<h2 id="synopsis">SYNOPSIS</h2>
|
||||
<pre><code>npm help <topic>
|
||||
npm help some search terms</code></pre>
|
||||
|
||||
<h2 id="DESCRIPTION">DESCRIPTION</h2>
|
||||
|
||||
npm help some search terms
|
||||
</code></pre><h2 id="description">DESCRIPTION</h2>
|
||||
<p>If supplied a topic, then show the appropriate documentation page.</p>
|
||||
|
||||
<p>If the topic does not exist, or if multiple terms are provided, then run
|
||||
the <code>help-search</code> command to find a match. Note that, if <code>help-search</code>
|
||||
finds a single subject, then it will run <code>help</code> on that topic, so unique
|
||||
matches are equivalent to specifying a topic name.</p>
|
||||
|
||||
<h2 id="CONFIGURATION">CONFIGURATION</h2>
|
||||
|
||||
<h2 id="configuration">CONFIGURATION</h2>
|
||||
<h3 id="viewer">viewer</h3>
|
||||
|
||||
<ul><li>Default: "man" on Posix, "browser" on Windows</li><li>Type: path</li></ul>
|
||||
|
||||
<ul>
|
||||
<li>Default: "man" on Posix, "browser" on Windows</li>
|
||||
<li>Type: path</li>
|
||||
</ul>
|
||||
<p>The program to use to view help content.</p>
|
||||
|
||||
<p>Set to <code>"browser"</code> to view html help content in the default web browser.</p>
|
||||
<h2 id="see-also">SEE ALSO</h2>
|
||||
<ul>
|
||||
<li><a href="../cli/npm.html">npm(1)</a></li>
|
||||
<li><a href="../../doc/README.html">README</a></li>
|
||||
<li><a href="../misc/npm-faq.html">npm-faq(7)</a></li>
|
||||
<li><a href="../files/npm-folders.html">npm-folders(5)</a></li>
|
||||
<li><a href="../cli/npm-config.html">npm-config(1)</a></li>
|
||||
<li><a href="../misc/npm-config.html">npm-config(7)</a></li>
|
||||
<li><a href="../files/npmrc.html">npmrc(5)</a></li>
|
||||
<li><a href="../files/package.json.html">package.json(5)</a></li>
|
||||
<li><a href="../cli/npm-help-search.html">npm-help-search(1)</a></li>
|
||||
<li><a href="../misc/npm-index.html">npm-index(7)</a></li>
|
||||
</ul>
|
||||
|
||||
<h2 id="SEE-ALSO">SEE ALSO</h2>
|
||||
|
||||
<ul><li><a href="../cli/npm.html">npm(1)</a></li><li><a href="../../doc/README.html">README</a></li><li><a href="../misc/npm-faq.html">npm-faq(7)</a></li><li><a href="../files/npm-folders.html">npm-folders(5)</a></li><li><a href="../cli/npm-config.html">npm-config(1)</a></li><li><a href="../misc/npm-config.html">npm-config(7)</a></li><li><a href="../files/npmrc.html">npmrc(5)</a></li><li><a href="../files/package.json.html">package.json(5)</a></li><li><a href="../cli/npm-help-search.html">npm-help-search(1)</a></li><li><a href="../misc/npm-index.html">npm-index(7)</a></li></ul>
|
||||
</div>
|
||||
|
||||
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
|
||||
@ -49,5 +52,5 @@ matches are equivalent to specifying a topic name.</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-help — npm@1.4.9</p>
|
||||
<p id="footer">npm-help — npm@1.4.10</p>
|
||||
|
||||
|
||||
24
deps/npm/html/doc/cli/npm-init.html
vendored
24
deps/npm/html/doc/cli/npm-init.html
vendored
@ -10,27 +10,23 @@
|
||||
<div id="wrapper">
|
||||
|
||||
<h1><a href="../cli/npm-init.html">npm-init</a></h1> <p>Interactively create a package.json file</p>
|
||||
|
||||
<h2 id="SYNOPSIS">SYNOPSIS</h2>
|
||||
|
||||
<pre><code>npm init</code></pre>
|
||||
|
||||
<h2 id="DESCRIPTION">DESCRIPTION</h2>
|
||||
|
||||
<h2 id="synopsis">SYNOPSIS</h2>
|
||||
<pre><code>npm init
|
||||
</code></pre><h2 id="description">DESCRIPTION</h2>
|
||||
<p>This will ask you a bunch of questions, and then write a package.json for you.</p>
|
||||
|
||||
<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.</p>
|
||||
|
||||
<p>If you already have a package.json file, it'll read that first, and default to
|
||||
the options in there.</p>
|
||||
|
||||
<p>It is strictly additive, so it does not delete options from your package.json
|
||||
without a really good reason to do so.</p>
|
||||
<h2 id="see-also">SEE ALSO</h2>
|
||||
<ul>
|
||||
<li><a href="https://github.com/isaacs/init-package-json">https://github.com/isaacs/init-package-json</a></li>
|
||||
<li><a href="../files/package.json.html">package.json(5)</a></li>
|
||||
<li><a href="../cli/npm-version.html">npm-version(1)</a></li>
|
||||
</ul>
|
||||
|
||||
<h2 id="SEE-ALSO">SEE ALSO</h2>
|
||||
|
||||
<ul><li><a href="https://github.com/isaacs/init-package-json">https://github.com/isaacs/init-package-json</a></li><li><a href="../files/package.json.html">package.json(5)</a></li><li><a href="../cli/npm-version.html">npm-version(1)</a></li></ul>
|
||||
</div>
|
||||
|
||||
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
|
||||
@ -42,5 +38,5 @@ without a really good reason to do so.</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-init — npm@1.4.9</p>
|
||||
<p id="footer">npm-init — npm@1.4.10</p>
|
||||
|
||||
|
||||
210
deps/npm/html/doc/cli/npm-install.html
vendored
210
deps/npm/html/doc/cli/npm-install.html
vendored
@ -10,9 +10,7 @@
|
||||
<div id="wrapper">
|
||||
|
||||
<h1><a href="../cli/npm-install.html">npm-install</a></h1> <p>Install a package</p>
|
||||
|
||||
<h2 id="SYNOPSIS">SYNOPSIS</h2>
|
||||
|
||||
<h2 id="synopsis">SYNOPSIS</h2>
|
||||
<pre><code>npm install (with no args in a package dir)
|
||||
npm install <tarball file>
|
||||
npm install <tarball url>
|
||||
@ -21,92 +19,144 @@ npm install <name> [--save|--save-dev|--save-optional] [--save-exact]
|
||||
npm install <name>@<tag>
|
||||
npm install <name>@<version>
|
||||
npm install <name>@<version range>
|
||||
npm i (with any of the previous argument usage)</code></pre>
|
||||
|
||||
<h2 id="DESCRIPTION">DESCRIPTION</h2>
|
||||
|
||||
npm i (with any of the previous argument usage)
|
||||
</code></pre><h2 id="description">DESCRIPTION</h2>
|
||||
<p>This command installs a package, and any packages that it depends on. If the
|
||||
package has a shrinkwrap file, the installation of dependencies will be driven
|
||||
by that. See <a href="../cli/npm-shrinkwrap.html">npm-shrinkwrap(1)</a>.</p>
|
||||
|
||||
<p>A <code>package</code> is:</p>
|
||||
|
||||
<ul><li>a) a folder containing a program described by a package.json file</li><li>b) a gzipped tarball containing (a)</li><li>c) a url that resolves to (b)</li><li>d) a <code><name>@<version></code> that is published on the registry (see <code><a href="../misc/npm-registry.html">npm-registry(7)</a></code>) with (c)</li><li>e) a <code><name>@<tag></code> that points to (d)</li><li>f) a <code><name></code> that has a "latest" tag satisfying (e)</li><li>g) a <code><git remote url></code> that resolves to (b)</li></ul>
|
||||
|
||||
<ul>
|
||||
<li>a) a folder containing a program described by a package.json file</li>
|
||||
<li>b) a gzipped tarball containing (a)</li>
|
||||
<li>c) a url that resolves to (b)</li>
|
||||
<li>d) a <code><name>@<version></code> that is published on the registry (see <code><a href="../misc/npm-registry.html">npm-registry(7)</a></code>) with (c)</li>
|
||||
<li>e) a <code><name>@<tag></code> that points to (d)</li>
|
||||
<li>f) a <code><name></code> that has a "latest" tag satisfying (e)</li>
|
||||
<li>g) a <code><git remote url></code> that resolves to (b)</li>
|
||||
</ul>
|
||||
<p>Even if you never publish your package, you can still get a lot of
|
||||
benefits of using npm if you just want to write a node program (a), and
|
||||
perhaps if you also want to be able to easily install it elsewhere
|
||||
after packing it up into a tarball (b).</p>
|
||||
|
||||
<ul><li><p><code>npm install</code> (in package directory, no arguments):</p><p>Install the dependencies in the local node_modules folder.</p><p>In global mode (ie, with <code>-g</code> or <code>--global</code> appended to the command),
|
||||
it installs the current package context (ie, the current working
|
||||
directory) as a global package.</p><p>By default, <code>npm install</code> will install all modules listed as
|
||||
dependencies. With the <code>--production</code> flag,
|
||||
npm will not install modules listed in <code>devDependencies</code>.</p></li><li><p><code>npm install <folder></code>:</p><p>Install a package that is sitting in a folder on the filesystem.</p></li><li><p><code>npm install <tarball file></code>:</p><p>Install a package that is sitting on the filesystem. Note: if you just want
|
||||
to link a dev directory into your npm root, you can do this more easily by
|
||||
using <code>npm link</code>.</p><p>Example:</p><pre><code> npm install ./package.tgz</code></pre></li><li><p><code>npm install <tarball url></code>:</p><p>Fetch the tarball url, and then install it. In order to distinguish between
|
||||
this and other options, the argument must start with "http://" or "https://"</p><p>Example:</p><pre><code> npm install https://github.com/indexzero/forever/tarball/v0.5.6</code></pre></li><li><p><code>npm install <name> [--save|--save-dev|--save-optional]</code>:</p><p>Do a <code><name>@<tag></code> install, where <code><tag></code> is the "tag" config. (See
|
||||
<code><a href="../misc/npm-config.html">npm-config(7)</a></code>.)</p><p>In most cases, this will install the latest version
|
||||
of the module published on npm.</p><p>Example:</p><p> npm install sax</p><p><code>npm install</code> takes 3 exclusive, optional flags which save or update
|
||||
the package version in your main package.json:</p><ul><li><p><code>--save</code>: Package will appear in your <code>dependencies</code>.</p></li><li><p><code>--save-dev</code>: Package will appear in your <code>devDependencies</code>.</p></li><li><p><code>--save-optional</code>: Package will appear in your <code>optionalDependencies</code>.</p><p>When using any of the above options to save dependencies to your
|
||||
package.json, there is an additional, optional flag:</p></li><li><p><code>--save-exact</code>: Saved dependencies will be configured with an
|
||||
<ul>
|
||||
<li><p><code>npm install</code> (in package directory, no arguments):</p>
|
||||
<p> Install the dependencies in the local node_modules folder.</p>
|
||||
<p> In global mode (ie, with <code>-g</code> or <code>--global</code> appended to the command),
|
||||
it installs the current package context (ie, the current working
|
||||
directory) as a global package.</p>
|
||||
<p> By default, <code>npm install</code> will install all modules listed as
|
||||
dependencies. With the <code>--production</code> flag,
|
||||
npm will not install modules listed in <code>devDependencies</code>.</p>
|
||||
</li>
|
||||
<li><p><code>npm install <folder></code>:</p>
|
||||
<p> Install a package that is sitting in a folder on the filesystem.</p>
|
||||
</li>
|
||||
<li><p><code>npm install <tarball file></code>:</p>
|
||||
<p> Install a package that is sitting on the filesystem. Note: if you just want
|
||||
to link a dev directory into your npm root, you can do this more easily by
|
||||
using <code>npm link</code>.</p>
|
||||
<p> Example:</p>
|
||||
<pre><code> npm install ./package.tgz
|
||||
</code></pre></li>
|
||||
<li><p><code>npm install <tarball url></code>:</p>
|
||||
<p> Fetch the tarball url, and then install it. In order to distinguish between
|
||||
this and other options, the argument must start with "http://" or "https://"</p>
|
||||
<p> Example:</p>
|
||||
<pre><code> npm install https://github.com/indexzero/forever/tarball/v0.5.6
|
||||
</code></pre></li>
|
||||
<li><p><code>npm install <name> [--save|--save-dev|--save-optional]</code>:</p>
|
||||
<p> Do a <code><name>@<tag></code> install, where <code><tag></code> is the "tag" config. (See
|
||||
<code><a href="../misc/npm-config.html">npm-config(7)</a></code>.)</p>
|
||||
<p> In most cases, this will install the latest version
|
||||
of the module published on npm.</p>
|
||||
<p> Example:</p>
|
||||
<pre><code> npm install sax
|
||||
</code></pre><p> <code>npm install</code> takes 3 exclusive, optional flags which save or update
|
||||
the package version in your main package.json:</p>
|
||||
<ul>
|
||||
<li><p><code>--save</code>: Package will appear in your <code>dependencies</code>.</p>
|
||||
</li>
|
||||
<li><p><code>--save-dev</code>: Package will appear in your <code>devDependencies</code>.</p>
|
||||
</li>
|
||||
<li><p><code>--save-optional</code>: Package will appear in your <code>optionalDependencies</code>.</p>
|
||||
<p>When using any of the above options to save dependencies to your
|
||||
package.json, there is an additional, optional flag:</p>
|
||||
</li>
|
||||
<li><p><code>--save-exact</code>: Saved dependencies will be configured with an
|
||||
exact version rather than using npm's default semver range
|
||||
operator.</p><p>Examples:</p><p> npm install sax --save
|
||||
npm install node-tap --save-dev
|
||||
npm install dtrace-provider --save-optional
|
||||
npm install readable-stream --save --save-exact</p><p><strong>Note</strong>: If there is a file or folder named <code><name></code> in the current
|
||||
operator.</p>
|
||||
<p>Examples:</p>
|
||||
<pre><code>npm install sax --save
|
||||
npm install node-tap --save-dev
|
||||
npm install dtrace-provider --save-optional
|
||||
npm install readable-stream --save --save-exact
|
||||
</code></pre></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<pre><code>**Note**: If there is a file or folder named `<name>` in the current
|
||||
working directory, then it will try to install that, and only try to
|
||||
fetch the package by name if it is not valid.</p></li></ul></li><li><p><code>npm install <name>@<tag></code>:</p><p>Install the version of the package that is referenced by the specified tag.
|
||||
If the tag does not exist in the registry data for that package, then this
|
||||
will fail.</p><p>Example:</p><pre><code> npm install sax@latest</code></pre></li><li><p><code>npm install <name>@<version></code>:</p><p>Install the specified version of the package. This will fail if the version
|
||||
has not been published to the registry.</p><p>Example:</p><pre><code> npm install sax@0.1.1</code></pre></li><li><p><code>npm install <name>@<version range></code>:</p><p>Install a version of the package matching the specified version range. This
|
||||
will follow the same rules for resolving dependencies described in <code><a href="../files/package.json.html">package.json(5)</a></code>.</p><p>Note that most version ranges must be put in quotes so that your shell will
|
||||
treat it as a single argument.</p><p>Example:</p><p> npm install sax@">=0.1.0 <0.2.0"</p></li><li><p><code>npm install <git remote url></code>:</p><p>Install a package by cloning a git remote url. The format of the git
|
||||
url is:</p><p> <protocol>://[<user>@]<hostname><separator><path>[#<commit-ish>]</p><p><code><protocol></code> is one of <code>git</code>, <code>git+ssh</code>, <code>git+http</code>, or
|
||||
<code>git+https</code>. If no <code><commit-ish></code> is specified, then <code>master</code> is
|
||||
used.</p><p>Examples:</p><pre><code> git+ssh://git@github.com:npm/npm.git#v1.0.27
|
||||
fetch the package by name if it is not valid.
|
||||
</code></pre><ul>
|
||||
<li><p><code>npm install <name>@<tag></code>:</p>
|
||||
<p> Install the version of the package that is referenced by the specified tag.
|
||||
If the tag does not exist in the registry data for that package, then this
|
||||
will fail.</p>
|
||||
<p> Example:</p>
|
||||
<pre><code> npm install sax@latest
|
||||
</code></pre></li>
|
||||
<li><p><code>npm install <name>@<version></code>:</p>
|
||||
<p> Install the specified version of the package. This will fail if the version
|
||||
has not been published to the registry.</p>
|
||||
<p> Example:</p>
|
||||
<pre><code> npm install sax@0.1.1
|
||||
</code></pre></li>
|
||||
<li><p><code>npm install <name>@<version range></code>:</p>
|
||||
<p> Install a version of the package matching the specified version range. This
|
||||
will follow the same rules for resolving dependencies described in <code><a href="../files/package.json.html">package.json(5)</a></code>.</p>
|
||||
<p> Note that most version ranges must be put in quotes so that your shell will
|
||||
treat it as a single argument.</p>
|
||||
<p> Example:</p>
|
||||
<pre><code> npm install sax@">=0.1.0 <0.2.0"
|
||||
</code></pre></li>
|
||||
<li><p><code>npm install <git remote url></code>:</p>
|
||||
<p> Install a package by cloning a git remote url. The format of the git
|
||||
url is:</p>
|
||||
<pre><code> <protocol>://[<user>@]<hostname><separator><path>[#<commit-ish>]
|
||||
</code></pre><p> <code><protocol></code> is one of <code>git</code>, <code>git+ssh</code>, <code>git+http</code>, or
|
||||
<code>git+https</code>. If no <code><commit-ish></code> is specified, then <code>master</code> is
|
||||
used.</p>
|
||||
<p> Examples:</p>
|
||||
<pre><code> git+ssh://git@github.com:npm/npm.git#v1.0.27
|
||||
git+https://isaacs@github.com/npm/npm.git
|
||||
git://github.com/npm/npm.git#v1.0.27</code></pre></li></ul>
|
||||
|
||||
git://github.com/npm/npm.git#v1.0.27
|
||||
</code></pre></li>
|
||||
</ul>
|
||||
<p>You may combine multiple arguments, and even multiple types of arguments.
|
||||
For example:</p>
|
||||
|
||||
<pre><code>npm install sax@">=0.1.0 <0.2.0" bench supervisor</code></pre>
|
||||
|
||||
<p>The <code>--tag</code> argument will apply to all of the specified install targets. If a
|
||||
<pre><code>npm install sax@">=0.1.0 <0.2.0" bench supervisor
|
||||
</code></pre><p>The <code>--tag</code> argument will apply to all of the specified install targets. If a
|
||||
tag with the given name exists, the tagged version is preferred over newer
|
||||
versions.</p>
|
||||
|
||||
<p>The <code>--force</code> argument will force npm to fetch remote resources even if a
|
||||
local copy exists on disk.</p>
|
||||
|
||||
<pre><code>npm install sax --force</code></pre>
|
||||
|
||||
<p>The <code>--global</code> argument will cause npm to install the package globally
|
||||
<pre><code>npm install sax --force
|
||||
</code></pre><p>The <code>--global</code> argument will cause npm to install the package globally
|
||||
rather than locally. See <code><a href="../files/npm-folders.html">npm-folders(5)</a></code>.</p>
|
||||
|
||||
<p>The <code>--link</code> argument will cause npm to link global installs into the
|
||||
local space in some cases.</p>
|
||||
|
||||
<p>The <code>--no-bin-links</code> argument will prevent npm from creating symlinks for
|
||||
any binaries the package might contain.</p>
|
||||
|
||||
<p>The <code>--no-optional</code> argument will prevent optional dependencies from
|
||||
being installed.</p>
|
||||
|
||||
<p>The <code>--no-shrinkwrap</code> argument, which will ignore an available
|
||||
shrinkwrap file and use the package.json instead.</p>
|
||||
|
||||
<p>The <code>--nodedir=/path/to/node/source</code> argument will allow npm to find the
|
||||
node source code so that npm can compile native modules.</p>
|
||||
|
||||
<p>See <code><a href="../misc/npm-config.html">npm-config(7)</a></code>. Many of the configuration params have some
|
||||
effect on installation, since that's most of what npm does.</p>
|
||||
|
||||
<h2 id="ALGORITHM">ALGORITHM</h2>
|
||||
|
||||
<h2 id="algorithm">ALGORITHM</h2>
|
||||
<p>To install a package, npm uses the following algorithm:</p>
|
||||
|
||||
<pre><code>install(where, what, family, ancestors)
|
||||
fetch what, unpack to <where>/node_modules/<what>
|
||||
for each dep in what.dependencies
|
||||
@ -115,46 +165,50 @@ for each dep@version in what.dependencies
|
||||
not in <where>/node_modules/<what>/node_modules/*
|
||||
and not in <family>
|
||||
add precise version deps to <family>
|
||||
install(<where>/node_modules/<what>, dep, family)</code></pre>
|
||||
|
||||
<p>For this <code>package{dep}</code> structure: <code>A{B,C}, B{C}, C{D}</code>,
|
||||
install(<where>/node_modules/<what>, dep, family)
|
||||
</code></pre><p>For this <code>package{dep}</code> structure: <code>A{B,C}, B{C}, C{D}</code>,
|
||||
this algorithm produces:</p>
|
||||
|
||||
<pre><code>A
|
||||
+-- B
|
||||
`-- C
|
||||
`-- D</code></pre>
|
||||
|
||||
<p>That is, the dependency from B to C is satisfied by the fact that A
|
||||
`-- D
|
||||
</code></pre><p>That is, the dependency from B to C is satisfied by the fact that A
|
||||
already caused C to be installed at a higher level.</p>
|
||||
|
||||
<p>See <a href="../files/npm-folders.html">npm-folders(5)</a> for a more detailed description of the specific
|
||||
folder structures that npm creates.</p>
|
||||
|
||||
<h3 id="Limitations-of-npm-s-Install-Algorithm">Limitations of npm's Install Algorithm</h3>
|
||||
|
||||
<h3 id="limitations-of-npm-s-install-algorithm">Limitations of npm's Install Algorithm</h3>
|
||||
<p>There are some very rare and pathological edge-cases where a cycle can
|
||||
cause npm to try to install a never-ending tree of packages. Here is
|
||||
the simplest case:</p>
|
||||
|
||||
<pre><code>A -> B -> A' -> B' -> A -> B -> A' -> B' -> A -> ...</code></pre>
|
||||
|
||||
<p>where <code>A</code> is some version of a package, and <code>A'</code> is a different version
|
||||
<pre><code>A -> B -> A' -> B' -> A -> B -> A' -> B' -> A -> ...
|
||||
</code></pre><p>where <code>A</code> is some version of a package, and <code>A'</code> is a different version
|
||||
of the same package. Because <code>B</code> depends on a different version of <code>A</code>
|
||||
than the one that is already in the tree, it must install a separate
|
||||
copy. The same is true of <code>A'</code>, which must install <code>B'</code>. Because <code>B'</code>
|
||||
depends on the original version of <code>A</code>, which has been overridden, the
|
||||
cycle falls into infinite regress.</p>
|
||||
|
||||
<p>To avoid this situation, npm flat-out refuses to install any
|
||||
<code>name@version</code> that is already present anywhere in the tree of package
|
||||
folder ancestors. A more correct, but more complex, solution would be
|
||||
to symlink the existing version into the new location. If this ever
|
||||
affects a real use-case, it will be investigated.</p>
|
||||
<h2 id="see-also">SEE ALSO</h2>
|
||||
<ul>
|
||||
<li><a href="../files/npm-folders.html">npm-folders(5)</a></li>
|
||||
<li><a href="../cli/npm-update.html">npm-update(1)</a></li>
|
||||
<li><a href="../cli/npm-link.html">npm-link(1)</a></li>
|
||||
<li><a href="../cli/npm-rebuild.html">npm-rebuild(1)</a></li>
|
||||
<li><a href="../misc/npm-scripts.html">npm-scripts(7)</a></li>
|
||||
<li><a href="../cli/npm-build.html">npm-build(1)</a></li>
|
||||
<li><a href="../cli/npm-config.html">npm-config(1)</a></li>
|
||||
<li><a href="../misc/npm-config.html">npm-config(7)</a></li>
|
||||
<li><a href="../files/npmrc.html">npmrc(5)</a></li>
|
||||
<li><a href="../misc/npm-registry.html">npm-registry(7)</a></li>
|
||||
<li><a href="../cli/npm-tag.html">npm-tag(1)</a></li>
|
||||
<li><a href="../cli/npm-rm.html">npm-rm(1)</a></li>
|
||||
<li><a href="../cli/npm-shrinkwrap.html">npm-shrinkwrap(1)</a></li>
|
||||
</ul>
|
||||
|
||||
<h2 id="SEE-ALSO">SEE ALSO</h2>
|
||||
|
||||
<ul><li><a href="../files/npm-folders.html">npm-folders(5)</a></li><li><a href="../cli/npm-update.html">npm-update(1)</a></li><li><a href="../cli/npm-link.html">npm-link(1)</a></li><li><a href="../cli/npm-rebuild.html">npm-rebuild(1)</a></li><li><a href="../misc/npm-scripts.html">npm-scripts(7)</a></li><li><a href="../cli/npm-build.html">npm-build(1)</a></li><li><a href="../cli/npm-config.html">npm-config(1)</a></li><li><a href="../misc/npm-config.html">npm-config(7)</a></li><li><a href="../files/npmrc.html">npmrc(5)</a></li><li><a href="../misc/npm-registry.html">npm-registry(7)</a></li><li><a href="../cli/npm-tag.html">npm-tag(1)</a></li><li><a href="../cli/npm-rm.html">npm-rm(1)</a></li><li><a href="../cli/npm-shrinkwrap.html">npm-shrinkwrap(1)</a></li></ul>
|
||||
</div>
|
||||
|
||||
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
|
||||
@ -166,5 +220,5 @@ affects a real use-case, it will be investigated.</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-install — npm@1.4.9</p>
|
||||
<p id="footer">npm-install — npm@1.4.10</p>
|
||||
|
||||
|
||||
51
deps/npm/html/doc/cli/npm-link.html
vendored
51
deps/npm/html/doc/cli/npm-link.html
vendored
@ -10,60 +10,51 @@
|
||||
<div id="wrapper">
|
||||
|
||||
<h1><a href="../cli/npm-link.html">npm-link</a></h1> <p>Symlink a package folder</p>
|
||||
|
||||
<h2 id="SYNOPSIS">SYNOPSIS</h2>
|
||||
|
||||
<h2 id="synopsis">SYNOPSIS</h2>
|
||||
<pre><code>npm link (in package folder)
|
||||
npm link <pkgname>
|
||||
npm ln (with any of the previous argument usage)</code></pre>
|
||||
|
||||
<h2 id="DESCRIPTION">DESCRIPTION</h2>
|
||||
|
||||
npm ln (with any of the previous argument usage)
|
||||
</code></pre><h2 id="description">DESCRIPTION</h2>
|
||||
<p>Package linking is a two-step process.</p>
|
||||
|
||||
<p>First, <code>npm link</code> in a package folder will create a globally-installed
|
||||
symbolic link from <code>prefix/package-name</code> to the current folder.</p>
|
||||
|
||||
<p>Next, in some other location, <code>npm link package-name</code> will create a
|
||||
symlink from the local <code>node_modules</code> folder to the global symlink.</p>
|
||||
|
||||
<p>Note that <code>package-name</code> is taken from <code>package.json</code>,
|
||||
not from directory name.</p>
|
||||
|
||||
<p>When creating tarballs for <code>npm publish</code>, the linked packages are
|
||||
"snapshotted" to their current state by resolving the symbolic links.</p>
|
||||
|
||||
<p>This is
|
||||
handy for installing your own stuff, so that you can work on it and test it
|
||||
iteratively without having to continually rebuild.</p>
|
||||
|
||||
<p>For example:</p>
|
||||
|
||||
<pre><code>cd ~/projects/node-redis # go into the package directory
|
||||
npm link # creates global link
|
||||
cd ~/projects/node-bloggy # go into some other package directory.
|
||||
npm link redis # link-install the package</code></pre>
|
||||
|
||||
<p>Now, any changes to ~/projects/node-redis will be reflected in
|
||||
npm link redis # link-install the package
|
||||
</code></pre><p>Now, any changes to ~/projects/node-redis will be reflected in
|
||||
~/projects/node-bloggy/node_modules/redis/</p>
|
||||
|
||||
<p>You may also shortcut the two steps in one. For example, to do the
|
||||
above use-case in a shorter way:</p>
|
||||
|
||||
<pre><code>cd ~/projects/node-bloggy # go into the dir of your main project
|
||||
npm link ../node-redis # link the dir of your dependency</code></pre>
|
||||
|
||||
<p>The second line is the equivalent of doing:</p>
|
||||
|
||||
npm link ../node-redis # link the dir of your dependency
|
||||
</code></pre><p>The second line is the equivalent of doing:</p>
|
||||
<pre><code>(cd ../node-redis; npm link)
|
||||
npm link redis</code></pre>
|
||||
|
||||
<p>That is, it first creates a global link, and then links the global
|
||||
npm link redis
|
||||
</code></pre><p>That is, it first creates a global link, and then links the global
|
||||
installation target into your project's <code>node_modules</code> folder.</p>
|
||||
<h2 id="see-also">SEE ALSO</h2>
|
||||
<ul>
|
||||
<li><a href="../misc/npm-developers.html">npm-developers(7)</a></li>
|
||||
<li><a href="../misc/npm-faq.html">npm-faq(7)</a></li>
|
||||
<li><a href="../files/package.json.html">package.json(5)</a></li>
|
||||
<li><a href="../cli/npm-install.html">npm-install(1)</a></li>
|
||||
<li><a href="../files/npm-folders.html">npm-folders(5)</a></li>
|
||||
<li><a href="../cli/npm-config.html">npm-config(1)</a></li>
|
||||
<li><a href="../misc/npm-config.html">npm-config(7)</a></li>
|
||||
<li><a href="../files/npmrc.html">npmrc(5)</a></li>
|
||||
</ul>
|
||||
|
||||
<h2 id="SEE-ALSO">SEE ALSO</h2>
|
||||
|
||||
<ul><li><a href="../misc/npm-developers.html">npm-developers(7)</a></li><li><a href="../misc/npm-faq.html">npm-faq(7)</a></li><li><a href="../files/package.json.html">package.json(5)</a></li><li><a href="../cli/npm-install.html">npm-install(1)</a></li><li><a href="../files/npm-folders.html">npm-folders(5)</a></li><li><a href="../cli/npm-config.html">npm-config(1)</a></li><li><a href="../misc/npm-config.html">npm-config(7)</a></li><li><a href="../files/npmrc.html">npmrc(5)</a></li></ul>
|
||||
</div>
|
||||
|
||||
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
|
||||
@ -75,5 +66,5 @@ installation target into your project's <code>node_modules</code> folder.</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-link — npm@1.4.9</p>
|
||||
<p id="footer">npm-link — npm@1.4.10</p>
|
||||
|
||||
|
||||
80
deps/npm/html/doc/cli/npm-ls.html
vendored
80
deps/npm/html/doc/cli/npm-ls.html
vendored
@ -10,72 +10,70 @@
|
||||
<div id="wrapper">
|
||||
|
||||
<h1><a href="../cli/npm-ls.html">npm-ls</a></h1> <p>List installed packages</p>
|
||||
|
||||
<h2 id="SYNOPSIS">SYNOPSIS</h2>
|
||||
|
||||
<h2 id="synopsis">SYNOPSIS</h2>
|
||||
<pre><code>npm list [<pkg> ...]
|
||||
npm ls [<pkg> ...]
|
||||
npm la [<pkg> ...]
|
||||
npm ll [<pkg> ...]</code></pre>
|
||||
|
||||
<h2 id="DESCRIPTION">DESCRIPTION</h2>
|
||||
|
||||
npm ll [<pkg> ...]
|
||||
</code></pre><h2 id="description">DESCRIPTION</h2>
|
||||
<p>This command will print to stdout all the versions of packages that are
|
||||
installed, as well as their dependencies, in a tree-structure.</p>
|
||||
|
||||
<p>Positional arguments are <code>name@version-range</code> identifiers, which will
|
||||
limit the results to only the paths to the packages named. Note that
|
||||
nested packages will <em>also</em> show the paths to the specified packages.
|
||||
For example, running <code>npm ls promzard</code> in npm's source tree will show:</p>
|
||||
|
||||
<pre><code>npm@1.4.9 /path/to/npm
|
||||
<pre><code>npm@1.4.10 /path/to/npm
|
||||
└─┬ init-package-json@0.0.4
|
||||
└── promzard@0.1.5</code></pre>
|
||||
|
||||
<p>It will print out extraneous, missing, and invalid packages.</p>
|
||||
|
||||
└── promzard@0.1.5
|
||||
</code></pre><p>It will print out extraneous, missing, and invalid packages.</p>
|
||||
<p>If a project specifies git urls for dependencies these are shown
|
||||
in parentheses after the name@version to make it easier for users to
|
||||
recognize potential forks of a project.</p>
|
||||
|
||||
<p>When run as <code>ll</code> or <code>la</code>, it shows extended information by default.</p>
|
||||
|
||||
<h2 id="CONFIGURATION">CONFIGURATION</h2>
|
||||
|
||||
<h2 id="configuration">CONFIGURATION</h2>
|
||||
<h3 id="json">json</h3>
|
||||
|
||||
<ul><li>Default: false</li><li>Type: Boolean</li></ul>
|
||||
|
||||
<ul>
|
||||
<li>Default: false</li>
|
||||
<li>Type: Boolean</li>
|
||||
</ul>
|
||||
<p>Show information in JSON format.</p>
|
||||
|
||||
<h3 id="long">long</h3>
|
||||
|
||||
<ul><li>Default: false</li><li>Type: Boolean</li></ul>
|
||||
|
||||
<ul>
|
||||
<li>Default: false</li>
|
||||
<li>Type: Boolean</li>
|
||||
</ul>
|
||||
<p>Show extended information.</p>
|
||||
|
||||
<h3 id="parseable">parseable</h3>
|
||||
|
||||
<ul><li>Default: false</li><li>Type: Boolean</li></ul>
|
||||
|
||||
<ul>
|
||||
<li>Default: false</li>
|
||||
<li>Type: Boolean</li>
|
||||
</ul>
|
||||
<p>Show parseable output instead of tree view.</p>
|
||||
|
||||
<h3 id="global">global</h3>
|
||||
|
||||
<ul><li>Default: false</li><li>Type: Boolean</li></ul>
|
||||
|
||||
<ul>
|
||||
<li>Default: false</li>
|
||||
<li>Type: Boolean</li>
|
||||
</ul>
|
||||
<p>List packages in the global install prefix instead of in the current
|
||||
project.</p>
|
||||
|
||||
<h3 id="depth">depth</h3>
|
||||
|
||||
<ul><li>Type: Int</li></ul>
|
||||
|
||||
<ul>
|
||||
<li>Type: Int</li>
|
||||
</ul>
|
||||
<p>Max display depth of the dependency tree.</p>
|
||||
<h2 id="see-also">SEE ALSO</h2>
|
||||
<ul>
|
||||
<li><a href="../cli/npm-config.html">npm-config(1)</a></li>
|
||||
<li><a href="../misc/npm-config.html">npm-config(7)</a></li>
|
||||
<li><a href="../files/npmrc.html">npmrc(5)</a></li>
|
||||
<li><a href="../files/npm-folders.html">npm-folders(5)</a></li>
|
||||
<li><a href="../cli/npm-install.html">npm-install(1)</a></li>
|
||||
<li><a href="../cli/npm-link.html">npm-link(1)</a></li>
|
||||
<li><a href="../cli/npm-prune.html">npm-prune(1)</a></li>
|
||||
<li><a href="../cli/npm-outdated.html">npm-outdated(1)</a></li>
|
||||
<li><a href="../cli/npm-update.html">npm-update(1)</a></li>
|
||||
</ul>
|
||||
|
||||
<h2 id="SEE-ALSO">SEE ALSO</h2>
|
||||
|
||||
<ul><li><a href="../cli/npm-config.html">npm-config(1)</a></li><li><a href="../misc/npm-config.html">npm-config(7)</a></li><li><a href="../files/npmrc.html">npmrc(5)</a></li><li><a href="../files/npm-folders.html">npm-folders(5)</a></li><li><a href="../cli/npm-install.html">npm-install(1)</a></li><li><a href="../cli/npm-link.html">npm-link(1)</a></li><li><a href="../cli/npm-prune.html">npm-prune(1)</a></li><li><a href="../cli/npm-outdated.html">npm-outdated(1)</a></li><li><a href="../cli/npm-update.html">npm-update(1)</a></li></ul>
|
||||
</div>
|
||||
|
||||
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
|
||||
@ -87,5 +85,5 @@ project.</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-ls — npm@1.4.9</p>
|
||||
<p id="footer">npm-ls — npm@1.4.10</p>
|
||||
|
||||
|
||||
64
deps/npm/html/doc/cli/npm-outdated.html
vendored
64
deps/npm/html/doc/cli/npm-outdated.html
vendored
@ -10,56 +10,52 @@
|
||||
<div id="wrapper">
|
||||
|
||||
<h1><a href="../cli/npm-outdated.html">npm-outdated</a></h1> <p>Check for outdated packages</p>
|
||||
|
||||
<h2 id="SYNOPSIS">SYNOPSIS</h2>
|
||||
|
||||
<pre><code>npm outdated [<name> [<name> ...]]</code></pre>
|
||||
|
||||
<h2 id="DESCRIPTION">DESCRIPTION</h2>
|
||||
|
||||
<h2 id="synopsis">SYNOPSIS</h2>
|
||||
<pre><code>npm outdated [<name> [<name> ...]]
|
||||
</code></pre><h2 id="description">DESCRIPTION</h2>
|
||||
<p>This command will check the registry to see if any (or, specific) installed
|
||||
packages are currently outdated.</p>
|
||||
|
||||
<p>The resulting field 'wanted' shows the latest version according to the
|
||||
version specified in the package.json, the field 'latest' the very latest
|
||||
version of the package.</p>
|
||||
|
||||
<h2 id="CONFIGURATION">CONFIGURATION</h2>
|
||||
|
||||
<h2 id="configuration">CONFIGURATION</h2>
|
||||
<h3 id="json">json</h3>
|
||||
|
||||
<ul><li>Default: false</li><li>Type: Boolean</li></ul>
|
||||
|
||||
<ul>
|
||||
<li>Default: false</li>
|
||||
<li>Type: Boolean</li>
|
||||
</ul>
|
||||
<p>Show information in JSON format.</p>
|
||||
|
||||
<h3 id="long">long</h3>
|
||||
|
||||
<ul><li>Default: false</li><li>Type: Boolean</li></ul>
|
||||
|
||||
<ul>
|
||||
<li>Default: false</li>
|
||||
<li>Type: Boolean</li>
|
||||
</ul>
|
||||
<p>Show extended information.</p>
|
||||
|
||||
<h3 id="parseable">parseable</h3>
|
||||
|
||||
<ul><li>Default: false</li><li>Type: Boolean</li></ul>
|
||||
|
||||
<ul>
|
||||
<li>Default: false</li>
|
||||
<li>Type: Boolean</li>
|
||||
</ul>
|
||||
<p>Show parseable output instead of tree view.</p>
|
||||
|
||||
<h3 id="global">global</h3>
|
||||
|
||||
<ul><li>Default: false</li><li>Type: Boolean</li></ul>
|
||||
|
||||
<ul>
|
||||
<li>Default: false</li>
|
||||
<li>Type: Boolean</li>
|
||||
</ul>
|
||||
<p>Check packages in the global install prefix instead of in the current
|
||||
project.</p>
|
||||
|
||||
<h3 id="depth">depth</h3>
|
||||
|
||||
<ul><li>Type: Int</li></ul>
|
||||
|
||||
<ul>
|
||||
<li>Type: Int</li>
|
||||
</ul>
|
||||
<p>Max depth for checking dependency tree.</p>
|
||||
<h2 id="see-also">SEE ALSO</h2>
|
||||
<ul>
|
||||
<li><a href="../cli/npm-update.html">npm-update(1)</a></li>
|
||||
<li><a href="../misc/npm-registry.html">npm-registry(7)</a></li>
|
||||
<li><a href="../files/npm-folders.html">npm-folders(5)</a></li>
|
||||
</ul>
|
||||
|
||||
<h2 id="SEE-ALSO">SEE ALSO</h2>
|
||||
|
||||
<ul><li><a href="../cli/npm-update.html">npm-update(1)</a></li><li><a href="../misc/npm-registry.html">npm-registry(7)</a></li><li><a href="../files/npm-folders.html">npm-folders(5)</a></li></ul>
|
||||
</div>
|
||||
|
||||
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
|
||||
@ -71,5 +67,5 @@ project.</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-outdated — npm@1.4.9</p>
|
||||
<p id="footer">npm-outdated — npm@1.4.10</p>
|
||||
|
||||
|
||||
36
deps/npm/html/doc/cli/npm-owner.html
vendored
36
deps/npm/html/doc/cli/npm-owner.html
vendored
@ -10,32 +10,34 @@
|
||||
<div id="wrapper">
|
||||
|
||||
<h1><a href="../cli/npm-owner.html">npm-owner</a></h1> <p>Manage package owners</p>
|
||||
|
||||
<h2 id="SYNOPSIS">SYNOPSIS</h2>
|
||||
|
||||
<h2 id="synopsis">SYNOPSIS</h2>
|
||||
<pre><code>npm owner ls <package name>
|
||||
npm owner add <user> <package name>
|
||||
npm owner rm <user> <package name></code></pre>
|
||||
|
||||
<h2 id="DESCRIPTION">DESCRIPTION</h2>
|
||||
|
||||
npm owner rm <user> <package name>
|
||||
</code></pre><h2 id="description">DESCRIPTION</h2>
|
||||
<p>Manage ownership of published packages.</p>
|
||||
|
||||
<ul><li>ls:
|
||||
<ul>
|
||||
<li>ls:
|
||||
List all the users who have access to modify a package and push new versions.
|
||||
Handy when you need to know who to bug for help.</li><li>add:
|
||||
Handy when you need to know who to bug for help.</li>
|
||||
<li>add:
|
||||
Add a new user as a maintainer of a package. This user is enabled to modify
|
||||
metadata, publish new versions, and add other owners.</li><li>rm:
|
||||
metadata, publish new versions, and add other owners.</li>
|
||||
<li>rm:
|
||||
Remove a user from the package owner list. This immediately revokes their
|
||||
privileges.</li></ul>
|
||||
|
||||
privileges.</li>
|
||||
</ul>
|
||||
<p>Note that there is only one level of access. Either you can modify a package,
|
||||
or you can't. Future versions may contain more fine-grained access levels, but
|
||||
that is not implemented at this time.</p>
|
||||
<h2 id="see-also">SEE ALSO</h2>
|
||||
<ul>
|
||||
<li><a href="../cli/npm-publish.html">npm-publish(1)</a></li>
|
||||
<li><a href="../misc/npm-registry.html">npm-registry(7)</a></li>
|
||||
<li><a href="../cli/npm-adduser.html">npm-adduser(1)</a></li>
|
||||
<li><a href="../misc/npm-disputes.html">npm-disputes(7)</a></li>
|
||||
</ul>
|
||||
|
||||
<h2 id="SEE-ALSO">SEE ALSO</h2>
|
||||
|
||||
<ul><li><a href="../cli/npm-publish.html">npm-publish(1)</a></li><li><a href="../misc/npm-registry.html">npm-registry(7)</a></li><li><a href="../cli/npm-adduser.html">npm-adduser(1)</a></li><li><a href="../misc/npm-disputes.html">npm-disputes(7)</a></li></ul>
|
||||
</div>
|
||||
|
||||
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
|
||||
@ -47,5 +49,5 @@ that is not implemented at this time.</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-owner — npm@1.4.9</p>
|
||||
<p id="footer">npm-owner — npm@1.4.10</p>
|
||||
|
||||
|
||||
25
deps/npm/html/doc/cli/npm-pack.html
vendored
25
deps/npm/html/doc/cli/npm-pack.html
vendored
@ -10,27 +10,26 @@
|
||||
<div id="wrapper">
|
||||
|
||||
<h1><a href="../cli/npm-pack.html">npm-pack</a></h1> <p>Create a tarball from a package</p>
|
||||
|
||||
<h2 id="SYNOPSIS">SYNOPSIS</h2>
|
||||
|
||||
<pre><code>npm pack [<pkg> [<pkg> ...]]</code></pre>
|
||||
|
||||
<h2 id="DESCRIPTION">DESCRIPTION</h2>
|
||||
|
||||
<h2 id="synopsis">SYNOPSIS</h2>
|
||||
<pre><code>npm pack [<pkg> [<pkg> ...]]
|
||||
</code></pre><h2 id="description">DESCRIPTION</h2>
|
||||
<p>For anything that's installable (that is, a package folder, tarball,
|
||||
tarball url, name@tag, name@version, or name), this command will fetch
|
||||
it to the cache, and then copy the tarball to the current working
|
||||
directory as <code><name>-<version>.tgz</code>, and then write the filenames out to
|
||||
stdout.</p>
|
||||
|
||||
<p>If the same package is specified multiple times, then the file will be
|
||||
overwritten the second time.</p>
|
||||
|
||||
<p>If no arguments are supplied, then npm packs the current package folder.</p>
|
||||
<h2 id="see-also">SEE ALSO</h2>
|
||||
<ul>
|
||||
<li><a href="../cli/npm-cache.html">npm-cache(1)</a></li>
|
||||
<li><a href="../cli/npm-publish.html">npm-publish(1)</a></li>
|
||||
<li><a href="../cli/npm-config.html">npm-config(1)</a></li>
|
||||
<li><a href="../misc/npm-config.html">npm-config(7)</a></li>
|
||||
<li><a href="../files/npmrc.html">npmrc(5)</a></li>
|
||||
</ul>
|
||||
|
||||
<h2 id="SEE-ALSO">SEE ALSO</h2>
|
||||
|
||||
<ul><li><a href="../cli/npm-cache.html">npm-cache(1)</a></li><li><a href="../cli/npm-publish.html">npm-publish(1)</a></li><li><a href="../cli/npm-config.html">npm-config(1)</a></li><li><a href="../misc/npm-config.html">npm-config(7)</a></li><li><a href="../files/npmrc.html">npmrc(5)</a></li></ul>
|
||||
</div>
|
||||
|
||||
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
|
||||
@ -42,5 +41,5 @@ overwritten the second time.</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-pack — npm@1.4.9</p>
|
||||
<p id="footer">npm-pack — npm@1.4.10</p>
|
||||
|
||||
|
||||
24
deps/npm/html/doc/cli/npm-prefix.html
vendored
24
deps/npm/html/doc/cli/npm-prefix.html
vendored
@ -10,18 +10,20 @@
|
||||
<div id="wrapper">
|
||||
|
||||
<h1><a href="../cli/npm-prefix.html">npm-prefix</a></h1> <p>Display prefix</p>
|
||||
|
||||
<h2 id="SYNOPSIS">SYNOPSIS</h2>
|
||||
|
||||
<pre><code>npm prefix</code></pre>
|
||||
|
||||
<h2 id="DESCRIPTION">DESCRIPTION</h2>
|
||||
|
||||
<h2 id="synopsis">SYNOPSIS</h2>
|
||||
<pre><code>npm prefix
|
||||
</code></pre><h2 id="description">DESCRIPTION</h2>
|
||||
<p>Print the prefix to standard out.</p>
|
||||
<h2 id="see-also">SEE ALSO</h2>
|
||||
<ul>
|
||||
<li><a href="../cli/npm-root.html">npm-root(1)</a></li>
|
||||
<li><a href="../cli/npm-bin.html">npm-bin(1)</a></li>
|
||||
<li><a href="../files/npm-folders.html">npm-folders(5)</a></li>
|
||||
<li><a href="../cli/npm-config.html">npm-config(1)</a></li>
|
||||
<li><a href="../misc/npm-config.html">npm-config(7)</a></li>
|
||||
<li><a href="../files/npmrc.html">npmrc(5)</a></li>
|
||||
</ul>
|
||||
|
||||
<h2 id="SEE-ALSO">SEE ALSO</h2>
|
||||
|
||||
<ul><li><a href="../cli/npm-root.html">npm-root(1)</a></li><li><a href="../cli/npm-bin.html">npm-bin(1)</a></li><li><a href="../files/npm-folders.html">npm-folders(5)</a></li><li><a href="../cli/npm-config.html">npm-config(1)</a></li><li><a href="../misc/npm-config.html">npm-config(7)</a></li><li><a href="../files/npmrc.html">npmrc(5)</a></li></ul>
|
||||
</div>
|
||||
|
||||
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
|
||||
@ -33,5 +35,5 @@
|
||||
<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-prefix — npm@1.4.9</p>
|
||||
<p id="footer">npm-prefix — npm@1.4.10</p>
|
||||
|
||||
|
||||
23
deps/npm/html/doc/cli/npm-prune.html
vendored
23
deps/npm/html/doc/cli/npm-prune.html
vendored
@ -10,27 +10,24 @@
|
||||
<div id="wrapper">
|
||||
|
||||
<h1><a href="../cli/npm-prune.html">npm-prune</a></h1> <p>Remove extraneous packages</p>
|
||||
|
||||
<h2 id="SYNOPSIS">SYNOPSIS</h2>
|
||||
|
||||
<h2 id="synopsis">SYNOPSIS</h2>
|
||||
<pre><code>npm prune [<name> [<name ...]]
|
||||
npm prune [<name> [<name ...]] [--production]</code></pre>
|
||||
|
||||
<h2 id="DESCRIPTION">DESCRIPTION</h2>
|
||||
|
||||
npm prune [<name> [<name ...]] [--production]
|
||||
</code></pre><h2 id="description">DESCRIPTION</h2>
|
||||
<p>This command removes "extraneous" packages. If a package name is
|
||||
provided, then only packages matching one of the supplied names are
|
||||
removed.</p>
|
||||
|
||||
<p>Extraneous packages are packages that are not listed on the parent
|
||||
package's dependencies list.</p>
|
||||
|
||||
<p>If the <code>--production</code> flag is specified, this command will remove the
|
||||
packages specified in your <code>devDependencies</code>.</p>
|
||||
<h2 id="see-also">SEE ALSO</h2>
|
||||
<ul>
|
||||
<li><a href="../cli/npm-rm.html">npm-rm(1)</a></li>
|
||||
<li><a href="../files/npm-folders.html">npm-folders(5)</a></li>
|
||||
<li><a href="../cli/npm-ls.html">npm-ls(1)</a></li>
|
||||
</ul>
|
||||
|
||||
<h2 id="SEE-ALSO">SEE ALSO</h2>
|
||||
|
||||
<ul><li><a href="../cli/npm-rm.html">npm-rm(1)</a></li><li><a href="../files/npm-folders.html">npm-folders(5)</a></li><li><a href="../cli/npm-ls.html">npm-ls(1)</a></li></ul>
|
||||
</div>
|
||||
|
||||
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
|
||||
@ -42,5 +39,5 @@ packages specified in your <code>devDependencies</code>.</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-prune — npm@1.4.9</p>
|
||||
<p id="footer">npm-prune — npm@1.4.10</p>
|
||||
|
||||
|
||||
41
deps/npm/html/doc/cli/npm-publish.html
vendored
41
deps/npm/html/doc/cli/npm-publish.html
vendored
@ -10,34 +10,39 @@
|
||||
<div id="wrapper">
|
||||
|
||||
<h1><a href="../cli/npm-publish.html">npm-publish</a></h1> <p>Publish a package</p>
|
||||
|
||||
<h2 id="SYNOPSIS">SYNOPSIS</h2>
|
||||
|
||||
<h2 id="synopsis">SYNOPSIS</h2>
|
||||
<pre><code>npm publish <tarball> [--tag <tag>]
|
||||
npm publish <folder> [--tag <tag>]</code></pre>
|
||||
|
||||
<h2 id="DESCRIPTION">DESCRIPTION</h2>
|
||||
|
||||
npm publish <folder> [--tag <tag>]
|
||||
</code></pre><h2 id="description">DESCRIPTION</h2>
|
||||
<p>Publishes a package to the registry so that it can be installed by name.</p>
|
||||
|
||||
<ul><li><p><code><folder></code>:
|
||||
A folder containing a package.json file</p></li><li><p><code><tarball></code>:
|
||||
<ul>
|
||||
<li><p><code><folder></code>:
|
||||
A folder containing a package.json file</p>
|
||||
</li>
|
||||
<li><p><code><tarball></code>:
|
||||
A url or file path to a gzipped tar archive containing a single folder
|
||||
with a package.json file inside.</p></li><li><p><code>[--tag <tag>]</code>
|
||||
with a package.json file inside.</p>
|
||||
</li>
|
||||
<li><p><code>[--tag <tag>]</code>
|
||||
Registers the published package with the given tag, such that <code>npm install
|
||||
<name>@<tag></code> will install this version. By default, <code>npm publish</code> updates
|
||||
and <code>npm install</code> installs the <code>latest</code> tag.</p></li></ul>
|
||||
|
||||
and <code>npm install</code> installs the <code>latest</code> tag.</p>
|
||||
</li>
|
||||
</ul>
|
||||
<p>Fails if the package name and version combination already exists in
|
||||
the registry.</p>
|
||||
|
||||
<p>Once a package is published with a given name and version, that
|
||||
specific name and version combination can never be used again, even if
|
||||
it is removed with <a href="../cli/npm-unpublish.html">npm-unpublish(1)</a>.</p>
|
||||
<h2 id="see-also">SEE ALSO</h2>
|
||||
<ul>
|
||||
<li><a href="../misc/npm-registry.html">npm-registry(7)</a></li>
|
||||
<li><a href="../cli/npm-adduser.html">npm-adduser(1)</a></li>
|
||||
<li><a href="../cli/npm-owner.html">npm-owner(1)</a></li>
|
||||
<li><a href="../cli/npm-deprecate.html">npm-deprecate(1)</a></li>
|
||||
<li><a href="../cli/npm-tag.html">npm-tag(1)</a></li>
|
||||
</ul>
|
||||
|
||||
<h2 id="SEE-ALSO">SEE ALSO</h2>
|
||||
|
||||
<ul><li><a href="../misc/npm-registry.html">npm-registry(7)</a></li><li><a href="../cli/npm-adduser.html">npm-adduser(1)</a></li><li><a href="../cli/npm-owner.html">npm-owner(1)</a></li><li><a href="../cli/npm-deprecate.html">npm-deprecate(1)</a></li><li><a href="../cli/npm-tag.html">npm-tag(1)</a></li></ul>
|
||||
</div>
|
||||
|
||||
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
|
||||
@ -49,5 +54,5 @@ it is removed with <a href="../cli/npm-unpublish.html">npm-unpublish(1)</a>.</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-publish — npm@1.4.9</p>
|
||||
<p id="footer">npm-publish — npm@1.4.10</p>
|
||||
|
||||
|
||||
27
deps/npm/html/doc/cli/npm-rebuild.html
vendored
27
deps/npm/html/doc/cli/npm-rebuild.html
vendored
@ -10,24 +10,23 @@
|
||||
<div id="wrapper">
|
||||
|
||||
<h1><a href="../cli/npm-rebuild.html">npm-rebuild</a></h1> <p>Rebuild a package</p>
|
||||
|
||||
<h2 id="SYNOPSIS">SYNOPSIS</h2>
|
||||
|
||||
<h2 id="synopsis">SYNOPSIS</h2>
|
||||
<pre><code>npm rebuild [<name> [<name> ...]]
|
||||
npm rb [<name> [<name> ...]]</code></pre>
|
||||
|
||||
<ul><li><code><name></code>:
|
||||
The package to rebuild</li></ul>
|
||||
|
||||
<h2 id="DESCRIPTION">DESCRIPTION</h2>
|
||||
|
||||
npm rb [<name> [<name> ...]]
|
||||
</code></pre><ul>
|
||||
<li><code><name></code>:
|
||||
The package to rebuild</li>
|
||||
</ul>
|
||||
<h2 id="description">DESCRIPTION</h2>
|
||||
<p>This command runs the <code>npm build</code> command on the matched folders. This is useful
|
||||
when you install a new version of node, and must recompile all your C++ addons with
|
||||
the new binary.</p>
|
||||
<h2 id="see-also">SEE ALSO</h2>
|
||||
<ul>
|
||||
<li><a href="../cli/npm-build.html">npm-build(1)</a></li>
|
||||
<li><a href="../cli/npm-install.html">npm-install(1)</a></li>
|
||||
</ul>
|
||||
|
||||
<h2 id="SEE-ALSO">SEE ALSO</h2>
|
||||
|
||||
<ul><li><a href="../cli/npm-build.html">npm-build(1)</a></li><li><a href="../cli/npm-install.html">npm-install(1)</a></li></ul>
|
||||
</div>
|
||||
|
||||
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
|
||||
@ -39,5 +38,5 @@ the new binary.</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-rebuild — npm@1.4.9</p>
|
||||
<p id="footer">npm-rebuild — npm@1.4.10</p>
|
||||
|
||||
|
||||
31
deps/npm/html/doc/cli/npm-repo.html
vendored
31
deps/npm/html/doc/cli/npm-repo.html
vendored
@ -10,30 +10,27 @@
|
||||
<div id="wrapper">
|
||||
|
||||
<h1><a href="../cli/npm-repo.html">npm-repo</a></h1> <p>Open package repository page in the browser</p>
|
||||
|
||||
<h2 id="SYNOPSIS">SYNOPSIS</h2>
|
||||
|
||||
<h2 id="synopsis">SYNOPSIS</h2>
|
||||
<pre><code>npm repo <pkgname>
|
||||
npm repo (with no args in a package dir)</code></pre>
|
||||
|
||||
<h2 id="DESCRIPTION">DESCRIPTION</h2>
|
||||
|
||||
npm repo (with no args in a package dir)
|
||||
</code></pre><h2 id="description">DESCRIPTION</h2>
|
||||
<p>This command tries to guess at the likely location of a package's
|
||||
repository URL, and then tries to open it using the <code>--browser</code>
|
||||
config param. If no package name is provided, it will search for
|
||||
a <code>package.json</code> in the current folder and use the <code>name</code> property.</p>
|
||||
|
||||
<h2 id="CONFIGURATION">CONFIGURATION</h2>
|
||||
|
||||
<h2 id="configuration">CONFIGURATION</h2>
|
||||
<h3 id="browser">browser</h3>
|
||||
|
||||
<ul><li>Default: OS X: <code>"open"</code>, Windows: <code>"start"</code>, Others: <code>"xdg-open"</code></li><li>Type: String</li></ul>
|
||||
|
||||
<ul>
|
||||
<li>Default: OS X: <code>"open"</code>, Windows: <code>"start"</code>, Others: <code>"xdg-open"</code></li>
|
||||
<li>Type: String</li>
|
||||
</ul>
|
||||
<p>The browser that is called by the <code>npm repo</code> command to open websites.</p>
|
||||
<h2 id="see-also">SEE ALSO</h2>
|
||||
<ul>
|
||||
<li><a href="../cli/npm-docs.html">npm-docs(1)</a></li>
|
||||
<li><a href="../cli/npm-config.html">npm-config(1)</a></li>
|
||||
</ul>
|
||||
|
||||
<h2 id="SEE-ALSO">SEE ALSO</h2>
|
||||
|
||||
<ul><li><a href="../cli/npm-docs.html">npm-docs(1)</a></li><li><a href="../cli/npm-config.html">npm-config(1)</a></li></ul>
|
||||
</div>
|
||||
|
||||
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
|
||||
@ -45,5 +42,5 @@ a <code>package.json</code> in the current folder and use the <code>name</code>
|
||||
<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-repo — npm@1.4.9</p>
|
||||
<p id="footer">npm-repo — npm@1.4.10</p>
|
||||
|
||||
|
||||
24
deps/npm/html/doc/cli/npm-restart.html
vendored
24
deps/npm/html/doc/cli/npm-restart.html
vendored
@ -10,22 +10,22 @@
|
||||
<div id="wrapper">
|
||||
|
||||
<h1><a href="../cli/npm-restart.html">npm-restart</a></h1> <p>Start a package</p>
|
||||
|
||||
<h2 id="SYNOPSIS">SYNOPSIS</h2>
|
||||
|
||||
<pre><code>npm restart <name></code></pre>
|
||||
|
||||
<h2 id="DESCRIPTION">DESCRIPTION</h2>
|
||||
|
||||
<h2 id="synopsis">SYNOPSIS</h2>
|
||||
<pre><code>npm restart <name>
|
||||
</code></pre><h2 id="description">DESCRIPTION</h2>
|
||||
<p>This runs a package's "restart" script, if one was provided.
|
||||
Otherwise it runs package's "stop" script, if one was provided, and then
|
||||
the "start" script.</p>
|
||||
|
||||
<p>If no version is specified, then it restarts the "active" version.</p>
|
||||
<h2 id="see-also">SEE ALSO</h2>
|
||||
<ul>
|
||||
<li><a href="../cli/npm-run-script.html">npm-run-script(1)</a></li>
|
||||
<li><a href="../misc/npm-scripts.html">npm-scripts(7)</a></li>
|
||||
<li><a href="../cli/npm-test.html">npm-test(1)</a></li>
|
||||
<li><a href="../cli/npm-start.html">npm-start(1)</a></li>
|
||||
<li><a href="../cli/npm-stop.html">npm-stop(1)</a></li>
|
||||
</ul>
|
||||
|
||||
<h2 id="SEE-ALSO">SEE ALSO</h2>
|
||||
|
||||
<ul><li><a href="../cli/npm-run-script.html">npm-run-script(1)</a></li><li><a href="../misc/npm-scripts.html">npm-scripts(7)</a></li><li><a href="../cli/npm-test.html">npm-test(1)</a></li><li><a href="../cli/npm-start.html">npm-start(1)</a></li><li><a href="../cli/npm-stop.html">npm-stop(1)</a></li></ul>
|
||||
</div>
|
||||
|
||||
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
|
||||
@ -37,5 +37,5 @@ the "start" script.</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-restart — npm@1.4.9</p>
|
||||
<p id="footer">npm-restart — npm@1.4.10</p>
|
||||
|
||||
|
||||
24
deps/npm/html/doc/cli/npm-rm.html
vendored
24
deps/npm/html/doc/cli/npm-rm.html
vendored
@ -10,22 +10,24 @@
|
||||
<div id="wrapper">
|
||||
|
||||
<h1><a href="../cli/npm-rm.html">npm-rm</a></h1> <p>Remove a package</p>
|
||||
|
||||
<h2 id="SYNOPSIS">SYNOPSIS</h2>
|
||||
|
||||
<h2 id="synopsis">SYNOPSIS</h2>
|
||||
<pre><code>npm rm <name>
|
||||
npm r <name>
|
||||
npm uninstall <name>
|
||||
npm un <name></code></pre>
|
||||
|
||||
<h2 id="DESCRIPTION">DESCRIPTION</h2>
|
||||
|
||||
npm un <name>
|
||||
</code></pre><h2 id="description">DESCRIPTION</h2>
|
||||
<p>This uninstalls a package, completely removing everything npm installed
|
||||
on its behalf.</p>
|
||||
<h2 id="see-also">SEE ALSO</h2>
|
||||
<ul>
|
||||
<li><a href="../cli/npm-prune.html">npm-prune(1)</a></li>
|
||||
<li><a href="../cli/npm-install.html">npm-install(1)</a></li>
|
||||
<li><a href="../files/npm-folders.html">npm-folders(5)</a></li>
|
||||
<li><a href="../cli/npm-config.html">npm-config(1)</a></li>
|
||||
<li><a href="../misc/npm-config.html">npm-config(7)</a></li>
|
||||
<li><a href="../files/npmrc.html">npmrc(5)</a></li>
|
||||
</ul>
|
||||
|
||||
<h2 id="SEE-ALSO">SEE ALSO</h2>
|
||||
|
||||
<ul><li><a href="../cli/npm-prune.html">npm-prune(1)</a></li><li><a href="../cli/npm-install.html">npm-install(1)</a></li><li><a href="../files/npm-folders.html">npm-folders(5)</a></li><li><a href="../cli/npm-config.html">npm-config(1)</a></li><li><a href="../misc/npm-config.html">npm-config(7)</a></li><li><a href="../files/npmrc.html">npmrc(5)</a></li></ul>
|
||||
</div>
|
||||
|
||||
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
|
||||
@ -37,5 +39,5 @@ on its behalf.</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-rm — npm@1.4.9</p>
|
||||
<p id="footer">npm-rm — npm@1.4.10</p>
|
||||
|
||||
|
||||
24
deps/npm/html/doc/cli/npm-root.html
vendored
24
deps/npm/html/doc/cli/npm-root.html
vendored
@ -10,18 +10,20 @@
|
||||
<div id="wrapper">
|
||||
|
||||
<h1><a href="../cli/npm-root.html">npm-root</a></h1> <p>Display npm root</p>
|
||||
|
||||
<h2 id="SYNOPSIS">SYNOPSIS</h2>
|
||||
|
||||
<pre><code>npm root</code></pre>
|
||||
|
||||
<h2 id="DESCRIPTION">DESCRIPTION</h2>
|
||||
|
||||
<h2 id="synopsis">SYNOPSIS</h2>
|
||||
<pre><code>npm root
|
||||
</code></pre><h2 id="description">DESCRIPTION</h2>
|
||||
<p>Print the effective <code>node_modules</code> folder to standard out.</p>
|
||||
<h2 id="see-also">SEE ALSO</h2>
|
||||
<ul>
|
||||
<li><a href="../cli/npm-prefix.html">npm-prefix(1)</a></li>
|
||||
<li><a href="../cli/npm-bin.html">npm-bin(1)</a></li>
|
||||
<li><a href="../files/npm-folders.html">npm-folders(5)</a></li>
|
||||
<li><a href="../cli/npm-config.html">npm-config(1)</a></li>
|
||||
<li><a href="../misc/npm-config.html">npm-config(7)</a></li>
|
||||
<li><a href="../files/npmrc.html">npmrc(5)</a></li>
|
||||
</ul>
|
||||
|
||||
<h2 id="SEE-ALSO">SEE ALSO</h2>
|
||||
|
||||
<ul><li><a href="../cli/npm-prefix.html">npm-prefix(1)</a></li><li><a href="../cli/npm-bin.html">npm-bin(1)</a></li><li><a href="../files/npm-folders.html">npm-folders(5)</a></li><li><a href="../cli/npm-config.html">npm-config(1)</a></li><li><a href="../misc/npm-config.html">npm-config(7)</a></li><li><a href="../files/npmrc.html">npmrc(5)</a></li></ul>
|
||||
</div>
|
||||
|
||||
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
|
||||
@ -33,5 +35,5 @@
|
||||
<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-root — npm@1.4.9</p>
|
||||
<p id="footer">npm-root — npm@1.4.10</p>
|
||||
|
||||
|
||||
27
deps/npm/html/doc/cli/npm-run-script.html
vendored
27
deps/npm/html/doc/cli/npm-run-script.html
vendored
@ -10,23 +10,24 @@
|
||||
<div id="wrapper">
|
||||
|
||||
<h1><a href="../cli/npm-run-script.html">npm-run-script</a></h1> <p>Run arbitrary package scripts</p>
|
||||
|
||||
<h2 id="SYNOPSIS">SYNOPSIS</h2>
|
||||
|
||||
<pre><code>npm run-script [<pkg>] <command></code></pre>
|
||||
|
||||
<h2 id="DESCRIPTION">DESCRIPTION</h2>
|
||||
|
||||
<h2 id="synopsis">SYNOPSIS</h2>
|
||||
<pre><code>npm run-script [<pkg>] [command]
|
||||
</code></pre><h2 id="description">DESCRIPTION</h2>
|
||||
<p>This runs an arbitrary command from a package's <code>"scripts"</code> object.
|
||||
If no package name is provided, it will search for a <code>package.json</code>
|
||||
in the current folder and use its <code>"scripts"</code> object.</p>
|
||||
|
||||
in the current folder and use its <code>"scripts"</code> object. If no <code>"command"</code>
|
||||
is provided, it will list the available top level scripts.</p>
|
||||
<p>It is used by the test, start, restart, and stop commands, but can be
|
||||
called directly, as well.</p>
|
||||
<h2 id="see-also">SEE ALSO</h2>
|
||||
<ul>
|
||||
<li><a href="../misc/npm-scripts.html">npm-scripts(7)</a></li>
|
||||
<li><a href="../cli/npm-test.html">npm-test(1)</a></li>
|
||||
<li><a href="../cli/npm-start.html">npm-start(1)</a></li>
|
||||
<li><a href="../cli/npm-restart.html">npm-restart(1)</a></li>
|
||||
<li><a href="../cli/npm-stop.html">npm-stop(1)</a></li>
|
||||
</ul>
|
||||
|
||||
<h2 id="SEE-ALSO">SEE ALSO</h2>
|
||||
|
||||
<ul><li><a href="../misc/npm-scripts.html">npm-scripts(7)</a></li><li><a href="../cli/npm-test.html">npm-test(1)</a></li><li><a href="../cli/npm-start.html">npm-start(1)</a></li><li><a href="../cli/npm-restart.html">npm-restart(1)</a></li><li><a href="../cli/npm-stop.html">npm-stop(1)</a></li></ul>
|
||||
</div>
|
||||
|
||||
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
|
||||
@ -38,5 +39,5 @@ called directly, as well.</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-run-script — npm@1.4.9</p>
|
||||
<p id="footer">npm-run-script — npm@1.4.10</p>
|
||||
|
||||
|
||||
35
deps/npm/html/doc/cli/npm-search.html
vendored
35
deps/npm/html/doc/cli/npm-search.html
vendored
@ -10,35 +10,34 @@
|
||||
<div id="wrapper">
|
||||
|
||||
<h1><a href="../cli/npm-search.html">npm-search</a></h1> <p>Search for packages</p>
|
||||
|
||||
<h2 id="SYNOPSIS">SYNOPSIS</h2>
|
||||
|
||||
<h2 id="synopsis">SYNOPSIS</h2>
|
||||
<pre><code>npm search [--long] [search terms ...]
|
||||
npm s [search terms ...]
|
||||
npm se [search terms ...]</code></pre>
|
||||
|
||||
<h2 id="DESCRIPTION">DESCRIPTION</h2>
|
||||
|
||||
npm se [search terms ...]
|
||||
</code></pre><h2 id="description">DESCRIPTION</h2>
|
||||
<p>Search the registry for packages matching the search terms.</p>
|
||||
|
||||
<p>If a term starts with <code>/</code>, then it's interpreted as a regular expression.
|
||||
A trailing <code>/</code> will be ignored in this case. (Note that many regular
|
||||
expression characters must be escaped or quoted in most shells.)</p>
|
||||
|
||||
<h2 id="CONFIGURATION">CONFIGURATION</h2>
|
||||
|
||||
<h2 id="configuration">CONFIGURATION</h2>
|
||||
<h3 id="long">long</h3>
|
||||
|
||||
<ul><li>Default: false</li><li>Type: Boolean</li></ul>
|
||||
|
||||
<ul>
|
||||
<li>Default: false</li>
|
||||
<li>Type: Boolean</li>
|
||||
</ul>
|
||||
<p>Display full package descriptions and other long text across multiple
|
||||
lines. When disabled (default) search results are truncated to fit
|
||||
neatly on a single line. Modules with extremely long names will
|
||||
fall on multiple lines.</p>
|
||||
<h2 id="see-also">SEE ALSO</h2>
|
||||
<ul>
|
||||
<li><a href="../misc/npm-registry.html">npm-registry(7)</a></li>
|
||||
<li><a href="../cli/npm-config.html">npm-config(1)</a></li>
|
||||
<li><a href="../misc/npm-config.html">npm-config(7)</a></li>
|
||||
<li><a href="../files/npmrc.html">npmrc(5)</a></li>
|
||||
<li><a href="../cli/npm-view.html">npm-view(1)</a></li>
|
||||
</ul>
|
||||
|
||||
<h2 id="SEE-ALSO">SEE ALSO</h2>
|
||||
|
||||
<ul><li><a href="../misc/npm-registry.html">npm-registry(7)</a></li><li><a href="../cli/npm-config.html">npm-config(1)</a></li><li><a href="../misc/npm-config.html">npm-config(7)</a></li><li><a href="../files/npmrc.html">npmrc(5)</a></li><li><a href="../cli/npm-view.html">npm-view(1)</a></li></ul>
|
||||
</div>
|
||||
|
||||
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
|
||||
@ -50,5 +49,5 @@ fall on multiple lines.</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-search — npm@1.4.9</p>
|
||||
<p id="footer">npm-search — npm@1.4.10</p>
|
||||
|
||||
|
||||
114
deps/npm/html/doc/cli/npm-shrinkwrap.html
vendored
114
deps/npm/html/doc/cli/npm-shrinkwrap.html
vendored
@ -10,18 +10,13 @@
|
||||
<div id="wrapper">
|
||||
|
||||
<h1><a href="../cli/npm-shrinkwrap.html">npm-shrinkwrap</a></h1> <p>Lock down dependency versions</p>
|
||||
|
||||
<h2 id="SYNOPSIS">SYNOPSIS</h2>
|
||||
|
||||
<pre><code>npm shrinkwrap</code></pre>
|
||||
|
||||
<h2 id="DESCRIPTION">DESCRIPTION</h2>
|
||||
|
||||
<h2 id="synopsis">SYNOPSIS</h2>
|
||||
<pre><code>npm shrinkwrap
|
||||
</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
|
||||
dependencies (as specified in package.json), choosing the latest
|
||||
available version that satisfies the dependency's semver pattern. In
|
||||
@ -34,62 +29,47 @@ dependency's package.json 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.</p>
|
||||
|
||||
<p>As an example, consider package A:</p>
|
||||
|
||||
<pre><code>{
|
||||
"name": "A",
|
||||
"version": "0.1.0",
|
||||
"dependencies": {
|
||||
"B": "<0.1.0"
|
||||
}
|
||||
}</code></pre>
|
||||
|
||||
<p>package B:</p>
|
||||
|
||||
}
|
||||
</code></pre><p>package B:</p>
|
||||
<pre><code>{
|
||||
"name": "B",
|
||||
"version": "0.0.1",
|
||||
"dependencies": {
|
||||
"C": "<0.1.0"
|
||||
}
|
||||
}</code></pre>
|
||||
|
||||
<p>and package C:</p>
|
||||
|
||||
}
|
||||
</code></pre><p>and package C:</p>
|
||||
<pre><code>{
|
||||
"name": "C,
|
||||
"version": "0.0.1"
|
||||
}</code></pre>
|
||||
|
||||
<p>If these are the only versions of A, B, and C available in the
|
||||
}
|
||||
</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>
|
||||
|
||||
<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
|
||||
`-- C@0.0.1
|
||||
</code></pre><p>However, if B@0.0.2 is published, then a fresh "npm install A" will
|
||||
install:</p>
|
||||
|
||||
<pre><code>A@0.1.0
|
||||
`-- B@0.0.2
|
||||
`-- C@0.0.1</code></pre>
|
||||
|
||||
<p>assuming the new version did not modify B's dependencies. Of course,
|
||||
`-- C@0.0.1
|
||||
</code></pre><p>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
|
||||
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.</p>
|
||||
|
||||
<p>In this case, A's author can run</p>
|
||||
|
||||
<pre><code>npm shrinkwrap</code></pre>
|
||||
|
||||
<p>This generates npm-shrinkwrap.json, which will look something like this:</p>
|
||||
|
||||
<pre><code>npm shrinkwrap
|
||||
</code></pre><p>This generates npm-shrinkwrap.json, which will look something like this:</p>
|
||||
<pre><code>{
|
||||
"name": "A",
|
||||
"version": "0.1.0",
|
||||
@ -103,9 +83,8 @@ when B hasn't changed at all.</p>
|
||||
}
|
||||
}
|
||||
}
|
||||
}</code></pre>
|
||||
|
||||
<p>The shrinkwrap command has locked down the dependencies based on
|
||||
}
|
||||
</code></pre><p>The shrinkwrap command has locked down the dependencies based on
|
||||
what's currently installed in node_modules. When "npm install"
|
||||
installs a package with a npm-shrinkwrap.json file in the package
|
||||
root, the shrinkwrap file (rather than package.json files) completely
|
||||
@ -114,59 +93,54 @@ drives the installation of that package and all of its dependencies
|
||||
installs of this package will use B@0.0.1 and C@0.1.0, regardless the
|
||||
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>
|
||||
|
||||
<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>
|
||||
|
||||
<h3 id="Building-shrinkwrapped-packages">Building shrinkwrapped packages</h3>
|
||||
|
||||
<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
|
||||
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
|
||||
your package.</li></ol>
|
||||
|
||||
<ol>
|
||||
<li>Run "npm install" 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
|
||||
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
|
||||
versions of all dependencies.</li><li>Add or update dependencies. "npm install" each new or updated
|
||||
<ol>
|
||||
<li>Run "npm install" in the package root to install the current
|
||||
versions of all dependencies.</li>
|
||||
<li>Add or update dependencies. "npm install" 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
|
||||
publish your package.</li></ol>
|
||||
|
||||
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
|
||||
publish your package.</li>
|
||||
</ol>
|
||||
<p>You can use <a href="../cli/npm-outdated.html">npm-outdated(1)</a> to view dependencies with newer versions
|
||||
available.</p>
|
||||
|
||||
<h3 id="Other-Notes">Other Notes</h3>
|
||||
|
||||
<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
|
||||
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
|
||||
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
|
||||
warning. If you want them to be installed with your module by
|
||||
default, please consider adding them to <code>dependencies</code> instead.</p>
|
||||
|
||||
<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,
|
||||
because A's shrinkwrap is constructed from a valid installation of B
|
||||
and recursively specifies all dependencies, the contents of B's
|
||||
shrinkwrap will implicitly be included in A's shrinkwrap.</p>
|
||||
|
||||
<h3 id="Caveats">Caveats</h3>
|
||||
|
||||
<h3 id="caveats">Caveats</h3>
|
||||
<p>Shrinkwrap files only lock down package versions, not actual package
|
||||
contents. While discouraged, a package author can republish an
|
||||
existing version of a package, causing shrinkwrapped packages using
|
||||
@ -175,16 +149,18 @@ want to avoid any risk that a byzantine author replaces a package
|
||||
you're using with code that breaks your application, you could modify
|
||||
the shrinkwrap file to use git URL references rather than version
|
||||
numbers so that npm always fetches all packages from git.</p>
|
||||
|
||||
<p>If you wish to lock down the specific bytes included in a package, for
|
||||
example to have 100% confidence in being able to reproduce a
|
||||
deployment or build, then you ought to check your dependencies into
|
||||
source control, or pursue some other mechanism that can verify
|
||||
contents rather than versions.</p>
|
||||
<h2 id="see-also">SEE ALSO</h2>
|
||||
<ul>
|
||||
<li><a href="../cli/npm-install.html">npm-install(1)</a></li>
|
||||
<li><a href="../files/package.json.html">package.json(5)</a></li>
|
||||
<li><a href="../cli/npm-ls.html">npm-ls(1)</a></li>
|
||||
</ul>
|
||||
|
||||
<h2 id="SEE-ALSO">SEE ALSO</h2>
|
||||
|
||||
<ul><li><a href="../cli/npm-install.html">npm-install(1)</a></li><li><a href="../files/package.json.html">package.json(5)</a></li><li><a href="../cli/npm-ls.html">npm-ls(1)</a></li></ul>
|
||||
</div>
|
||||
|
||||
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
|
||||
@ -196,5 +172,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@1.4.9</p>
|
||||
<p id="footer">npm-shrinkwrap — npm@1.4.10</p>
|
||||
|
||||
|
||||
23
deps/npm/html/doc/cli/npm-star.html
vendored
23
deps/npm/html/doc/cli/npm-star.html
vendored
@ -10,24 +10,21 @@
|
||||
<div id="wrapper">
|
||||
|
||||
<h1><a href="../cli/npm-star.html">npm-star</a></h1> <p>Mark your favorite packages</p>
|
||||
|
||||
<h2 id="SYNOPSIS">SYNOPSIS</h2>
|
||||
|
||||
<h2 id="synopsis">SYNOPSIS</h2>
|
||||
<pre><code>npm star <pkgname> [<pkg>, ...]
|
||||
npm unstar <pkgname> [<pkg>, ...]</code></pre>
|
||||
|
||||
<h2 id="DESCRIPTION">DESCRIPTION</h2>
|
||||
|
||||
npm unstar <pkgname> [<pkg>, ...]
|
||||
</code></pre><h2 id="description">DESCRIPTION</h2>
|
||||
<p>"Starring" a package means that you have some interest in it. It's
|
||||
a vaguely positive way to show that you care.</p>
|
||||
|
||||
<p>"Unstarring" is the same thing, but in reverse.</p>
|
||||
|
||||
<p>It's a boolean thing. Starring repeatedly has no additional effect.</p>
|
||||
<h2 id="see-also">SEE ALSO</h2>
|
||||
<ul>
|
||||
<li><a href="../cli/npm-view.html">npm-view(1)</a></li>
|
||||
<li><a href="../cli/npm-whoami.html">npm-whoami(1)</a></li>
|
||||
<li><a href="../cli/npm-adduser.html">npm-adduser(1)</a></li>
|
||||
</ul>
|
||||
|
||||
<h2 id="SEE-ALSO">SEE ALSO</h2>
|
||||
|
||||
<ul><li><a href="../cli/npm-view.html">npm-view(1)</a></li><li><a href="../cli/npm-whoami.html">npm-whoami(1)</a></li><li><a href="../cli/npm-adduser.html">npm-adduser(1)</a></li></ul>
|
||||
</div>
|
||||
|
||||
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
|
||||
@ -39,5 +36,5 @@ a vaguely positive way to show that you care.</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-star — npm@1.4.9</p>
|
||||
<p id="footer">npm-star — npm@1.4.10</p>
|
||||
|
||||
|
||||
23
deps/npm/html/doc/cli/npm-stars.html
vendored
23
deps/npm/html/doc/cli/npm-stars.html
vendored
@ -10,23 +10,22 @@
|
||||
<div id="wrapper">
|
||||
|
||||
<h1><a href="../cli/npm-stars.html">npm-stars</a></h1> <p>View packages marked as favorites</p>
|
||||
|
||||
<h2 id="SYNOPSIS">SYNOPSIS</h2>
|
||||
|
||||
<h2 id="synopsis">SYNOPSIS</h2>
|
||||
<pre><code>npm stars
|
||||
npm stars [username]</code></pre>
|
||||
|
||||
<h2 id="DESCRIPTION">DESCRIPTION</h2>
|
||||
|
||||
npm stars [username]
|
||||
</code></pre><h2 id="description">DESCRIPTION</h2>
|
||||
<p>If you have starred a lot of neat things and want to find them again
|
||||
quickly this command lets you do just that.</p>
|
||||
|
||||
<p>You may also want to see your friend's favorite packages, in this case
|
||||
you will most certainly enjoy this command.</p>
|
||||
<h2 id="see-also">SEE ALSO</h2>
|
||||
<ul>
|
||||
<li><a href="../cli/npm-star.html">npm-star(1)</a></li>
|
||||
<li><a href="../cli/npm-view.html">npm-view(1)</a></li>
|
||||
<li><a href="../cli/npm-whoami.html">npm-whoami(1)</a></li>
|
||||
<li><a href="../cli/npm-adduser.html">npm-adduser(1)</a></li>
|
||||
</ul>
|
||||
|
||||
<h2 id="SEE-ALSO">SEE ALSO</h2>
|
||||
|
||||
<ul><li><a href="../cli/npm-star.html">npm-star(1)</a></li><li><a href="../cli/npm-view.html">npm-view(1)</a></li><li><a href="../cli/npm-whoami.html">npm-whoami(1)</a></li><li><a href="../cli/npm-adduser.html">npm-adduser(1)</a></li></ul>
|
||||
</div>
|
||||
|
||||
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
|
||||
@ -38,5 +37,5 @@ you will most certainly enjoy this command.</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-stars — npm@1.4.9</p>
|
||||
<p id="footer">npm-stars — npm@1.4.10</p>
|
||||
|
||||
|
||||
23
deps/npm/html/doc/cli/npm-start.html
vendored
23
deps/npm/html/doc/cli/npm-start.html
vendored
@ -10,18 +10,19 @@
|
||||
<div id="wrapper">
|
||||
|
||||
<h1><a href="../cli/npm-start.html">npm-start</a></h1> <p>Start a package</p>
|
||||
|
||||
<h2 id="SYNOPSIS">SYNOPSIS</h2>
|
||||
|
||||
<pre><code>npm start <name></code></pre>
|
||||
|
||||
<h2 id="DESCRIPTION">DESCRIPTION</h2>
|
||||
|
||||
<h2 id="synopsis">SYNOPSIS</h2>
|
||||
<pre><code>npm start <name>
|
||||
</code></pre><h2 id="description">DESCRIPTION</h2>
|
||||
<p>This runs a package's "start" script, if one was provided.</p>
|
||||
<h2 id="see-also">SEE ALSO</h2>
|
||||
<ul>
|
||||
<li><a href="../cli/npm-run-script.html">npm-run-script(1)</a></li>
|
||||
<li><a href="../misc/npm-scripts.html">npm-scripts(7)</a></li>
|
||||
<li><a href="../cli/npm-test.html">npm-test(1)</a></li>
|
||||
<li><a href="../cli/npm-restart.html">npm-restart(1)</a></li>
|
||||
<li><a href="../cli/npm-stop.html">npm-stop(1)</a></li>
|
||||
</ul>
|
||||
|
||||
<h2 id="SEE-ALSO">SEE ALSO</h2>
|
||||
|
||||
<ul><li><a href="../cli/npm-run-script.html">npm-run-script(1)</a></li><li><a href="../misc/npm-scripts.html">npm-scripts(7)</a></li><li><a href="../cli/npm-test.html">npm-test(1)</a></li><li><a href="../cli/npm-restart.html">npm-restart(1)</a></li><li><a href="../cli/npm-stop.html">npm-stop(1)</a></li></ul>
|
||||
</div>
|
||||
|
||||
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
|
||||
@ -33,5 +34,5 @@
|
||||
<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-start — npm@1.4.9</p>
|
||||
<p id="footer">npm-start — npm@1.4.10</p>
|
||||
|
||||
|
||||
23
deps/npm/html/doc/cli/npm-stop.html
vendored
23
deps/npm/html/doc/cli/npm-stop.html
vendored
@ -10,18 +10,19 @@
|
||||
<div id="wrapper">
|
||||
|
||||
<h1><a href="../cli/npm-stop.html">npm-stop</a></h1> <p>Stop a package</p>
|
||||
|
||||
<h2 id="SYNOPSIS">SYNOPSIS</h2>
|
||||
|
||||
<pre><code>npm stop <name></code></pre>
|
||||
|
||||
<h2 id="DESCRIPTION">DESCRIPTION</h2>
|
||||
|
||||
<h2 id="synopsis">SYNOPSIS</h2>
|
||||
<pre><code>npm stop <name>
|
||||
</code></pre><h2 id="description">DESCRIPTION</h2>
|
||||
<p>This runs a package's "stop" script, if one was provided.</p>
|
||||
<h2 id="see-also">SEE ALSO</h2>
|
||||
<ul>
|
||||
<li><a href="../cli/npm-run-script.html">npm-run-script(1)</a></li>
|
||||
<li><a href="../misc/npm-scripts.html">npm-scripts(7)</a></li>
|
||||
<li><a href="../cli/npm-test.html">npm-test(1)</a></li>
|
||||
<li><a href="../cli/npm-start.html">npm-start(1)</a></li>
|
||||
<li><a href="../cli/npm-restart.html">npm-restart(1)</a></li>
|
||||
</ul>
|
||||
|
||||
<h2 id="SEE-ALSO">SEE ALSO</h2>
|
||||
|
||||
<ul><li><a href="../cli/npm-run-script.html">npm-run-script(1)</a></li><li><a href="../misc/npm-scripts.html">npm-scripts(7)</a></li><li><a href="../cli/npm-test.html">npm-test(1)</a></li><li><a href="../cli/npm-start.html">npm-start(1)</a></li><li><a href="../cli/npm-restart.html">npm-restart(1)</a></li></ul>
|
||||
</div>
|
||||
|
||||
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
|
||||
@ -33,5 +34,5 @@
|
||||
<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-stop — npm@1.4.9</p>
|
||||
<p id="footer">npm-stop — npm@1.4.10</p>
|
||||
|
||||
|
||||
22
deps/npm/html/doc/cli/npm-submodule.html
vendored
22
deps/npm/html/doc/cli/npm-submodule.html
vendored
@ -10,31 +10,27 @@
|
||||
<div id="wrapper">
|
||||
|
||||
<h1><a href="../cli/npm-submodule.html">npm-submodule</a></h1> <p>Add a package as a git submodule</p>
|
||||
|
||||
<h2 id="SYNOPSIS">SYNOPSIS</h2>
|
||||
|
||||
<pre><code>npm submodule <pkg></code></pre>
|
||||
|
||||
<h2 id="DESCRIPTION">DESCRIPTION</h2>
|
||||
|
||||
<h2 id="synopsis">SYNOPSIS</h2>
|
||||
<pre><code>npm submodule <pkg>
|
||||
</code></pre><h2 id="description">DESCRIPTION</h2>
|
||||
<p>If the specified package has a git repository url in its package.json
|
||||
description, then this command will add it as a git submodule at
|
||||
<code>node_modules/<pkg name></code>.</p>
|
||||
|
||||
<p>This is a convenience only. From then on, it's up to you to manage
|
||||
updates by using the appropriate git commands. npm will stubbornly
|
||||
refuse to update, modify, or remove anything with a <code>.git</code> subfolder
|
||||
in it.</p>
|
||||
|
||||
<p>This command also does not install missing dependencies, if the package
|
||||
does not include them in its git repository. If <code>npm ls</code> reports that
|
||||
things are missing, you can either install, link, or submodule them yourself,
|
||||
or you can do <code>npm explore <pkgname> -- npm install</code> to install the
|
||||
dependencies into the submodule folder.</p>
|
||||
<h2 id="see-also">SEE ALSO</h2>
|
||||
<ul>
|
||||
<li><a href="../files/package.json.html">package.json(5)</a></li>
|
||||
<li>git help submodule</li>
|
||||
</ul>
|
||||
|
||||
<h2 id="SEE-ALSO">SEE ALSO</h2>
|
||||
|
||||
<ul><li><a href="../files/package.json.html">package.json(5)</a></li><li>git help submodule</li></ul>
|
||||
</div>
|
||||
|
||||
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
|
||||
@ -46,5 +42,5 @@ dependencies into the submodule folder.</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-submodule — npm@1.4.9</p>
|
||||
<p id="footer">npm-submodule — npm@1.4.10</p>
|
||||
|
||||
|
||||
39
deps/npm/html/doc/cli/npm-tag.html
vendored
39
deps/npm/html/doc/cli/npm-tag.html
vendored
@ -10,32 +10,29 @@
|
||||
<div id="wrapper">
|
||||
|
||||
<h1><a href="../cli/npm-tag.html">npm-tag</a></h1> <p>Tag a published version</p>
|
||||
|
||||
<h2 id="SYNOPSIS">SYNOPSIS</h2>
|
||||
|
||||
<pre><code>npm tag <name>@<version> [<tag>]</code></pre>
|
||||
|
||||
<h2 id="DESCRIPTION">DESCRIPTION</h2>
|
||||
|
||||
<h2 id="synopsis">SYNOPSIS</h2>
|
||||
<pre><code>npm tag <name>@<version> [<tag>]
|
||||
</code></pre><h2 id="description">DESCRIPTION</h2>
|
||||
<p>Tags the specified version of the package with the specified tag, or the
|
||||
<code>--tag</code> config if not specified.</p>
|
||||
|
||||
<p>A tag can be used when installing packages as a reference to a version instead
|
||||
of using a specific version number:</p>
|
||||
|
||||
<pre><code>npm install <name>@<tag></code></pre>
|
||||
|
||||
<p>When installing dependencies, a preferred tagged version may be specified:</p>
|
||||
|
||||
<pre><code>npm install --tag <tag></code></pre>
|
||||
|
||||
<p>This also applies to <code>npm dedupe</code>.</p>
|
||||
|
||||
<pre><code>npm install <name>@<tag>
|
||||
</code></pre><p>When installing dependencies, a preferred tagged version may be specified:</p>
|
||||
<pre><code>npm install --tag <tag>
|
||||
</code></pre><p>This also applies to <code>npm dedupe</code>.</p>
|
||||
<p>Publishing a package always sets the "latest" tag to the published version.</p>
|
||||
<h2 id="see-also">SEE ALSO</h2>
|
||||
<ul>
|
||||
<li><a href="../cli/npm-publish.html">npm-publish(1)</a></li>
|
||||
<li><a href="../cli/npm-install.html">npm-install(1)</a></li>
|
||||
<li><a href="../cli/npm-dedupe.html">npm-dedupe(1)</a></li>
|
||||
<li><a href="../misc/npm-registry.html">npm-registry(7)</a></li>
|
||||
<li><a href="../cli/npm-config.html">npm-config(1)</a></li>
|
||||
<li><a href="../misc/npm-config.html">npm-config(7)</a></li>
|
||||
<li><a href="../files/npmrc.html">npmrc(5)</a></li>
|
||||
</ul>
|
||||
|
||||
<h2 id="SEE-ALSO">SEE ALSO</h2>
|
||||
|
||||
<ul><li><a href="../cli/npm-publish.html">npm-publish(1)</a></li><li><a href="../cli/npm-install.html">npm-install(1)</a></li><li><a href="../cli/npm-dedupe.html">npm-dedupe(1)</a></li><li><a href="../misc/npm-registry.html">npm-registry(7)</a></li><li><a href="../cli/npm-config.html">npm-config(1)</a></li><li><a href="../misc/npm-config.html">npm-config(7)</a></li><li><a href="../files/npmrc.html">npmrc(5)</a></li></ul>
|
||||
</div>
|
||||
|
||||
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
|
||||
@ -47,5 +44,5 @@ of using a specific version number:</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-tag — npm@1.4.9</p>
|
||||
<p id="footer">npm-tag — npm@1.4.10</p>
|
||||
|
||||
|
||||
24
deps/npm/html/doc/cli/npm-test.html
vendored
24
deps/npm/html/doc/cli/npm-test.html
vendored
@ -10,22 +10,22 @@
|
||||
<div id="wrapper">
|
||||
|
||||
<h1><a href="../cli/npm-test.html">npm-test</a></h1> <p>Test a package</p>
|
||||
|
||||
<h2 id="SYNOPSIS">SYNOPSIS</h2>
|
||||
|
||||
<h2 id="synopsis">SYNOPSIS</h2>
|
||||
<pre><code> npm test <name>
|
||||
npm tst <name></code></pre>
|
||||
|
||||
<h2 id="DESCRIPTION">DESCRIPTION</h2>
|
||||
|
||||
npm tst <name>
|
||||
</code></pre><h2 id="description">DESCRIPTION</h2>
|
||||
<p>This runs a package's "test" script, if one was provided.</p>
|
||||
|
||||
<p>To run tests as a condition of installation, set the <code>npat</code> config to
|
||||
true.</p>
|
||||
<h2 id="see-also">SEE ALSO</h2>
|
||||
<ul>
|
||||
<li><a href="../cli/npm-run-script.html">npm-run-script(1)</a></li>
|
||||
<li><a href="../misc/npm-scripts.html">npm-scripts(7)</a></li>
|
||||
<li><a href="../cli/npm-start.html">npm-start(1)</a></li>
|
||||
<li><a href="../cli/npm-restart.html">npm-restart(1)</a></li>
|
||||
<li><a href="../cli/npm-stop.html">npm-stop(1)</a></li>
|
||||
</ul>
|
||||
|
||||
<h2 id="SEE-ALSO">SEE ALSO</h2>
|
||||
|
||||
<ul><li><a href="../cli/npm-run-script.html">npm-run-script(1)</a></li><li><a href="../misc/npm-scripts.html">npm-scripts(7)</a></li><li><a href="../cli/npm-start.html">npm-start(1)</a></li><li><a href="../cli/npm-restart.html">npm-restart(1)</a></li><li><a href="../cli/npm-stop.html">npm-stop(1)</a></li></ul>
|
||||
</div>
|
||||
|
||||
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
|
||||
@ -37,5 +37,5 @@ true.</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-test — npm@1.4.9</p>
|
||||
<p id="footer">npm-test — npm@1.4.10</p>
|
||||
|
||||
|
||||
46
deps/npm/html/doc/cli/npm-uninstall.html
vendored
46
deps/npm/html/doc/cli/npm-uninstall.html
vendored
@ -10,38 +10,40 @@
|
||||
<div id="wrapper">
|
||||
|
||||
<h1><a href="../cli/npm-rm.html">npm-rm</a></h1> <p>Remove a package</p>
|
||||
|
||||
<h2 id="SYNOPSIS">SYNOPSIS</h2>
|
||||
|
||||
<h2 id="synopsis">SYNOPSIS</h2>
|
||||
<pre><code>npm uninstall <name> [--save|--save-dev|--save-optional]
|
||||
npm rm (with any of the previous argument usage)</code></pre>
|
||||
|
||||
<h2 id="DESCRIPTION">DESCRIPTION</h2>
|
||||
|
||||
npm rm (with any of the previous argument usage)
|
||||
</code></pre><h2 id="description">DESCRIPTION</h2>
|
||||
<p>This uninstalls a package, completely removing everything npm installed
|
||||
on its behalf.</p>
|
||||
|
||||
<p>Example:</p>
|
||||
|
||||
<pre><code>npm uninstall sax</code></pre>
|
||||
|
||||
<p>In global mode (ie, with <code>-g</code> or <code>--global</code> appended to the command),
|
||||
<pre><code>npm uninstall sax
|
||||
</code></pre><p>In global mode (ie, with <code>-g</code> or <code>--global</code> appended to the command),
|
||||
it uninstalls the current package context as a global package.</p>
|
||||
|
||||
<p><code>npm uninstall</code> takes 3 exclusive, optional flags which save or update
|
||||
the package version in your main package.json:</p>
|
||||
|
||||
<ul><li><p><code>--save</code>: Package will be removed from your <code>dependencies</code>.</p></li><li><p><code>--save-dev</code>: Package will be removed from your <code>devDependencies</code>.</p></li><li><p><code>--save-optional</code>: Package will be removed from your <code>optionalDependencies</code>.</p></li></ul>
|
||||
|
||||
<ul>
|
||||
<li><p><code>--save</code>: Package will be removed from your <code>dependencies</code>.</p>
|
||||
</li>
|
||||
<li><p><code>--save-dev</code>: Package will be removed from your <code>devDependencies</code>.</p>
|
||||
</li>
|
||||
<li><p><code>--save-optional</code>: Package will be removed from your <code>optionalDependencies</code>.</p>
|
||||
</li>
|
||||
</ul>
|
||||
<p>Examples:</p>
|
||||
|
||||
<pre><code>npm uninstall sax --save
|
||||
npm uninstall node-tap --save-dev
|
||||
npm uninstall dtrace-provider --save-optional</code></pre>
|
||||
npm uninstall dtrace-provider --save-optional
|
||||
</code></pre><h2 id="see-also">SEE ALSO</h2>
|
||||
<ul>
|
||||
<li><a href="../cli/npm-prune.html">npm-prune(1)</a></li>
|
||||
<li><a href="../cli/npm-install.html">npm-install(1)</a></li>
|
||||
<li><a href="../files/npm-folders.html">npm-folders(5)</a></li>
|
||||
<li><a href="../cli/npm-config.html">npm-config(1)</a></li>
|
||||
<li><a href="../misc/npm-config.html">npm-config(7)</a></li>
|
||||
<li><a href="../files/npmrc.html">npmrc(5)</a></li>
|
||||
</ul>
|
||||
|
||||
<h2 id="SEE-ALSO">SEE ALSO</h2>
|
||||
|
||||
<ul><li><a href="../cli/npm-prune.html">npm-prune(1)</a></li><li><a href="../cli/npm-install.html">npm-install(1)</a></li><li><a href="../files/npm-folders.html">npm-folders(5)</a></li><li><a href="../cli/npm-config.html">npm-config(1)</a></li><li><a href="../misc/npm-config.html">npm-config(7)</a></li><li><a href="../files/npmrc.html">npmrc(5)</a></li></ul>
|
||||
</div>
|
||||
|
||||
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
|
||||
@ -53,5 +55,5 @@ npm uninstall dtrace-provider --save-optional</code></pre>
|
||||
<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-uninstall — npm@1.4.9</p>
|
||||
<p id="footer">npm-uninstall — npm@1.4.10</p>
|
||||
|
||||
|
||||
31
deps/npm/html/doc/cli/npm-unpublish.html
vendored
31
deps/npm/html/doc/cli/npm-unpublish.html
vendored
@ -10,36 +10,31 @@
|
||||
<div id="wrapper">
|
||||
|
||||
<h1><a href="../cli/npm-unpublish.html">npm-unpublish</a></h1> <p>Remove a package from the registry</p>
|
||||
|
||||
<h2 id="SYNOPSIS">SYNOPSIS</h2>
|
||||
|
||||
<pre><code>npm unpublish <name>[@<version>]</code></pre>
|
||||
|
||||
<h2 id="WARNING">WARNING</h2>
|
||||
|
||||
<h2 id="synopsis">SYNOPSIS</h2>
|
||||
<pre><code>npm unpublish <name>[@<version>]
|
||||
</code></pre><h2 id="warning">WARNING</h2>
|
||||
<p><strong>It is generally considered bad behavior to remove versions of a library
|
||||
that others are depending on!</strong></p>
|
||||
|
||||
<p>Consider using the <code>deprecate</code> command
|
||||
instead, if your intent is to encourage users to upgrade.</p>
|
||||
|
||||
<p>There is plenty of room on the registry.</p>
|
||||
|
||||
<h2 id="DESCRIPTION">DESCRIPTION</h2>
|
||||
|
||||
<h2 id="description">DESCRIPTION</h2>
|
||||
<p>This removes a package version from the registry, deleting its
|
||||
entry and removing the tarball.</p>
|
||||
|
||||
<p>If no version is specified, or if all versions are removed then
|
||||
the root package entry is removed from the registry entirely.</p>
|
||||
|
||||
<p>Even if a package version is unpublished, that specific name and
|
||||
version combination can never be reused. In order to publish the
|
||||
package again, a new version number must be used.</p>
|
||||
<h2 id="see-also">SEE ALSO</h2>
|
||||
<ul>
|
||||
<li><a href="../cli/npm-deprecate.html">npm-deprecate(1)</a></li>
|
||||
<li><a href="../cli/npm-publish.html">npm-publish(1)</a></li>
|
||||
<li><a href="../misc/npm-registry.html">npm-registry(7)</a></li>
|
||||
<li><a href="../cli/npm-adduser.html">npm-adduser(1)</a></li>
|
||||
<li><a href="../cli/npm-owner.html">npm-owner(1)</a></li>
|
||||
</ul>
|
||||
|
||||
<h2 id="SEE-ALSO">SEE ALSO</h2>
|
||||
|
||||
<ul><li><a href="../cli/npm-deprecate.html">npm-deprecate(1)</a></li><li><a href="../cli/npm-publish.html">npm-publish(1)</a></li><li><a href="../misc/npm-registry.html">npm-registry(7)</a></li><li><a href="../cli/npm-adduser.html">npm-adduser(1)</a></li><li><a href="../cli/npm-owner.html">npm-owner(1)</a></li></ul>
|
||||
</div>
|
||||
|
||||
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
|
||||
@ -51,5 +46,5 @@ package again, a new version number must be used.</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-unpublish — npm@1.4.9</p>
|
||||
<p id="footer">npm-unpublish — npm@1.4.10</p>
|
||||
|
||||
|
||||
25
deps/npm/html/doc/cli/npm-update.html
vendored
25
deps/npm/html/doc/cli/npm-update.html
vendored
@ -10,24 +10,23 @@
|
||||
<div id="wrapper">
|
||||
|
||||
<h1><a href="../cli/npm-update.html">npm-update</a></h1> <p>Update a package</p>
|
||||
|
||||
<h2 id="SYNOPSIS">SYNOPSIS</h2>
|
||||
|
||||
<pre><code>npm update [-g] [<name> [<name> ...]]</code></pre>
|
||||
|
||||
<h2 id="DESCRIPTION">DESCRIPTION</h2>
|
||||
|
||||
<h2 id="synopsis">SYNOPSIS</h2>
|
||||
<pre><code>npm update [-g] [<name> [<name> ...]]
|
||||
</code></pre><h2 id="description">DESCRIPTION</h2>
|
||||
<p>This command will update all the packages listed to the latest version
|
||||
(specified by the <code>tag</code> config).</p>
|
||||
|
||||
<p>It will also install missing packages.</p>
|
||||
|
||||
<p>If the <code>-g</code> flag is specified, this command will update globally installed packages.
|
||||
If no package name is specified, all packages in the specified location (global or local) will be updated.</p>
|
||||
<h2 id="see-also">SEE ALSO</h2>
|
||||
<ul>
|
||||
<li><a href="../cli/npm-install.html">npm-install(1)</a></li>
|
||||
<li><a href="../cli/npm-outdated.html">npm-outdated(1)</a></li>
|
||||
<li><a href="../misc/npm-registry.html">npm-registry(7)</a></li>
|
||||
<li><a href="../files/npm-folders.html">npm-folders(5)</a></li>
|
||||
<li><a href="../cli/npm-ls.html">npm-ls(1)</a></li>
|
||||
</ul>
|
||||
|
||||
<h2 id="SEE-ALSO">SEE ALSO</h2>
|
||||
|
||||
<ul><li><a href="../cli/npm-install.html">npm-install(1)</a></li><li><a href="../cli/npm-outdated.html">npm-outdated(1)</a></li><li><a href="../misc/npm-registry.html">npm-registry(7)</a></li><li><a href="../files/npm-folders.html">npm-folders(5)</a></li><li><a href="../cli/npm-ls.html">npm-ls(1)</a></li></ul>
|
||||
</div>
|
||||
|
||||
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
|
||||
@ -39,5 +38,5 @@ If no package name is specified, all packages in the specified location (global
|
||||
<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-update — npm@1.4.9</p>
|
||||
<p id="footer">npm-update — npm@1.4.10</p>
|
||||
|
||||
|
||||
33
deps/npm/html/doc/cli/npm-version.html
vendored
33
deps/npm/html/doc/cli/npm-version.html
vendored
@ -10,35 +10,25 @@
|
||||
<div id="wrapper">
|
||||
|
||||
<h1><a href="../cli/npm-version.html">npm-version</a></h1> <p>Bump a package version</p>
|
||||
|
||||
<h2 id="SYNOPSIS">SYNOPSIS</h2>
|
||||
|
||||
<pre><code>npm version [<newversion> | major | minor | patch]</code></pre>
|
||||
|
||||
<h2 id="DESCRIPTION">DESCRIPTION</h2>
|
||||
|
||||
<h2 id="synopsis">SYNOPSIS</h2>
|
||||
<pre><code>npm version [<newversion> | major | minor | patch]
|
||||
</code></pre><h2 id="description">DESCRIPTION</h2>
|
||||
<p>Run this in a package directory to bump the version and write the new
|
||||
data back to the package.json file.</p>
|
||||
|
||||
<p>The <code>newversion</code> argument should be a valid semver string, <em>or</em> a valid
|
||||
second argument to semver.inc (one of "patch", "minor", or
|
||||
"major"). In the second case, the existing version will be incremented
|
||||
by 1 in the specified field.</p>
|
||||
|
||||
<p>If run in a git repo, it will also create a version commit and tag, and
|
||||
fail if the repo is not clean.</p>
|
||||
|
||||
<p>If supplied with <code>--message</code> (shorthand: <code>-m</code>) config option, npm will
|
||||
use it as a commit message when creating a version commit. If the
|
||||
<code>message</code> config contains <code>%s</code> then that will be replaced with the
|
||||
resulting version number. For example:</p>
|
||||
|
||||
<pre><code>npm version patch -m "Upgrade to %s for reasons"</code></pre>
|
||||
|
||||
<p>If the <code>sign-git-tag</code> config is set, then the tag will be signed using
|
||||
<pre><code>npm version patch -m "Upgrade to %s for reasons"
|
||||
</code></pre><p>If the <code>sign-git-tag</code> config is set, then the tag will be signed using
|
||||
the <code>-s</code> flag to git. Note that you must have a default GPG key set up
|
||||
in your git config for this to work properly. For example:</p>
|
||||
|
||||
<pre><code>$ npm config set sign-git-tag true
|
||||
$ npm version patch
|
||||
|
||||
@ -46,11 +36,14 @@ You need a passphrase to unlock the secret key for
|
||||
user: "isaacs (http://blog.izs.me/) <i@izs.me>"
|
||||
2048-bit RSA key, ID 6C481CF6, created 2010-08-31
|
||||
|
||||
Enter passphrase:</code></pre>
|
||||
Enter passphrase:
|
||||
</code></pre><h2 id="see-also">SEE ALSO</h2>
|
||||
<ul>
|
||||
<li><a href="../cli/npm-init.html">npm-init(1)</a></li>
|
||||
<li><a href="../files/package.json.html">package.json(5)</a></li>
|
||||
<li><a href="../misc/semver.html">semver(7)</a></li>
|
||||
</ul>
|
||||
|
||||
<h2 id="SEE-ALSO">SEE ALSO</h2>
|
||||
|
||||
<ul><li><a href="../cli/npm-init.html">npm-init(1)</a></li><li><a href="../files/package.json.html">package.json(5)</a></li><li><a href="../misc/semver.html">semver(7)</a></li></ul>
|
||||
</div>
|
||||
|
||||
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
|
||||
@ -62,5 +55,5 @@ Enter passphrase:</code></pre>
|
||||
<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-version — npm@1.4.9</p>
|
||||
<p id="footer">npm-version — npm@1.4.10</p>
|
||||
|
||||
|
||||
84
deps/npm/html/doc/cli/npm-view.html
vendored
84
deps/npm/html/doc/cli/npm-view.html
vendored
@ -10,89 +10,67 @@
|
||||
<div id="wrapper">
|
||||
|
||||
<h1><a href="../cli/npm-view.html">npm-view</a></h1> <p>View registry info</p>
|
||||
|
||||
<h2 id="SYNOPSIS">SYNOPSIS</h2>
|
||||
|
||||
<h2 id="synopsis">SYNOPSIS</h2>
|
||||
<pre><code>npm view <name>[@<version>] [<field>[.<subfield>]...]
|
||||
npm v <name>[@<version>] [<field>[.<subfield>]...]</code></pre>
|
||||
|
||||
<h2 id="DESCRIPTION">DESCRIPTION</h2>
|
||||
|
||||
npm v <name>[@<version>] [<field>[.<subfield>]...]
|
||||
</code></pre><h2 id="description">DESCRIPTION</h2>
|
||||
<p>This command shows data about a package and prints it to the stream
|
||||
referenced by the <code>outfd</code> config, which defaults to stdout.</p>
|
||||
|
||||
<p>To show the package registry entry for the <code>connect</code> package, you can do
|
||||
this:</p>
|
||||
|
||||
<pre><code>npm view connect</code></pre>
|
||||
|
||||
<p>The default version is "latest" if unspecified.</p>
|
||||
|
||||
<pre><code>npm view connect
|
||||
</code></pre><p>The default version is "latest" if unspecified.</p>
|
||||
<p>Field names can be specified after the package descriptor.
|
||||
For example, to show the dependencies of the <code>ronn</code> package at version
|
||||
0.3.5, you could do the following:</p>
|
||||
|
||||
<pre><code>npm view ronn@0.3.5 dependencies</code></pre>
|
||||
|
||||
<p>You can view child field by separating them with a period.
|
||||
<pre><code>npm view ronn@0.3.5 dependencies
|
||||
</code></pre><p>You can view child field by separating them with a period.
|
||||
To view the git repository URL for the latest version of npm, you could
|
||||
do this:</p>
|
||||
|
||||
<pre><code>npm view npm repository.url</code></pre>
|
||||
|
||||
<p>This makes it easy to view information about a dependency with a bit of
|
||||
<pre><code>npm view npm repository.url
|
||||
</code></pre><p>This makes it easy to view information about a dependency with a bit of
|
||||
shell scripting. For example, to view all the data about the version of
|
||||
opts that ronn depends on, you can do this:</p>
|
||||
|
||||
<pre><code>npm view opts@$(npm view ronn dependencies.opts)</code></pre>
|
||||
|
||||
<p>For fields that are arrays, requesting a non-numeric field will return
|
||||
<pre><code>npm view opts@$(npm view ronn dependencies.opts)
|
||||
</code></pre><p>For fields that are arrays, requesting a non-numeric field will return
|
||||
all of the values from the objects in the list. For example, to get all
|
||||
the contributor names for the "express" project, you can do this:</p>
|
||||
|
||||
<pre><code>npm view express contributors.email</code></pre>
|
||||
|
||||
<p>You may also use numeric indices in square braces to specifically select
|
||||
<pre><code>npm view express contributors.email
|
||||
</code></pre><p>You may also use numeric indices in square braces to specifically select
|
||||
an item in an array field. To just get the email address of the first
|
||||
contributor in the list, you can do this:</p>
|
||||
|
||||
<pre><code>npm view express contributors[0].email</code></pre>
|
||||
|
||||
<p>Multiple fields may be specified, and will be printed one after another.
|
||||
<pre><code>npm view express contributors[0].email
|
||||
</code></pre><p>Multiple fields may be specified, and will be printed one after another.
|
||||
For exampls, to get all the contributor names and email addresses, you
|
||||
can do this:</p>
|
||||
|
||||
<pre><code>npm view express contributors.name contributors.email</code></pre>
|
||||
|
||||
<p>"Person" fields are shown as a string if they would be shown as an
|
||||
<pre><code>npm view express contributors.name contributors.email
|
||||
</code></pre><p>"Person" fields are shown as a string if they would be shown as an
|
||||
object. So, for example, this will show the list of npm contributors in
|
||||
the shortened string format. (See <code><a href="../files/package.json.html">package.json(5)</a></code> for more on this.)</p>
|
||||
|
||||
<pre><code>npm view npm contributors</code></pre>
|
||||
|
||||
<p>If a version range is provided, then data will be printed for every
|
||||
<pre><code>npm view npm contributors
|
||||
</code></pre><p>If a version range is provided, then data will be printed for every
|
||||
matching version of the package. This will show which version of jsdom
|
||||
was required by each matching version of yui3:</p>
|
||||
|
||||
<pre><code>npm view yui3@'>0.5.4' dependencies.jsdom</code></pre>
|
||||
|
||||
<h2 id="OUTPUT">OUTPUT</h2>
|
||||
|
||||
<pre><code>npm view yui3@'>0.5.4' dependencies.jsdom
|
||||
</code></pre><h2 id="output">OUTPUT</h2>
|
||||
<p>If only a single string field for a single version is output, then it
|
||||
will not be colorized or quoted, so as to enable piping the output to
|
||||
another command. If the field is an object, it will be output as a JavaScript object literal.</p>
|
||||
|
||||
<p>If the --json flag is given, the outputted fields will be JSON.</p>
|
||||
|
||||
<p>If the version range matches multiple versions, than each printed value
|
||||
will be prefixed with the version it applies to.</p>
|
||||
|
||||
<p>If multiple fields are requested, than each of them are prefixed with
|
||||
the field name.</p>
|
||||
<h2 id="see-also">SEE ALSO</h2>
|
||||
<ul>
|
||||
<li><a href="../cli/npm-search.html">npm-search(1)</a></li>
|
||||
<li><a href="../misc/npm-registry.html">npm-registry(7)</a></li>
|
||||
<li><a href="../cli/npm-config.html">npm-config(1)</a></li>
|
||||
<li><a href="../misc/npm-config.html">npm-config(7)</a></li>
|
||||
<li><a href="../files/npmrc.html">npmrc(5)</a></li>
|
||||
<li><a href="../cli/npm-docs.html">npm-docs(1)</a></li>
|
||||
</ul>
|
||||
|
||||
<h2 id="SEE-ALSO">SEE ALSO</h2>
|
||||
|
||||
<ul><li><a href="../cli/npm-search.html">npm-search(1)</a></li><li><a href="../misc/npm-registry.html">npm-registry(7)</a></li><li><a href="../cli/npm-config.html">npm-config(1)</a></li><li><a href="../misc/npm-config.html">npm-config(7)</a></li><li><a href="../files/npmrc.html">npmrc(5)</a></li><li><a href="../cli/npm-docs.html">npm-docs(1)</a></li></ul>
|
||||
</div>
|
||||
|
||||
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
|
||||
@ -104,5 +82,5 @@ the field name.</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-view — npm@1.4.9</p>
|
||||
<p id="footer">npm-view — npm@1.4.10</p>
|
||||
|
||||
|
||||
22
deps/npm/html/doc/cli/npm-whoami.html
vendored
22
deps/npm/html/doc/cli/npm-whoami.html
vendored
@ -10,18 +10,18 @@
|
||||
<div id="wrapper">
|
||||
|
||||
<h1><a href="../cli/npm-whoami.html">npm-whoami</a></h1> <p>Display npm username</p>
|
||||
|
||||
<h2 id="SYNOPSIS">SYNOPSIS</h2>
|
||||
|
||||
<pre><code>npm whoami</code></pre>
|
||||
|
||||
<h2 id="DESCRIPTION">DESCRIPTION</h2>
|
||||
|
||||
<h2 id="synopsis">SYNOPSIS</h2>
|
||||
<pre><code>npm whoami
|
||||
</code></pre><h2 id="description">DESCRIPTION</h2>
|
||||
<p>Print the <code>username</code> config to standard output.</p>
|
||||
<h2 id="see-also">SEE ALSO</h2>
|
||||
<ul>
|
||||
<li><a href="../cli/npm-config.html">npm-config(1)</a></li>
|
||||
<li><a href="../misc/npm-config.html">npm-config(7)</a></li>
|
||||
<li><a href="../files/npmrc.html">npmrc(5)</a></li>
|
||||
<li><a href="../cli/npm-adduser.html">npm-adduser(1)</a></li>
|
||||
</ul>
|
||||
|
||||
<h2 id="SEE-ALSO">SEE ALSO</h2>
|
||||
|
||||
<ul><li><a href="../cli/npm-config.html">npm-config(1)</a></li><li><a href="../misc/npm-config.html">npm-config(7)</a></li><li><a href="../files/npmrc.html">npmrc(5)</a></li><li><a href="../cli/npm-adduser.html">npm-adduser(1)</a></li></ul>
|
||||
</div>
|
||||
|
||||
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
|
||||
@ -33,5 +33,5 @@
|
||||
<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-whoami — npm@1.4.9</p>
|
||||
<p id="footer">npm-whoami — npm@1.4.10</p>
|
||||
|
||||
|
||||
149
deps/npm/html/doc/cli/npm.html
vendored
149
deps/npm/html/doc/cli/npm.html
vendored
@ -10,129 +10,126 @@
|
||||
<div id="wrapper">
|
||||
|
||||
<h1><a href="../cli/npm.html">npm</a></h1> <p>node package manager</p>
|
||||
|
||||
<h2 id="SYNOPSIS">SYNOPSIS</h2>
|
||||
|
||||
<pre><code>npm <command> [args]</code></pre>
|
||||
|
||||
<h2 id="VERSION">VERSION</h2>
|
||||
|
||||
<p>1.4.9</p>
|
||||
|
||||
<h2 id="DESCRIPTION">DESCRIPTION</h2>
|
||||
|
||||
<h2 id="synopsis">SYNOPSIS</h2>
|
||||
<pre><code>npm <command> [args]
|
||||
</code></pre><h2 id="version">VERSION</h2>
|
||||
<p>1.4.10</p>
|
||||
<h2 id="description">DESCRIPTION</h2>
|
||||
<p>npm is the package manager for the Node JavaScript platform. It puts
|
||||
modules in place so that node can find them, and manages dependency
|
||||
conflicts intelligently.</p>
|
||||
|
||||
<p>It is extremely configurable to support a wide variety of use cases.
|
||||
Most commonly, it is used to publish, discover, install, and develop node
|
||||
programs.</p>
|
||||
|
||||
<p>Run <code>npm help</code> to get a list of available commands.</p>
|
||||
|
||||
<h2 id="INTRODUCTION">INTRODUCTION</h2>
|
||||
|
||||
<h2 id="introduction">INTRODUCTION</h2>
|
||||
<p>You probably got npm because you want to install stuff.</p>
|
||||
|
||||
<p>Use <code>npm install blerg</code> to install the latest version of "blerg". Check out
|
||||
<code><a href="../cli/npm-install.html">npm-install(1)</a></code> for more info. It can do a lot of stuff.</p>
|
||||
|
||||
<p>Use the <code>npm search</code> command to show everything that's available.
|
||||
Use <code>npm ls</code> to show everything you've installed.</p>
|
||||
|
||||
<h2 id="DIRECTORIES">DIRECTORIES</h2>
|
||||
|
||||
<h2 id="directories">DIRECTORIES</h2>
|
||||
<p>See <code><a href="../files/npm-folders.html">npm-folders(5)</a></code> to learn about where npm puts stuff.</p>
|
||||
|
||||
<p>In particular, npm has two modes of operation:</p>
|
||||
|
||||
<ul><li>global mode:<br />npm installs packages into the install prefix at
|
||||
<code>prefix/lib/node_modules</code> and bins are installed in <code>prefix/bin</code>.</li><li>local mode:<br />npm installs packages into the current project directory, which
|
||||
<ul>
|
||||
<li>global mode:<br>npm installs packages into the install prefix at
|
||||
<code>prefix/lib/node_modules</code> and bins are installed in <code>prefix/bin</code>.</li>
|
||||
<li>local mode:<br>npm installs packages into the current project directory, which
|
||||
defaults to the current working directory. Packages are installed to
|
||||
<code>./node_modules</code>, and bins are installed to <code>./node_modules/.bin</code>.</li></ul>
|
||||
|
||||
<code>./node_modules</code>, and bins are installed to <code>./node_modules/.bin</code>.</li>
|
||||
</ul>
|
||||
<p>Local mode is the default. Use <code>--global</code> or <code>-g</code> on any command to
|
||||
operate in global mode instead.</p>
|
||||
|
||||
<h2 id="DEVELOPER-USAGE">DEVELOPER USAGE</h2>
|
||||
|
||||
<h2 id="developer-usage">DEVELOPER USAGE</h2>
|
||||
<p>If you're using npm to develop and publish your code, check out the
|
||||
following help topics:</p>
|
||||
|
||||
<ul><li>json:
|
||||
Make a package.json file. See <code><a href="../files/package.json.html">package.json(5)</a></code>.</li><li>link:
|
||||
<ul>
|
||||
<li>json:
|
||||
Make a package.json file. See <code><a href="../files/package.json.html">package.json(5)</a></code>.</li>
|
||||
<li>link:
|
||||
For linking your current working code into Node's path, so that you
|
||||
don't have to reinstall every time you make a change. Use
|
||||
<code>npm link</code> to do this.</li><li>install:
|
||||
<code>npm link</code> to do this.</li>
|
||||
<li>install:
|
||||
It's a good idea to install things if you don't need the symbolic link.
|
||||
Especially, installing other peoples code from the registry is done via
|
||||
<code>npm install</code></li><li>adduser:
|
||||
<code>npm install</code></li>
|
||||
<li>adduser:
|
||||
Create an account or log in. Credentials are stored in the
|
||||
user config file.</li><li>publish:
|
||||
Use the <code>npm publish</code> command to upload your code to the registry.</li></ul>
|
||||
|
||||
<h2 id="CONFIGURATION">CONFIGURATION</h2>
|
||||
|
||||
user config file.</li>
|
||||
<li>publish:
|
||||
Use the <code>npm publish</code> command to upload your code to the registry.</li>
|
||||
</ul>
|
||||
<h2 id="configuration">CONFIGURATION</h2>
|
||||
<p>npm is extremely configurable. It reads its configuration options from
|
||||
5 places.</p>
|
||||
|
||||
<ul><li>Command line switches:<br />Set a config with <code>--key val</code>. All keys take a value, even if they
|
||||
<ul>
|
||||
<li>Command line switches:<br>Set a config with <code>--key val</code>. 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
|
||||
to boolean <code>true</code>.</li><li>Environment Variables:<br />Set any config by prefixing the name in an environment variable with
|
||||
<code>npm_config_</code>. For example, <code>export npm_config_key=val</code>.</li><li>User Configs:<br />The file at $HOME/.npmrc is an ini-formatted list of configs. If
|
||||
to boolean <code>true</code>.</li>
|
||||
<li>Environment Variables:<br>Set any config by prefixing the name in an environment variable with
|
||||
<code>npm_config_</code>. For example, <code>export npm_config_key=val</code>.</li>
|
||||
<li>User Configs:<br>The file at $HOME/.npmrc is an ini-formatted list of configs. If
|
||||
present, it is parsed. If the <code>userconfig</code> option is set in the cli
|
||||
or env, then that will be used instead.</li><li>Global Configs:<br />The file found at ../etc/npmrc (from the node executable, by default
|
||||
or env, then that will be used instead.</li>
|
||||
<li>Global Configs:<br>The file found at ../etc/npmrc (from the node executable, by default
|
||||
this resolves to /usr/local/etc/npmrc) will be parsed if it is found.
|
||||
If the <code>globalconfig</code> option is set in the cli, env, or user config,
|
||||
then that file is parsed instead.</li><li>Defaults:<br />npm's default configuration options are defined in
|
||||
lib/utils/config-defs.js. These must not be changed.</li></ul>
|
||||
|
||||
then that file is parsed instead.</li>
|
||||
<li>Defaults:<br>npm's default configuration options are defined in
|
||||
lib/utils/config-defs.js. These must not be changed.</li>
|
||||
</ul>
|
||||
<p>See <code><a href="../misc/npm-config.html">npm-config(7)</a></code> for much much more information.</p>
|
||||
|
||||
<h2 id="CONTRIBUTIONS">CONTRIBUTIONS</h2>
|
||||
|
||||
<h2 id="contributions">CONTRIBUTIONS</h2>
|
||||
<p>Patches welcome!</p>
|
||||
|
||||
<ul><li>code:
|
||||
<ul>
|
||||
<li>code:
|
||||
Read through <code><a href="../misc/npm-coding-style.html">npm-coding-style(7)</a></code> if you plan to submit code.
|
||||
You don't have to agree with it, but you do have to follow it.</li><li>docs:
|
||||
You don't have to agree with it, but you do have to follow it.</li>
|
||||
<li>docs:
|
||||
If you find an error in the documentation, edit the appropriate markdown
|
||||
file in the "doc" folder. (Don't worry about generating the man page.)</li></ul>
|
||||
|
||||
file in the "doc" folder. (Don't worry about generating the man page.)</li>
|
||||
</ul>
|
||||
<p>Contributors are listed in npm's <code>package.json</code> file. You can view them
|
||||
easily by doing <code>npm view npm contributors</code>.</p>
|
||||
|
||||
<p>If you would like to contribute, but don't know what to work on, check
|
||||
the issues list or ask on the mailing list.</p>
|
||||
|
||||
<ul><li><a href="http://github.com/npm/npm/issues">http://github.com/npm/npm/issues</a></li><li><a href="mailto:npm-@googlegroups.com">npm-@googlegroups.com</a></li></ul>
|
||||
|
||||
<h2 id="BUGS">BUGS</h2>
|
||||
|
||||
<ul>
|
||||
<li><a href="http://github.com/npm/npm/issues">http://github.com/npm/npm/issues</a></li>
|
||||
<li><a href="mailto:npm-@googlegroups.com">npm-@googlegroups.com</a></li>
|
||||
</ul>
|
||||
<h2 id="bugs">BUGS</h2>
|
||||
<p>When you find issues, please report them:</p>
|
||||
|
||||
<ul><li>web:
|
||||
<a href="http://github.com/npm/npm/issues">http://github.com/npm/npm/issues</a></li><li>email:
|
||||
<a href="mailto:npm-@googlegroups.com">npm-@googlegroups.com</a></li></ul>
|
||||
|
||||
<ul>
|
||||
<li>web:
|
||||
<a href="http://github.com/npm/npm/issues">http://github.com/npm/npm/issues</a></li>
|
||||
<li>email:
|
||||
<a href="mailto:npm-@googlegroups.com">npm-@googlegroups.com</a></li>
|
||||
</ul>
|
||||
<p>Be sure to include <em>all</em> of the output from the npm command that didn't work
|
||||
as expected. The <code>npm-debug.log</code> file is also helpful to provide.</p>
|
||||
|
||||
<p>You can also look for isaacs in #node.js on irc://irc.freenode.net. He
|
||||
will no doubt tell you to put the output in a gist or email.</p>
|
||||
|
||||
<h2 id="AUTHOR">AUTHOR</h2>
|
||||
|
||||
<h2 id="author">AUTHOR</h2>
|
||||
<p><a href="http://blog.izs.me/">Isaac Z. Schlueter</a> ::
|
||||
<a href="https://github.com/isaacs/">isaacs</a> ::
|
||||
<a href="http://twitter.com/izs">@izs</a> ::
|
||||
<a href="mailto:i@izs.me">i@izs.me</a></p>
|
||||
<a href="mailto:i@izs.me">i@izs.me</a></p>
|
||||
<h2 id="see-also">SEE ALSO</h2>
|
||||
<ul>
|
||||
<li><a href="../cli/npm-help.html">npm-help(1)</a></li>
|
||||
<li><a href="../misc/npm-faq.html">npm-faq(7)</a></li>
|
||||
<li><a href="../../doc/README.html">README</a></li>
|
||||
<li><a href="../files/package.json.html">package.json(5)</a></li>
|
||||
<li><a href="../cli/npm-install.html">npm-install(1)</a></li>
|
||||
<li><a href="../cli/npm-config.html">npm-config(1)</a></li>
|
||||
<li><a href="../misc/npm-config.html">npm-config(7)</a></li>
|
||||
<li><a href="../files/npmrc.html">npmrc(5)</a></li>
|
||||
<li><a href="../misc/npm-index.html">npm-index(7)</a></li>
|
||||
<li><a href="../api/npm.html">npm(3)</a></li>
|
||||
</ul>
|
||||
|
||||
<h2 id="SEE-ALSO">SEE ALSO</h2>
|
||||
|
||||
<ul><li><a href="../cli/npm-help.html">npm-help(1)</a></li><li><a href="../misc/npm-faq.html">npm-faq(7)</a></li><li><a href="../../doc/README.html">README</a></li><li><a href="../files/package.json.html">package.json(5)</a></li><li><a href="../cli/npm-install.html">npm-install(1)</a></li><li><a href="../cli/npm-config.html">npm-config(1)</a></li><li><a href="../misc/npm-config.html">npm-config(7)</a></li><li><a href="../files/npmrc.html">npmrc(5)</a></li><li><a href="../misc/npm-index.html">npm-index(7)</a></li><li><a href="../api/npm.html">npm(3)</a></li></ul>
|
||||
</div>
|
||||
|
||||
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
|
||||
@ -144,5 +141,5 @@ will no doubt tell you to put the output in a gist or email.</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 — npm@1.4.9</p>
|
||||
<p id="footer">npm — npm@1.4.10</p>
|
||||
|
||||
|
||||
115
deps/npm/html/doc/files/npm-folders.html
vendored
115
deps/npm/html/doc/files/npm-folders.html
vendored
@ -10,119 +10,87 @@
|
||||
<div id="wrapper">
|
||||
|
||||
<h1><a href="../files/npm-folders.html">npm-folders</a></h1> <p>Folder Structures Used by npm</p>
|
||||
|
||||
<h2 id="DESCRIPTION">DESCRIPTION</h2>
|
||||
|
||||
<h2 id="description">DESCRIPTION</h2>
|
||||
<p>npm puts various things on your computer. That's its job.</p>
|
||||
|
||||
<p>This document will tell you what it puts where.</p>
|
||||
|
||||
<h3 id="tl-dr">tl;dr</h3>
|
||||
|
||||
<ul><li>Local install (default): puts stuff in <code>./node_modules</code> of the current
|
||||
package root.</li><li>Global install (with <code>-g</code>): puts stuff in /usr/local or wherever node
|
||||
is installed.</li><li>Install it <strong>locally</strong> if you're going to <code>require()</code> it.</li><li>Install it <strong>globally</strong> if you're going to run it on the command line.</li><li>If you need both, then install it in both places, or use <code>npm link</code>.</li></ul>
|
||||
|
||||
<h3 id="prefix-Configuration">prefix Configuration</h3>
|
||||
|
||||
<ul>
|
||||
<li>Local install (default): puts stuff in <code>./node_modules</code> of the current
|
||||
package root.</li>
|
||||
<li>Global install (with <code>-g</code>): puts stuff in /usr/local or wherever node
|
||||
is installed.</li>
|
||||
<li>Install it <strong>locally</strong> if you're going to <code>require()</code> it.</li>
|
||||
<li>Install it <strong>globally</strong> if you're going to run it on the command line.</li>
|
||||
<li>If you need both, then install it in both places, or use <code>npm link</code>.</li>
|
||||
</ul>
|
||||
<h3 id="prefix-configuration">prefix Configuration</h3>
|
||||
<p>The <code>prefix</code> config defaults to the location where node is installed.
|
||||
On most systems, this is <code>/usr/local</code>, and most of the time is the same
|
||||
as node's <code>process.installPrefix</code>.</p>
|
||||
|
||||
<p>On windows, this is the exact location of the node.exe binary. On Unix
|
||||
systems, it's one level up, since node is typically installed at
|
||||
<code>{prefix}/bin/node</code> rather than <code>{prefix}/node.exe</code>.</p>
|
||||
|
||||
<p>When the <code>global</code> flag is set, npm installs things into this prefix.
|
||||
When it is not set, it uses the root of the current package, or the
|
||||
current working directory if not in a package already.</p>
|
||||
|
||||
<h3 id="Node-Modules">Node Modules</h3>
|
||||
|
||||
<h3 id="node-modules">Node Modules</h3>
|
||||
<p>Packages are dropped into the <code>node_modules</code> folder under the <code>prefix</code>.
|
||||
When installing locally, this means that you can
|
||||
<code>require("packagename")</code> to load its main module, or
|
||||
<code>require("packagename/lib/path/to/sub/module")</code> to load other modules.</p>
|
||||
|
||||
<p>Global installs on Unix systems go to <code>{prefix}/lib/node_modules</code>.
|
||||
Global installs on Windows go to <code>{prefix}/node_modules</code> (that is, no
|
||||
<code>lib</code> folder.)</p>
|
||||
|
||||
<p>If you wish to <code>require()</code> a package, then install it locally.</p>
|
||||
|
||||
<h3 id="Executables">Executables</h3>
|
||||
|
||||
<h3 id="executables">Executables</h3>
|
||||
<p>When in global mode, executables are linked into <code>{prefix}/bin</code> on Unix,
|
||||
or directly into <code>{prefix}</code> on Windows.</p>
|
||||
|
||||
<p>When in local mode, executables are linked into
|
||||
<code>./node_modules/.bin</code> so that they can be made available to scripts run
|
||||
through npm. (For example, so that a test runner will be in the path
|
||||
when you run <code>npm test</code>.)</p>
|
||||
|
||||
<h3 id="Man-Pages">Man Pages</h3>
|
||||
|
||||
<h3 id="man-pages">Man Pages</h3>
|
||||
<p>When in global mode, man pages are linked into <code>{prefix}/share/man</code>.</p>
|
||||
|
||||
<p>When in local mode, man pages are not installed.</p>
|
||||
|
||||
<p>Man pages are not installed on Windows systems.</p>
|
||||
|
||||
<h3 id="Cache">Cache</h3>
|
||||
|
||||
<h3 id="cache">Cache</h3>
|
||||
<p>See <code><a href="../cli/npm-cache.html">npm-cache(1)</a></code>. Cache files are stored in <code>~/.npm</code> on Posix, or
|
||||
<code>~/npm-cache</code> on Windows.</p>
|
||||
|
||||
<p>This is controlled by the <code>cache</code> configuration param.</p>
|
||||
|
||||
<h3 id="Temp-Files">Temp Files</h3>
|
||||
|
||||
<h3 id="temp-files">Temp Files</h3>
|
||||
<p>Temporary files are stored by default in the folder specified by the
|
||||
<code>tmp</code> config, which defaults to the TMPDIR, TMP, or TEMP environment
|
||||
variables, or <code>/tmp</code> on Unix and <code>c:\windows\temp</code> on Windows.</p>
|
||||
|
||||
<p>Temp files are given a unique folder under this root for each run of the
|
||||
program, and are deleted upon successful exit.</p>
|
||||
|
||||
<h2 id="More-Information">More Information</h2>
|
||||
|
||||
<h2 id="more-information">More Information</h2>
|
||||
<p>When installing locally, npm first tries to find an appropriate
|
||||
<code>prefix</code> folder. This is so that <code>npm install foo@1.2.3</code> will install
|
||||
to the sensible root of your package, even if you happen to have <code>cd</code>ed
|
||||
into some other folder.</p>
|
||||
|
||||
<p>Starting at the $PWD, npm will walk up the folder tree checking for a
|
||||
folder that contains either a <code>package.json</code> file, or a <code>node_modules</code>
|
||||
folder. If such a thing is found, then that is treated as the effective
|
||||
"current directory" for the purpose of running npm commands. (This
|
||||
behavior is inspired by and similar to git's .git-folder seeking
|
||||
logic when running git commands in a working dir.)</p>
|
||||
|
||||
<p>If no package root is found, then the current folder is used.</p>
|
||||
|
||||
<p>When you run <code>npm install foo@1.2.3</code>, then the package is loaded into
|
||||
the cache, and then unpacked into <code>./node_modules/foo</code>. Then, any of
|
||||
foo's dependencies are similarly unpacked into
|
||||
<code>./node_modules/foo/node_modules/...</code>.</p>
|
||||
|
||||
<p>Any bin files are symlinked to <code>./node_modules/.bin/</code>, so that they may
|
||||
be found by npm scripts when necessary.</p>
|
||||
|
||||
<h3 id="Global-Installation">Global Installation</h3>
|
||||
|
||||
<h3 id="global-installation">Global Installation</h3>
|
||||
<p>If the <code>global</code> configuration is set to true, then npm will
|
||||
install packages "globally".</p>
|
||||
|
||||
<p>For global installation, packages are installed roughly the same way,
|
||||
but using the folders described above.</p>
|
||||
|
||||
<h3 id="Cycles-Conflicts-and-Folder-Parsimony">Cycles, Conflicts, and Folder Parsimony</h3>
|
||||
|
||||
<h3 id="cycles-conflicts-and-folder-parsimony">Cycles, Conflicts, and Folder Parsimony</h3>
|
||||
<p>Cycles are handled using the property of node's module system that it
|
||||
walks up the directories looking for <code>node_modules</code> folders. So, at every
|
||||
stage, if a package is already installed in an ancestor <code>node_modules</code>
|
||||
folder, then it is not installed at the current location.</p>
|
||||
|
||||
<p>Consider the case above, where <code>foo -> bar -> baz</code>. Imagine if, in
|
||||
addition to that, baz depended on bar, so you'd have:
|
||||
<code>foo -> bar -> baz -> bar -> baz ...</code>. However, since the folder
|
||||
@ -130,21 +98,16 @@ structure is: <code>foo/node_modules/bar/node_modules/baz</code>, there's no
|
||||
put another copy of bar into <code>.../baz/node_modules</code>, since when it calls
|
||||
require("bar"), it will get the copy that is installed in
|
||||
<code>foo/node_modules/bar</code>.</p>
|
||||
|
||||
<p>This shortcut is only used if the exact same
|
||||
version would be installed in multiple nested <code>node_modules</code> folders. It
|
||||
is still possible to have <code>a/node_modules/b/node_modules/a</code> if the two
|
||||
"a" packages are different versions. However, without repeating the
|
||||
exact same package multiple times, an infinite regress will always be
|
||||
prevented.</p>
|
||||
|
||||
<p>Another optimization can be made by installing dependencies at the
|
||||
highest level possible, below the localized "target" folder.</p>
|
||||
|
||||
<h4 id="Example">Example</h4>
|
||||
|
||||
<h4 id="example">Example</h4>
|
||||
<p>Consider this dependency graph:</p>
|
||||
|
||||
<pre><code>foo
|
||||
+-- blerg@1.2.5
|
||||
+-- bar@1.2.3
|
||||
@ -155,10 +118,8 @@ highest level possible, below the localized "target" folder.</p>
|
||||
| `-- asdf@*
|
||||
`-- baz@1.2.3
|
||||
`-- quux@3.x
|
||||
`-- bar</code></pre>
|
||||
|
||||
<p>In this case, we might expect a folder structure like this:</p>
|
||||
|
||||
`-- bar
|
||||
</code></pre><p>In this case, we might expect a folder structure like this:</p>
|
||||
<pre><code>foo
|
||||
+-- node_modules
|
||||
+-- blerg (1.2.5) <---[A]
|
||||
@ -170,43 +131,43 @@ highest level possible, below the localized "target" folder.</p>
|
||||
| `-- asdf (2.3.4)
|
||||
`-- baz (1.2.3) <---[D]
|
||||
`-- node_modules
|
||||
`-- quux (3.2.0) <---[E]</code></pre>
|
||||
|
||||
<p>Since foo depends directly on <code>bar@1.2.3</code> and <code>baz@1.2.3</code>, those are
|
||||
`-- quux (3.2.0) <---[E]
|
||||
</code></pre><p>Since foo depends directly on <code>bar@1.2.3</code> and <code>baz@1.2.3</code>, those are
|
||||
installed in foo's <code>node_modules</code> folder.</p>
|
||||
|
||||
<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 <code>blerg@1.x</code>,
|
||||
it does not install another copy under [B].</p>
|
||||
|
||||
<p>Bar [B] also has dependencies on baz and asdf, so those are installed in
|
||||
bar's <code>node_modules</code> folder. Because it depends on <code>baz@2.x</code>, it cannot
|
||||
re-use the <code>baz@1.2.3</code> installed in the parent <code>node_modules</code> folder [D],
|
||||
and must install its own copy [C].</p>
|
||||
|
||||
<p>Underneath bar, the <code>baz -> quux -> bar</code> dependency creates a cycle.
|
||||
However, because bar is already in quux's ancestry [B], it does not
|
||||
unpack another copy of bar into that folder.</p>
|
||||
|
||||
<p>Underneath <code>foo -> baz</code> [D], quux's [E] folder tree is empty, because its
|
||||
dependency on bar is satisfied by the parent folder copy installed at [B].</p>
|
||||
|
||||
<p>For a graphical breakdown of what is installed where, use <code>npm ls</code>.</p>
|
||||
|
||||
<h3 id="Publishing">Publishing</h3>
|
||||
|
||||
<h3 id="publishing">Publishing</h3>
|
||||
<p>Upon publishing, npm will look in the <code>node_modules</code> folder. If any of
|
||||
the items there are not in the <code>bundledDependencies</code> array, then they will
|
||||
not be included in the package tarball.</p>
|
||||
|
||||
<p>This allows a package maintainer to install all of their dependencies
|
||||
(and dev dependencies) locally, but only re-publish those items that
|
||||
cannot be found elsewhere. See <code><a href="../files/package.json.html">package.json(5)</a></code> for more information.</p>
|
||||
<h2 id="see-also">SEE ALSO</h2>
|
||||
<ul>
|
||||
<li><a href="../misc/npm-faq.html">npm-faq(7)</a></li>
|
||||
<li><a href="../files/package.json.html">package.json(5)</a></li>
|
||||
<li><a href="../cli/npm-install.html">npm-install(1)</a></li>
|
||||
<li><a href="../cli/npm-pack.html">npm-pack(1)</a></li>
|
||||
<li><a href="../cli/npm-cache.html">npm-cache(1)</a></li>
|
||||
<li><a href="../cli/npm-config.html">npm-config(1)</a></li>
|
||||
<li><a href="../files/npmrc.html">npmrc(5)</a></li>
|
||||
<li><a href="../misc/npm-config.html">npm-config(7)</a></li>
|
||||
<li><a href="../cli/npm-publish.html">npm-publish(1)</a></li>
|
||||
</ul>
|
||||
|
||||
<h2 id="SEE-ALSO">SEE ALSO</h2>
|
||||
|
||||
<ul><li><a href="../misc/npm-faq.html">npm-faq(7)</a></li><li><a href="../files/package.json.html">package.json(5)</a></li><li><a href="../cli/npm-install.html">npm-install(1)</a></li><li><a href="../cli/npm-pack.html">npm-pack(1)</a></li><li><a href="../cli/npm-cache.html">npm-cache(1)</a></li><li><a href="../cli/npm-config.html">npm-config(1)</a></li><li><a href="../files/npmrc.html">npmrc(5)</a></li><li><a href="../misc/npm-config.html">npm-config(7)</a></li><li><a href="../cli/npm-publish.html">npm-publish(1)</a></li></ul>
|
||||
</div>
|
||||
|
||||
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
|
||||
@ -218,5 +179,5 @@ cannot be found elsewhere. See <code><a href="../files/package.json.html">packa
|
||||
<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-folders — npm@1.4.9</p>
|
||||
<p id="footer">npm-folders — npm@1.4.10</p>
|
||||
|
||||
|
||||
115
deps/npm/html/doc/files/npm-global.html
vendored
115
deps/npm/html/doc/files/npm-global.html
vendored
@ -10,119 +10,87 @@
|
||||
<div id="wrapper">
|
||||
|
||||
<h1><a href="../files/npm-folders.html">npm-folders</a></h1> <p>Folder Structures Used by npm</p>
|
||||
|
||||
<h2 id="DESCRIPTION">DESCRIPTION</h2>
|
||||
|
||||
<h2 id="description">DESCRIPTION</h2>
|
||||
<p>npm puts various things on your computer. That's its job.</p>
|
||||
|
||||
<p>This document will tell you what it puts where.</p>
|
||||
|
||||
<h3 id="tl-dr">tl;dr</h3>
|
||||
|
||||
<ul><li>Local install (default): puts stuff in <code>./node_modules</code> of the current
|
||||
package root.</li><li>Global install (with <code>-g</code>): puts stuff in /usr/local or wherever node
|
||||
is installed.</li><li>Install it <strong>locally</strong> if you're going to <code>require()</code> it.</li><li>Install it <strong>globally</strong> if you're going to run it on the command line.</li><li>If you need both, then install it in both places, or use <code>npm link</code>.</li></ul>
|
||||
|
||||
<h3 id="prefix-Configuration">prefix Configuration</h3>
|
||||
|
||||
<ul>
|
||||
<li>Local install (default): puts stuff in <code>./node_modules</code> of the current
|
||||
package root.</li>
|
||||
<li>Global install (with <code>-g</code>): puts stuff in /usr/local or wherever node
|
||||
is installed.</li>
|
||||
<li>Install it <strong>locally</strong> if you're going to <code>require()</code> it.</li>
|
||||
<li>Install it <strong>globally</strong> if you're going to run it on the command line.</li>
|
||||
<li>If you need both, then install it in both places, or use <code>npm link</code>.</li>
|
||||
</ul>
|
||||
<h3 id="prefix-configuration">prefix Configuration</h3>
|
||||
<p>The <code>prefix</code> config defaults to the location where node is installed.
|
||||
On most systems, this is <code>/usr/local</code>, and most of the time is the same
|
||||
as node's <code>process.installPrefix</code>.</p>
|
||||
|
||||
<p>On windows, this is the exact location of the node.exe binary. On Unix
|
||||
systems, it's one level up, since node is typically installed at
|
||||
<code>{prefix}/bin/node</code> rather than <code>{prefix}/node.exe</code>.</p>
|
||||
|
||||
<p>When the <code>global</code> flag is set, npm installs things into this prefix.
|
||||
When it is not set, it uses the root of the current package, or the
|
||||
current working directory if not in a package already.</p>
|
||||
|
||||
<h3 id="Node-Modules">Node Modules</h3>
|
||||
|
||||
<h3 id="node-modules">Node Modules</h3>
|
||||
<p>Packages are dropped into the <code>node_modules</code> folder under the <code>prefix</code>.
|
||||
When installing locally, this means that you can
|
||||
<code>require("packagename")</code> to load its main module, or
|
||||
<code>require("packagename/lib/path/to/sub/module")</code> to load other modules.</p>
|
||||
|
||||
<p>Global installs on Unix systems go to <code>{prefix}/lib/node_modules</code>.
|
||||
Global installs on Windows go to <code>{prefix}/node_modules</code> (that is, no
|
||||
<code>lib</code> folder.)</p>
|
||||
|
||||
<p>If you wish to <code>require()</code> a package, then install it locally.</p>
|
||||
|
||||
<h3 id="Executables">Executables</h3>
|
||||
|
||||
<h3 id="executables">Executables</h3>
|
||||
<p>When in global mode, executables are linked into <code>{prefix}/bin</code> on Unix,
|
||||
or directly into <code>{prefix}</code> on Windows.</p>
|
||||
|
||||
<p>When in local mode, executables are linked into
|
||||
<code>./node_modules/.bin</code> so that they can be made available to scripts run
|
||||
through npm. (For example, so that a test runner will be in the path
|
||||
when you run <code>npm test</code>.)</p>
|
||||
|
||||
<h3 id="Man-Pages">Man Pages</h3>
|
||||
|
||||
<h3 id="man-pages">Man Pages</h3>
|
||||
<p>When in global mode, man pages are linked into <code>{prefix}/share/man</code>.</p>
|
||||
|
||||
<p>When in local mode, man pages are not installed.</p>
|
||||
|
||||
<p>Man pages are not installed on Windows systems.</p>
|
||||
|
||||
<h3 id="Cache">Cache</h3>
|
||||
|
||||
<h3 id="cache">Cache</h3>
|
||||
<p>See <code><a href="../cli/npm-cache.html">npm-cache(1)</a></code>. Cache files are stored in <code>~/.npm</code> on Posix, or
|
||||
<code>~/npm-cache</code> on Windows.</p>
|
||||
|
||||
<p>This is controlled by the <code>cache</code> configuration param.</p>
|
||||
|
||||
<h3 id="Temp-Files">Temp Files</h3>
|
||||
|
||||
<h3 id="temp-files">Temp Files</h3>
|
||||
<p>Temporary files are stored by default in the folder specified by the
|
||||
<code>tmp</code> config, which defaults to the TMPDIR, TMP, or TEMP environment
|
||||
variables, or <code>/tmp</code> on Unix and <code>c:\windows\temp</code> on Windows.</p>
|
||||
|
||||
<p>Temp files are given a unique folder under this root for each run of the
|
||||
program, and are deleted upon successful exit.</p>
|
||||
|
||||
<h2 id="More-Information">More Information</h2>
|
||||
|
||||
<h2 id="more-information">More Information</h2>
|
||||
<p>When installing locally, npm first tries to find an appropriate
|
||||
<code>prefix</code> folder. This is so that <code>npm install foo@1.2.3</code> will install
|
||||
to the sensible root of your package, even if you happen to have <code>cd</code>ed
|
||||
into some other folder.</p>
|
||||
|
||||
<p>Starting at the $PWD, npm will walk up the folder tree checking for a
|
||||
folder that contains either a <code>package.json</code> file, or a <code>node_modules</code>
|
||||
folder. If such a thing is found, then that is treated as the effective
|
||||
"current directory" for the purpose of running npm commands. (This
|
||||
behavior is inspired by and similar to git's .git-folder seeking
|
||||
logic when running git commands in a working dir.)</p>
|
||||
|
||||
<p>If no package root is found, then the current folder is used.</p>
|
||||
|
||||
<p>When you run <code>npm install foo@1.2.3</code>, then the package is loaded into
|
||||
the cache, and then unpacked into <code>./node_modules/foo</code>. Then, any of
|
||||
foo's dependencies are similarly unpacked into
|
||||
<code>./node_modules/foo/node_modules/...</code>.</p>
|
||||
|
||||
<p>Any bin files are symlinked to <code>./node_modules/.bin/</code>, so that they may
|
||||
be found by npm scripts when necessary.</p>
|
||||
|
||||
<h3 id="Global-Installation">Global Installation</h3>
|
||||
|
||||
<h3 id="global-installation">Global Installation</h3>
|
||||
<p>If the <code>global</code> configuration is set to true, then npm will
|
||||
install packages "globally".</p>
|
||||
|
||||
<p>For global installation, packages are installed roughly the same way,
|
||||
but using the folders described above.</p>
|
||||
|
||||
<h3 id="Cycles-Conflicts-and-Folder-Parsimony">Cycles, Conflicts, and Folder Parsimony</h3>
|
||||
|
||||
<h3 id="cycles-conflicts-and-folder-parsimony">Cycles, Conflicts, and Folder Parsimony</h3>
|
||||
<p>Cycles are handled using the property of node's module system that it
|
||||
walks up the directories looking for <code>node_modules</code> folders. So, at every
|
||||
stage, if a package is already installed in an ancestor <code>node_modules</code>
|
||||
folder, then it is not installed at the current location.</p>
|
||||
|
||||
<p>Consider the case above, where <code>foo -> bar -> baz</code>. Imagine if, in
|
||||
addition to that, baz depended on bar, so you'd have:
|
||||
<code>foo -> bar -> baz -> bar -> baz ...</code>. However, since the folder
|
||||
@ -130,21 +98,16 @@ structure is: <code>foo/node_modules/bar/node_modules/baz</code>, there's no
|
||||
put another copy of bar into <code>.../baz/node_modules</code>, since when it calls
|
||||
require("bar"), it will get the copy that is installed in
|
||||
<code>foo/node_modules/bar</code>.</p>
|
||||
|
||||
<p>This shortcut is only used if the exact same
|
||||
version would be installed in multiple nested <code>node_modules</code> folders. It
|
||||
is still possible to have <code>a/node_modules/b/node_modules/a</code> if the two
|
||||
"a" packages are different versions. However, without repeating the
|
||||
exact same package multiple times, an infinite regress will always be
|
||||
prevented.</p>
|
||||
|
||||
<p>Another optimization can be made by installing dependencies at the
|
||||
highest level possible, below the localized "target" folder.</p>
|
||||
|
||||
<h4 id="Example">Example</h4>
|
||||
|
||||
<h4 id="example">Example</h4>
|
||||
<p>Consider this dependency graph:</p>
|
||||
|
||||
<pre><code>foo
|
||||
+-- blerg@1.2.5
|
||||
+-- bar@1.2.3
|
||||
@ -155,10 +118,8 @@ highest level possible, below the localized "target" folder.</p>
|
||||
| `-- asdf@*
|
||||
`-- baz@1.2.3
|
||||
`-- quux@3.x
|
||||
`-- bar</code></pre>
|
||||
|
||||
<p>In this case, we might expect a folder structure like this:</p>
|
||||
|
||||
`-- bar
|
||||
</code></pre><p>In this case, we might expect a folder structure like this:</p>
|
||||
<pre><code>foo
|
||||
+-- node_modules
|
||||
+-- blerg (1.2.5) <---[A]
|
||||
@ -170,43 +131,43 @@ highest level possible, below the localized "target" folder.</p>
|
||||
| `-- asdf (2.3.4)
|
||||
`-- baz (1.2.3) <---[D]
|
||||
`-- node_modules
|
||||
`-- quux (3.2.0) <---[E]</code></pre>
|
||||
|
||||
<p>Since foo depends directly on <code>bar@1.2.3</code> and <code>baz@1.2.3</code>, those are
|
||||
`-- quux (3.2.0) <---[E]
|
||||
</code></pre><p>Since foo depends directly on <code>bar@1.2.3</code> and <code>baz@1.2.3</code>, those are
|
||||
installed in foo's <code>node_modules</code> folder.</p>
|
||||
|
||||
<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 <code>blerg@1.x</code>,
|
||||
it does not install another copy under [B].</p>
|
||||
|
||||
<p>Bar [B] also has dependencies on baz and asdf, so those are installed in
|
||||
bar's <code>node_modules</code> folder. Because it depends on <code>baz@2.x</code>, it cannot
|
||||
re-use the <code>baz@1.2.3</code> installed in the parent <code>node_modules</code> folder [D],
|
||||
and must install its own copy [C].</p>
|
||||
|
||||
<p>Underneath bar, the <code>baz -> quux -> bar</code> dependency creates a cycle.
|
||||
However, because bar is already in quux's ancestry [B], it does not
|
||||
unpack another copy of bar into that folder.</p>
|
||||
|
||||
<p>Underneath <code>foo -> baz</code> [D], quux's [E] folder tree is empty, because its
|
||||
dependency on bar is satisfied by the parent folder copy installed at [B].</p>
|
||||
|
||||
<p>For a graphical breakdown of what is installed where, use <code>npm ls</code>.</p>
|
||||
|
||||
<h3 id="Publishing">Publishing</h3>
|
||||
|
||||
<h3 id="publishing">Publishing</h3>
|
||||
<p>Upon publishing, npm will look in the <code>node_modules</code> folder. If any of
|
||||
the items there are not in the <code>bundledDependencies</code> array, then they will
|
||||
not be included in the package tarball.</p>
|
||||
|
||||
<p>This allows a package maintainer to install all of their dependencies
|
||||
(and dev dependencies) locally, but only re-publish those items that
|
||||
cannot be found elsewhere. See <code><a href="../files/package.json.html">package.json(5)</a></code> for more information.</p>
|
||||
<h2 id="see-also">SEE ALSO</h2>
|
||||
<ul>
|
||||
<li><a href="../misc/npm-faq.html">npm-faq(7)</a></li>
|
||||
<li><a href="../files/package.json.html">package.json(5)</a></li>
|
||||
<li><a href="../cli/npm-install.html">npm-install(1)</a></li>
|
||||
<li><a href="../cli/npm-pack.html">npm-pack(1)</a></li>
|
||||
<li><a href="../cli/npm-cache.html">npm-cache(1)</a></li>
|
||||
<li><a href="../cli/npm-config.html">npm-config(1)</a></li>
|
||||
<li><a href="../files/npmrc.html">npmrc(5)</a></li>
|
||||
<li><a href="../misc/npm-config.html">npm-config(7)</a></li>
|
||||
<li><a href="../cli/npm-publish.html">npm-publish(1)</a></li>
|
||||
</ul>
|
||||
|
||||
<h2 id="SEE-ALSO">SEE ALSO</h2>
|
||||
|
||||
<ul><li><a href="../misc/npm-faq.html">npm-faq(7)</a></li><li><a href="../files/package.json.html">package.json(5)</a></li><li><a href="../cli/npm-install.html">npm-install(1)</a></li><li><a href="../cli/npm-pack.html">npm-pack(1)</a></li><li><a href="../cli/npm-cache.html">npm-cache(1)</a></li><li><a href="../cli/npm-config.html">npm-config(1)</a></li><li><a href="../files/npmrc.html">npmrc(5)</a></li><li><a href="../misc/npm-config.html">npm-config(7)</a></li><li><a href="../cli/npm-publish.html">npm-publish(1)</a></li></ul>
|
||||
</div>
|
||||
|
||||
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
|
||||
@ -218,5 +179,5 @@ cannot be found elsewhere. See <code><a href="../files/package.json.html">packa
|
||||
<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-folders — npm@1.4.9</p>
|
||||
<p id="footer">npm-folders — npm@1.4.10</p>
|
||||
|
||||
|
||||
360
deps/npm/html/doc/files/npm-json.html
vendored
360
deps/npm/html/doc/files/npm-json.html
vendored
@ -10,257 +10,178 @@
|
||||
<div id="wrapper">
|
||||
|
||||
<h1><a href="../files/package.json.html">package.json</a></h1> <p>Specifics of npm's package.json handling</p>
|
||||
|
||||
<h2 id="DESCRIPTION">DESCRIPTION</h2>
|
||||
|
||||
<h2 id="description">DESCRIPTION</h2>
|
||||
<p>This document is all you need to know about what's required in your package.json
|
||||
file. It must be actual JSON, not just a JavaScript object literal.</p>
|
||||
|
||||
<p>A lot of the behavior described in this document is affected by the config
|
||||
settings described in <code><a href="../misc/npm-config.html">npm-config(7)</a></code>.</p>
|
||||
|
||||
<h2 id="name">name</h2>
|
||||
|
||||
<p>The <em>most</em> 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.</p>
|
||||
|
||||
<p>The name is what your thing is called. Some tips:</p>
|
||||
|
||||
<ul><li>Don't put "js" or "node" in the name. It's assumed that it's js, since you're
|
||||
<ul>
|
||||
<li>Don't put "js" or "node" in the name. It's assumed that it's js, since you're
|
||||
writing a package.json file, and you can specify the engine using the "engines"
|
||||
field. (See below.)</li><li>The name ends up being part of a URL, an argument on the command line, and a
|
||||
field. (See below.)</li>
|
||||
<li>The name ends up being part of a URL, an argument on the command line, and a
|
||||
folder name. Any name with non-url-safe characters will be rejected.
|
||||
Also, it can't start with a dot or an underscore.</li><li>The name will probably be passed as an argument to require(), so it should
|
||||
be something short, but also reasonably descriptive.</li><li>You may want to check the npm registry to see if there's something by that name
|
||||
already, before you get too attached to it. http://registry.npmjs.org/</li></ul>
|
||||
|
||||
Also, it can't start with a dot or an underscore.</li>
|
||||
<li>The name will probably be passed as an argument to require(), so it should
|
||||
be something short, but also reasonably descriptive.</li>
|
||||
<li>You may want to check the npm registry to see if there's something by that name
|
||||
already, before you get too attached to it. <a href="http://registry.npmjs.org/">http://registry.npmjs.org/</a></li>
|
||||
</ul>
|
||||
<h2 id="version">version</h2>
|
||||
|
||||
<p>The <em>most</em> 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.</p>
|
||||
|
||||
<p>Version must be parseable by
|
||||
<a href="https://github.com/isaacs/node-semver">node-semver</a>, which is bundled
|
||||
with npm as a dependency. (<code>npm install semver</code> to use it yourself.)</p>
|
||||
|
||||
<p>More on version numbers and ranges at <a href="../misc/semver.html">semver(7)</a>.</p>
|
||||
|
||||
<h2 id="description">description</h2>
|
||||
|
||||
<p>Put a description in it. It's a string. This helps people discover your
|
||||
package, as it's listed in <code>npm search</code>.</p>
|
||||
|
||||
<h2 id="keywords">keywords</h2>
|
||||
|
||||
<p>Put keywords in it. It's an array of strings. This helps people
|
||||
discover your package as it's listed in <code>npm search</code>.</p>
|
||||
|
||||
<h2 id="homepage">homepage</h2>
|
||||
|
||||
<p>The url to the project homepage.</p>
|
||||
|
||||
<p><strong>NOTE</strong>: This is <em>not</em> the same as "url". If you put a "url" field,
|
||||
then the registry will think it's a redirection to your package that has
|
||||
been published somewhere else, and spit at you.</p>
|
||||
|
||||
<p>Literally. Spit. I'm so not kidding.</p>
|
||||
|
||||
<h2 id="bugs">bugs</h2>
|
||||
|
||||
<p>The url to your project's issue tracker and / or the email address to which
|
||||
issues should be reported. These are helpful for people who encounter issues
|
||||
with your package.</p>
|
||||
|
||||
<p>It should look like this:</p>
|
||||
|
||||
<pre><code>{ "url" : "http://github.com/owner/project/issues"
|
||||
, "email" : "project@hostname.com"
|
||||
}</code></pre>
|
||||
|
||||
<p>You can specify either one or both values. If you want to provide only a url,
|
||||
}
|
||||
</code></pre><p>You can specify either one or both values. If you want to provide only a url,
|
||||
you can specify the value for "bugs" as a simple string instead of an object.</p>
|
||||
|
||||
<p>If a url is provided, it will be used by the <code>npm bugs</code> command.</p>
|
||||
|
||||
<h2 id="license">license</h2>
|
||||
|
||||
<p>You should specify a license for your package so that people know how they are
|
||||
permitted to use it, and any restrictions you're placing on it.</p>
|
||||
|
||||
<p>The simplest way, assuming you're using a common license such as BSD-3-Clause
|
||||
or MIT, is to just specify the standard SPDX ID of the license you're using,
|
||||
like this:</p>
|
||||
|
||||
<pre><code>{ "license" : "BSD-3-Clause" }</code></pre>
|
||||
|
||||
<p>You can check <a href="https://spdx.org/licenses/">the full list of SPDX license IDs</a>.
|
||||
<pre><code>{ "license" : "BSD-3-Clause" }
|
||||
</code></pre><p>You can check <a href="https://spdx.org/licenses/">the full list of SPDX license IDs</a>.
|
||||
Ideally you should pick one that is
|
||||
<a href="http://opensource.org/licenses/alphabetical">OSI</a> approved.</p>
|
||||
|
||||
<p>It's also a good idea to include a LICENSE file at the top level in
|
||||
your package.</p>
|
||||
|
||||
<h2 id="people-fields-author-contributors">people fields: author, contributors</h2>
|
||||
|
||||
<p>The "author" is one person. "contributors" is an array of people. A "person"
|
||||
is an object with a "name" field and optionally "url" and "email", like this:</p>
|
||||
|
||||
<pre><code>{ "name" : "Barney Rubble"
|
||||
, "email" : "b@rubble.com"
|
||||
, "url" : "http://barnyrubble.tumblr.com/"
|
||||
}</code></pre>
|
||||
|
||||
<p>Or you can shorten that all into a single string, and npm will parse it for you:</p>
|
||||
|
||||
<pre><code>"Barney Rubble <b@rubble.com> (http://barnyrubble.tumblr.com/)</code></pre>
|
||||
|
||||
<p>Both email and url are optional either way.</p>
|
||||
|
||||
}
|
||||
</code></pre><p>Or you can shorten that all into a single string, and npm will parse it for you:</p>
|
||||
<pre><code>"Barney Rubble <b@rubble.com> (http://barnyrubble.tumblr.com/)
|
||||
</code></pre><p>Both email and url are optional either way.</p>
|
||||
<p>npm also sets a top-level "maintainers" field with your npm user info.</p>
|
||||
|
||||
<h2 id="files">files</h2>
|
||||
|
||||
<p>The "files" field is an array of files to include in your project. 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.)</p>
|
||||
|
||||
<p>You can also provide a ".npmignore" file in the root of your package,
|
||||
which will keep files from being included, even if they would be picked
|
||||
up by the files array. The ".npmignore" file works just like a
|
||||
".gitignore".</p>
|
||||
|
||||
<h2 id="main">main</h2>
|
||||
|
||||
<p>The main field is a module ID that is the primary entry point to your program.
|
||||
That is, if your package is named <code>foo</code>, and a user installs it, and then does
|
||||
<code>require("foo")</code>, then your main module's exports object will be returned.</p>
|
||||
|
||||
<p>This should be a module ID relative to the root of your package folder.</p>
|
||||
|
||||
<p>For most modules, it makes the most sense to have a main script and often not
|
||||
much else.</p>
|
||||
|
||||
<h2 id="bin">bin</h2>
|
||||
|
||||
<p>A lot of packages have one or more executable files that they'd like to
|
||||
install into the PATH. npm makes this pretty easy (in fact, it uses this
|
||||
feature to install the "npm" executable.)</p>
|
||||
|
||||
<p>To use this, supply a <code>bin</code> field in your package.json which is a map of
|
||||
command name to local file name. On install, npm will symlink that file into
|
||||
<code>prefix/bin</code> for global installs, or <code>./node_modules/.bin/</code> for local
|
||||
installs.</p>
|
||||
|
||||
<p>For example, npm has this:</p>
|
||||
|
||||
<pre><code>{ "bin" : { "npm" : "./cli.js" } }</code></pre>
|
||||
|
||||
<p>So, when you install npm, it'll create a symlink from the <code>cli.js</code> script to
|
||||
<pre><code>{ "bin" : { "npm" : "./cli.js" } }
|
||||
</code></pre><p>So, when you install npm, it'll create a symlink from the <code>cli.js</code> script to
|
||||
<code>/usr/local/bin/npm</code>.</p>
|
||||
|
||||
<p>If you have a single executable, and its name should be the name
|
||||
of the package, then you can just supply it as a string. For example:</p>
|
||||
|
||||
<pre><code>{ "name": "my-program"
|
||||
, "version": "1.2.5"
|
||||
, "bin": "./path/to/program" }</code></pre>
|
||||
|
||||
<p>would be the same as this:</p>
|
||||
|
||||
, "bin": "./path/to/program" }
|
||||
</code></pre><p>would be the same as this:</p>
|
||||
<pre><code>{ "name": "my-program"
|
||||
, "version": "1.2.5"
|
||||
, "bin" : { "my-program" : "./path/to/program" } }</code></pre>
|
||||
|
||||
<h2 id="man">man</h2>
|
||||
|
||||
, "bin" : { "my-program" : "./path/to/program" } }
|
||||
</code></pre><h2 id="man">man</h2>
|
||||
<p>Specify either a single file or an array of filenames to put in place for the
|
||||
<code>man</code> program to find.</p>
|
||||
|
||||
<p>If only a single file is provided, then it's installed such that it is the
|
||||
result from <code>man <pkgname></code>, regardless of its actual filename. For example:</p>
|
||||
|
||||
<pre><code>{ "name" : "foo"
|
||||
, "version" : "1.2.3"
|
||||
, "description" : "A packaged foo fooer for fooing foos"
|
||||
, "main" : "foo.js"
|
||||
, "man" : "./man/doc.1"
|
||||
}</code></pre>
|
||||
|
||||
<p>would link the <code>./man/doc.1</code> file in such that it is the target for <code>man foo</code></p>
|
||||
|
||||
}
|
||||
</code></pre><p>would link the <code>./man/doc.1</code> file in such that it is the target for <code>man foo</code></p>
|
||||
<p>If the filename doesn't start with the package name, then it's prefixed.
|
||||
So, this:</p>
|
||||
|
||||
<pre><code>{ "name" : "foo"
|
||||
, "version" : "1.2.3"
|
||||
, "description" : "A packaged foo fooer for fooing foos"
|
||||
, "main" : "foo.js"
|
||||
, "man" : [ "./man/foo.1", "./man/bar.1" ]
|
||||
}</code></pre>
|
||||
|
||||
<p>will create files to do <code>man foo</code> and <code>man foo-bar</code>.</p>
|
||||
|
||||
}
|
||||
</code></pre><p>will create files to do <code>man foo</code> and <code>man foo-bar</code>.</p>
|
||||
<p>Man files must end with a number, and optionally a <code>.gz</code> suffix if they are
|
||||
compressed. The number dictates which man section the file is installed into.</p>
|
||||
|
||||
<pre><code>{ "name" : "foo"
|
||||
, "version" : "1.2.3"
|
||||
, "description" : "A packaged foo fooer for fooing foos"
|
||||
, "main" : "foo.js"
|
||||
, "man" : [ "./man/foo.1", "./man/foo.2" ]
|
||||
}</code></pre>
|
||||
|
||||
<p>will create entries for <code>man foo</code> and <code>man 2 foo</code></p>
|
||||
|
||||
}
|
||||
</code></pre><p>will create entries for <code>man foo</code> and <code>man 2 foo</code></p>
|
||||
<h2 id="directories">directories</h2>
|
||||
|
||||
<p>The CommonJS <a href="http://wiki.commonjs.org/wiki/Packages/1.0">Packages</a> spec details a
|
||||
few ways that you can indicate the structure of your package using a <code>directories</code>
|
||||
hash. If you look at <a href="http://registry.npmjs.org/npm/latest">npm's package.json</a>,
|
||||
you'll see that it has directories for doc, lib, and man.</p>
|
||||
|
||||
<p>In the future, this information may be used in other creative ways.</p>
|
||||
|
||||
<h3 id="directories-lib">directories.lib</h3>
|
||||
|
||||
<p>Tell people where the bulk of your library is. Nothing special is done
|
||||
with the lib folder in any way, but it's useful meta info.</p>
|
||||
|
||||
<h3 id="directories-bin">directories.bin</h3>
|
||||
|
||||
<p>If you specify a "bin" directory, then all the files in that folder will
|
||||
be used as the "bin" hash.</p>
|
||||
|
||||
<p>If you have a "bin" hash already, then this has no effect.</p>
|
||||
|
||||
<h3 id="directories-man">directories.man</h3>
|
||||
|
||||
<p>A folder that is full of man pages. Sugar to generate a "man" array by
|
||||
walking the folder.</p>
|
||||
|
||||
<h3 id="directories-doc">directories.doc</h3>
|
||||
|
||||
<p>Put markdown files in here. Eventually, these will be displayed nicely,
|
||||
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>
|
||||
|
||||
<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>
|
||||
command will be able to find you.</p>
|
||||
|
||||
<p>Do it like this:</p>
|
||||
|
||||
<pre><code>"repository" :
|
||||
{ "type" : "git"
|
||||
, "url" : "http://github.com/npm/npm.git"
|
||||
@ -269,52 +190,52 @@ command will be able to find you.</p>
|
||||
"repository" :
|
||||
{ "type" : "svn"
|
||||
, "url" : "http://v8.googlecode.com/svn/trunk/"
|
||||
}</code></pre>
|
||||
|
||||
<p>The URL should be a publicly available (perhaps read-only) url that can be handed
|
||||
}
|
||||
</code></pre><p>The URL should be a publicly available (perhaps read-only) url that can be handed
|
||||
directly to a VCS program without any modification. It should not be a url to an
|
||||
html project page that you put in your browser. It's for computers.</p>
|
||||
|
||||
<h2 id="scripts">scripts</h2>
|
||||
|
||||
<p>The "scripts" member is an object hash of script commands that are run
|
||||
at various times in the lifecycle of your package. The key is the lifecycle
|
||||
event, and the value is the command to run at that point.</p>
|
||||
|
||||
<p>See <code><a href="../misc/npm-scripts.html">npm-scripts(7)</a></code> to find out more about writing package scripts.</p>
|
||||
|
||||
<h2 id="config">config</h2>
|
||||
|
||||
<p>A "config" hash can be used to set configuration
|
||||
parameters used in package scripts that persist across upgrades. For
|
||||
instance, if a package had the following:</p>
|
||||
|
||||
<pre><code>{ "name" : "foo"
|
||||
, "config" : { "port" : "8080" } }</code></pre>
|
||||
|
||||
<p>and then had a "start" command that then referenced the
|
||||
, "config" : { "port" : "8080" } }
|
||||
</code></pre><p>and then had a "start" command that then referenced the
|
||||
<code>npm_package_config_port</code> environment variable, then the user could
|
||||
override that by doing <code>npm config set foo:port 8001</code>.</p>
|
||||
|
||||
<p>See <code><a href="../misc/npm-config.html">npm-config(7)</a></code> and <code><a href="../misc/npm-scripts.html">npm-scripts(7)</a></code> for more on package
|
||||
configs.</p>
|
||||
|
||||
<h2 id="dependencies">dependencies</h2>
|
||||
|
||||
<p>Dependencies are specified with a simple hash of package name to
|
||||
version range. The version range is a string which has one or more
|
||||
space-separated descriptors. Dependencies can also be identified with
|
||||
a tarball or git URL.</p>
|
||||
|
||||
<p><strong>Please do not put test harnesses or transpilers in your
|
||||
<code>dependencies</code> hash.</strong> See <code>devDependencies</code>, below.</p>
|
||||
|
||||
<p>See <a href="../misc/semver.html">semver(7)</a> for more details about specifying version ranges.</p>
|
||||
|
||||
<ul><li><code>version</code> Must match <code>version</code> exactly</li><li><code>>version</code> Must be greater than <code>version</code></li><li><code>>=version</code> etc</li><li><code><version</code></li><li><code><=version</code></li><li><code>~version</code> "Approximately equivalent to version" See <a href="../misc/semver.html">semver(7)</a></li><li><code>^version</code> "Compatible with version" See <a href="../misc/semver.html">semver(7)</a></li><li><code>1.2.x</code> 1.2.0, 1.2.1, etc., but not 1.3.0</li><li><code>http://...</code> See 'URLs as Dependencies' below</li><li><code>*</code> Matches any version</li><li><code>""</code> (just an empty string) Same as <code>*</code></li><li><code>version1 - version2</code> Same as <code>>=version1 <=version2</code>.</li><li><code>range1 || range2</code> Passes if either range1 or range2 are satisfied.</li><li><code>git...</code> See 'Git URLs as Dependencies' below</li><li><code>user/repo</code> See 'GitHub URLs' below</li></ul>
|
||||
|
||||
<ul>
|
||||
<li><code>version</code> Must match <code>version</code> exactly</li>
|
||||
<li><code>>version</code> Must be greater than <code>version</code></li>
|
||||
<li><code>>=version</code> etc</li>
|
||||
<li><code><version</code></li>
|
||||
<li><code><=version</code></li>
|
||||
<li><code>~version</code> "Approximately equivalent to version" See <a href="../misc/semver.html">semver(7)</a></li>
|
||||
<li><code>^version</code> "Compatible with version" See <a href="../misc/semver.html">semver(7)</a></li>
|
||||
<li><code>1.2.x</code> 1.2.0, 1.2.1, etc., but not 1.3.0</li>
|
||||
<li><code>http://...</code> See 'URLs as Dependencies' below</li>
|
||||
<li><code>*</code> Matches any version</li>
|
||||
<li><code>""</code> (just an empty string) Same as <code>*</code></li>
|
||||
<li><code>version1 - version2</code> Same as <code>>=version1 <=version2</code>.</li>
|
||||
<li><code>range1 || range2</code> Passes if either range1 or range2 are satisfied.</li>
|
||||
<li><code>git...</code> See 'Git URLs as Dependencies' below</li>
|
||||
<li><code>user/repo</code> See 'GitHub URLs' below</li>
|
||||
</ul>
|
||||
<p>For example, these are all valid:</p>
|
||||
|
||||
<pre><code>{ "dependencies" :
|
||||
{ "foo" : "1.0.0 - 2.9999.9999"
|
||||
, "bar" : ">=1.0.2 <2.1.2"
|
||||
@ -327,59 +248,42 @@ a tarball or git URL.</p>
|
||||
, "two" : "2.x"
|
||||
, "thr" : "3.3.x"
|
||||
}
|
||||
}</code></pre>
|
||||
|
||||
<h3 id="URLs-as-Dependencies">URLs as Dependencies</h3>
|
||||
|
||||
}
|
||||
</code></pre><h3 id="urls-as-dependencies">URLs as Dependencies</h3>
|
||||
<p>You may specify a tarball URL in place of a version range.</p>
|
||||
|
||||
<p>This tarball will be downloaded and installed locally to your package at
|
||||
install time.</p>
|
||||
|
||||
<h3 id="Git-URLs-as-Dependencies">Git URLs as Dependencies</h3>
|
||||
|
||||
<h3 id="git-urls-as-dependencies">Git URLs as Dependencies</h3>
|
||||
<p>Git urls can be of the form:</p>
|
||||
|
||||
<pre><code>git://github.com/user/project.git#commit-ish
|
||||
git+ssh://user@hostname:project.git#commit-ish
|
||||
git+ssh://user@hostname/project.git#commit-ish
|
||||
git+http://user@hostname/project/blah.git#commit-ish
|
||||
git+https://user@hostname/project/blah.git#commit-ish</code></pre>
|
||||
|
||||
<p>The <code>commit-ish</code> can be any tag, sha, or branch which can be supplied as
|
||||
git+https://user@hostname/project/blah.git#commit-ish
|
||||
</code></pre><p>The <code>commit-ish</code> can be any tag, sha, or branch which can be supplied as
|
||||
an argument to <code>git checkout</code>. The default is <code>master</code>.</p>
|
||||
|
||||
<h2 id="GitHub-URLs">GitHub URLs</h2>
|
||||
|
||||
<h2 id="github-urls">GitHub URLs</h2>
|
||||
<p>As of version 1.1.65, you can refer to GitHub urls as just "foo": "user/foo-project". For example:</p>
|
||||
|
||||
<pre><code>{
|
||||
"name": "foo",
|
||||
"version": "0.0.0",
|
||||
"dependencies": {
|
||||
"express": "visionmedia/express"
|
||||
}
|
||||
}</code></pre>
|
||||
|
||||
<h2 id="devDependencies">devDependencies</h2>
|
||||
|
||||
}
|
||||
</code></pre><h2 id="devdependencies">devDependencies</h2>
|
||||
<p>If someone is planning on downloading and using your module in their
|
||||
program, then they probably don't want or need to download and build
|
||||
the external test or documentation framework that you use.</p>
|
||||
|
||||
<p>In this case, it's best to list these additional items in a
|
||||
<code>devDependencies</code> hash.</p>
|
||||
|
||||
<p>These things will be installed when doing <code>npm link</code> or <code>npm install</code>
|
||||
from the root of a package, and can be managed like any other npm
|
||||
configuration param. See <code><a href="../misc/npm-config.html">npm-config(7)</a></code> for more on the topic.</p>
|
||||
|
||||
<p>For build steps that are not platform-specific, such as compiling
|
||||
CoffeeScript or other languages to JavaScript, use the <code>prepublish</code>
|
||||
script to do this, and make the required package a devDependency.</p>
|
||||
|
||||
<p>For example:</p>
|
||||
|
||||
<pre><code>{ "name": "ethopia-waza",
|
||||
"description": "a delightfully fruity coffee varietal",
|
||||
"version": "1.2.3",
|
||||
@ -390,64 +294,48 @@ script to do this, and make the required package a devDependency.</p>
|
||||
"prepublish": "coffee -o lib/ -c src/waza.coffee"
|
||||
},
|
||||
"main": "lib/waza.js"
|
||||
}</code></pre>
|
||||
|
||||
<p>The <code>prepublish</code> script will be run before publishing, so that users
|
||||
}
|
||||
</code></pre><p>The <code>prepublish</code> script will be run before publishing, so that users
|
||||
can consume the functionality without requiring them to compile it
|
||||
themselves. In dev mode (ie, locally running <code>npm install</code>), it'll
|
||||
run this script as well, so that you can test it easily.</p>
|
||||
|
||||
<h2 id="peerDependencies">peerDependencies</h2>
|
||||
|
||||
<h2 id="peerdependencies">peerDependencies</h2>
|
||||
<p>In some cases, you want to express the compatibility of your package with an
|
||||
host tool or library, while not necessarily doing a <code>require</code> of this host.
|
||||
This is usually refered to as a <em>plugin</em>. Notably, your module may be exposing
|
||||
a specific interface, expected and specified by the host documentation.</p>
|
||||
|
||||
<p>For example:</p>
|
||||
|
||||
<pre><code>{
|
||||
"name": "tea-latte",
|
||||
"version": "1.3.5"
|
||||
"peerDependencies": {
|
||||
"tea": "2.x"
|
||||
}
|
||||
}</code></pre>
|
||||
|
||||
<p>This ensures your package <code>tea-latte</code> can be installed <em>along</em> with the second
|
||||
}
|
||||
</code></pre><p>This ensures your package <code>tea-latte</code> can be installed <em>along</em> with the second
|
||||
major version of the host package <code>tea</code> only. The host package is automatically
|
||||
installed if needed. <code>npm install tea-latte</code> could possibly yield the following
|
||||
dependency graph:</p>
|
||||
|
||||
<pre><code>├── tea-latte@1.3.5
|
||||
└── tea@2.2.0</code></pre>
|
||||
|
||||
<p>Trying to install another plugin with a conflicting requirement will cause an
|
||||
└── tea@2.2.0
|
||||
</code></pre><p>Trying to install another plugin with a conflicting requirement will cause an
|
||||
error. For this reason, make sure your plugin requirement is as broad as
|
||||
possible, and not to lock it down to specific patch versions.</p>
|
||||
|
||||
<p>Assuming the host complies with <a href="http://semver.org/">semver</a>, only changes in
|
||||
the host package's major version will break your plugin. Thus, if you've worked
|
||||
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>
|
||||
|
||||
<h2 id="bundleddependencies">bundledDependencies</h2>
|
||||
<p>Array of package names that will be bundled when publishing the package.</p>
|
||||
|
||||
<p>If this is spelled <code>"bundleDependencies"</code>, then that is also honorable.</p>
|
||||
|
||||
<h2 id="optionalDependencies">optionalDependencies</h2>
|
||||
|
||||
<h2 id="optionaldependencies">optionalDependencies</h2>
|
||||
<p>If a dependency can be used, but you would like npm to proceed if it
|
||||
cannot be found or fails to install, then you may put it in the
|
||||
<code>optionalDependencies</code> hash. This is a map of package name to version
|
||||
or url, just like the <code>dependencies</code> hash. The difference is that
|
||||
failure is tolerated.</p>
|
||||
|
||||
<p>It is still your program's responsibility to handle the lack of the
|
||||
dependency. For example, something like this:</p>
|
||||
|
||||
<pre><code>try {
|
||||
var foo = require('foo')
|
||||
var fooVersion = require('foo/package.json').version
|
||||
@ -462,122 +350,104 @@ if ( notGoodFooVersion(fooVersion) ) {
|
||||
|
||||
if (foo) {
|
||||
foo.doFooThings()
|
||||
}</code></pre>
|
||||
|
||||
<p>Entries in <code>optionalDependencies</code> will override entries of the same name in
|
||||
}
|
||||
</code></pre><p>Entries in <code>optionalDependencies</code> will override entries of the same name in
|
||||
<code>dependencies</code>, so it's usually best to only put in one place.</p>
|
||||
|
||||
<h2 id="engines">engines</h2>
|
||||
|
||||
<p>You can specify the version of node that your stuff works on:</p>
|
||||
|
||||
<pre><code>{ "engines" : { "node" : ">=0.10.3 <0.12" } }</code></pre>
|
||||
|
||||
<p>And, like with dependencies, if you don't specify the version (or if you
|
||||
<pre><code>{ "engines" : { "node" : ">=0.10.3 <0.12" } }
|
||||
</code></pre><p>And, like with dependencies, if you don't specify the version (or if you
|
||||
specify "*" as the version), then any version of node will do.</p>
|
||||
|
||||
<p>If you specify an "engines" field, then npm will require that "node" be
|
||||
somewhere on that list. If "engines" is omitted, then npm will just assume
|
||||
that it works on node.</p>
|
||||
|
||||
<p>You can also use the "engines" field to specify which versions of npm
|
||||
are capable of properly installing your program. For example:</p>
|
||||
|
||||
<pre><code>{ "engines" : { "npm" : "~1.0.20" } }</code></pre>
|
||||
|
||||
<p>Note that, unless the user has set the <code>engine-strict</code> config flag, this
|
||||
<pre><code>{ "engines" : { "npm" : "~1.0.20" } }
|
||||
</code></pre><p>Note that, unless the user has set the <code>engine-strict</code> config flag, this
|
||||
field is advisory only.</p>
|
||||
|
||||
<h2 id="engineStrict">engineStrict</h2>
|
||||
|
||||
<h2 id="enginestrict">engineStrict</h2>
|
||||
<p>If you are sure that your module will <em>definitely not</em> run properly on
|
||||
versions of Node/npm other than those specified in the <code>engines</code> hash,
|
||||
then you can set <code>"engineStrict": true</code> in your package.json file.
|
||||
This will override the user's <code>engine-strict</code> config setting.</p>
|
||||
|
||||
<p>Please do not do this unless you are really very very sure. If your
|
||||
engines hash is something overly restrictive, you can quite easily and
|
||||
inadvertently lock yourself into obscurity and prevent your users from
|
||||
updating to new versions of Node. Consider this choice carefully. If
|
||||
people abuse it, it will be removed in a future version of npm.</p>
|
||||
|
||||
<h2 id="os">os</h2>
|
||||
|
||||
<p>You can specify which operating systems your
|
||||
module will run on:</p>
|
||||
|
||||
<pre><code>"os" : [ "darwin", "linux" ]</code></pre>
|
||||
|
||||
<p>You can also blacklist instead of whitelist operating systems,
|
||||
<pre><code>"os" : [ "darwin", "linux" ]
|
||||
</code></pre><p>You can also blacklist instead of whitelist operating systems,
|
||||
just prepend the blacklisted os with a '!':</p>
|
||||
|
||||
<pre><code>"os" : [ "!win32" ]</code></pre>
|
||||
|
||||
<p>The host operating system is determined by <code>process.platform</code></p>
|
||||
|
||||
<pre><code>"os" : [ "!win32" ]
|
||||
</code></pre><p>The host operating system is determined by <code>process.platform</code></p>
|
||||
<p>It is allowed to both blacklist, and whitelist, although there isn't any
|
||||
good reason to do this.</p>
|
||||
|
||||
<h2 id="cpu">cpu</h2>
|
||||
|
||||
<p>If your code only runs on certain cpu architectures,
|
||||
you can specify which ones.</p>
|
||||
|
||||
<pre><code>"cpu" : [ "x64", "ia32" ]</code></pre>
|
||||
|
||||
<p>Like the <code>os</code> option, you can also blacklist architectures:</p>
|
||||
|
||||
<pre><code>"cpu" : [ "!arm", "!mips" ]</code></pre>
|
||||
|
||||
<p>The host architecture is determined by <code>process.arch</code></p>
|
||||
|
||||
<h2 id="preferGlobal">preferGlobal</h2>
|
||||
|
||||
<pre><code>"cpu" : [ "x64", "ia32" ]
|
||||
</code></pre><p>Like the <code>os</code> option, you can also blacklist architectures:</p>
|
||||
<pre><code>"cpu" : [ "!arm", "!mips" ]
|
||||
</code></pre><p>The host architecture is determined by <code>process.arch</code></p>
|
||||
<h2 id="preferglobal">preferGlobal</h2>
|
||||
<p>If your package is primarily a command-line application that should be
|
||||
installed globally, then set this value to <code>true</code> to provide a warning
|
||||
if it is installed locally.</p>
|
||||
|
||||
<p>It doesn't actually prevent users from installing it locally, but it
|
||||
does help prevent some confusion if it doesn't work as expected.</p>
|
||||
|
||||
<h2 id="private">private</h2>
|
||||
|
||||
<p>If you set <code>"private": true</code> in your package.json, then npm will refuse
|
||||
to publish it.</p>
|
||||
|
||||
<p>This is a way to prevent accidental publication of private repositories.
|
||||
If you would like to ensure that a given package is only ever published
|
||||
to a specific registry (for example, an internal registry),
|
||||
then use the <code>publishConfig</code> hash described below
|
||||
to override the <code>registry</code> config param at publish-time.</p>
|
||||
|
||||
<h2 id="publishConfig">publishConfig</h2>
|
||||
|
||||
<h2 id="publishconfig">publishConfig</h2>
|
||||
<p>This is a set of config values that will be used at publish-time. It's
|
||||
especially handy if you want to set the tag or registry, so that you can
|
||||
ensure that a given package is not tagged with "latest" or published to
|
||||
the global public registry by default.</p>
|
||||
|
||||
<p>Any config values can be overridden, but of course only "tag" and
|
||||
"registry" probably matter for the purposes of publishing.</p>
|
||||
|
||||
<p>See <code><a href="../misc/npm-config.html">npm-config(7)</a></code> to see the list of config options that can be
|
||||
overridden.</p>
|
||||
|
||||
<h2 id="DEFAULT-VALUES">DEFAULT VALUES</h2>
|
||||
|
||||
<h2 id="default-values">DEFAULT VALUES</h2>
|
||||
<p>npm will default some values based on package contents.</p>
|
||||
|
||||
<ul><li><p><code>"scripts": {"start": "node server.js"}</code></p><p>If there is a <code>server.js</code> file in the root of your package, then npm
|
||||
will default the <code>start</code> command to <code>node server.js</code>.</p></li><li><p><code>"scripts":{"preinstall": "node-gyp rebuild"}</code></p><p>If there is a <code>binding.gyp</code> file in the root of your package, npm will
|
||||
default the <code>preinstall</code> command to compile using node-gyp.</p></li><li><p><code>"contributors": [...]</code></p><p>If there is an <code>AUTHORS</code> file in the root of your package, npm will
|
||||
<ul>
|
||||
<li><p><code>"scripts": {"start": "node server.js"}</code></p>
|
||||
<p>If there is a <code>server.js</code> file in the root of your package, then npm
|
||||
will default the <code>start</code> command to <code>node server.js</code>.</p>
|
||||
</li>
|
||||
<li><p><code>"scripts":{"preinstall": "node-gyp rebuild"}</code></p>
|
||||
<p>If there is a <code>binding.gyp</code> file in the root of your package, npm will
|
||||
default the <code>preinstall</code> command to compile using node-gyp.</p>
|
||||
</li>
|
||||
<li><p><code>"contributors": [...]</code></p>
|
||||
<p>If there is an <code>AUTHORS</code> file in the root of your package, npm will
|
||||
treat each line as a <code>Name <email> (url)</code> format, where email and url
|
||||
are optional. Lines which start with a <code>#</code> or are blank, will be
|
||||
ignored.</p></li></ul>
|
||||
ignored.</p>
|
||||
</li>
|
||||
</ul>
|
||||
<h2 id="see-also">SEE ALSO</h2>
|
||||
<ul>
|
||||
<li><a href="../misc/semver.html">semver(7)</a></li>
|
||||
<li><a href="../cli/npm-init.html">npm-init(1)</a></li>
|
||||
<li><a href="../cli/npm-version.html">npm-version(1)</a></li>
|
||||
<li><a href="../cli/npm-config.html">npm-config(1)</a></li>
|
||||
<li><a href="../misc/npm-config.html">npm-config(7)</a></li>
|
||||
<li><a href="../cli/npm-help.html">npm-help(1)</a></li>
|
||||
<li><a href="../misc/npm-faq.html">npm-faq(7)</a></li>
|
||||
<li><a href="../cli/npm-install.html">npm-install(1)</a></li>
|
||||
<li><a href="../cli/npm-publish.html">npm-publish(1)</a></li>
|
||||
<li><a href="../cli/npm-rm.html">npm-rm(1)</a></li>
|
||||
</ul>
|
||||
|
||||
<h2 id="SEE-ALSO">SEE ALSO</h2>
|
||||
|
||||
<ul><li><a href="../misc/semver.html">semver(7)</a></li><li><a href="../cli/npm-init.html">npm-init(1)</a></li><li><a href="../cli/npm-version.html">npm-version(1)</a></li><li><a href="../cli/npm-config.html">npm-config(1)</a></li><li><a href="../misc/npm-config.html">npm-config(7)</a></li><li><a href="../cli/npm-help.html">npm-help(1)</a></li><li><a href="../misc/npm-faq.html">npm-faq(7)</a></li><li><a href="../cli/npm-install.html">npm-install(1)</a></li><li><a href="../cli/npm-publish.html">npm-publish(1)</a></li><li><a href="../cli/npm-rm.html">npm-rm(1)</a></li></ul>
|
||||
</div>
|
||||
|
||||
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
|
||||
@ -589,5 +459,5 @@ ignored.</p></li></ul>
|
||||
<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@1.4.9</p>
|
||||
<p id="footer">package.json — npm@1.4.10</p>
|
||||
|
||||
|
||||
50
deps/npm/html/doc/files/npmrc.html
vendored
50
deps/npm/html/doc/files/npmrc.html
vendored
@ -10,57 +10,49 @@
|
||||
<div id="wrapper">
|
||||
|
||||
<h1><a href="../files/npmrc.html">npmrc</a></h1> <p>The npm config files</p>
|
||||
|
||||
<h2 id="DESCRIPTION">DESCRIPTION</h2>
|
||||
|
||||
<h2 id="description">DESCRIPTION</h2>
|
||||
<p>npm gets its config settings from the command line, environment
|
||||
variables, and <code>npmrc</code> files.</p>
|
||||
|
||||
<p>The <code>npm config</code> command can be used to update and edit the contents
|
||||
of the user and global npmrc files.</p>
|
||||
|
||||
<p>For a list of available configuration options, see <a href="../misc/npm-config.html">npm-config(7)</a>.</p>
|
||||
|
||||
<h2 id="FILES">FILES</h2>
|
||||
|
||||
<h2 id="files">FILES</h2>
|
||||
<p>The three relevant files are:</p>
|
||||
|
||||
<ul><li>per-user config file (~/.npmrc)</li><li>global config file ($PREFIX/npmrc)</li><li>npm builtin config file (/path/to/npm/npmrc)</li></ul>
|
||||
|
||||
<ul>
|
||||
<li>per-user config file (~/.npmrc)</li>
|
||||
<li>global config file ($PREFIX/npmrc)</li>
|
||||
<li>npm builtin config file (/path/to/npm/npmrc)</li>
|
||||
</ul>
|
||||
<p>All npm config files are an ini-formatted list of <code>key = value</code>
|
||||
parameters. Environment variables can be replaced using
|
||||
<code>${VARIABLE_NAME}</code>. For example:</p>
|
||||
|
||||
<pre><code>prefix = ${HOME}/.npm-packages</code></pre>
|
||||
|
||||
<p>Each of these files is loaded, and config options are resolved in
|
||||
<pre><code>prefix = ${HOME}/.npm-packages
|
||||
</code></pre><p>Each of these files is loaded, and config options are resolved in
|
||||
priority order. For example, a setting in the userconfig file would
|
||||
override the setting in the globalconfig file.</p>
|
||||
|
||||
<h3 id="Per-user-config-file">Per-user config file</h3>
|
||||
|
||||
<h3 id="per-user-config-file">Per-user config file</h3>
|
||||
<p><code>$HOME/.npmrc</code> (or the <code>userconfig</code> param, if set in the environment
|
||||
or on the command line)</p>
|
||||
|
||||
<h3 id="Global-config-file">Global config file</h3>
|
||||
|
||||
<h3 id="global-config-file">Global config file</h3>
|
||||
<p><code>$PREFIX/etc/npmrc</code> (or the <code>globalconfig</code> param, if set above):
|
||||
This file is an ini-file formatted list of <code>key = value</code> parameters.
|
||||
Environment variables can be replaced as above.</p>
|
||||
|
||||
<h3 id="Built-in-config-file">Built-in config file</h3>
|
||||
|
||||
<h3 id="built-in-config-file">Built-in config file</h3>
|
||||
<p><code>path/to/npm/itself/npmrc</code></p>
|
||||
|
||||
<p>This is an unchangeable "builtin" configuration file that npm keeps
|
||||
consistent across updates. Set fields in here using the <code>./configure</code>
|
||||
script that comes with npm. This is primarily for distribution
|
||||
maintainers to override default configs in a standard and consistent
|
||||
manner.</p>
|
||||
<h2 id="see-also">SEE ALSO</h2>
|
||||
<ul>
|
||||
<li><a href="../files/npm-folders.html">npm-folders(5)</a></li>
|
||||
<li><a href="../cli/npm-config.html">npm-config(1)</a></li>
|
||||
<li><a href="../misc/npm-config.html">npm-config(7)</a></li>
|
||||
<li><a href="../files/package.json.html">package.json(5)</a></li>
|
||||
<li><a href="../cli/npm.html">npm(1)</a></li>
|
||||
</ul>
|
||||
|
||||
<h2 id="SEE-ALSO">SEE ALSO</h2>
|
||||
|
||||
<ul><li><a href="../files/npm-folders.html">npm-folders(5)</a></li><li><a href="../cli/npm-config.html">npm-config(1)</a></li><li><a href="../misc/npm-config.html">npm-config(7)</a></li><li><a href="../files/package.json.html">package.json(5)</a></li><li><a href="../cli/npm.html">npm(1)</a></li></ul>
|
||||
</div>
|
||||
|
||||
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
|
||||
@ -72,5 +64,5 @@ manner.</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">npmrc — npm@1.4.9</p>
|
||||
<p id="footer">npmrc — npm@1.4.10</p>
|
||||
|
||||
|
||||
360
deps/npm/html/doc/files/package.json.html
vendored
360
deps/npm/html/doc/files/package.json.html
vendored
@ -10,257 +10,178 @@
|
||||
<div id="wrapper">
|
||||
|
||||
<h1><a href="../files/package.json.html">package.json</a></h1> <p>Specifics of npm's package.json handling</p>
|
||||
|
||||
<h2 id="DESCRIPTION">DESCRIPTION</h2>
|
||||
|
||||
<h2 id="description">DESCRIPTION</h2>
|
||||
<p>This document is all you need to know about what's required in your package.json
|
||||
file. It must be actual JSON, not just a JavaScript object literal.</p>
|
||||
|
||||
<p>A lot of the behavior described in this document is affected by the config
|
||||
settings described in <code><a href="../misc/npm-config.html">npm-config(7)</a></code>.</p>
|
||||
|
||||
<h2 id="name">name</h2>
|
||||
|
||||
<p>The <em>most</em> 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.</p>
|
||||
|
||||
<p>The name is what your thing is called. Some tips:</p>
|
||||
|
||||
<ul><li>Don't put "js" or "node" in the name. It's assumed that it's js, since you're
|
||||
<ul>
|
||||
<li>Don't put "js" or "node" in the name. It's assumed that it's js, since you're
|
||||
writing a package.json file, and you can specify the engine using the "engines"
|
||||
field. (See below.)</li><li>The name ends up being part of a URL, an argument on the command line, and a
|
||||
field. (See below.)</li>
|
||||
<li>The name ends up being part of a URL, an argument on the command line, and a
|
||||
folder name. Any name with non-url-safe characters will be rejected.
|
||||
Also, it can't start with a dot or an underscore.</li><li>The name will probably be passed as an argument to require(), so it should
|
||||
be something short, but also reasonably descriptive.</li><li>You may want to check the npm registry to see if there's something by that name
|
||||
already, before you get too attached to it. http://registry.npmjs.org/</li></ul>
|
||||
|
||||
Also, it can't start with a dot or an underscore.</li>
|
||||
<li>The name will probably be passed as an argument to require(), so it should
|
||||
be something short, but also reasonably descriptive.</li>
|
||||
<li>You may want to check the npm registry to see if there's something by that name
|
||||
already, before you get too attached to it. <a href="http://registry.npmjs.org/">http://registry.npmjs.org/</a></li>
|
||||
</ul>
|
||||
<h2 id="version">version</h2>
|
||||
|
||||
<p>The <em>most</em> 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.</p>
|
||||
|
||||
<p>Version must be parseable by
|
||||
<a href="https://github.com/isaacs/node-semver">node-semver</a>, which is bundled
|
||||
with npm as a dependency. (<code>npm install semver</code> to use it yourself.)</p>
|
||||
|
||||
<p>More on version numbers and ranges at <a href="../misc/semver.html">semver(7)</a>.</p>
|
||||
|
||||
<h2 id="description">description</h2>
|
||||
|
||||
<p>Put a description in it. It's a string. This helps people discover your
|
||||
package, as it's listed in <code>npm search</code>.</p>
|
||||
|
||||
<h2 id="keywords">keywords</h2>
|
||||
|
||||
<p>Put keywords in it. It's an array of strings. This helps people
|
||||
discover your package as it's listed in <code>npm search</code>.</p>
|
||||
|
||||
<h2 id="homepage">homepage</h2>
|
||||
|
||||
<p>The url to the project homepage.</p>
|
||||
|
||||
<p><strong>NOTE</strong>: This is <em>not</em> the same as "url". If you put a "url" field,
|
||||
then the registry will think it's a redirection to your package that has
|
||||
been published somewhere else, and spit at you.</p>
|
||||
|
||||
<p>Literally. Spit. I'm so not kidding.</p>
|
||||
|
||||
<h2 id="bugs">bugs</h2>
|
||||
|
||||
<p>The url to your project's issue tracker and / or the email address to which
|
||||
issues should be reported. These are helpful for people who encounter issues
|
||||
with your package.</p>
|
||||
|
||||
<p>It should look like this:</p>
|
||||
|
||||
<pre><code>{ "url" : "http://github.com/owner/project/issues"
|
||||
, "email" : "project@hostname.com"
|
||||
}</code></pre>
|
||||
|
||||
<p>You can specify either one or both values. If you want to provide only a url,
|
||||
}
|
||||
</code></pre><p>You can specify either one or both values. If you want to provide only a url,
|
||||
you can specify the value for "bugs" as a simple string instead of an object.</p>
|
||||
|
||||
<p>If a url is provided, it will be used by the <code>npm bugs</code> command.</p>
|
||||
|
||||
<h2 id="license">license</h2>
|
||||
|
||||
<p>You should specify a license for your package so that people know how they are
|
||||
permitted to use it, and any restrictions you're placing on it.</p>
|
||||
|
||||
<p>The simplest way, assuming you're using a common license such as BSD-3-Clause
|
||||
or MIT, is to just specify the standard SPDX ID of the license you're using,
|
||||
like this:</p>
|
||||
|
||||
<pre><code>{ "license" : "BSD-3-Clause" }</code></pre>
|
||||
|
||||
<p>You can check <a href="https://spdx.org/licenses/">the full list of SPDX license IDs</a>.
|
||||
<pre><code>{ "license" : "BSD-3-Clause" }
|
||||
</code></pre><p>You can check <a href="https://spdx.org/licenses/">the full list of SPDX license IDs</a>.
|
||||
Ideally you should pick one that is
|
||||
<a href="http://opensource.org/licenses/alphabetical">OSI</a> approved.</p>
|
||||
|
||||
<p>It's also a good idea to include a LICENSE file at the top level in
|
||||
your package.</p>
|
||||
|
||||
<h2 id="people-fields-author-contributors">people fields: author, contributors</h2>
|
||||
|
||||
<p>The "author" is one person. "contributors" is an array of people. A "person"
|
||||
is an object with a "name" field and optionally "url" and "email", like this:</p>
|
||||
|
||||
<pre><code>{ "name" : "Barney Rubble"
|
||||
, "email" : "b@rubble.com"
|
||||
, "url" : "http://barnyrubble.tumblr.com/"
|
||||
}</code></pre>
|
||||
|
||||
<p>Or you can shorten that all into a single string, and npm will parse it for you:</p>
|
||||
|
||||
<pre><code>"Barney Rubble <b@rubble.com> (http://barnyrubble.tumblr.com/)</code></pre>
|
||||
|
||||
<p>Both email and url are optional either way.</p>
|
||||
|
||||
}
|
||||
</code></pre><p>Or you can shorten that all into a single string, and npm will parse it for you:</p>
|
||||
<pre><code>"Barney Rubble <b@rubble.com> (http://barnyrubble.tumblr.com/)
|
||||
</code></pre><p>Both email and url are optional either way.</p>
|
||||
<p>npm also sets a top-level "maintainers" field with your npm user info.</p>
|
||||
|
||||
<h2 id="files">files</h2>
|
||||
|
||||
<p>The "files" field is an array of files to include in your project. 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.)</p>
|
||||
|
||||
<p>You can also provide a ".npmignore" file in the root of your package,
|
||||
which will keep files from being included, even if they would be picked
|
||||
up by the files array. The ".npmignore" file works just like a
|
||||
".gitignore".</p>
|
||||
|
||||
<h2 id="main">main</h2>
|
||||
|
||||
<p>The main field is a module ID that is the primary entry point to your program.
|
||||
That is, if your package is named <code>foo</code>, and a user installs it, and then does
|
||||
<code>require("foo")</code>, then your main module's exports object will be returned.</p>
|
||||
|
||||
<p>This should be a module ID relative to the root of your package folder.</p>
|
||||
|
||||
<p>For most modules, it makes the most sense to have a main script and often not
|
||||
much else.</p>
|
||||
|
||||
<h2 id="bin">bin</h2>
|
||||
|
||||
<p>A lot of packages have one or more executable files that they'd like to
|
||||
install into the PATH. npm makes this pretty easy (in fact, it uses this
|
||||
feature to install the "npm" executable.)</p>
|
||||
|
||||
<p>To use this, supply a <code>bin</code> field in your package.json which is a map of
|
||||
command name to local file name. On install, npm will symlink that file into
|
||||
<code>prefix/bin</code> for global installs, or <code>./node_modules/.bin/</code> for local
|
||||
installs.</p>
|
||||
|
||||
<p>For example, npm has this:</p>
|
||||
|
||||
<pre><code>{ "bin" : { "npm" : "./cli.js" } }</code></pre>
|
||||
|
||||
<p>So, when you install npm, it'll create a symlink from the <code>cli.js</code> script to
|
||||
<pre><code>{ "bin" : { "npm" : "./cli.js" } }
|
||||
</code></pre><p>So, when you install npm, it'll create a symlink from the <code>cli.js</code> script to
|
||||
<code>/usr/local/bin/npm</code>.</p>
|
||||
|
||||
<p>If you have a single executable, and its name should be the name
|
||||
of the package, then you can just supply it as a string. For example:</p>
|
||||
|
||||
<pre><code>{ "name": "my-program"
|
||||
, "version": "1.2.5"
|
||||
, "bin": "./path/to/program" }</code></pre>
|
||||
|
||||
<p>would be the same as this:</p>
|
||||
|
||||
, "bin": "./path/to/program" }
|
||||
</code></pre><p>would be the same as this:</p>
|
||||
<pre><code>{ "name": "my-program"
|
||||
, "version": "1.2.5"
|
||||
, "bin" : { "my-program" : "./path/to/program" } }</code></pre>
|
||||
|
||||
<h2 id="man">man</h2>
|
||||
|
||||
, "bin" : { "my-program" : "./path/to/program" } }
|
||||
</code></pre><h2 id="man">man</h2>
|
||||
<p>Specify either a single file or an array of filenames to put in place for the
|
||||
<code>man</code> program to find.</p>
|
||||
|
||||
<p>If only a single file is provided, then it's installed such that it is the
|
||||
result from <code>man <pkgname></code>, regardless of its actual filename. For example:</p>
|
||||
|
||||
<pre><code>{ "name" : "foo"
|
||||
, "version" : "1.2.3"
|
||||
, "description" : "A packaged foo fooer for fooing foos"
|
||||
, "main" : "foo.js"
|
||||
, "man" : "./man/doc.1"
|
||||
}</code></pre>
|
||||
|
||||
<p>would link the <code>./man/doc.1</code> file in such that it is the target for <code>man foo</code></p>
|
||||
|
||||
}
|
||||
</code></pre><p>would link the <code>./man/doc.1</code> file in such that it is the target for <code>man foo</code></p>
|
||||
<p>If the filename doesn't start with the package name, then it's prefixed.
|
||||
So, this:</p>
|
||||
|
||||
<pre><code>{ "name" : "foo"
|
||||
, "version" : "1.2.3"
|
||||
, "description" : "A packaged foo fooer for fooing foos"
|
||||
, "main" : "foo.js"
|
||||
, "man" : [ "./man/foo.1", "./man/bar.1" ]
|
||||
}</code></pre>
|
||||
|
||||
<p>will create files to do <code>man foo</code> and <code>man foo-bar</code>.</p>
|
||||
|
||||
}
|
||||
</code></pre><p>will create files to do <code>man foo</code> and <code>man foo-bar</code>.</p>
|
||||
<p>Man files must end with a number, and optionally a <code>.gz</code> suffix if they are
|
||||
compressed. The number dictates which man section the file is installed into.</p>
|
||||
|
||||
<pre><code>{ "name" : "foo"
|
||||
, "version" : "1.2.3"
|
||||
, "description" : "A packaged foo fooer for fooing foos"
|
||||
, "main" : "foo.js"
|
||||
, "man" : [ "./man/foo.1", "./man/foo.2" ]
|
||||
}</code></pre>
|
||||
|
||||
<p>will create entries for <code>man foo</code> and <code>man 2 foo</code></p>
|
||||
|
||||
}
|
||||
</code></pre><p>will create entries for <code>man foo</code> and <code>man 2 foo</code></p>
|
||||
<h2 id="directories">directories</h2>
|
||||
|
||||
<p>The CommonJS <a href="http://wiki.commonjs.org/wiki/Packages/1.0">Packages</a> spec details a
|
||||
few ways that you can indicate the structure of your package using a <code>directories</code>
|
||||
hash. If you look at <a href="http://registry.npmjs.org/npm/latest">npm's package.json</a>,
|
||||
you'll see that it has directories for doc, lib, and man.</p>
|
||||
|
||||
<p>In the future, this information may be used in other creative ways.</p>
|
||||
|
||||
<h3 id="directories-lib">directories.lib</h3>
|
||||
|
||||
<p>Tell people where the bulk of your library is. Nothing special is done
|
||||
with the lib folder in any way, but it's useful meta info.</p>
|
||||
|
||||
<h3 id="directories-bin">directories.bin</h3>
|
||||
|
||||
<p>If you specify a "bin" directory, then all the files in that folder will
|
||||
be used as the "bin" hash.</p>
|
||||
|
||||
<p>If you have a "bin" hash already, then this has no effect.</p>
|
||||
|
||||
<h3 id="directories-man">directories.man</h3>
|
||||
|
||||
<p>A folder that is full of man pages. Sugar to generate a "man" array by
|
||||
walking the folder.</p>
|
||||
|
||||
<h3 id="directories-doc">directories.doc</h3>
|
||||
|
||||
<p>Put markdown files in here. Eventually, these will be displayed nicely,
|
||||
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>
|
||||
|
||||
<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>
|
||||
command will be able to find you.</p>
|
||||
|
||||
<p>Do it like this:</p>
|
||||
|
||||
<pre><code>"repository" :
|
||||
{ "type" : "git"
|
||||
, "url" : "http://github.com/npm/npm.git"
|
||||
@ -269,52 +190,52 @@ command will be able to find you.</p>
|
||||
"repository" :
|
||||
{ "type" : "svn"
|
||||
, "url" : "http://v8.googlecode.com/svn/trunk/"
|
||||
}</code></pre>
|
||||
|
||||
<p>The URL should be a publicly available (perhaps read-only) url that can be handed
|
||||
}
|
||||
</code></pre><p>The URL should be a publicly available (perhaps read-only) url that can be handed
|
||||
directly to a VCS program without any modification. It should not be a url to an
|
||||
html project page that you put in your browser. It's for computers.</p>
|
||||
|
||||
<h2 id="scripts">scripts</h2>
|
||||
|
||||
<p>The "scripts" member is an object hash of script commands that are run
|
||||
at various times in the lifecycle of your package. The key is the lifecycle
|
||||
event, and the value is the command to run at that point.</p>
|
||||
|
||||
<p>See <code><a href="../misc/npm-scripts.html">npm-scripts(7)</a></code> to find out more about writing package scripts.</p>
|
||||
|
||||
<h2 id="config">config</h2>
|
||||
|
||||
<p>A "config" hash can be used to set configuration
|
||||
parameters used in package scripts that persist across upgrades. For
|
||||
instance, if a package had the following:</p>
|
||||
|
||||
<pre><code>{ "name" : "foo"
|
||||
, "config" : { "port" : "8080" } }</code></pre>
|
||||
|
||||
<p>and then had a "start" command that then referenced the
|
||||
, "config" : { "port" : "8080" } }
|
||||
</code></pre><p>and then had a "start" command that then referenced the
|
||||
<code>npm_package_config_port</code> environment variable, then the user could
|
||||
override that by doing <code>npm config set foo:port 8001</code>.</p>
|
||||
|
||||
<p>See <code><a href="../misc/npm-config.html">npm-config(7)</a></code> and <code><a href="../misc/npm-scripts.html">npm-scripts(7)</a></code> for more on package
|
||||
configs.</p>
|
||||
|
||||
<h2 id="dependencies">dependencies</h2>
|
||||
|
||||
<p>Dependencies are specified with a simple hash of package name to
|
||||
version range. The version range is a string which has one or more
|
||||
space-separated descriptors. Dependencies can also be identified with
|
||||
a tarball or git URL.</p>
|
||||
|
||||
<p><strong>Please do not put test harnesses or transpilers in your
|
||||
<code>dependencies</code> hash.</strong> See <code>devDependencies</code>, below.</p>
|
||||
|
||||
<p>See <a href="../misc/semver.html">semver(7)</a> for more details about specifying version ranges.</p>
|
||||
|
||||
<ul><li><code>version</code> Must match <code>version</code> exactly</li><li><code>>version</code> Must be greater than <code>version</code></li><li><code>>=version</code> etc</li><li><code><version</code></li><li><code><=version</code></li><li><code>~version</code> "Approximately equivalent to version" See <a href="../misc/semver.html">semver(7)</a></li><li><code>^version</code> "Compatible with version" See <a href="../misc/semver.html">semver(7)</a></li><li><code>1.2.x</code> 1.2.0, 1.2.1, etc., but not 1.3.0</li><li><code>http://...</code> See 'URLs as Dependencies' below</li><li><code>*</code> Matches any version</li><li><code>""</code> (just an empty string) Same as <code>*</code></li><li><code>version1 - version2</code> Same as <code>>=version1 <=version2</code>.</li><li><code>range1 || range2</code> Passes if either range1 or range2 are satisfied.</li><li><code>git...</code> See 'Git URLs as Dependencies' below</li><li><code>user/repo</code> See 'GitHub URLs' below</li></ul>
|
||||
|
||||
<ul>
|
||||
<li><code>version</code> Must match <code>version</code> exactly</li>
|
||||
<li><code>>version</code> Must be greater than <code>version</code></li>
|
||||
<li><code>>=version</code> etc</li>
|
||||
<li><code><version</code></li>
|
||||
<li><code><=version</code></li>
|
||||
<li><code>~version</code> "Approximately equivalent to version" See <a href="../misc/semver.html">semver(7)</a></li>
|
||||
<li><code>^version</code> "Compatible with version" See <a href="../misc/semver.html">semver(7)</a></li>
|
||||
<li><code>1.2.x</code> 1.2.0, 1.2.1, etc., but not 1.3.0</li>
|
||||
<li><code>http://...</code> See 'URLs as Dependencies' below</li>
|
||||
<li><code>*</code> Matches any version</li>
|
||||
<li><code>""</code> (just an empty string) Same as <code>*</code></li>
|
||||
<li><code>version1 - version2</code> Same as <code>>=version1 <=version2</code>.</li>
|
||||
<li><code>range1 || range2</code> Passes if either range1 or range2 are satisfied.</li>
|
||||
<li><code>git...</code> See 'Git URLs as Dependencies' below</li>
|
||||
<li><code>user/repo</code> See 'GitHub URLs' below</li>
|
||||
</ul>
|
||||
<p>For example, these are all valid:</p>
|
||||
|
||||
<pre><code>{ "dependencies" :
|
||||
{ "foo" : "1.0.0 - 2.9999.9999"
|
||||
, "bar" : ">=1.0.2 <2.1.2"
|
||||
@ -327,59 +248,42 @@ a tarball or git URL.</p>
|
||||
, "two" : "2.x"
|
||||
, "thr" : "3.3.x"
|
||||
}
|
||||
}</code></pre>
|
||||
|
||||
<h3 id="URLs-as-Dependencies">URLs as Dependencies</h3>
|
||||
|
||||
}
|
||||
</code></pre><h3 id="urls-as-dependencies">URLs as Dependencies</h3>
|
||||
<p>You may specify a tarball URL in place of a version range.</p>
|
||||
|
||||
<p>This tarball will be downloaded and installed locally to your package at
|
||||
install time.</p>
|
||||
|
||||
<h3 id="Git-URLs-as-Dependencies">Git URLs as Dependencies</h3>
|
||||
|
||||
<h3 id="git-urls-as-dependencies">Git URLs as Dependencies</h3>
|
||||
<p>Git urls can be of the form:</p>
|
||||
|
||||
<pre><code>git://github.com/user/project.git#commit-ish
|
||||
git+ssh://user@hostname:project.git#commit-ish
|
||||
git+ssh://user@hostname/project.git#commit-ish
|
||||
git+http://user@hostname/project/blah.git#commit-ish
|
||||
git+https://user@hostname/project/blah.git#commit-ish</code></pre>
|
||||
|
||||
<p>The <code>commit-ish</code> can be any tag, sha, or branch which can be supplied as
|
||||
git+https://user@hostname/project/blah.git#commit-ish
|
||||
</code></pre><p>The <code>commit-ish</code> can be any tag, sha, or branch which can be supplied as
|
||||
an argument to <code>git checkout</code>. The default is <code>master</code>.</p>
|
||||
|
||||
<h2 id="GitHub-URLs">GitHub URLs</h2>
|
||||
|
||||
<h2 id="github-urls">GitHub URLs</h2>
|
||||
<p>As of version 1.1.65, you can refer to GitHub urls as just "foo": "user/foo-project". For example:</p>
|
||||
|
||||
<pre><code>{
|
||||
"name": "foo",
|
||||
"version": "0.0.0",
|
||||
"dependencies": {
|
||||
"express": "visionmedia/express"
|
||||
}
|
||||
}</code></pre>
|
||||
|
||||
<h2 id="devDependencies">devDependencies</h2>
|
||||
|
||||
}
|
||||
</code></pre><h2 id="devdependencies">devDependencies</h2>
|
||||
<p>If someone is planning on downloading and using your module in their
|
||||
program, then they probably don't want or need to download and build
|
||||
the external test or documentation framework that you use.</p>
|
||||
|
||||
<p>In this case, it's best to list these additional items in a
|
||||
<code>devDependencies</code> hash.</p>
|
||||
|
||||
<p>These things will be installed when doing <code>npm link</code> or <code>npm install</code>
|
||||
from the root of a package, and can be managed like any other npm
|
||||
configuration param. See <code><a href="../misc/npm-config.html">npm-config(7)</a></code> for more on the topic.</p>
|
||||
|
||||
<p>For build steps that are not platform-specific, such as compiling
|
||||
CoffeeScript or other languages to JavaScript, use the <code>prepublish</code>
|
||||
script to do this, and make the required package a devDependency.</p>
|
||||
|
||||
<p>For example:</p>
|
||||
|
||||
<pre><code>{ "name": "ethopia-waza",
|
||||
"description": "a delightfully fruity coffee varietal",
|
||||
"version": "1.2.3",
|
||||
@ -390,64 +294,48 @@ script to do this, and make the required package a devDependency.</p>
|
||||
"prepublish": "coffee -o lib/ -c src/waza.coffee"
|
||||
},
|
||||
"main": "lib/waza.js"
|
||||
}</code></pre>
|
||||
|
||||
<p>The <code>prepublish</code> script will be run before publishing, so that users
|
||||
}
|
||||
</code></pre><p>The <code>prepublish</code> script will be run before publishing, so that users
|
||||
can consume the functionality without requiring them to compile it
|
||||
themselves. In dev mode (ie, locally running <code>npm install</code>), it'll
|
||||
run this script as well, so that you can test it easily.</p>
|
||||
|
||||
<h2 id="peerDependencies">peerDependencies</h2>
|
||||
|
||||
<h2 id="peerdependencies">peerDependencies</h2>
|
||||
<p>In some cases, you want to express the compatibility of your package with an
|
||||
host tool or library, while not necessarily doing a <code>require</code> of this host.
|
||||
This is usually refered to as a <em>plugin</em>. Notably, your module may be exposing
|
||||
a specific interface, expected and specified by the host documentation.</p>
|
||||
|
||||
<p>For example:</p>
|
||||
|
||||
<pre><code>{
|
||||
"name": "tea-latte",
|
||||
"version": "1.3.5"
|
||||
"peerDependencies": {
|
||||
"tea": "2.x"
|
||||
}
|
||||
}</code></pre>
|
||||
|
||||
<p>This ensures your package <code>tea-latte</code> can be installed <em>along</em> with the second
|
||||
}
|
||||
</code></pre><p>This ensures your package <code>tea-latte</code> can be installed <em>along</em> with the second
|
||||
major version of the host package <code>tea</code> only. The host package is automatically
|
||||
installed if needed. <code>npm install tea-latte</code> could possibly yield the following
|
||||
dependency graph:</p>
|
||||
|
||||
<pre><code>├── tea-latte@1.3.5
|
||||
└── tea@2.2.0</code></pre>
|
||||
|
||||
<p>Trying to install another plugin with a conflicting requirement will cause an
|
||||
└── tea@2.2.0
|
||||
</code></pre><p>Trying to install another plugin with a conflicting requirement will cause an
|
||||
error. For this reason, make sure your plugin requirement is as broad as
|
||||
possible, and not to lock it down to specific patch versions.</p>
|
||||
|
||||
<p>Assuming the host complies with <a href="http://semver.org/">semver</a>, only changes in
|
||||
the host package's major version will break your plugin. Thus, if you've worked
|
||||
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>
|
||||
|
||||
<h2 id="bundleddependencies">bundledDependencies</h2>
|
||||
<p>Array of package names that will be bundled when publishing the package.</p>
|
||||
|
||||
<p>If this is spelled <code>"bundleDependencies"</code>, then that is also honorable.</p>
|
||||
|
||||
<h2 id="optionalDependencies">optionalDependencies</h2>
|
||||
|
||||
<h2 id="optionaldependencies">optionalDependencies</h2>
|
||||
<p>If a dependency can be used, but you would like npm to proceed if it
|
||||
cannot be found or fails to install, then you may put it in the
|
||||
<code>optionalDependencies</code> hash. This is a map of package name to version
|
||||
or url, just like the <code>dependencies</code> hash. The difference is that
|
||||
failure is tolerated.</p>
|
||||
|
||||
<p>It is still your program's responsibility to handle the lack of the
|
||||
dependency. For example, something like this:</p>
|
||||
|
||||
<pre><code>try {
|
||||
var foo = require('foo')
|
||||
var fooVersion = require('foo/package.json').version
|
||||
@ -462,122 +350,104 @@ if ( notGoodFooVersion(fooVersion) ) {
|
||||
|
||||
if (foo) {
|
||||
foo.doFooThings()
|
||||
}</code></pre>
|
||||
|
||||
<p>Entries in <code>optionalDependencies</code> will override entries of the same name in
|
||||
}
|
||||
</code></pre><p>Entries in <code>optionalDependencies</code> will override entries of the same name in
|
||||
<code>dependencies</code>, so it's usually best to only put in one place.</p>
|
||||
|
||||
<h2 id="engines">engines</h2>
|
||||
|
||||
<p>You can specify the version of node that your stuff works on:</p>
|
||||
|
||||
<pre><code>{ "engines" : { "node" : ">=0.10.3 <0.12" } }</code></pre>
|
||||
|
||||
<p>And, like with dependencies, if you don't specify the version (or if you
|
||||
<pre><code>{ "engines" : { "node" : ">=0.10.3 <0.12" } }
|
||||
</code></pre><p>And, like with dependencies, if you don't specify the version (or if you
|
||||
specify "*" as the version), then any version of node will do.</p>
|
||||
|
||||
<p>If you specify an "engines" field, then npm will require that "node" be
|
||||
somewhere on that list. If "engines" is omitted, then npm will just assume
|
||||
that it works on node.</p>
|
||||
|
||||
<p>You can also use the "engines" field to specify which versions of npm
|
||||
are capable of properly installing your program. For example:</p>
|
||||
|
||||
<pre><code>{ "engines" : { "npm" : "~1.0.20" } }</code></pre>
|
||||
|
||||
<p>Note that, unless the user has set the <code>engine-strict</code> config flag, this
|
||||
<pre><code>{ "engines" : { "npm" : "~1.0.20" } }
|
||||
</code></pre><p>Note that, unless the user has set the <code>engine-strict</code> config flag, this
|
||||
field is advisory only.</p>
|
||||
|
||||
<h2 id="engineStrict">engineStrict</h2>
|
||||
|
||||
<h2 id="enginestrict">engineStrict</h2>
|
||||
<p>If you are sure that your module will <em>definitely not</em> run properly on
|
||||
versions of Node/npm other than those specified in the <code>engines</code> hash,
|
||||
then you can set <code>"engineStrict": true</code> in your package.json file.
|
||||
This will override the user's <code>engine-strict</code> config setting.</p>
|
||||
|
||||
<p>Please do not do this unless you are really very very sure. If your
|
||||
engines hash is something overly restrictive, you can quite easily and
|
||||
inadvertently lock yourself into obscurity and prevent your users from
|
||||
updating to new versions of Node. Consider this choice carefully. If
|
||||
people abuse it, it will be removed in a future version of npm.</p>
|
||||
|
||||
<h2 id="os">os</h2>
|
||||
|
||||
<p>You can specify which operating systems your
|
||||
module will run on:</p>
|
||||
|
||||
<pre><code>"os" : [ "darwin", "linux" ]</code></pre>
|
||||
|
||||
<p>You can also blacklist instead of whitelist operating systems,
|
||||
<pre><code>"os" : [ "darwin", "linux" ]
|
||||
</code></pre><p>You can also blacklist instead of whitelist operating systems,
|
||||
just prepend the blacklisted os with a '!':</p>
|
||||
|
||||
<pre><code>"os" : [ "!win32" ]</code></pre>
|
||||
|
||||
<p>The host operating system is determined by <code>process.platform</code></p>
|
||||
|
||||
<pre><code>"os" : [ "!win32" ]
|
||||
</code></pre><p>The host operating system is determined by <code>process.platform</code></p>
|
||||
<p>It is allowed to both blacklist, and whitelist, although there isn't any
|
||||
good reason to do this.</p>
|
||||
|
||||
<h2 id="cpu">cpu</h2>
|
||||
|
||||
<p>If your code only runs on certain cpu architectures,
|
||||
you can specify which ones.</p>
|
||||
|
||||
<pre><code>"cpu" : [ "x64", "ia32" ]</code></pre>
|
||||
|
||||
<p>Like the <code>os</code> option, you can also blacklist architectures:</p>
|
||||
|
||||
<pre><code>"cpu" : [ "!arm", "!mips" ]</code></pre>
|
||||
|
||||
<p>The host architecture is determined by <code>process.arch</code></p>
|
||||
|
||||
<h2 id="preferGlobal">preferGlobal</h2>
|
||||
|
||||
<pre><code>"cpu" : [ "x64", "ia32" ]
|
||||
</code></pre><p>Like the <code>os</code> option, you can also blacklist architectures:</p>
|
||||
<pre><code>"cpu" : [ "!arm", "!mips" ]
|
||||
</code></pre><p>The host architecture is determined by <code>process.arch</code></p>
|
||||
<h2 id="preferglobal">preferGlobal</h2>
|
||||
<p>If your package is primarily a command-line application that should be
|
||||
installed globally, then set this value to <code>true</code> to provide a warning
|
||||
if it is installed locally.</p>
|
||||
|
||||
<p>It doesn't actually prevent users from installing it locally, but it
|
||||
does help prevent some confusion if it doesn't work as expected.</p>
|
||||
|
||||
<h2 id="private">private</h2>
|
||||
|
||||
<p>If you set <code>"private": true</code> in your package.json, then npm will refuse
|
||||
to publish it.</p>
|
||||
|
||||
<p>This is a way to prevent accidental publication of private repositories.
|
||||
If you would like to ensure that a given package is only ever published
|
||||
to a specific registry (for example, an internal registry),
|
||||
then use the <code>publishConfig</code> hash described below
|
||||
to override the <code>registry</code> config param at publish-time.</p>
|
||||
|
||||
<h2 id="publishConfig">publishConfig</h2>
|
||||
|
||||
<h2 id="publishconfig">publishConfig</h2>
|
||||
<p>This is a set of config values that will be used at publish-time. It's
|
||||
especially handy if you want to set the tag or registry, so that you can
|
||||
ensure that a given package is not tagged with "latest" or published to
|
||||
the global public registry by default.</p>
|
||||
|
||||
<p>Any config values can be overridden, but of course only "tag" and
|
||||
"registry" probably matter for the purposes of publishing.</p>
|
||||
|
||||
<p>See <code><a href="../misc/npm-config.html">npm-config(7)</a></code> to see the list of config options that can be
|
||||
overridden.</p>
|
||||
|
||||
<h2 id="DEFAULT-VALUES">DEFAULT VALUES</h2>
|
||||
|
||||
<h2 id="default-values">DEFAULT VALUES</h2>
|
||||
<p>npm will default some values based on package contents.</p>
|
||||
|
||||
<ul><li><p><code>"scripts": {"start": "node server.js"}</code></p><p>If there is a <code>server.js</code> file in the root of your package, then npm
|
||||
will default the <code>start</code> command to <code>node server.js</code>.</p></li><li><p><code>"scripts":{"preinstall": "node-gyp rebuild"}</code></p><p>If there is a <code>binding.gyp</code> file in the root of your package, npm will
|
||||
default the <code>preinstall</code> command to compile using node-gyp.</p></li><li><p><code>"contributors": [...]</code></p><p>If there is an <code>AUTHORS</code> file in the root of your package, npm will
|
||||
<ul>
|
||||
<li><p><code>"scripts": {"start": "node server.js"}</code></p>
|
||||
<p>If there is a <code>server.js</code> file in the root of your package, then npm
|
||||
will default the <code>start</code> command to <code>node server.js</code>.</p>
|
||||
</li>
|
||||
<li><p><code>"scripts":{"preinstall": "node-gyp rebuild"}</code></p>
|
||||
<p>If there is a <code>binding.gyp</code> file in the root of your package, npm will
|
||||
default the <code>preinstall</code> command to compile using node-gyp.</p>
|
||||
</li>
|
||||
<li><p><code>"contributors": [...]</code></p>
|
||||
<p>If there is an <code>AUTHORS</code> file in the root of your package, npm will
|
||||
treat each line as a <code>Name <email> (url)</code> format, where email and url
|
||||
are optional. Lines which start with a <code>#</code> or are blank, will be
|
||||
ignored.</p></li></ul>
|
||||
ignored.</p>
|
||||
</li>
|
||||
</ul>
|
||||
<h2 id="see-also">SEE ALSO</h2>
|
||||
<ul>
|
||||
<li><a href="../misc/semver.html">semver(7)</a></li>
|
||||
<li><a href="../cli/npm-init.html">npm-init(1)</a></li>
|
||||
<li><a href="../cli/npm-version.html">npm-version(1)</a></li>
|
||||
<li><a href="../cli/npm-config.html">npm-config(1)</a></li>
|
||||
<li><a href="../misc/npm-config.html">npm-config(7)</a></li>
|
||||
<li><a href="../cli/npm-help.html">npm-help(1)</a></li>
|
||||
<li><a href="../misc/npm-faq.html">npm-faq(7)</a></li>
|
||||
<li><a href="../cli/npm-install.html">npm-install(1)</a></li>
|
||||
<li><a href="../cli/npm-publish.html">npm-publish(1)</a></li>
|
||||
<li><a href="../cli/npm-rm.html">npm-rm(1)</a></li>
|
||||
</ul>
|
||||
|
||||
<h2 id="SEE-ALSO">SEE ALSO</h2>
|
||||
|
||||
<ul><li><a href="../misc/semver.html">semver(7)</a></li><li><a href="../cli/npm-init.html">npm-init(1)</a></li><li><a href="../cli/npm-version.html">npm-version(1)</a></li><li><a href="../cli/npm-config.html">npm-config(1)</a></li><li><a href="../misc/npm-config.html">npm-config(7)</a></li><li><a href="../cli/npm-help.html">npm-help(1)</a></li><li><a href="../misc/npm-faq.html">npm-faq(7)</a></li><li><a href="../cli/npm-install.html">npm-install(1)</a></li><li><a href="../cli/npm-publish.html">npm-publish(1)</a></li><li><a href="../cli/npm-rm.html">npm-rm(1)</a></li></ul>
|
||||
</div>
|
||||
|
||||
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
|
||||
@ -589,5 +459,5 @@ ignored.</p></li></ul>
|
||||
<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@1.4.9</p>
|
||||
<p id="footer">package.json — npm@1.4.10</p>
|
||||
|
||||
|
||||
415
deps/npm/html/doc/index.html
vendored
415
deps/npm/html/doc/index.html
vendored
@ -10,414 +10,211 @@
|
||||
<div id="wrapper">
|
||||
|
||||
<h1><a href="misc/npm-index.html">npm-index</a></h1> <p>Index of all npm documentation</p>
|
||||
|
||||
<h2 id="README-1"><a href="../doc/README.html">README</a></h2>
|
||||
|
||||
<h2 id="readme-1-"><a href="../doc/README.html">README</a></h2>
|
||||
<p>node package manager</p>
|
||||
|
||||
<h1>Command Line Documentation</h1>
|
||||
|
||||
<h2 id="npm-1"><a href="cli/npm.html">npm(1)</a></h2>
|
||||
|
||||
<h1 id="command-line-documentation">Command Line Documentation</h1>
|
||||
<h2 id="npm-1-"><a href="cli/npm.html">npm(1)</a></h2>
|
||||
<p>node package manager</p>
|
||||
|
||||
<h2 id="npm-adduser-1"><a href="cli/npm-adduser.html">npm-adduser(1)</a></h2>
|
||||
|
||||
<h2 id="npm-adduser-1-"><a href="cli/npm-adduser.html">npm-adduser(1)</a></h2>
|
||||
<p>Add a registry user account</p>
|
||||
|
||||
<h2 id="npm-bin-1"><a href="cli/npm-bin.html">npm-bin(1)</a></h2>
|
||||
|
||||
<h2 id="npm-bin-1-"><a href="cli/npm-bin.html">npm-bin(1)</a></h2>
|
||||
<p>Display npm bin folder</p>
|
||||
|
||||
<h2 id="npm-bugs-1"><a href="cli/npm-bugs.html">npm-bugs(1)</a></h2>
|
||||
|
||||
<h2 id="npm-bugs-1-"><a href="cli/npm-bugs.html">npm-bugs(1)</a></h2>
|
||||
<p>Bugs for a package in a web browser maybe</p>
|
||||
|
||||
<h2 id="npm-build-1"><a href="cli/npm-build.html">npm-build(1)</a></h2>
|
||||
|
||||
<h2 id="npm-build-1-"><a href="cli/npm-build.html">npm-build(1)</a></h2>
|
||||
<p>Build a package</p>
|
||||
|
||||
<h2 id="npm-bundle-1"><a href="cli/npm-bundle.html">npm-bundle(1)</a></h2>
|
||||
|
||||
<h2 id="npm-bundle-1-"><a href="cli/npm-bundle.html">npm-bundle(1)</a></h2>
|
||||
<p>REMOVED</p>
|
||||
|
||||
<h2 id="npm-cache-1"><a href="cli/npm-cache.html">npm-cache(1)</a></h2>
|
||||
|
||||
<h2 id="npm-cache-1-"><a href="cli/npm-cache.html">npm-cache(1)</a></h2>
|
||||
<p>Manipulates packages cache</p>
|
||||
|
||||
<h2 id="npm-completion-1"><a href="cli/npm-completion.html">npm-completion(1)</a></h2>
|
||||
|
||||
<h2 id="npm-completion-1-"><a href="cli/npm-completion.html">npm-completion(1)</a></h2>
|
||||
<p>Tab Completion for npm</p>
|
||||
|
||||
<h2 id="npm-config-1"><a href="cli/npm-config.html">npm-config(1)</a></h2>
|
||||
|
||||
<h2 id="npm-config-1-"><a href="cli/npm-config.html">npm-config(1)</a></h2>
|
||||
<p>Manage the npm configuration files</p>
|
||||
|
||||
<h2 id="npm-dedupe-1"><a href="cli/npm-dedupe.html">npm-dedupe(1)</a></h2>
|
||||
|
||||
<h2 id="npm-dedupe-1-"><a href="cli/npm-dedupe.html">npm-dedupe(1)</a></h2>
|
||||
<p>Reduce duplication</p>
|
||||
|
||||
<h2 id="npm-deprecate-1"><a href="cli/npm-deprecate.html">npm-deprecate(1)</a></h2>
|
||||
|
||||
<h2 id="npm-deprecate-1-"><a href="cli/npm-deprecate.html">npm-deprecate(1)</a></h2>
|
||||
<p>Deprecate a version of a package</p>
|
||||
|
||||
<h2 id="npm-docs-1"><a href="cli/npm-docs.html">npm-docs(1)</a></h2>
|
||||
|
||||
<h2 id="npm-docs-1-"><a href="cli/npm-docs.html">npm-docs(1)</a></h2>
|
||||
<p>Docs for a package in a web browser maybe</p>
|
||||
|
||||
<h2 id="npm-edit-1"><a href="cli/npm-edit.html">npm-edit(1)</a></h2>
|
||||
|
||||
<h2 id="npm-edit-1-"><a href="cli/npm-edit.html">npm-edit(1)</a></h2>
|
||||
<p>Edit an installed package</p>
|
||||
|
||||
<h2 id="npm-explore-1"><a href="cli/npm-explore.html">npm-explore(1)</a></h2>
|
||||
|
||||
<h2 id="npm-explore-1-"><a href="cli/npm-explore.html">npm-explore(1)</a></h2>
|
||||
<p>Browse an installed package</p>
|
||||
|
||||
<h2 id="npm-help-search-1"><a href="cli/npm-help-search.html">npm-help-search(1)</a></h2>
|
||||
|
||||
<h2 id="npm-help-search-1-"><a href="cli/npm-help-search.html">npm-help-search(1)</a></h2>
|
||||
<p>Search npm help documentation</p>
|
||||
|
||||
<h2 id="npm-help-1"><a href="cli/npm-help.html">npm-help(1)</a></h2>
|
||||
|
||||
<h2 id="npm-help-1-"><a href="cli/npm-help.html">npm-help(1)</a></h2>
|
||||
<p>Get help on npm</p>
|
||||
|
||||
<h2 id="npm-init-1"><a href="cli/npm-init.html">npm-init(1)</a></h2>
|
||||
|
||||
<h2 id="npm-init-1-"><a href="cli/npm-init.html">npm-init(1)</a></h2>
|
||||
<p>Interactively create a package.json file</p>
|
||||
|
||||
<h2 id="npm-install-1"><a href="cli/npm-install.html">npm-install(1)</a></h2>
|
||||
|
||||
<h2 id="npm-install-1-"><a href="cli/npm-install.html">npm-install(1)</a></h2>
|
||||
<p>Install a package</p>
|
||||
|
||||
<h2 id="npm-link-1"><a href="cli/npm-link.html">npm-link(1)</a></h2>
|
||||
|
||||
<h2 id="npm-link-1-"><a href="cli/npm-link.html">npm-link(1)</a></h2>
|
||||
<p>Symlink a package folder</p>
|
||||
|
||||
<h2 id="npm-ls-1"><a href="cli/npm-ls.html">npm-ls(1)</a></h2>
|
||||
|
||||
<h2 id="npm-ls-1-"><a href="cli/npm-ls.html">npm-ls(1)</a></h2>
|
||||
<p>List installed packages</p>
|
||||
|
||||
<h2 id="npm-outdated-1"><a href="cli/npm-outdated.html">npm-outdated(1)</a></h2>
|
||||
|
||||
<h2 id="npm-outdated-1-"><a href="cli/npm-outdated.html">npm-outdated(1)</a></h2>
|
||||
<p>Check for outdated packages</p>
|
||||
|
||||
<h2 id="npm-owner-1"><a href="cli/npm-owner.html">npm-owner(1)</a></h2>
|
||||
|
||||
<h2 id="npm-owner-1-"><a href="cli/npm-owner.html">npm-owner(1)</a></h2>
|
||||
<p>Manage package owners</p>
|
||||
|
||||
<h2 id="npm-pack-1"><a href="cli/npm-pack.html">npm-pack(1)</a></h2>
|
||||
|
||||
<h2 id="npm-pack-1-"><a href="cli/npm-pack.html">npm-pack(1)</a></h2>
|
||||
<p>Create a tarball from a package</p>
|
||||
|
||||
<h2 id="npm-prefix-1"><a href="cli/npm-prefix.html">npm-prefix(1)</a></h2>
|
||||
|
||||
<h2 id="npm-prefix-1-"><a href="cli/npm-prefix.html">npm-prefix(1)</a></h2>
|
||||
<p>Display prefix</p>
|
||||
|
||||
<h2 id="npm-prune-1"><a href="cli/npm-prune.html">npm-prune(1)</a></h2>
|
||||
|
||||
<h2 id="npm-prune-1-"><a href="cli/npm-prune.html">npm-prune(1)</a></h2>
|
||||
<p>Remove extraneous packages</p>
|
||||
|
||||
<h2 id="npm-publish-1"><a href="cli/npm-publish.html">npm-publish(1)</a></h2>
|
||||
|
||||
<h2 id="npm-publish-1-"><a href="cli/npm-publish.html">npm-publish(1)</a></h2>
|
||||
<p>Publish a package</p>
|
||||
|
||||
<h2 id="npm-rebuild-1"><a href="cli/npm-rebuild.html">npm-rebuild(1)</a></h2>
|
||||
|
||||
<h2 id="npm-rebuild-1-"><a href="cli/npm-rebuild.html">npm-rebuild(1)</a></h2>
|
||||
<p>Rebuild a package</p>
|
||||
|
||||
<h2 id="npm-repo-1"><a href="cli/npm-repo.html">npm-repo(1)</a></h2>
|
||||
|
||||
<h2 id="npm-repo-1-"><a href="cli/npm-repo.html">npm-repo(1)</a></h2>
|
||||
<p>Open package repository page in the browser</p>
|
||||
|
||||
<h2 id="npm-restart-1"><a href="cli/npm-restart.html">npm-restart(1)</a></h2>
|
||||
|
||||
<h2 id="npm-restart-1-"><a href="cli/npm-restart.html">npm-restart(1)</a></h2>
|
||||
<p>Start a package</p>
|
||||
|
||||
<h2 id="npm-rm-1"><a href="cli/npm-rm.html">npm-rm(1)</a></h2>
|
||||
|
||||
<h2 id="npm-rm-1-"><a href="cli/npm-rm.html">npm-rm(1)</a></h2>
|
||||
<p>Remove a package</p>
|
||||
|
||||
<h2 id="npm-root-1"><a href="cli/npm-root.html">npm-root(1)</a></h2>
|
||||
|
||||
<h2 id="npm-root-1-"><a href="cli/npm-root.html">npm-root(1)</a></h2>
|
||||
<p>Display npm root</p>
|
||||
|
||||
<h2 id="npm-run-script-1"><a href="cli/npm-run-script.html">npm-run-script(1)</a></h2>
|
||||
|
||||
<h2 id="npm-run-script-1-"><a href="cli/npm-run-script.html">npm-run-script(1)</a></h2>
|
||||
<p>Run arbitrary package scripts</p>
|
||||
|
||||
<h2 id="npm-search-1"><a href="cli/npm-search.html">npm-search(1)</a></h2>
|
||||
|
||||
<h2 id="npm-search-1-"><a href="cli/npm-search.html">npm-search(1)</a></h2>
|
||||
<p>Search for packages</p>
|
||||
|
||||
<h2 id="npm-shrinkwrap-1"><a href="cli/npm-shrinkwrap.html">npm-shrinkwrap(1)</a></h2>
|
||||
|
||||
<h2 id="npm-shrinkwrap-1-"><a href="cli/npm-shrinkwrap.html">npm-shrinkwrap(1)</a></h2>
|
||||
<p>Lock down dependency versions</p>
|
||||
|
||||
<h2 id="npm-star-1"><a href="cli/npm-star.html">npm-star(1)</a></h2>
|
||||
|
||||
<h2 id="npm-star-1-"><a href="cli/npm-star.html">npm-star(1)</a></h2>
|
||||
<p>Mark your favorite packages</p>
|
||||
|
||||
<h2 id="npm-stars-1"><a href="cli/npm-stars.html">npm-stars(1)</a></h2>
|
||||
|
||||
<h2 id="npm-stars-1-"><a href="cli/npm-stars.html">npm-stars(1)</a></h2>
|
||||
<p>View packages marked as favorites</p>
|
||||
|
||||
<h2 id="npm-start-1"><a href="cli/npm-start.html">npm-start(1)</a></h2>
|
||||
|
||||
<h2 id="npm-start-1-"><a href="cli/npm-start.html">npm-start(1)</a></h2>
|
||||
<p>Start a package</p>
|
||||
|
||||
<h2 id="npm-stop-1"><a href="cli/npm-stop.html">npm-stop(1)</a></h2>
|
||||
|
||||
<h2 id="npm-stop-1-"><a href="cli/npm-stop.html">npm-stop(1)</a></h2>
|
||||
<p>Stop a package</p>
|
||||
|
||||
<h2 id="npm-submodule-1"><a href="cli/npm-submodule.html">npm-submodule(1)</a></h2>
|
||||
|
||||
<h2 id="npm-submodule-1-"><a href="cli/npm-submodule.html">npm-submodule(1)</a></h2>
|
||||
<p>Add a package as a git submodule</p>
|
||||
|
||||
<h2 id="npm-tag-1"><a href="cli/npm-tag.html">npm-tag(1)</a></h2>
|
||||
|
||||
<h2 id="npm-tag-1-"><a href="cli/npm-tag.html">npm-tag(1)</a></h2>
|
||||
<p>Tag a published version</p>
|
||||
|
||||
<h2 id="npm-test-1"><a href="cli/npm-test.html">npm-test(1)</a></h2>
|
||||
|
||||
<h2 id="npm-test-1-"><a href="cli/npm-test.html">npm-test(1)</a></h2>
|
||||
<p>Test a package</p>
|
||||
|
||||
<h2 id="npm-uninstall-1"><a href="cli/npm-uninstall.html">npm-uninstall(1)</a></h2>
|
||||
|
||||
<h2 id="npm-uninstall-1-"><a href="cli/npm-uninstall.html">npm-uninstall(1)</a></h2>
|
||||
<p>Remove a package</p>
|
||||
|
||||
<h2 id="npm-unpublish-1"><a href="cli/npm-unpublish.html">npm-unpublish(1)</a></h2>
|
||||
|
||||
<h2 id="npm-unpublish-1-"><a href="cli/npm-unpublish.html">npm-unpublish(1)</a></h2>
|
||||
<p>Remove a package from the registry</p>
|
||||
|
||||
<h2 id="npm-update-1"><a href="cli/npm-update.html">npm-update(1)</a></h2>
|
||||
|
||||
<h2 id="npm-update-1-"><a href="cli/npm-update.html">npm-update(1)</a></h2>
|
||||
<p>Update a package</p>
|
||||
|
||||
<h2 id="npm-version-1"><a href="cli/npm-version.html">npm-version(1)</a></h2>
|
||||
|
||||
<h2 id="npm-version-1-"><a href="cli/npm-version.html">npm-version(1)</a></h2>
|
||||
<p>Bump a package version</p>
|
||||
|
||||
<h2 id="npm-view-1"><a href="cli/npm-view.html">npm-view(1)</a></h2>
|
||||
|
||||
<h2 id="npm-view-1-"><a href="cli/npm-view.html">npm-view(1)</a></h2>
|
||||
<p>View registry info</p>
|
||||
|
||||
<h2 id="npm-whoami-1"><a href="cli/npm-whoami.html">npm-whoami(1)</a></h2>
|
||||
|
||||
<h2 id="npm-whoami-1-"><a href="cli/npm-whoami.html">npm-whoami(1)</a></h2>
|
||||
<p>Display npm username</p>
|
||||
|
||||
<h1>API Documentation</h1>
|
||||
|
||||
<h2 id="npm-3"><a href="api/npm.html">npm(3)</a></h2>
|
||||
|
||||
<h1 id="api-documentation">API Documentation</h1>
|
||||
<h2 id="npm-3-"><a href="api/npm.html">npm(3)</a></h2>
|
||||
<p>node package manager</p>
|
||||
|
||||
<h2 id="npm-bin-3"><a href="api/npm-bin.html">npm-bin(3)</a></h2>
|
||||
|
||||
<h2 id="npm-bin-3-"><a href="api/npm-bin.html">npm-bin(3)</a></h2>
|
||||
<p>Display npm bin folder</p>
|
||||
|
||||
<h2 id="npm-bugs-3"><a href="api/npm-bugs.html">npm-bugs(3)</a></h2>
|
||||
|
||||
<h2 id="npm-bugs-3-"><a href="api/npm-bugs.html">npm-bugs(3)</a></h2>
|
||||
<p>Bugs for a package in a web browser maybe</p>
|
||||
|
||||
<h2 id="npm-commands-3"><a href="api/npm-commands.html">npm-commands(3)</a></h2>
|
||||
|
||||
<h2 id="npm-commands-3-"><a href="api/npm-commands.html">npm-commands(3)</a></h2>
|
||||
<p>npm commands</p>
|
||||
|
||||
<h2 id="npm-config-3"><a href="api/npm-config.html">npm-config(3)</a></h2>
|
||||
|
||||
<h2 id="npm-config-3-"><a href="api/npm-config.html">npm-config(3)</a></h2>
|
||||
<p>Manage the npm configuration files</p>
|
||||
|
||||
<h2 id="npm-deprecate-3"><a href="api/npm-deprecate.html">npm-deprecate(3)</a></h2>
|
||||
|
||||
<h2 id="npm-deprecate-3-"><a href="api/npm-deprecate.html">npm-deprecate(3)</a></h2>
|
||||
<p>Deprecate a version of a package</p>
|
||||
|
||||
<h2 id="npm-docs-3"><a href="api/npm-docs.html">npm-docs(3)</a></h2>
|
||||
|
||||
<h2 id="npm-docs-3-"><a href="api/npm-docs.html">npm-docs(3)</a></h2>
|
||||
<p>Docs for a package in a web browser maybe</p>
|
||||
|
||||
<h2 id="npm-edit-3"><a href="api/npm-edit.html">npm-edit(3)</a></h2>
|
||||
|
||||
<h2 id="npm-edit-3-"><a href="api/npm-edit.html">npm-edit(3)</a></h2>
|
||||
<p>Edit an installed package</p>
|
||||
|
||||
<h2 id="npm-explore-3"><a href="api/npm-explore.html">npm-explore(3)</a></h2>
|
||||
|
||||
<h2 id="npm-explore-3-"><a href="api/npm-explore.html">npm-explore(3)</a></h2>
|
||||
<p>Browse an installed package</p>
|
||||
|
||||
<h2 id="npm-help-search-3"><a href="api/npm-help-search.html">npm-help-search(3)</a></h2>
|
||||
|
||||
<h2 id="npm-help-search-3-"><a href="api/npm-help-search.html">npm-help-search(3)</a></h2>
|
||||
<p>Search the help pages</p>
|
||||
|
||||
<h2 id="npm-init-3"><a href="api/npm-init.html">npm-init(3)</a></h2>
|
||||
|
||||
<h2 id="npm-init-3-"><a href="api/npm-init.html">npm-init(3)</a></h2>
|
||||
<p>Interactively create a package.json file</p>
|
||||
|
||||
<h2 id="npm-install-3"><a href="api/npm-install.html">npm-install(3)</a></h2>
|
||||
|
||||
<h2 id="npm-install-3-"><a href="api/npm-install.html">npm-install(3)</a></h2>
|
||||
<p>install a package programmatically</p>
|
||||
|
||||
<h2 id="npm-link-3"><a href="api/npm-link.html">npm-link(3)</a></h2>
|
||||
|
||||
<h2 id="npm-link-3-"><a href="api/npm-link.html">npm-link(3)</a></h2>
|
||||
<p>Symlink a package folder</p>
|
||||
|
||||
<h2 id="npm-load-3"><a href="api/npm-load.html">npm-load(3)</a></h2>
|
||||
|
||||
<h2 id="npm-load-3-"><a href="api/npm-load.html">npm-load(3)</a></h2>
|
||||
<p>Load config settings</p>
|
||||
|
||||
<h2 id="npm-ls-3"><a href="api/npm-ls.html">npm-ls(3)</a></h2>
|
||||
|
||||
<h2 id="npm-ls-3-"><a href="api/npm-ls.html">npm-ls(3)</a></h2>
|
||||
<p>List installed packages</p>
|
||||
|
||||
<h2 id="npm-outdated-3"><a href="api/npm-outdated.html">npm-outdated(3)</a></h2>
|
||||
|
||||
<h2 id="npm-outdated-3-"><a href="api/npm-outdated.html">npm-outdated(3)</a></h2>
|
||||
<p>Check for outdated packages</p>
|
||||
|
||||
<h2 id="npm-owner-3"><a href="api/npm-owner.html">npm-owner(3)</a></h2>
|
||||
|
||||
<h2 id="npm-owner-3-"><a href="api/npm-owner.html">npm-owner(3)</a></h2>
|
||||
<p>Manage package owners</p>
|
||||
|
||||
<h2 id="npm-pack-3"><a href="api/npm-pack.html">npm-pack(3)</a></h2>
|
||||
|
||||
<h2 id="npm-pack-3-"><a href="api/npm-pack.html">npm-pack(3)</a></h2>
|
||||
<p>Create a tarball from a package</p>
|
||||
|
||||
<h2 id="npm-prefix-3"><a href="api/npm-prefix.html">npm-prefix(3)</a></h2>
|
||||
|
||||
<h2 id="npm-prefix-3-"><a href="api/npm-prefix.html">npm-prefix(3)</a></h2>
|
||||
<p>Display prefix</p>
|
||||
|
||||
<h2 id="npm-prune-3"><a href="api/npm-prune.html">npm-prune(3)</a></h2>
|
||||
|
||||
<h2 id="npm-prune-3-"><a href="api/npm-prune.html">npm-prune(3)</a></h2>
|
||||
<p>Remove extraneous packages</p>
|
||||
|
||||
<h2 id="npm-publish-3"><a href="api/npm-publish.html">npm-publish(3)</a></h2>
|
||||
|
||||
<h2 id="npm-publish-3-"><a href="api/npm-publish.html">npm-publish(3)</a></h2>
|
||||
<p>Publish a package</p>
|
||||
|
||||
<h2 id="npm-rebuild-3"><a href="api/npm-rebuild.html">npm-rebuild(3)</a></h2>
|
||||
|
||||
<h2 id="npm-rebuild-3-"><a href="api/npm-rebuild.html">npm-rebuild(3)</a></h2>
|
||||
<p>Rebuild a package</p>
|
||||
|
||||
<h2 id="npm-repo-3"><a href="api/npm-repo.html">npm-repo(3)</a></h2>
|
||||
|
||||
<h2 id="npm-repo-3-"><a href="api/npm-repo.html">npm-repo(3)</a></h2>
|
||||
<p>Open package repository page in the browser</p>
|
||||
|
||||
<h2 id="npm-restart-3"><a href="api/npm-restart.html">npm-restart(3)</a></h2>
|
||||
|
||||
<h2 id="npm-restart-3-"><a href="api/npm-restart.html">npm-restart(3)</a></h2>
|
||||
<p>Start a package</p>
|
||||
|
||||
<h2 id="npm-root-3"><a href="api/npm-root.html">npm-root(3)</a></h2>
|
||||
|
||||
<h2 id="npm-root-3-"><a href="api/npm-root.html">npm-root(3)</a></h2>
|
||||
<p>Display npm root</p>
|
||||
|
||||
<h2 id="npm-run-script-3"><a href="api/npm-run-script.html">npm-run-script(3)</a></h2>
|
||||
|
||||
<h2 id="npm-run-script-3-"><a href="api/npm-run-script.html">npm-run-script(3)</a></h2>
|
||||
<p>Run arbitrary package scripts</p>
|
||||
|
||||
<h2 id="npm-search-3"><a href="api/npm-search.html">npm-search(3)</a></h2>
|
||||
|
||||
<h2 id="npm-search-3-"><a href="api/npm-search.html">npm-search(3)</a></h2>
|
||||
<p>Search for packages</p>
|
||||
|
||||
<h2 id="npm-shrinkwrap-3"><a href="api/npm-shrinkwrap.html">npm-shrinkwrap(3)</a></h2>
|
||||
|
||||
<h2 id="npm-shrinkwrap-3-"><a href="api/npm-shrinkwrap.html">npm-shrinkwrap(3)</a></h2>
|
||||
<p>programmatically generate package shrinkwrap file</p>
|
||||
|
||||
<h2 id="npm-start-3"><a href="api/npm-start.html">npm-start(3)</a></h2>
|
||||
|
||||
<h2 id="npm-start-3-"><a href="api/npm-start.html">npm-start(3)</a></h2>
|
||||
<p>Start a package</p>
|
||||
|
||||
<h2 id="npm-stop-3"><a href="api/npm-stop.html">npm-stop(3)</a></h2>
|
||||
|
||||
<h2 id="npm-stop-3-"><a href="api/npm-stop.html">npm-stop(3)</a></h2>
|
||||
<p>Stop a package</p>
|
||||
|
||||
<h2 id="npm-submodule-3"><a href="api/npm-submodule.html">npm-submodule(3)</a></h2>
|
||||
|
||||
<h2 id="npm-submodule-3-"><a href="api/npm-submodule.html">npm-submodule(3)</a></h2>
|
||||
<p>Add a package as a git submodule</p>
|
||||
|
||||
<h2 id="npm-tag-3"><a href="api/npm-tag.html">npm-tag(3)</a></h2>
|
||||
|
||||
<h2 id="npm-tag-3-"><a href="api/npm-tag.html">npm-tag(3)</a></h2>
|
||||
<p>Tag a published version</p>
|
||||
|
||||
<h2 id="npm-test-3"><a href="api/npm-test.html">npm-test(3)</a></h2>
|
||||
|
||||
<h2 id="npm-test-3-"><a href="api/npm-test.html">npm-test(3)</a></h2>
|
||||
<p>Test a package</p>
|
||||
|
||||
<h2 id="npm-uninstall-3"><a href="api/npm-uninstall.html">npm-uninstall(3)</a></h2>
|
||||
|
||||
<h2 id="npm-uninstall-3-"><a href="api/npm-uninstall.html">npm-uninstall(3)</a></h2>
|
||||
<p>uninstall a package programmatically</p>
|
||||
|
||||
<h2 id="npm-unpublish-3"><a href="api/npm-unpublish.html">npm-unpublish(3)</a></h2>
|
||||
|
||||
<h2 id="npm-unpublish-3-"><a href="api/npm-unpublish.html">npm-unpublish(3)</a></h2>
|
||||
<p>Remove a package from the registry</p>
|
||||
|
||||
<h2 id="npm-update-3"><a href="api/npm-update.html">npm-update(3)</a></h2>
|
||||
|
||||
<h2 id="npm-update-3-"><a href="api/npm-update.html">npm-update(3)</a></h2>
|
||||
<p>Update a package</p>
|
||||
|
||||
<h2 id="npm-version-3"><a href="api/npm-version.html">npm-version(3)</a></h2>
|
||||
|
||||
<h2 id="npm-version-3-"><a href="api/npm-version.html">npm-version(3)</a></h2>
|
||||
<p>Bump a package version</p>
|
||||
|
||||
<h2 id="npm-view-3"><a href="api/npm-view.html">npm-view(3)</a></h2>
|
||||
|
||||
<h2 id="npm-view-3-"><a href="api/npm-view.html">npm-view(3)</a></h2>
|
||||
<p>View registry info</p>
|
||||
|
||||
<h2 id="npm-whoami-3"><a href="api/npm-whoami.html">npm-whoami(3)</a></h2>
|
||||
|
||||
<h2 id="npm-whoami-3-"><a href="api/npm-whoami.html">npm-whoami(3)</a></h2>
|
||||
<p>Display npm username</p>
|
||||
|
||||
<h1>Files</h1>
|
||||
|
||||
<h2 id="npm-folders-5"><a href="files/npm-folders.html">npm-folders(5)</a></h2>
|
||||
|
||||
<h1 id="files">Files</h1>
|
||||
<h2 id="npm-folders-5-"><a href="files/npm-folders.html">npm-folders(5)</a></h2>
|
||||
<p>Folder Structures Used by npm</p>
|
||||
|
||||
<h2 id="npmrc-5"><a href="files/npmrc.html">npmrc(5)</a></h2>
|
||||
|
||||
<h2 id="npmrc-5-"><a href="files/npmrc.html">npmrc(5)</a></h2>
|
||||
<p>The npm config files</p>
|
||||
|
||||
<h2 id="package-json-5"><a href="files/package.json.html">package.json(5)</a></h2>
|
||||
|
||||
<h2 id="package-json-5-"><a href="files/package.json.html">package.json(5)</a></h2>
|
||||
<p>Specifics of npm's package.json handling</p>
|
||||
|
||||
<h1>Misc</h1>
|
||||
|
||||
<h2 id="npm-coding-style-7"><a href="misc/npm-coding-style.html">npm-coding-style(7)</a></h2>
|
||||
|
||||
<h1 id="misc">Misc</h1>
|
||||
<h2 id="npm-coding-style-7-"><a href="misc/npm-coding-style.html">npm-coding-style(7)</a></h2>
|
||||
<p>npm's "funny" coding style</p>
|
||||
|
||||
<h2 id="npm-config-7"><a href="misc/npm-config.html">npm-config(7)</a></h2>
|
||||
|
||||
<h2 id="npm-config-7-"><a href="misc/npm-config.html">npm-config(7)</a></h2>
|
||||
<p>More than you probably want to know about npm configuration</p>
|
||||
|
||||
<h2 id="npm-developers-7"><a href="misc/npm-developers.html">npm-developers(7)</a></h2>
|
||||
|
||||
<h2 id="npm-developers-7-"><a href="misc/npm-developers.html">npm-developers(7)</a></h2>
|
||||
<p>Developer Guide</p>
|
||||
|
||||
<h2 id="npm-disputes-7"><a href="misc/npm-disputes.html">npm-disputes(7)</a></h2>
|
||||
|
||||
<h2 id="npm-disputes-7-"><a href="misc/npm-disputes.html">npm-disputes(7)</a></h2>
|
||||
<p>Handling Module Name Disputes</p>
|
||||
|
||||
<h2 id="npm-faq-7"><a href="misc/npm-faq.html">npm-faq(7)</a></h2>
|
||||
|
||||
<h2 id="npm-faq-7-"><a href="misc/npm-faq.html">npm-faq(7)</a></h2>
|
||||
<p>Frequently Asked Questions</p>
|
||||
|
||||
<h2 id="npm-index-7"><a href="misc/npm-index.html">npm-index(7)</a></h2>
|
||||
|
||||
<h2 id="npm-index-7-"><a href="misc/npm-index.html">npm-index(7)</a></h2>
|
||||
<p>Index of all npm documentation</p>
|
||||
|
||||
<h2 id="npm-registry-7"><a href="misc/npm-registry.html">npm-registry(7)</a></h2>
|
||||
|
||||
<h2 id="npm-registry-7-"><a href="misc/npm-registry.html">npm-registry(7)</a></h2>
|
||||
<p>The JavaScript Package Registry</p>
|
||||
|
||||
<h2 id="npm-scripts-7"><a href="misc/npm-scripts.html">npm-scripts(7)</a></h2>
|
||||
|
||||
<h2 id="npm-scripts-7-"><a href="misc/npm-scripts.html">npm-scripts(7)</a></h2>
|
||||
<p>How npm handles the "scripts" field</p>
|
||||
|
||||
<h2 id="removing-npm-7"><a href="misc/removing-npm.html">removing-npm(7)</a></h2>
|
||||
|
||||
<h2 id="removing-npm-7-"><a href="misc/removing-npm.html">removing-npm(7)</a></h2>
|
||||
<p>Cleaning the Slate</p>
|
||||
|
||||
<h2 id="semver-7"><a href="misc/semver.html">semver(7)</a></h2>
|
||||
|
||||
<h2 id="semver-7-"><a href="misc/semver.html">semver(7)</a></h2>
|
||||
<p>The semantic versioner for npm</p>
|
||||
|
||||
</div>
|
||||
|
||||
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
|
||||
@ -429,5 +226,5 @@
|
||||
<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-index — npm@1.4.9</p>
|
||||
<p id="footer">npm-index — npm@1.4.10</p>
|
||||
|
||||
|
||||
122
deps/npm/html/doc/misc/npm-coding-style.html
vendored
122
deps/npm/html/doc/misc/npm-coding-style.html
vendored
@ -10,71 +10,51 @@
|
||||
<div id="wrapper">
|
||||
|
||||
<h1><a href="../misc/npm-coding-style.html">npm-coding-style</a></h1> <p>npm's "funny" coding style</p>
|
||||
|
||||
<h2 id="DESCRIPTION">DESCRIPTION</h2>
|
||||
|
||||
<h2 id="description">DESCRIPTION</h2>
|
||||
<p>npm's coding style is a bit unconventional. It is not different for
|
||||
difference's sake, but rather a carefully crafted style that is
|
||||
designed to reduce visual clutter and make bugs more apparent.</p>
|
||||
|
||||
<p>If you want to contribute to npm (which is very encouraged), you should
|
||||
make your code conform to npm's style.</p>
|
||||
|
||||
<p>Note: this concerns npm's code not the specific packages at npmjs.org</p>
|
||||
|
||||
<h2 id="Line-Length">Line Length</h2>
|
||||
|
||||
<h2 id="line-length">Line Length</h2>
|
||||
<p>Keep lines shorter than 80 characters. It's better for lines to be
|
||||
too short than to be too long. Break up long lists, objects, and other
|
||||
statements onto multiple lines.</p>
|
||||
|
||||
<h2 id="Indentation">Indentation</h2>
|
||||
|
||||
<h2 id="indentation">Indentation</h2>
|
||||
<p>Two-spaces. Tabs are better, but they look like hell in web browsers
|
||||
(and on github), and node uses 2 spaces, so that's that.</p>
|
||||
|
||||
<p>Configure your editor appropriately.</p>
|
||||
|
||||
<h2 id="Curly-braces">Curly braces</h2>
|
||||
|
||||
<h2 id="curly-braces">Curly braces</h2>
|
||||
<p>Curly braces belong on the same line as the thing that necessitates them.</p>
|
||||
|
||||
<p>Bad:</p>
|
||||
|
||||
<pre><code>function ()
|
||||
{</code></pre>
|
||||
|
||||
<p>Good:</p>
|
||||
|
||||
<pre><code>function () {</code></pre>
|
||||
|
||||
<p>If a block needs to wrap to the next line, use a curly brace. Don't
|
||||
{
|
||||
</code></pre><p>Good:</p>
|
||||
<pre><code>function () {
|
||||
</code></pre><p>If a block needs to wrap to the next line, use a curly brace. Don't
|
||||
use it if it doesn't.</p>
|
||||
|
||||
<p>Bad:</p>
|
||||
|
||||
<pre><code>if (foo) { bar() }
|
||||
while (foo)
|
||||
bar()</code></pre>
|
||||
|
||||
<p>Good:</p>
|
||||
|
||||
bar()
|
||||
</code></pre><p>Good:</p>
|
||||
<pre><code>if (foo) bar()
|
||||
while (foo) {
|
||||
bar()
|
||||
}</code></pre>
|
||||
|
||||
<h2 id="Semicolons">Semicolons</h2>
|
||||
|
||||
}
|
||||
</code></pre><h2 id="semicolons">Semicolons</h2>
|
||||
<p>Don't use them except in four situations:</p>
|
||||
|
||||
<ul><li><code>for (;;)</code> loops. They're actually required.</li><li>null loops like: <code>while (something) ;</code> (But you'd better have a good
|
||||
reason for doing that.)</li><li><code>case "foo": doSomething(); break</code></li><li>In front of a leading <code>(</code> or <code>[</code> at the start of the line.
|
||||
<ul>
|
||||
<li><code>for (;;)</code> loops. They're actually required.</li>
|
||||
<li>null loops like: <code>while (something) ;</code> (But you'd better have a good
|
||||
reason for doing that.)</li>
|
||||
<li><code>case "foo": doSomething(); break</code></li>
|
||||
<li>In front of a leading <code>(</code> or <code>[</code> at the start of the line.
|
||||
This prevents the expression from being interpreted
|
||||
as a function call or property access, respectively.</li></ul>
|
||||
|
||||
as a function call or property access, respectively.</li>
|
||||
</ul>
|
||||
<p>Some examples of good semicolon usage:</p>
|
||||
|
||||
<pre><code>;(x || y).doSomething()
|
||||
;[a, b, c].forEach(doSomething)
|
||||
for (var i = 0; i < 10; i ++) {
|
||||
@ -84,18 +64,14 @@ for (var i = 0; i < 10; i ++) {
|
||||
default: throw new Error("unknown state")
|
||||
}
|
||||
end()
|
||||
}</code></pre>
|
||||
|
||||
<p>Note that starting lines with <code>-</code> and <code>+</code> also should be prefixed
|
||||
}
|
||||
</code></pre><p>Note that starting lines with <code>-</code> and <code>+</code> also should be prefixed
|
||||
with a semicolon, but this is much less common.</p>
|
||||
|
||||
<h2 id="Comma-First">Comma First</h2>
|
||||
|
||||
<h2 id="comma-first">Comma First</h2>
|
||||
<p>If there is a list of things separated by commas, and it wraps
|
||||
across multiple lines, put the comma at the start of the next
|
||||
line, directly below the token that starts the list. Put the
|
||||
final token in the list on a line by itself. For example:</p>
|
||||
|
||||
<pre><code>var magicWords = [ "abracadabra"
|
||||
, "gesundheit"
|
||||
, "ventrilo"
|
||||
@ -106,84 +82,60 @@ final token in the list on a line by itself. For example:</p>
|
||||
, a = 1
|
||||
, b = "abc"
|
||||
, etc
|
||||
, somethingElse</code></pre>
|
||||
|
||||
<h2 id="Whitespace">Whitespace</h2>
|
||||
|
||||
, somethingElse
|
||||
</code></pre><h2 id="whitespace">Whitespace</h2>
|
||||
<p>Put a single space in front of ( for anything other than a function call.
|
||||
Also use a single space wherever it makes things more readable.</p>
|
||||
|
||||
<p>Don't leave trailing whitespace at the end of lines. Don't indent empty
|
||||
lines. Don't use more spaces than are helpful.</p>
|
||||
|
||||
<h2 id="Functions">Functions</h2>
|
||||
|
||||
<h2 id="functions">Functions</h2>
|
||||
<p>Use named functions. They make stack traces a lot easier to read.</p>
|
||||
|
||||
<h2 id="Callbacks-Sync-async-Style">Callbacks, Sync/async Style</h2>
|
||||
|
||||
<h2 id="callbacks-sync-async-style">Callbacks, Sync/async Style</h2>
|
||||
<p>Use the asynchronous/non-blocking versions of things as much as possible.
|
||||
It might make more sense for npm to use the synchronous fs APIs, but this
|
||||
way, the fs and http and child process stuff all uses the same callback-passing
|
||||
methodology.</p>
|
||||
|
||||
<p>The callback should always be the last argument in the list. Its first
|
||||
argument is the Error or null.</p>
|
||||
|
||||
<p>Be very careful never to ever ever throw anything. It's worse than useless.
|
||||
Just send the error message back as the first argument to the callback.</p>
|
||||
|
||||
<h2 id="Errors">Errors</h2>
|
||||
|
||||
<h2 id="errors">Errors</h2>
|
||||
<p>Always create a new Error object with your message. Don't just return a
|
||||
string message to the callback. Stack traces are handy.</p>
|
||||
|
||||
<h2 id="Logging">Logging</h2>
|
||||
|
||||
<h2 id="logging">Logging</h2>
|
||||
<p>Logging is done using the <a href="https://github.com/npm/npmlog">npmlog</a>
|
||||
utility.</p>
|
||||
|
||||
<p>Please clean up logs when they are no longer helpful. In particular,
|
||||
logging the same object over and over again is not helpful. Logs should
|
||||
report what's happening so that it's easier to track down where a fault
|
||||
occurs.</p>
|
||||
|
||||
<p>Use appropriate log levels. See <code><a href="../misc/npm-config.html">npm-config(7)</a></code> and search for
|
||||
"loglevel".</p>
|
||||
|
||||
<h2 id="Case-naming-etc">Case, naming, etc.</h2>
|
||||
|
||||
<h2 id="case-naming-etc-">Case, naming, etc.</h2>
|
||||
<p>Use <code>lowerCamelCase</code> for multiword identifiers when they refer to objects,
|
||||
functions, methods, members, or anything not specified in this section.</p>
|
||||
|
||||
<p>Use <code>UpperCamelCase</code> for class names (things that you'd pass to "new").</p>
|
||||
|
||||
<p>Use <code>all-lower-hyphen-css-case</code> for multiword filenames and config keys.</p>
|
||||
|
||||
<p>Use named functions. They make stack traces easier to follow.</p>
|
||||
|
||||
<p>Use <code>CAPS_SNAKE_CASE</code> for constants, things that should never change
|
||||
and are rarely used.</p>
|
||||
|
||||
<p>Use a single uppercase letter for function names where the function
|
||||
would normally be anonymous, but needs to call itself recursively. It
|
||||
makes it clear that it's a "throwaway" function.</p>
|
||||
|
||||
<h2 id="null-undefined-false-0">null, undefined, false, 0</h2>
|
||||
|
||||
<p>Boolean variables and functions should always be either <code>true</code> or
|
||||
<code>false</code>. Don't set it to 0 unless it's supposed to be a number.</p>
|
||||
|
||||
<p>When something is intentionally missing or removed, set it to <code>null</code>.</p>
|
||||
|
||||
<p>Don't set things to <code>undefined</code>. Reserve that value to mean "not yet
|
||||
set to anything."</p>
|
||||
|
||||
<p>Boolean objects are verboten.</p>
|
||||
<h2 id="see-also">SEE ALSO</h2>
|
||||
<ul>
|
||||
<li><a href="../misc/npm-developers.html">npm-developers(7)</a></li>
|
||||
<li><a href="../misc/npm-faq.html">npm-faq(7)</a></li>
|
||||
<li><a href="../cli/npm.html">npm(1)</a></li>
|
||||
</ul>
|
||||
|
||||
<h2 id="SEE-ALSO">SEE ALSO</h2>
|
||||
|
||||
<ul><li><a href="../misc/npm-developers.html">npm-developers(7)</a></li><li><a href="../misc/npm-faq.html">npm-faq(7)</a></li><li><a href="../cli/npm.html">npm(1)</a></li></ul>
|
||||
</div>
|
||||
|
||||
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
|
||||
@ -195,5 +147,5 @@ set to anything."</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-coding-style — npm@1.4.9</p>
|
||||
<p id="footer">npm-coding-style — npm@1.4.10</p>
|
||||
|
||||
|
||||
832
deps/npm/html/doc/misc/npm-config.html
vendored
832
deps/npm/html/doc/misc/npm-config.html
vendored
File diff suppressed because it is too large
Load Diff
174
deps/npm/html/doc/misc/npm-developers.html
vendored
174
deps/npm/html/doc/misc/npm-developers.html
vendored
@ -10,172 +10,166 @@
|
||||
<div id="wrapper">
|
||||
|
||||
<h1><a href="../misc/npm-developers.html">npm-developers</a></h1> <p>Developer Guide</p>
|
||||
|
||||
<h2 id="DESCRIPTION">DESCRIPTION</h2>
|
||||
|
||||
<h2 id="description">DESCRIPTION</h2>
|
||||
<p>So, you've decided to use npm to develop (and maybe publish/deploy)
|
||||
your project.</p>
|
||||
|
||||
<p>Fantastic!</p>
|
||||
|
||||
<p>There are a few things that you need to do above the simple steps
|
||||
that your users will do to install your program.</p>
|
||||
|
||||
<h2 id="About-These-Documents">About These Documents</h2>
|
||||
|
||||
<h2 id="about-these-documents">About These Documents</h2>
|
||||
<p>These are man pages. If you install npm, you should be able to
|
||||
then do <code>man npm-thing</code> to get the documentation on a particular
|
||||
topic, or <code>npm help thing</code> to see the same information.</p>
|
||||
|
||||
<h2 id="What-is-a-package">What is a <code>package</code></h2>
|
||||
|
||||
<h2 id="what-is-a-package-">What is a <code>package</code></h2>
|
||||
<p>A package is:</p>
|
||||
|
||||
<ul><li>a) a folder containing a program described by a package.json file</li><li>b) a gzipped tarball containing (a)</li><li>c) a url that resolves to (b)</li><li>d) a <code><name>@<version></code> that is published on the registry with (c)</li><li>e) a <code><name>@<tag></code> that points to (d)</li><li>f) a <code><name></code> that has a "latest" tag satisfying (e)</li><li>g) a <code>git</code> url that, when cloned, results in (a).</li></ul>
|
||||
|
||||
<ul>
|
||||
<li>a) a folder containing a program described by a package.json file</li>
|
||||
<li>b) a gzipped tarball containing (a)</li>
|
||||
<li>c) a url that resolves to (b)</li>
|
||||
<li>d) a <code><name>@<version></code> that is published on the registry with (c)</li>
|
||||
<li>e) a <code><name>@<tag></code> that points to (d)</li>
|
||||
<li>f) a <code><name></code> that has a "latest" tag satisfying (e)</li>
|
||||
<li>g) a <code>git</code> url that, when cloned, results in (a).</li>
|
||||
</ul>
|
||||
<p>Even if you never publish your package, you can still get a lot of
|
||||
benefits of using npm if you just want to write a node program (a), and
|
||||
perhaps if you also want to be able to easily install it elsewhere
|
||||
after packing it up into a tarball (b).</p>
|
||||
|
||||
<p>Git urls can be of the form:</p>
|
||||
|
||||
<pre><code>git://github.com/user/project.git#commit-ish
|
||||
git+ssh://user@hostname:project.git#commit-ish
|
||||
git+http://user@hostname/project/blah.git#commit-ish
|
||||
git+https://user@hostname/project/blah.git#commit-ish</code></pre>
|
||||
|
||||
<p>The <code>commit-ish</code> can be any tag, sha, or branch which can be supplied as
|
||||
git+https://user@hostname/project/blah.git#commit-ish
|
||||
</code></pre><p>The <code>commit-ish</code> can be any tag, sha, or branch which can be supplied as
|
||||
an argument to <code>git checkout</code>. The default is <code>master</code>.</p>
|
||||
|
||||
<h2 id="The-package-json-File">The package.json File</h2>
|
||||
|
||||
<h2 id="the-package-json-file">The package.json File</h2>
|
||||
<p>You need to have a <code>package.json</code> file in the root of your project to do
|
||||
much of anything with npm. That is basically the whole interface.</p>
|
||||
|
||||
<p>See <code><a href="../files/package.json.html">package.json(5)</a></code> for details about what goes in that file. At the very
|
||||
least, you need:</p>
|
||||
|
||||
<ul><li><p>name:
|
||||
<ul>
|
||||
<li><p>name:
|
||||
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.</p><p>It does not necessarily need to match your github repository name.</p><p>So, <code>node-foo</code> and <code>bar-js</code> are bad names. <code>foo</code> or <code>bar</code> are better.</p></li><li><p>version:
|
||||
A semver-compatible version.</p></li><li><p>engines:
|
||||
well assumed that it's javascript.</p>
|
||||
<p>It does not necessarily need to match your github repository name.</p>
|
||||
<p>So, <code>node-foo</code> and <code>bar-js</code> are bad names. <code>foo</code> or <code>bar</code> are better.</p>
|
||||
</li>
|
||||
<li><p>version:
|
||||
A semver-compatible version.</p>
|
||||
</li>
|
||||
<li><p>engines:
|
||||
Specify the versions of node (or whatever else) that your program
|
||||
runs on. The node API changes a lot, and there may be bugs or new
|
||||
functionality that you depend on. Be explicit.</p></li><li><p>author:
|
||||
Take some credit.</p></li><li><p>scripts:
|
||||
functionality that you depend on. Be explicit.</p>
|
||||
</li>
|
||||
<li><p>author:
|
||||
Take some credit.</p>
|
||||
</li>
|
||||
<li><p>scripts:
|
||||
If you have a special compilation or installation script, then you
|
||||
should put it in the <code>scripts</code> hash. You should definitely have at
|
||||
least a basic smoke-test command as the "scripts.test" field.
|
||||
See <a href="../misc/npm-scripts.html">npm-scripts(7)</a>.</p></li><li><p>main:
|
||||
See <a href="../misc/npm-scripts.html">npm-scripts(7)</a>.</p>
|
||||
</li>
|
||||
<li><p>main:
|
||||
If you have a single module that serves as the entry point to your
|
||||
program (like what the "foo" package gives you at require("foo")),
|
||||
then you need to specify that in the "main" field.</p></li><li><p>directories:
|
||||
then you need to specify that in the "main" field.</p>
|
||||
</li>
|
||||
<li><p>directories:
|
||||
This is a hash of folders. The best ones to include are "lib" and
|
||||
"doc", but if you specify a folder full of man pages in "man", then
|
||||
they'll get installed just like these ones.</p></li></ul>
|
||||
|
||||
they'll get installed just like these ones.</p>
|
||||
</li>
|
||||
</ul>
|
||||
<p>You can use <code>npm init</code> in the root of your package in order to get you
|
||||
started with a pretty basic package.json file. See <code><a href="../cli/npm-init.html">npm-init(1)</a></code> for
|
||||
more info.</p>
|
||||
|
||||
<h2 id="Keeping-files-out-of-your-package">Keeping files <em>out</em> of your package</h2>
|
||||
|
||||
<h2 id="keeping-files-out-of-your-package">Keeping files <em>out</em> of your package</h2>
|
||||
<p>Use a <code>.npmignore</code> file to keep stuff out of your package. If there's
|
||||
no <code>.npmignore</code> file, but there <em>is</em> a <code>.gitignore</code> file, then npm will
|
||||
ignore the stuff matched by the <code>.gitignore</code> file. If you <em>want</em> to
|
||||
include something that is excluded by your <code>.gitignore</code> file, you can
|
||||
create an empty <code>.npmignore</code> file to override it.</p>
|
||||
|
||||
<p>By default, the following paths and files are ignored, so there's no
|
||||
need to add them to <code>.npmignore</code> explicitly:</p>
|
||||
|
||||
<ul><li><code>.*.swp</code></li><li><code>._*</code></li><li><code>.DS_Store</code></li><li><code>.git</code></li><li><code>.hg</code></li><li><code>.lock-wscript</code></li><li><code>.svn</code></li><li><code>.wafpickle-*</code></li><li><code>CVS</code></li><li><code>npm-debug.log</code></li></ul>
|
||||
|
||||
<ul>
|
||||
<li><code>.*.swp</code></li>
|
||||
<li><code>._*</code></li>
|
||||
<li><code>.DS_Store</code></li>
|
||||
<li><code>.git</code></li>
|
||||
<li><code>.hg</code></li>
|
||||
<li><code>.lock-wscript</code></li>
|
||||
<li><code>.svn</code></li>
|
||||
<li><code>.wafpickle-*</code></li>
|
||||
<li><code>CVS</code></li>
|
||||
<li><code>npm-debug.log</code></li>
|
||||
</ul>
|
||||
<p>Additionally, everything in <code>node_modules</code> is ignored, except for
|
||||
bundled dependencies. npm automatically handles this for you, so don't
|
||||
bother adding <code>node_modules</code> to <code>.npmignore</code>.</p>
|
||||
|
||||
<p>The following paths and files are never ignored, so adding them to
|
||||
<code>.npmignore</code> is pointless:</p>
|
||||
|
||||
<ul><li><code>package.json</code></li><li><code><a href="../../doc/README.html">README</a>.*</code></li></ul>
|
||||
|
||||
<h2 id="Link-Packages">Link Packages</h2>
|
||||
|
||||
<ul>
|
||||
<li><code>package.json</code></li>
|
||||
<li><code><a href="../../doc/README.html">README</a>.*</code></li>
|
||||
</ul>
|
||||
<h2 id="link-packages">Link Packages</h2>
|
||||
<p><code>npm link</code> is designed to install a development package and see the
|
||||
changes in real time without having to keep re-installing it. (You do
|
||||
need to either re-link or <code>npm rebuild -g</code> to update compiled packages,
|
||||
of course.)</p>
|
||||
|
||||
<p>More info at <code><a href="../cli/npm-link.html">npm-link(1)</a></code>.</p>
|
||||
|
||||
<h2 id="Before-Publishing-Make-Sure-Your-Package-Installs-and-Works">Before Publishing: Make Sure Your Package Installs and Works</h2>
|
||||
|
||||
<h2 id="before-publishing-make-sure-your-package-installs-and-works">Before Publishing: Make Sure Your Package Installs and Works</h2>
|
||||
<p><strong>This is important.</strong></p>
|
||||
|
||||
<p>If you can not install it locally, you'll have
|
||||
problems trying to publish it. Or, worse yet, you'll be able to
|
||||
publish it, but you'll be publishing a broken or pointless package.
|
||||
So don't do that.</p>
|
||||
|
||||
<p>In the root of your package, do this:</p>
|
||||
|
||||
<pre><code>npm install . -g</code></pre>
|
||||
|
||||
<p>That'll show you that it's working. If you'd rather just create a symlink
|
||||
<pre><code>npm install . -g
|
||||
</code></pre><p>That'll show you that it's working. If you'd rather just create a symlink
|
||||
package that points to your working directory, then do this:</p>
|
||||
|
||||
<pre><code>npm link</code></pre>
|
||||
|
||||
<p>Use <code>npm ls -g</code> to see if it's there.</p>
|
||||
|
||||
<pre><code>npm link
|
||||
</code></pre><p>Use <code>npm ls -g</code> to see if it's there.</p>
|
||||
<p>To test a local install, go into some other folder, and then do:</p>
|
||||
|
||||
<pre><code>cd ../some-other-folder
|
||||
npm install ../my-package</code></pre>
|
||||
|
||||
<p>to install it locally into the node_modules folder in that other place.</p>
|
||||
|
||||
npm install ../my-package
|
||||
</code></pre><p>to install it locally into the node_modules folder in that other place.</p>
|
||||
<p>Then go into the node-repl, and try using require("my-thing") to
|
||||
bring in your module's main module.</p>
|
||||
|
||||
<h2 id="Create-a-User-Account">Create a User Account</h2>
|
||||
|
||||
<h2 id="create-a-user-account">Create a User Account</h2>
|
||||
<p>Create a user with the adduser command. It works like this:</p>
|
||||
|
||||
<pre><code>npm adduser</code></pre>
|
||||
|
||||
<p>and then follow the prompts.</p>
|
||||
|
||||
<pre><code>npm adduser
|
||||
</code></pre><p>and then follow the prompts.</p>
|
||||
<p>This is documented better in <a href="../cli/npm-adduser.html">npm-adduser(1)</a>.</p>
|
||||
|
||||
<h2 id="Publish-your-package">Publish your package</h2>
|
||||
|
||||
<h2 id="publish-your-package">Publish your package</h2>
|
||||
<p>This part's easy. IN the root of your folder, do this:</p>
|
||||
|
||||
<pre><code>npm publish</code></pre>
|
||||
|
||||
<p>You can give publish a url to a tarball, or a filename of a tarball,
|
||||
<pre><code>npm publish
|
||||
</code></pre><p>You can give publish a url to a tarball, or a filename of a tarball,
|
||||
or a path to a folder.</p>
|
||||
|
||||
<p>Note that pretty much <strong>everything in that folder will be exposed</strong>
|
||||
by default. So, if you have secret stuff in there, use a
|
||||
<code>.npmignore</code> file to list out the globs to ignore, or publish
|
||||
from a fresh checkout.</p>
|
||||
|
||||
<h2 id="Brag-about-it">Brag about it</h2>
|
||||
|
||||
<h2 id="brag-about-it">Brag about it</h2>
|
||||
<p>Send emails, write blogs, blab in IRC.</p>
|
||||
|
||||
<p>Tell the world how easy it is to install your program!</p>
|
||||
<h2 id="see-also">SEE ALSO</h2>
|
||||
<ul>
|
||||
<li><a href="../misc/npm-faq.html">npm-faq(7)</a></li>
|
||||
<li><a href="../cli/npm.html">npm(1)</a></li>
|
||||
<li><a href="../cli/npm-init.html">npm-init(1)</a></li>
|
||||
<li><a href="../files/package.json.html">package.json(5)</a></li>
|
||||
<li><a href="../misc/npm-scripts.html">npm-scripts(7)</a></li>
|
||||
<li><a href="../cli/npm-publish.html">npm-publish(1)</a></li>
|
||||
<li><a href="../cli/npm-adduser.html">npm-adduser(1)</a></li>
|
||||
<li><a href="../misc/npm-registry.html">npm-registry(7)</a></li>
|
||||
</ul>
|
||||
|
||||
<h2 id="SEE-ALSO">SEE ALSO</h2>
|
||||
|
||||
<ul><li><a href="../misc/npm-faq.html">npm-faq(7)</a></li><li><a href="../cli/npm.html">npm(1)</a></li><li><a href="../cli/npm-init.html">npm-init(1)</a></li><li><a href="../files/package.json.html">package.json(5)</a></li><li><a href="../misc/npm-scripts.html">npm-scripts(7)</a></li><li><a href="../cli/npm-publish.html">npm-publish(1)</a></li><li><a href="../cli/npm-adduser.html">npm-adduser(1)</a></li><li><a href="../misc/npm-registry.html">npm-registry(7)</a></li></ul>
|
||||
</div>
|
||||
|
||||
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
|
||||
@ -187,5 +181,5 @@ from a fresh checkout.</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-developers — npm@1.4.9</p>
|
||||
<p id="footer">npm-developers — npm@1.4.10</p>
|
||||
|
||||
|
||||
89
deps/npm/html/doc/misc/npm-disputes.html
vendored
89
deps/npm/html/doc/misc/npm-disputes.html
vendored
@ -10,90 +10,97 @@
|
||||
<div id="wrapper">
|
||||
|
||||
<h1><a href="../misc/npm-disputes.html">npm-disputes</a></h1> <p>Handling Module Name Disputes</p>
|
||||
|
||||
<h2 id="SYNOPSIS">SYNOPSIS</h2>
|
||||
|
||||
<ol><li>Get the author email with <code>npm owner ls <pkgname></code></li><li>Email the author, CC <a href="mailto:support@npmjs.com">support@npmjs.com</a></li><li>After a few weeks, if there's no resolution, we'll sort it out.</li></ol>
|
||||
|
||||
<h2 id="synopsis">SYNOPSIS</h2>
|
||||
<ol>
|
||||
<li>Get the author email with <code>npm owner ls <pkgname></code></li>
|
||||
<li>Email the author, CC <a href="mailto:support@npmjs.com">support@npmjs.com</a></li>
|
||||
<li>After a few weeks, if there's no resolution, we'll sort it out.</li>
|
||||
</ol>
|
||||
<p>Don't squat on package names. Publish code or move out of the way.</p>
|
||||
|
||||
<h2 id="DESCRIPTION">DESCRIPTION</h2>
|
||||
|
||||
<h2 id="description">DESCRIPTION</h2>
|
||||
<p>There sometimes arise cases where a user publishes a module, and then
|
||||
later, some other user wants to use that name. Here are some common
|
||||
ways that happens (each of these is based on actual events.)</p>
|
||||
|
||||
<ol><li>Joe writes a JavaScript module <code>foo</code>, which is not node-specific.
|
||||
<ol>
|
||||
<li>Joe writes a JavaScript module <code>foo</code>, which is not node-specific.
|
||||
Joe doesn't use node at all. Bob wants to use <code>foo</code> in node, so he
|
||||
wraps it in an npm module. Some time later, Joe starts using node,
|
||||
and wants to take over management of his program.</li><li>Bob writes an npm module <code>foo</code>, and publishes it. Perhaps much
|
||||
and wants to take over management of his program.</li>
|
||||
<li>Bob writes an npm module <code>foo</code>, and publishes it. Perhaps much
|
||||
later, Joe finds a bug in <code>foo</code>, and fixes it. He sends a pull
|
||||
request to Bob, but Bob doesn't have the time to deal with it,
|
||||
because he has a new job and a new baby and is focused on his new
|
||||
erlang project, and kind of not involved with node any more. Joe
|
||||
would like to publish a new <code>foo</code>, but can't, because the name is
|
||||
taken.</li><li>Bob writes a 10-line flow-control library, and calls it <code>foo</code>, and
|
||||
taken.</li>
|
||||
<li>Bob writes a 10-line flow-control library, and calls it <code>foo</code>, and
|
||||
publishes it to the npm registry. Being a simple little thing, it
|
||||
never really has to be updated. Joe works for Foo Inc, the makers
|
||||
of the critically acclaimed and widely-marketed <code>foo</code> JavaScript
|
||||
toolkit framework. They publish it to npm as <code>foojs</code>, but people are
|
||||
routinely confused when <code>npm install foo</code> is some different thing.</li><li>Bob writes a parser for the widely-known <code>foo</code> file format, because
|
||||
routinely confused when <code>npm install foo</code> is some different thing.</li>
|
||||
<li>Bob writes a parser for the widely-known <code>foo</code> file format, because
|
||||
he needs it for work. Then, he gets a new job, and never updates the
|
||||
prototype. Later on, Joe writes a much more complete <code>foo</code> parser,
|
||||
but can't publish, because Bob's <code>foo</code> is in the way.</li></ol>
|
||||
|
||||
but can't publish, because Bob's <code>foo</code> is in the way.</li>
|
||||
</ol>
|
||||
<p>The validity of Joe's claim in each situation can be debated. However,
|
||||
Joe's appropriate course of action in each case is the same.</p>
|
||||
|
||||
<ol><li><code>npm owner ls foo</code>. This will tell Joe the email address of the
|
||||
owner (Bob).</li><li>Joe emails Bob, explaining the situation <strong>as respectfully as
|
||||
<ol>
|
||||
<li><code>npm owner ls foo</code>. This will tell Joe the email address of the
|
||||
owner (Bob).</li>
|
||||
<li>Joe emails Bob, explaining the situation <strong>as respectfully as
|
||||
possible</strong>, and what he would like to do with the module name. He
|
||||
adds the npm support staff <a href="mailto:support@npmjs.com">support@npmjs.com</a> to the CC list of
|
||||
adds the npm support staff <a href="mailto:support@npmjs.com">support@npmjs.com</a> to the CC list of
|
||||
the email. Mention in the email that Bob can run <code>npm owner add
|
||||
joe foo</code> to add Joe as an owner of the <code>foo</code> package.</li><li>After a reasonable amount of time, if Bob has not responded, or if
|
||||
joe foo</code> to add Joe as an owner of the <code>foo</code> package.</li>
|
||||
<li>After a reasonable amount of time, if Bob has not responded, or if
|
||||
Bob and Joe can't come to any sort of resolution, email support
|
||||
<a href="mailto:support@npmjs.com">support@npmjs.com</a> and we'll sort it out. ("Reasonable" is
|
||||
<a href="mailto:support@npmjs.com">support@npmjs.com</a> and we'll sort it out. ("Reasonable" is
|
||||
usually at least 4 weeks, but extra time is allowed around common
|
||||
holidays.)</li></ol>
|
||||
|
||||
<h2 id="REASONING">REASONING</h2>
|
||||
|
||||
holidays.)</li>
|
||||
</ol>
|
||||
<h2 id="reasoning">REASONING</h2>
|
||||
<p>In almost every case so far, the parties involved have been able to reach
|
||||
an amicable resolution without any major intervention. Most people
|
||||
really do want to be reasonable, and are probably not even aware that
|
||||
they're in your way.</p>
|
||||
|
||||
<p>Module ecosystems are most vibrant and powerful when they are as
|
||||
self-directed as possible. If an admin one day deletes something you
|
||||
had worked on, then that is going to make most people quite upset,
|
||||
regardless of the justification. When humans solve their problems by
|
||||
talking to other humans with respect, everyone has the chance to end up
|
||||
feeling good about the interaction.</p>
|
||||
|
||||
<h2 id="EXCEPTIONS">EXCEPTIONS</h2>
|
||||
|
||||
<h2 id="exceptions">EXCEPTIONS</h2>
|
||||
<p>Some things are not allowed, and will be removed without discussion if
|
||||
they are brought to the attention of the npm registry admins, including
|
||||
but not limited to:</p>
|
||||
|
||||
<ol><li>Malware (that is, a package designed to exploit or harm the machine on
|
||||
which it is installed).</li><li>Violations of copyright or licenses (for example, cloning an
|
||||
<ol>
|
||||
<li>Malware (that is, a package designed to exploit or harm the machine on
|
||||
which it is installed).</li>
|
||||
<li>Violations of copyright or licenses (for example, cloning an
|
||||
MIT-licensed program, and then removing or changing the copyright and
|
||||
license statement).</li><li>Illegal content.</li><li>"Squatting" on a package name that you <em>plan</em> to use, but aren't
|
||||
license statement).</li>
|
||||
<li>Illegal content.</li>
|
||||
<li>"Squatting" on a package name that you <em>plan</em> to use, but aren't
|
||||
actually using. Sorry, I don't care how great the name is, or how
|
||||
perfect a fit it is for the thing that someday might happen. If
|
||||
someone wants to use it today, and you're just taking up space with
|
||||
an empty tarball, you're going to be evicted.</li><li>Putting empty packages in the registry. Packages must have SOME
|
||||
an empty tarball, you're going to be evicted.</li>
|
||||
<li>Putting empty packages in the registry. Packages must have SOME
|
||||
functionality. It can be silly, but it can't be <em>nothing</em>. (See
|
||||
also: squatting.)</li><li>Doing weird things with the registry, like using it as your own
|
||||
also: squatting.)</li>
|
||||
<li>Doing weird things with the registry, like using it as your own
|
||||
personal application database or otherwise putting non-packagey
|
||||
things into it.</li></ol>
|
||||
|
||||
things into it.</li>
|
||||
</ol>
|
||||
<p>If you see bad behavior like this, please report it right away.</p>
|
||||
<h2 id="see-also">SEE ALSO</h2>
|
||||
<ul>
|
||||
<li><a href="../misc/npm-registry.html">npm-registry(7)</a></li>
|
||||
<li><a href="../cli/npm-owner.html">npm-owner(1)</a></li>
|
||||
</ul>
|
||||
|
||||
<h2 id="SEE-ALSO">SEE ALSO</h2>
|
||||
|
||||
<ul><li><a href="../misc/npm-registry.html">npm-registry(7)</a></li><li><a href="../cli/npm-owner.html">npm-owner(1)</a></li></ul>
|
||||
</div>
|
||||
|
||||
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
|
||||
@ -105,5 +112,5 @@ things into it.</li></ol>
|
||||
<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-disputes — npm@1.4.9</p>
|
||||
<p id="footer">npm-disputes — npm@1.4.10</p>
|
||||
|
||||
|
||||
260
deps/npm/html/doc/misc/npm-faq.html
vendored
260
deps/npm/html/doc/misc/npm-faq.html
vendored
@ -10,238 +10,181 @@
|
||||
<div id="wrapper">
|
||||
|
||||
<h1><a href="../misc/npm-faq.html">npm-faq</a></h1> <p>Frequently Asked Questions</p>
|
||||
|
||||
<h2 id="Where-can-I-find-these-docs-in-HTML">Where can I find these docs in HTML?</h2>
|
||||
|
||||
<h2 id="where-can-i-find-these-docs-in-html-">Where can I find these docs in HTML?</h2>
|
||||
<p><a href="https://www.npmjs.org/doc/">https://www.npmjs.org/doc/</a>, or run:</p>
|
||||
|
||||
<pre><code>npm config set viewer browser</code></pre>
|
||||
|
||||
<p>to open these documents in your default web browser rather than <code>man</code>.</p>
|
||||
|
||||
<h2 id="It-didn-t-work">It didn't work.</h2>
|
||||
|
||||
<pre><code>npm config set viewer browser
|
||||
</code></pre><p>to open these documents in your default web browser rather than <code>man</code>.</p>
|
||||
<h2 id="it-didn-t-work-">It didn't work.</h2>
|
||||
<p>That's not really a question.</p>
|
||||
|
||||
<h2 id="Why-didn-t-it-work">Why didn't it work?</h2>
|
||||
|
||||
<h2 id="why-didn-t-it-work-">Why didn't it work?</h2>
|
||||
<p>I don't know yet.</p>
|
||||
|
||||
<p>Read the error output, and if you can't figure out what it means,
|
||||
do what it says and post a bug with all the information it asks for.</p>
|
||||
|
||||
<h2 id="Where-does-npm-put-stuff">Where does npm put stuff?</h2>
|
||||
|
||||
<h2 id="where-does-npm-put-stuff-">Where does npm put stuff?</h2>
|
||||
<p>See <code><a href="../files/npm-folders.html">npm-folders(5)</a></code></p>
|
||||
|
||||
<p>tl;dr:</p>
|
||||
|
||||
<ul><li>Use the <code>npm root</code> command to see where modules go, and the <code>npm bin</code>
|
||||
command to see where executables go</li><li>Global installs are different from local installs. If you install
|
||||
<ul>
|
||||
<li>Use the <code>npm root</code> command to see where modules go, and the <code>npm bin</code>
|
||||
command to see where executables go</li>
|
||||
<li>Global installs are different from local installs. If you install
|
||||
something with the <code>-g</code> flag, then its executables go in <code>npm bin -g</code>
|
||||
and its modules go in <code>npm root -g</code>.</li></ul>
|
||||
|
||||
<h2 id="How-do-I-install-something-on-my-computer-in-a-central-location">How do I install something on my computer in a central location?</h2>
|
||||
|
||||
and its modules go in <code>npm root -g</code>.</li>
|
||||
</ul>
|
||||
<h2 id="how-do-i-install-something-on-my-computer-in-a-central-location-">How do I install something on my computer in a central location?</h2>
|
||||
<p>Install it globally by tacking <code>-g</code> or <code>--global</code> to the command. (This
|
||||
is especially important for command line utilities that need to add
|
||||
their bins to the global system <code>PATH</code>.)</p>
|
||||
|
||||
<h2 id="I-installed-something-globally-but-I-can-t-require-it">I installed something globally, but I can't <code>require()</code> it</h2>
|
||||
|
||||
<h2 id="i-installed-something-globally-but-i-can-t-require-it">I installed something globally, but I can't <code>require()</code> it</h2>
|
||||
<p>Install it locally.</p>
|
||||
|
||||
<p>The global install location is a place for command-line utilities
|
||||
to put their bins in the system <code>PATH</code>. It's not for use with <code>require()</code>.</p>
|
||||
|
||||
<p>If you <code>require()</code> a module in your code, then that means it's a
|
||||
dependency, and a part of your program. You need to install it locally
|
||||
in your program.</p>
|
||||
|
||||
<h2 id="Why-can-t-npm-just-put-everything-in-one-place-like-other-package-managers">Why can't npm just put everything in one place, like other package managers?</h2>
|
||||
|
||||
<h2 id="why-can-t-npm-just-put-everything-in-one-place-like-other-package-managers-">Why can't npm just put everything in one place, like other package managers?</h2>
|
||||
<p>Not every change is an improvement, but every improvement is a change.
|
||||
This would be like asking git to do network IO for every commit. It's
|
||||
not going to happen, because it's a terrible idea that causes more
|
||||
problems than it solves.</p>
|
||||
|
||||
<p>It is much harder to avoid dependency conflicts without nesting
|
||||
dependencies. This is fundamental to the way that npm works, and has
|
||||
proven to be an extremely successful approach. See <code><a href="../files/npm-folders.html">npm-folders(5)</a></code> for
|
||||
more details.</p>
|
||||
|
||||
<p>If you want a package to be installed in one place, and have all your
|
||||
programs reference the same copy of it, then use the <code>npm link</code> command.
|
||||
That's what it's for. Install it globally, then link it into each
|
||||
program that uses it.</p>
|
||||
|
||||
<h2 id="Whatever-I-really-want-the-old-style-everything-global-style">Whatever, I really want the old style 'everything global' style.</h2>
|
||||
|
||||
<h2 id="whatever-i-really-want-the-old-style-everything-global-style-">Whatever, I really want the old style 'everything global' style.</h2>
|
||||
<p>Write your own package manager. You could probably even wrap up <code>npm</code>
|
||||
in a shell script if you really wanted to.</p>
|
||||
|
||||
<p>npm will not help you do something that is known to be a bad idea.</p>
|
||||
|
||||
<h2 id="Should-I-check-my-node_modules-folder-into-git">Should I check my <code>node_modules</code> folder into git?</h2>
|
||||
|
||||
<h2 id="should-i-check-my-node_modules-folder-into-git-">Should I check my <code>node_modules</code> folder into git?</h2>
|
||||
<p>Mikeal Rogers answered this question very well:</p>
|
||||
|
||||
<p><a href="http://www.futurealoof.com/posts/nodemodules-in-git.html">http://www.futurealoof.com/posts/nodemodules-in-git.html</a></p>
|
||||
|
||||
<p>tl;dr</p>
|
||||
|
||||
<ul><li>Check <code>node_modules</code> into git for things you <strong>deploy</strong>, such as
|
||||
websites and apps.</li><li>Do not check <code>node_modules</code> into git for libraries and modules
|
||||
intended to be reused.</li><li>Use npm to manage dependencies in your dev environment, but not in
|
||||
your deployment scripts.</li></ul>
|
||||
|
||||
<h2 id="Is-it-npm-or-NPM-or-Npm">Is it 'npm' or 'NPM' or 'Npm'?</h2>
|
||||
|
||||
<ul>
|
||||
<li>Check <code>node_modules</code> into git for things you <strong>deploy</strong>, such as
|
||||
websites and apps.</li>
|
||||
<li>Do not check <code>node_modules</code> into git for libraries and modules
|
||||
intended to be reused.</li>
|
||||
<li>Use npm to manage dependencies in your dev environment, but not in
|
||||
your deployment scripts.</li>
|
||||
</ul>
|
||||
<h2 id="is-it-npm-or-npm-or-npm-">Is it 'npm' or 'NPM' or 'Npm'?</h2>
|
||||
<p>npm should never be capitalized unless it is being displayed in a
|
||||
location that is customarily all-caps (such as the title of man pages.)</p>
|
||||
|
||||
<h2 id="If-npm-is-an-acronym-why-is-it-never-capitalized">If 'npm' is an acronym, why is it never capitalized?</h2>
|
||||
|
||||
<h2 id="if-npm-is-an-acronym-why-is-it-never-capitalized-">If 'npm' is an acronym, why is it never capitalized?</h2>
|
||||
<p>Contrary to the belief of many, "npm" is not in fact an abbreviation for
|
||||
"Node Package Manager". It is a recursive bacronymic abbreviation for
|
||||
"npm is not an acronym". (If it was "ninaa", then it would be an
|
||||
acronym, and thus incorrectly named.)</p>
|
||||
|
||||
<p>"NPM", however, <em>is</em> an acronym (more precisely, a capitonym) for the
|
||||
National Association of Pastoral Musicians. You can learn more
|
||||
about them at <a href="http://npm.org/">http://npm.org/</a>.</p>
|
||||
|
||||
<p>In software, "NPM" is a Non-Parametric Mapping utility written by
|
||||
Chris Rorden. You can analyze pictures of brains with it. Learn more
|
||||
about the (capitalized) NPM program at <a href="http://www.cabiatl.com/mricro/npm/">http://www.cabiatl.com/mricro/npm/</a>.</p>
|
||||
|
||||
<p>The first seed that eventually grew into this flower was a bash utility
|
||||
named "pm", which was a shortened descendent of "pkgmakeinst", a
|
||||
bash function that was used to install various different things on different
|
||||
platforms, most often using Yahoo's <code>yinst</code>. If <code>npm</code> was ever an
|
||||
acronym for anything, it was <code>node pm</code> or maybe <code>new pm</code>.</p>
|
||||
|
||||
<p>So, in all seriousness, the "npm" project is named after its command-line
|
||||
utility, which was organically selected to be easily typed by a right-handed
|
||||
programmer using a US QWERTY keyboard layout, ending with the
|
||||
right-ring-finger in a postition to type the <code>-</code> key for flags and
|
||||
other command-line arguments. That command-line utility is always
|
||||
lower-case, though it starts most sentences it is a part of.</p>
|
||||
|
||||
<h2 id="How-do-I-list-installed-packages">How do I list installed packages?</h2>
|
||||
|
||||
<h2 id="how-do-i-list-installed-packages-">How do I list installed packages?</h2>
|
||||
<p><code>npm ls</code></p>
|
||||
|
||||
<h2 id="How-do-I-search-for-packages">How do I search for packages?</h2>
|
||||
|
||||
<h2 id="how-do-i-search-for-packages-">How do I search for packages?</h2>
|
||||
<p><code>npm search</code></p>
|
||||
|
||||
<p>Arguments are greps. <code>npm search jsdom</code> shows jsdom packages.</p>
|
||||
|
||||
<h2 id="How-do-I-update-npm">How do I update npm?</h2>
|
||||
|
||||
<pre><code>npm update npm -g</code></pre>
|
||||
|
||||
<p>You can also update all outdated local packages by doing <code>npm update</code> without
|
||||
<h2 id="how-do-i-update-npm-">How do I update npm?</h2>
|
||||
<pre><code>npm update npm -g
|
||||
</code></pre><p>You can also update all outdated local packages by doing <code>npm update</code> without
|
||||
any arguments, or global packages by doing <code>npm update -g</code>.</p>
|
||||
|
||||
<p>Occasionally, the version of npm will progress such that the current
|
||||
version cannot be properly installed with the version that you have
|
||||
installed already. (Consider, if there is ever a bug in the <code>update</code>
|
||||
command.)</p>
|
||||
|
||||
<p>In those cases, you can do this:</p>
|
||||
|
||||
<pre><code>curl https://www.npmjs.org/install.sh | sh</code></pre>
|
||||
|
||||
<h2 id="What-is-a-package">What is a <code>package</code>?</h2>
|
||||
|
||||
<pre><code>curl https://www.npmjs.org/install.sh | sh
|
||||
</code></pre><h2 id="what-is-a-package-">What is a <code>package</code>?</h2>
|
||||
<p>A package is:</p>
|
||||
|
||||
<ul><li>a) a folder containing a program described by a package.json file</li><li>b) a gzipped tarball containing (a)</li><li>c) a url that resolves to (b)</li><li>d) a <code><name>@<version></code> that is published on the registry with (c)</li><li>e) a <code><name>@<tag></code> that points to (d)</li><li>f) a <code><name></code> that has a "latest" tag satisfying (e)</li><li>g) a <code>git</code> url that, when cloned, results in (a).</li></ul>
|
||||
|
||||
<ul>
|
||||
<li>a) a folder containing a program described by a package.json file</li>
|
||||
<li>b) a gzipped tarball containing (a)</li>
|
||||
<li>c) a url that resolves to (b)</li>
|
||||
<li>d) a <code><name>@<version></code> that is published on the registry with (c)</li>
|
||||
<li>e) a <code><name>@<tag></code> that points to (d)</li>
|
||||
<li>f) a <code><name></code> that has a "latest" tag satisfying (e)</li>
|
||||
<li>g) a <code>git</code> url that, when cloned, results in (a).</li>
|
||||
</ul>
|
||||
<p>Even if you never publish your package, you can still get a lot of
|
||||
benefits of using npm if you just want to write a node program (a), and
|
||||
perhaps if you also want to be able to easily install it elsewhere
|
||||
after packing it up into a tarball (b).</p>
|
||||
|
||||
<p>Git urls can be of the form:</p>
|
||||
|
||||
<pre><code>git://github.com/user/project.git#commit-ish
|
||||
git+ssh://user@hostname:project.git#commit-ish
|
||||
git+http://user@hostname/project/blah.git#commit-ish
|
||||
git+https://user@hostname/project/blah.git#commit-ish</code></pre>
|
||||
|
||||
<p>The <code>commit-ish</code> can be any tag, sha, or branch which can be supplied as
|
||||
git+https://user@hostname/project/blah.git#commit-ish
|
||||
</code></pre><p>The <code>commit-ish</code> can be any tag, sha, or branch which can be supplied as
|
||||
an argument to <code>git checkout</code>. The default is <code>master</code>.</p>
|
||||
|
||||
<h2 id="What-is-a-module">What is a <code>module</code>?</h2>
|
||||
|
||||
<h2 id="what-is-a-module-">What is a <code>module</code>?</h2>
|
||||
<p>A module is anything that can be loaded with <code>require()</code> in a Node.js
|
||||
program. The following things are all examples of things that can be
|
||||
loaded as modules:</p>
|
||||
|
||||
<ul><li>A folder with a <code>package.json</code> file containing a <code>main</code> field.</li><li>A folder with an <code>index.js</code> file in it.</li><li>A JavaScript file.</li></ul>
|
||||
|
||||
<ul>
|
||||
<li>A folder with a <code>package.json</code> file containing a <code>main</code> field.</li>
|
||||
<li>A folder with an <code>index.js</code> file in it.</li>
|
||||
<li>A JavaScript file.</li>
|
||||
</ul>
|
||||
<p>Most npm packages are modules, because they are libraries that you
|
||||
load with <code>require</code>. However, there's no requirement that an npm
|
||||
package be a module! Some only contain an executable command-line
|
||||
interface, and don't provide a <code>main</code> field for use in Node programs.</p>
|
||||
|
||||
<p>Almost all npm packages (at least, those that are Node programs)
|
||||
<em>contain</em> many modules within them (because every file they load with
|
||||
<code>require()</code> is a module).</p>
|
||||
|
||||
<p>In the context of a Node program, the <code>module</code> is also the thing that
|
||||
was loaded <em>from</em> a file. For example, in the following program:</p>
|
||||
|
||||
<pre><code>var req = require('request')</code></pre>
|
||||
|
||||
<p>we might say that "The variable <code>req</code> refers to the <code>request</code> module".</p>
|
||||
|
||||
<h2 id="So-why-is-it-the-node_modules-folder-but-package-json-file-Why-not-node_packages-or-module-json">So, why is it the "<code>node_modules</code>" folder, but "<code>package.json</code>" file? Why not <code>node_packages</code> or <code>module.json</code>?</h2>
|
||||
|
||||
<pre><code>var req = require('request')
|
||||
</code></pre><p>we might say that "The variable <code>req</code> refers to the <code>request</code> module".</p>
|
||||
<h2 id="so-why-is-it-the-node_modules-folder-but-package-json-file-why-not-node_packages-or-module-json-">So, why is it the "<code>node_modules</code>" folder, but "<code>package.json</code>" file? Why not <code>node_packages</code> or <code>module.json</code>?</h2>
|
||||
<p>The <code>package.json</code> file defines the package. (See "What is a
|
||||
package?" above.)</p>
|
||||
|
||||
<p>The <code>node_modules</code> folder is the place Node.js looks for modules.
|
||||
(See "What is a module?" above.)</p>
|
||||
|
||||
<p>For example, if you create a file at <code>node_modules/foo.js</code> and then
|
||||
had a program that did <code>var f = require('foo.js')</code> then it would load
|
||||
the module. However, <code>foo.js</code> is not a "package" in this case,
|
||||
because it does not have a package.json.</p>
|
||||
|
||||
<p>Alternatively, if you create a package which does not have an
|
||||
<code>index.js</code> or a <code>"main"</code> field in the <code>package.json</code> file, then it is
|
||||
not a module. Even if it's installed in <code>node_modules</code>, it can't be
|
||||
an argument to <code>require()</code>.</p>
|
||||
|
||||
<h2 id="node_modules-is-the-name-of-my-deity-s-arch-rival-and-a-Forbidden-Word-in-my-religion-Can-I-configure-npm-to-use-a-different-folder"><code>"node_modules"</code> is the name of my deity's arch-rival, and a Forbidden Word in my religion. Can I configure npm to use a different folder?</h2>
|
||||
|
||||
<h2 id="-node_modules-is-the-name-of-my-deity-s-arch-rival-and-a-forbidden-word-in-my-religion-can-i-configure-npm-to-use-a-different-folder-"><code>"node_modules"</code> is the name of my deity's arch-rival, and a Forbidden Word in my religion. Can I configure npm to use a different folder?</h2>
|
||||
<p>No. This will never happen. This question comes up sometimes,
|
||||
because it seems silly from the outside that npm couldn't just be
|
||||
configured to put stuff somewhere else, and then npm could load them
|
||||
from there. It's an arbitrary spelling choice, right? What's the big
|
||||
deal?</p>
|
||||
|
||||
<p>At the time of this writing, the string <code>'node_modules'</code> appears 151
|
||||
times in 53 separate files in npm and node core (excluding tests and
|
||||
documentation).</p>
|
||||
|
||||
<p>Some of these references are in node's built-in module loader. Since
|
||||
npm is not involved <strong>at all</strong> at run-time, node itself would have to
|
||||
be configured to know where you've decided to stick stuff. Complexity
|
||||
hurdle #1. Since the Node module system is locked, this cannot be
|
||||
changed, and is enough to kill this request. But I'll continue, in
|
||||
deference to your deity's delicate feelings regarding spelling.</p>
|
||||
|
||||
<p>Many of the others are in dependencies that npm uses, which are not
|
||||
necessarily tightly coupled to npm (in the sense that they do not read
|
||||
npm's configuration files, etc.) Each of these would have to be
|
||||
configured to take the name of the <code>node_modules</code> folder as a
|
||||
parameter. Complexity hurdle #2.</p>
|
||||
|
||||
<p>Furthermore, npm has the ability to "bundle" dependencies by adding
|
||||
the dep names to the <code>"bundledDependencies"</code> list in package.json,
|
||||
which causes the folder to be included in the package tarball. What
|
||||
@ -249,7 +192,6 @@ if the author of a module bundles its dependencies, and they use a
|
||||
different spelling for <code>node_modules</code>? npm would have to rename the
|
||||
folder at publish time, and then be smart enough to unpack it using
|
||||
your locally configured name. Complexity hurdle #3.</p>
|
||||
|
||||
<p>Furthermore, what happens when you <em>change</em> this name? Fine, it's
|
||||
easy enough the first time, just rename the <code>node_modules</code> folders to
|
||||
<code>./blergyblerp/</code> or whatever name you choose. But what about when you
|
||||
@ -258,98 +200,80 @@ configuration settings, so this would be rather difficult to do
|
||||
properly. It would have to track every previous value for this
|
||||
config, and always accept any of them, or else yesterday's install may
|
||||
be broken tomorrow. Complexity hurdle #5.</p>
|
||||
|
||||
<p>Never going to happen. The folder is named <code>node_modules</code>. It is
|
||||
written indelibly in the Node Way, handed down from the ancient times
|
||||
of Node 0.3.</p>
|
||||
|
||||
<h2 id="How-do-I-install-node-with-npm">How do I install node with npm?</h2>
|
||||
|
||||
<h2 id="how-do-i-install-node-with-npm-">How do I install node with npm?</h2>
|
||||
<p>You don't. Try one of these node version managers:</p>
|
||||
|
||||
<p>Unix:</p>
|
||||
|
||||
<ul><li><a href="http://github.com/isaacs/nave">http://github.com/isaacs/nave</a></li><li><a href="http://github.com/visionmedia/n">http://github.com/visionmedia/n</a></li><li><a href="http://github.com/creationix/nvm">http://github.com/creationix/nvm</a></li></ul>
|
||||
|
||||
<ul>
|
||||
<li><a href="http://github.com/isaacs/nave">http://github.com/isaacs/nave</a></li>
|
||||
<li><a href="http://github.com/visionmedia/n">http://github.com/visionmedia/n</a></li>
|
||||
<li><a href="http://github.com/creationix/nvm">http://github.com/creationix/nvm</a></li>
|
||||
</ul>
|
||||
<p>Windows:</p>
|
||||
|
||||
<ul><li><a href="http://github.com/marcelklehr/nodist">http://github.com/marcelklehr/nodist</a></li><li><a href="https://github.com/hakobera/nvmw">https://github.com/hakobera/nvmw</a></li><li><a href="https://github.com/nanjingboy/nvmw">https://github.com/nanjingboy/nvmw</a></li></ul>
|
||||
|
||||
<h2 id="How-can-I-use-npm-for-development">How can I use npm for development?</h2>
|
||||
|
||||
<ul>
|
||||
<li><a href="http://github.com/marcelklehr/nodist">http://github.com/marcelklehr/nodist</a></li>
|
||||
<li><a href="https://github.com/hakobera/nvmw">https://github.com/hakobera/nvmw</a></li>
|
||||
<li><a href="https://github.com/nanjingboy/nvmw">https://github.com/nanjingboy/nvmw</a></li>
|
||||
</ul>
|
||||
<h2 id="how-can-i-use-npm-for-development-">How can I use npm for development?</h2>
|
||||
<p>See <code><a href="../misc/npm-developers.html">npm-developers(7)</a></code> and <code><a href="../files/package.json.html">package.json(5)</a></code>.</p>
|
||||
|
||||
<p>You'll most likely want to <code>npm link</code> your development folder. That's
|
||||
awesomely handy.</p>
|
||||
|
||||
<p>To set up your own private registry, check out <code><a href="../misc/npm-registry.html">npm-registry(7)</a></code>.</p>
|
||||
|
||||
<h2 id="Can-I-list-a-url-as-a-dependency">Can I list a url as a dependency?</h2>
|
||||
|
||||
<h2 id="can-i-list-a-url-as-a-dependency-">Can I list a url as a dependency?</h2>
|
||||
<p>Yes. It should be a url to a gzipped tarball containing a single folder
|
||||
that has a package.json in its root, or a git url.
|
||||
(See "what is a package?" above.)</p>
|
||||
|
||||
<h2 id="How-do-I-symlink-to-a-dev-folder-so-I-don-t-have-to-keep-re-installing">How do I symlink to a dev folder so I don't have to keep re-installing?</h2>
|
||||
|
||||
<h2 id="how-do-i-symlink-to-a-dev-folder-so-i-don-t-have-to-keep-re-installing-">How do I symlink to a dev folder so I don't have to keep re-installing?</h2>
|
||||
<p>See <code><a href="../cli/npm-link.html">npm-link(1)</a></code></p>
|
||||
|
||||
<h2 id="The-package-registry-website-What-is-that-exactly">The package registry website. What is that exactly?</h2>
|
||||
|
||||
<h2 id="the-package-registry-website-what-is-that-exactly-">The package registry website. What is that exactly?</h2>
|
||||
<p>See <code><a href="../misc/npm-registry.html">npm-registry(7)</a></code>.</p>
|
||||
|
||||
<h2 id="I-forgot-my-password-and-can-t-publish-How-do-I-reset-it">I forgot my password, and can't publish. How do I reset it?</h2>
|
||||
|
||||
<h2 id="i-forgot-my-password-and-can-t-publish-how-do-i-reset-it-">I forgot my password, and can't publish. How do I reset it?</h2>
|
||||
<p>Go to <a href="https://npmjs.org/forgot">https://npmjs.org/forgot</a>.</p>
|
||||
|
||||
<h2 id="I-get-ECONNREFUSED-a-lot-What-s-up">I get ECONNREFUSED a lot. What's up?</h2>
|
||||
|
||||
<h2 id="i-get-econnrefused-a-lot-what-s-up-">I get ECONNREFUSED a lot. What's up?</h2>
|
||||
<p>Either the registry is down, or node's DNS isn't able to reach out.</p>
|
||||
|
||||
<p>To check if the registry is down, open up
|
||||
<a href="https://registry.npmjs.org/">https://registry.npmjs.org/</a> in a web browser. This will also tell
|
||||
you if you are just unable to access the internet for some reason.</p>
|
||||
|
||||
<p>If the registry IS down, let us know by emailing <a href="mailto:support@npmjs.com">support@npmjs.com</a>
|
||||
<p>If the registry IS down, let us know by emailing <a href="mailto:support@npmjs.com">support@npmjs.com</a>
|
||||
or posting an issue at <a href="https://github.com/npm/npm/issues">https://github.com/npm/npm/issues</a>. If it's
|
||||
down for the world (and not just on your local network) then we're
|
||||
probably already being pinged about it.</p>
|
||||
|
||||
<p>You can also often get a faster response by visiting the #npm channel
|
||||
on Freenode IRC.</p>
|
||||
|
||||
<h2 id="Why-no-namespaces">Why no namespaces?</h2>
|
||||
|
||||
<h2 id="why-no-namespaces-">Why no namespaces?</h2>
|
||||
<p>Please see this discussion: <a href="https://github.com/npm/npm/issues/798">https://github.com/npm/npm/issues/798</a></p>
|
||||
|
||||
<p>tl;dr - It doesn't actually make things better, and can make them worse.</p>
|
||||
|
||||
<p>If you want to namespace your own packages, you may: simply use the
|
||||
<code>-</code> character to separate the names. npm is a mostly anarchic system.
|
||||
There is not sufficient need to impose namespace rules on everyone.</p>
|
||||
|
||||
<h2 id="Who-does-npm">Who does npm?</h2>
|
||||
|
||||
<h2 id="who-does-npm-">Who does npm?</h2>
|
||||
<p>npm was originally written by Isaac Z. Schlueter, and many others have
|
||||
contributed to it, some of them quite substantially.</p>
|
||||
|
||||
<p>The npm open source project, The npm Registry, and <a href="https://www.npmjs.org">the community
|
||||
website</a> are maintained and operated by the
|
||||
good folks at <a href="https://www.npmjs.com">npm, Inc.</a></p>
|
||||
|
||||
<h2 id="I-have-a-question-or-request-not-addressed-here-Where-should-I-put-it">I have a question or request not addressed here. Where should I put it?</h2>
|
||||
|
||||
<h2 id="i-have-a-question-or-request-not-addressed-here-where-should-i-put-it-">I have a question or request not addressed here. Where should I put it?</h2>
|
||||
<p>Post an issue on the github project:</p>
|
||||
|
||||
<ul><li><a href="https://github.com/npm/npm/issues">https://github.com/npm/npm/issues</a></li></ul>
|
||||
|
||||
<h2 id="Why-does-npm-hate-me">Why does npm hate me?</h2>
|
||||
|
||||
<ul>
|
||||
<li><a href="https://github.com/npm/npm/issues">https://github.com/npm/npm/issues</a></li>
|
||||
</ul>
|
||||
<h2 id="why-does-npm-hate-me-">Why does npm hate me?</h2>
|
||||
<p>npm is not capable of hatred. It loves everyone, especially you.</p>
|
||||
<h2 id="see-also">SEE ALSO</h2>
|
||||
<ul>
|
||||
<li><a href="../cli/npm.html">npm(1)</a></li>
|
||||
<li><a href="../misc/npm-developers.html">npm-developers(7)</a></li>
|
||||
<li><a href="../files/package.json.html">package.json(5)</a></li>
|
||||
<li><a href="../cli/npm-config.html">npm-config(1)</a></li>
|
||||
<li><a href="../misc/npm-config.html">npm-config(7)</a></li>
|
||||
<li><a href="../files/npmrc.html">npmrc(5)</a></li>
|
||||
<li><a href="../misc/npm-config.html">npm-config(7)</a></li>
|
||||
<li><a href="../files/npm-folders.html">npm-folders(5)</a></li>
|
||||
</ul>
|
||||
|
||||
<h2 id="SEE-ALSO">SEE ALSO</h2>
|
||||
|
||||
<ul><li><a href="../cli/npm.html">npm(1)</a></li><li><a href="../misc/npm-developers.html">npm-developers(7)</a></li><li><a href="../files/package.json.html">package.json(5)</a></li><li><a href="../cli/npm-config.html">npm-config(1)</a></li><li><a href="../misc/npm-config.html">npm-config(7)</a></li><li><a href="../files/npmrc.html">npmrc(5)</a></li><li><a href="../misc/npm-config.html">npm-config(7)</a></li><li><a href="../files/npm-folders.html">npm-folders(5)</a></li></ul>
|
||||
</div>
|
||||
|
||||
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
|
||||
@ -361,5 +285,5 @@ good folks at <a href="https://www.npmjs.com">npm, Inc.</a></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-faq — npm@1.4.9</p>
|
||||
<p id="footer">npm-faq — npm@1.4.10</p>
|
||||
|
||||
|
||||
415
deps/npm/html/doc/misc/npm-index.html
vendored
415
deps/npm/html/doc/misc/npm-index.html
vendored
@ -10,414 +10,211 @@
|
||||
<div id="wrapper">
|
||||
|
||||
<h1><a href="../misc/npm-index.html">npm-index</a></h1> <p>Index of all npm documentation</p>
|
||||
|
||||
<h2 id="README-1"><a href="../../doc/README.html">README</a></h2>
|
||||
|
||||
<h2 id="readme-1-"><a href="../../doc/README.html">README</a></h2>
|
||||
<p>node package manager</p>
|
||||
|
||||
<h1>Command Line Documentation</h1>
|
||||
|
||||
<h2 id="npm-1"><a href="../cli/npm.html">npm(1)</a></h2>
|
||||
|
||||
<h1 id="command-line-documentation">Command Line Documentation</h1>
|
||||
<h2 id="npm-1-"><a href="../cli/npm.html">npm(1)</a></h2>
|
||||
<p>node package manager</p>
|
||||
|
||||
<h2 id="npm-adduser-1"><a href="../cli/npm-adduser.html">npm-adduser(1)</a></h2>
|
||||
|
||||
<h2 id="npm-adduser-1-"><a href="../cli/npm-adduser.html">npm-adduser(1)</a></h2>
|
||||
<p>Add a registry user account</p>
|
||||
|
||||
<h2 id="npm-bin-1"><a href="../cli/npm-bin.html">npm-bin(1)</a></h2>
|
||||
|
||||
<h2 id="npm-bin-1-"><a href="../cli/npm-bin.html">npm-bin(1)</a></h2>
|
||||
<p>Display npm bin folder</p>
|
||||
|
||||
<h2 id="npm-bugs-1"><a href="../cli/npm-bugs.html">npm-bugs(1)</a></h2>
|
||||
|
||||
<h2 id="npm-bugs-1-"><a href="../cli/npm-bugs.html">npm-bugs(1)</a></h2>
|
||||
<p>Bugs for a package in a web browser maybe</p>
|
||||
|
||||
<h2 id="npm-build-1"><a href="../cli/npm-build.html">npm-build(1)</a></h2>
|
||||
|
||||
<h2 id="npm-build-1-"><a href="../cli/npm-build.html">npm-build(1)</a></h2>
|
||||
<p>Build a package</p>
|
||||
|
||||
<h2 id="npm-bundle-1"><a href="../cli/npm-bundle.html">npm-bundle(1)</a></h2>
|
||||
|
||||
<h2 id="npm-bundle-1-"><a href="../cli/npm-bundle.html">npm-bundle(1)</a></h2>
|
||||
<p>REMOVED</p>
|
||||
|
||||
<h2 id="npm-cache-1"><a href="../cli/npm-cache.html">npm-cache(1)</a></h2>
|
||||
|
||||
<h2 id="npm-cache-1-"><a href="../cli/npm-cache.html">npm-cache(1)</a></h2>
|
||||
<p>Manipulates packages cache</p>
|
||||
|
||||
<h2 id="npm-completion-1"><a href="../cli/npm-completion.html">npm-completion(1)</a></h2>
|
||||
|
||||
<h2 id="npm-completion-1-"><a href="../cli/npm-completion.html">npm-completion(1)</a></h2>
|
||||
<p>Tab Completion for npm</p>
|
||||
|
||||
<h2 id="npm-config-1"><a href="../cli/npm-config.html">npm-config(1)</a></h2>
|
||||
|
||||
<h2 id="npm-config-1-"><a href="../cli/npm-config.html">npm-config(1)</a></h2>
|
||||
<p>Manage the npm configuration files</p>
|
||||
|
||||
<h2 id="npm-dedupe-1"><a href="../cli/npm-dedupe.html">npm-dedupe(1)</a></h2>
|
||||
|
||||
<h2 id="npm-dedupe-1-"><a href="../cli/npm-dedupe.html">npm-dedupe(1)</a></h2>
|
||||
<p>Reduce duplication</p>
|
||||
|
||||
<h2 id="npm-deprecate-1"><a href="../cli/npm-deprecate.html">npm-deprecate(1)</a></h2>
|
||||
|
||||
<h2 id="npm-deprecate-1-"><a href="../cli/npm-deprecate.html">npm-deprecate(1)</a></h2>
|
||||
<p>Deprecate a version of a package</p>
|
||||
|
||||
<h2 id="npm-docs-1"><a href="../cli/npm-docs.html">npm-docs(1)</a></h2>
|
||||
|
||||
<h2 id="npm-docs-1-"><a href="../cli/npm-docs.html">npm-docs(1)</a></h2>
|
||||
<p>Docs for a package in a web browser maybe</p>
|
||||
|
||||
<h2 id="npm-edit-1"><a href="../cli/npm-edit.html">npm-edit(1)</a></h2>
|
||||
|
||||
<h2 id="npm-edit-1-"><a href="../cli/npm-edit.html">npm-edit(1)</a></h2>
|
||||
<p>Edit an installed package</p>
|
||||
|
||||
<h2 id="npm-explore-1"><a href="../cli/npm-explore.html">npm-explore(1)</a></h2>
|
||||
|
||||
<h2 id="npm-explore-1-"><a href="../cli/npm-explore.html">npm-explore(1)</a></h2>
|
||||
<p>Browse an installed package</p>
|
||||
|
||||
<h2 id="npm-help-search-1"><a href="../cli/npm-help-search.html">npm-help-search(1)</a></h2>
|
||||
|
||||
<h2 id="npm-help-search-1-"><a href="../cli/npm-help-search.html">npm-help-search(1)</a></h2>
|
||||
<p>Search npm help documentation</p>
|
||||
|
||||
<h2 id="npm-help-1"><a href="../cli/npm-help.html">npm-help(1)</a></h2>
|
||||
|
||||
<h2 id="npm-help-1-"><a href="../cli/npm-help.html">npm-help(1)</a></h2>
|
||||
<p>Get help on npm</p>
|
||||
|
||||
<h2 id="npm-init-1"><a href="../cli/npm-init.html">npm-init(1)</a></h2>
|
||||
|
||||
<h2 id="npm-init-1-"><a href="../cli/npm-init.html">npm-init(1)</a></h2>
|
||||
<p>Interactively create a package.json file</p>
|
||||
|
||||
<h2 id="npm-install-1"><a href="../cli/npm-install.html">npm-install(1)</a></h2>
|
||||
|
||||
<h2 id="npm-install-1-"><a href="../cli/npm-install.html">npm-install(1)</a></h2>
|
||||
<p>Install a package</p>
|
||||
|
||||
<h2 id="npm-link-1"><a href="../cli/npm-link.html">npm-link(1)</a></h2>
|
||||
|
||||
<h2 id="npm-link-1-"><a href="../cli/npm-link.html">npm-link(1)</a></h2>
|
||||
<p>Symlink a package folder</p>
|
||||
|
||||
<h2 id="npm-ls-1"><a href="../cli/npm-ls.html">npm-ls(1)</a></h2>
|
||||
|
||||
<h2 id="npm-ls-1-"><a href="../cli/npm-ls.html">npm-ls(1)</a></h2>
|
||||
<p>List installed packages</p>
|
||||
|
||||
<h2 id="npm-outdated-1"><a href="../cli/npm-outdated.html">npm-outdated(1)</a></h2>
|
||||
|
||||
<h2 id="npm-outdated-1-"><a href="../cli/npm-outdated.html">npm-outdated(1)</a></h2>
|
||||
<p>Check for outdated packages</p>
|
||||
|
||||
<h2 id="npm-owner-1"><a href="../cli/npm-owner.html">npm-owner(1)</a></h2>
|
||||
|
||||
<h2 id="npm-owner-1-"><a href="../cli/npm-owner.html">npm-owner(1)</a></h2>
|
||||
<p>Manage package owners</p>
|
||||
|
||||
<h2 id="npm-pack-1"><a href="../cli/npm-pack.html">npm-pack(1)</a></h2>
|
||||
|
||||
<h2 id="npm-pack-1-"><a href="../cli/npm-pack.html">npm-pack(1)</a></h2>
|
||||
<p>Create a tarball from a package</p>
|
||||
|
||||
<h2 id="npm-prefix-1"><a href="../cli/npm-prefix.html">npm-prefix(1)</a></h2>
|
||||
|
||||
<h2 id="npm-prefix-1-"><a href="../cli/npm-prefix.html">npm-prefix(1)</a></h2>
|
||||
<p>Display prefix</p>
|
||||
|
||||
<h2 id="npm-prune-1"><a href="../cli/npm-prune.html">npm-prune(1)</a></h2>
|
||||
|
||||
<h2 id="npm-prune-1-"><a href="../cli/npm-prune.html">npm-prune(1)</a></h2>
|
||||
<p>Remove extraneous packages</p>
|
||||
|
||||
<h2 id="npm-publish-1"><a href="../cli/npm-publish.html">npm-publish(1)</a></h2>
|
||||
|
||||
<h2 id="npm-publish-1-"><a href="../cli/npm-publish.html">npm-publish(1)</a></h2>
|
||||
<p>Publish a package</p>
|
||||
|
||||
<h2 id="npm-rebuild-1"><a href="../cli/npm-rebuild.html">npm-rebuild(1)</a></h2>
|
||||
|
||||
<h2 id="npm-rebuild-1-"><a href="../cli/npm-rebuild.html">npm-rebuild(1)</a></h2>
|
||||
<p>Rebuild a package</p>
|
||||
|
||||
<h2 id="npm-repo-1"><a href="../cli/npm-repo.html">npm-repo(1)</a></h2>
|
||||
|
||||
<h2 id="npm-repo-1-"><a href="../cli/npm-repo.html">npm-repo(1)</a></h2>
|
||||
<p>Open package repository page in the browser</p>
|
||||
|
||||
<h2 id="npm-restart-1"><a href="../cli/npm-restart.html">npm-restart(1)</a></h2>
|
||||
|
||||
<h2 id="npm-restart-1-"><a href="../cli/npm-restart.html">npm-restart(1)</a></h2>
|
||||
<p>Start a package</p>
|
||||
|
||||
<h2 id="npm-rm-1"><a href="../cli/npm-rm.html">npm-rm(1)</a></h2>
|
||||
|
||||
<h2 id="npm-rm-1-"><a href="../cli/npm-rm.html">npm-rm(1)</a></h2>
|
||||
<p>Remove a package</p>
|
||||
|
||||
<h2 id="npm-root-1"><a href="../cli/npm-root.html">npm-root(1)</a></h2>
|
||||
|
||||
<h2 id="npm-root-1-"><a href="../cli/npm-root.html">npm-root(1)</a></h2>
|
||||
<p>Display npm root</p>
|
||||
|
||||
<h2 id="npm-run-script-1"><a href="../cli/npm-run-script.html">npm-run-script(1)</a></h2>
|
||||
|
||||
<h2 id="npm-run-script-1-"><a href="../cli/npm-run-script.html">npm-run-script(1)</a></h2>
|
||||
<p>Run arbitrary package scripts</p>
|
||||
|
||||
<h2 id="npm-search-1"><a href="../cli/npm-search.html">npm-search(1)</a></h2>
|
||||
|
||||
<h2 id="npm-search-1-"><a href="../cli/npm-search.html">npm-search(1)</a></h2>
|
||||
<p>Search for packages</p>
|
||||
|
||||
<h2 id="npm-shrinkwrap-1"><a href="../cli/npm-shrinkwrap.html">npm-shrinkwrap(1)</a></h2>
|
||||
|
||||
<h2 id="npm-shrinkwrap-1-"><a href="../cli/npm-shrinkwrap.html">npm-shrinkwrap(1)</a></h2>
|
||||
<p>Lock down dependency versions</p>
|
||||
|
||||
<h2 id="npm-star-1"><a href="../cli/npm-star.html">npm-star(1)</a></h2>
|
||||
|
||||
<h2 id="npm-star-1-"><a href="../cli/npm-star.html">npm-star(1)</a></h2>
|
||||
<p>Mark your favorite packages</p>
|
||||
|
||||
<h2 id="npm-stars-1"><a href="../cli/npm-stars.html">npm-stars(1)</a></h2>
|
||||
|
||||
<h2 id="npm-stars-1-"><a href="../cli/npm-stars.html">npm-stars(1)</a></h2>
|
||||
<p>View packages marked as favorites</p>
|
||||
|
||||
<h2 id="npm-start-1"><a href="../cli/npm-start.html">npm-start(1)</a></h2>
|
||||
|
||||
<h2 id="npm-start-1-"><a href="../cli/npm-start.html">npm-start(1)</a></h2>
|
||||
<p>Start a package</p>
|
||||
|
||||
<h2 id="npm-stop-1"><a href="../cli/npm-stop.html">npm-stop(1)</a></h2>
|
||||
|
||||
<h2 id="npm-stop-1-"><a href="../cli/npm-stop.html">npm-stop(1)</a></h2>
|
||||
<p>Stop a package</p>
|
||||
|
||||
<h2 id="npm-submodule-1"><a href="../cli/npm-submodule.html">npm-submodule(1)</a></h2>
|
||||
|
||||
<h2 id="npm-submodule-1-"><a href="../cli/npm-submodule.html">npm-submodule(1)</a></h2>
|
||||
<p>Add a package as a git submodule</p>
|
||||
|
||||
<h2 id="npm-tag-1"><a href="../cli/npm-tag.html">npm-tag(1)</a></h2>
|
||||
|
||||
<h2 id="npm-tag-1-"><a href="../cli/npm-tag.html">npm-tag(1)</a></h2>
|
||||
<p>Tag a published version</p>
|
||||
|
||||
<h2 id="npm-test-1"><a href="../cli/npm-test.html">npm-test(1)</a></h2>
|
||||
|
||||
<h2 id="npm-test-1-"><a href="../cli/npm-test.html">npm-test(1)</a></h2>
|
||||
<p>Test a package</p>
|
||||
|
||||
<h2 id="npm-uninstall-1"><a href="../cli/npm-uninstall.html">npm-uninstall(1)</a></h2>
|
||||
|
||||
<h2 id="npm-uninstall-1-"><a href="../cli/npm-uninstall.html">npm-uninstall(1)</a></h2>
|
||||
<p>Remove a package</p>
|
||||
|
||||
<h2 id="npm-unpublish-1"><a href="../cli/npm-unpublish.html">npm-unpublish(1)</a></h2>
|
||||
|
||||
<h2 id="npm-unpublish-1-"><a href="../cli/npm-unpublish.html">npm-unpublish(1)</a></h2>
|
||||
<p>Remove a package from the registry</p>
|
||||
|
||||
<h2 id="npm-update-1"><a href="../cli/npm-update.html">npm-update(1)</a></h2>
|
||||
|
||||
<h2 id="npm-update-1-"><a href="../cli/npm-update.html">npm-update(1)</a></h2>
|
||||
<p>Update a package</p>
|
||||
|
||||
<h2 id="npm-version-1"><a href="../cli/npm-version.html">npm-version(1)</a></h2>
|
||||
|
||||
<h2 id="npm-version-1-"><a href="../cli/npm-version.html">npm-version(1)</a></h2>
|
||||
<p>Bump a package version</p>
|
||||
|
||||
<h2 id="npm-view-1"><a href="../cli/npm-view.html">npm-view(1)</a></h2>
|
||||
|
||||
<h2 id="npm-view-1-"><a href="../cli/npm-view.html">npm-view(1)</a></h2>
|
||||
<p>View registry info</p>
|
||||
|
||||
<h2 id="npm-whoami-1"><a href="../cli/npm-whoami.html">npm-whoami(1)</a></h2>
|
||||
|
||||
<h2 id="npm-whoami-1-"><a href="../cli/npm-whoami.html">npm-whoami(1)</a></h2>
|
||||
<p>Display npm username</p>
|
||||
|
||||
<h1>API Documentation</h1>
|
||||
|
||||
<h2 id="npm-3"><a href="../api/npm.html">npm(3)</a></h2>
|
||||
|
||||
<h1 id="api-documentation">API Documentation</h1>
|
||||
<h2 id="npm-3-"><a href="../api/npm.html">npm(3)</a></h2>
|
||||
<p>node package manager</p>
|
||||
|
||||
<h2 id="npm-bin-3"><a href="../api/npm-bin.html">npm-bin(3)</a></h2>
|
||||
|
||||
<h2 id="npm-bin-3-"><a href="../api/npm-bin.html">npm-bin(3)</a></h2>
|
||||
<p>Display npm bin folder</p>
|
||||
|
||||
<h2 id="npm-bugs-3"><a href="../api/npm-bugs.html">npm-bugs(3)</a></h2>
|
||||
|
||||
<h2 id="npm-bugs-3-"><a href="../api/npm-bugs.html">npm-bugs(3)</a></h2>
|
||||
<p>Bugs for a package in a web browser maybe</p>
|
||||
|
||||
<h2 id="npm-commands-3"><a href="../api/npm-commands.html">npm-commands(3)</a></h2>
|
||||
|
||||
<h2 id="npm-commands-3-"><a href="../api/npm-commands.html">npm-commands(3)</a></h2>
|
||||
<p>npm commands</p>
|
||||
|
||||
<h2 id="npm-config-3"><a href="../api/npm-config.html">npm-config(3)</a></h2>
|
||||
|
||||
<h2 id="npm-config-3-"><a href="../api/npm-config.html">npm-config(3)</a></h2>
|
||||
<p>Manage the npm configuration files</p>
|
||||
|
||||
<h2 id="npm-deprecate-3"><a href="../api/npm-deprecate.html">npm-deprecate(3)</a></h2>
|
||||
|
||||
<h2 id="npm-deprecate-3-"><a href="../api/npm-deprecate.html">npm-deprecate(3)</a></h2>
|
||||
<p>Deprecate a version of a package</p>
|
||||
|
||||
<h2 id="npm-docs-3"><a href="../api/npm-docs.html">npm-docs(3)</a></h2>
|
||||
|
||||
<h2 id="npm-docs-3-"><a href="../api/npm-docs.html">npm-docs(3)</a></h2>
|
||||
<p>Docs for a package in a web browser maybe</p>
|
||||
|
||||
<h2 id="npm-edit-3"><a href="../api/npm-edit.html">npm-edit(3)</a></h2>
|
||||
|
||||
<h2 id="npm-edit-3-"><a href="../api/npm-edit.html">npm-edit(3)</a></h2>
|
||||
<p>Edit an installed package</p>
|
||||
|
||||
<h2 id="npm-explore-3"><a href="../api/npm-explore.html">npm-explore(3)</a></h2>
|
||||
|
||||
<h2 id="npm-explore-3-"><a href="../api/npm-explore.html">npm-explore(3)</a></h2>
|
||||
<p>Browse an installed package</p>
|
||||
|
||||
<h2 id="npm-help-search-3"><a href="../api/npm-help-search.html">npm-help-search(3)</a></h2>
|
||||
|
||||
<h2 id="npm-help-search-3-"><a href="../api/npm-help-search.html">npm-help-search(3)</a></h2>
|
||||
<p>Search the help pages</p>
|
||||
|
||||
<h2 id="npm-init-3"><a href="../api/npm-init.html">npm-init(3)</a></h2>
|
||||
|
||||
<h2 id="npm-init-3-"><a href="../api/npm-init.html">npm-init(3)</a></h2>
|
||||
<p>Interactively create a package.json file</p>
|
||||
|
||||
<h2 id="npm-install-3"><a href="../api/npm-install.html">npm-install(3)</a></h2>
|
||||
|
||||
<h2 id="npm-install-3-"><a href="../api/npm-install.html">npm-install(3)</a></h2>
|
||||
<p>install a package programmatically</p>
|
||||
|
||||
<h2 id="npm-link-3"><a href="../api/npm-link.html">npm-link(3)</a></h2>
|
||||
|
||||
<h2 id="npm-link-3-"><a href="../api/npm-link.html">npm-link(3)</a></h2>
|
||||
<p>Symlink a package folder</p>
|
||||
|
||||
<h2 id="npm-load-3"><a href="../api/npm-load.html">npm-load(3)</a></h2>
|
||||
|
||||
<h2 id="npm-load-3-"><a href="../api/npm-load.html">npm-load(3)</a></h2>
|
||||
<p>Load config settings</p>
|
||||
|
||||
<h2 id="npm-ls-3"><a href="../api/npm-ls.html">npm-ls(3)</a></h2>
|
||||
|
||||
<h2 id="npm-ls-3-"><a href="../api/npm-ls.html">npm-ls(3)</a></h2>
|
||||
<p>List installed packages</p>
|
||||
|
||||
<h2 id="npm-outdated-3"><a href="../api/npm-outdated.html">npm-outdated(3)</a></h2>
|
||||
|
||||
<h2 id="npm-outdated-3-"><a href="../api/npm-outdated.html">npm-outdated(3)</a></h2>
|
||||
<p>Check for outdated packages</p>
|
||||
|
||||
<h2 id="npm-owner-3"><a href="../api/npm-owner.html">npm-owner(3)</a></h2>
|
||||
|
||||
<h2 id="npm-owner-3-"><a href="../api/npm-owner.html">npm-owner(3)</a></h2>
|
||||
<p>Manage package owners</p>
|
||||
|
||||
<h2 id="npm-pack-3"><a href="../api/npm-pack.html">npm-pack(3)</a></h2>
|
||||
|
||||
<h2 id="npm-pack-3-"><a href="../api/npm-pack.html">npm-pack(3)</a></h2>
|
||||
<p>Create a tarball from a package</p>
|
||||
|
||||
<h2 id="npm-prefix-3"><a href="../api/npm-prefix.html">npm-prefix(3)</a></h2>
|
||||
|
||||
<h2 id="npm-prefix-3-"><a href="../api/npm-prefix.html">npm-prefix(3)</a></h2>
|
||||
<p>Display prefix</p>
|
||||
|
||||
<h2 id="npm-prune-3"><a href="../api/npm-prune.html">npm-prune(3)</a></h2>
|
||||
|
||||
<h2 id="npm-prune-3-"><a href="../api/npm-prune.html">npm-prune(3)</a></h2>
|
||||
<p>Remove extraneous packages</p>
|
||||
|
||||
<h2 id="npm-publish-3"><a href="../api/npm-publish.html">npm-publish(3)</a></h2>
|
||||
|
||||
<h2 id="npm-publish-3-"><a href="../api/npm-publish.html">npm-publish(3)</a></h2>
|
||||
<p>Publish a package</p>
|
||||
|
||||
<h2 id="npm-rebuild-3"><a href="../api/npm-rebuild.html">npm-rebuild(3)</a></h2>
|
||||
|
||||
<h2 id="npm-rebuild-3-"><a href="../api/npm-rebuild.html">npm-rebuild(3)</a></h2>
|
||||
<p>Rebuild a package</p>
|
||||
|
||||
<h2 id="npm-repo-3"><a href="../api/npm-repo.html">npm-repo(3)</a></h2>
|
||||
|
||||
<h2 id="npm-repo-3-"><a href="../api/npm-repo.html">npm-repo(3)</a></h2>
|
||||
<p>Open package repository page in the browser</p>
|
||||
|
||||
<h2 id="npm-restart-3"><a href="../api/npm-restart.html">npm-restart(3)</a></h2>
|
||||
|
||||
<h2 id="npm-restart-3-"><a href="../api/npm-restart.html">npm-restart(3)</a></h2>
|
||||
<p>Start a package</p>
|
||||
|
||||
<h2 id="npm-root-3"><a href="../api/npm-root.html">npm-root(3)</a></h2>
|
||||
|
||||
<h2 id="npm-root-3-"><a href="../api/npm-root.html">npm-root(3)</a></h2>
|
||||
<p>Display npm root</p>
|
||||
|
||||
<h2 id="npm-run-script-3"><a href="../api/npm-run-script.html">npm-run-script(3)</a></h2>
|
||||
|
||||
<h2 id="npm-run-script-3-"><a href="../api/npm-run-script.html">npm-run-script(3)</a></h2>
|
||||
<p>Run arbitrary package scripts</p>
|
||||
|
||||
<h2 id="npm-search-3"><a href="../api/npm-search.html">npm-search(3)</a></h2>
|
||||
|
||||
<h2 id="npm-search-3-"><a href="../api/npm-search.html">npm-search(3)</a></h2>
|
||||
<p>Search for packages</p>
|
||||
|
||||
<h2 id="npm-shrinkwrap-3"><a href="../api/npm-shrinkwrap.html">npm-shrinkwrap(3)</a></h2>
|
||||
|
||||
<h2 id="npm-shrinkwrap-3-"><a href="../api/npm-shrinkwrap.html">npm-shrinkwrap(3)</a></h2>
|
||||
<p>programmatically generate package shrinkwrap file</p>
|
||||
|
||||
<h2 id="npm-start-3"><a href="../api/npm-start.html">npm-start(3)</a></h2>
|
||||
|
||||
<h2 id="npm-start-3-"><a href="../api/npm-start.html">npm-start(3)</a></h2>
|
||||
<p>Start a package</p>
|
||||
|
||||
<h2 id="npm-stop-3"><a href="../api/npm-stop.html">npm-stop(3)</a></h2>
|
||||
|
||||
<h2 id="npm-stop-3-"><a href="../api/npm-stop.html">npm-stop(3)</a></h2>
|
||||
<p>Stop a package</p>
|
||||
|
||||
<h2 id="npm-submodule-3"><a href="../api/npm-submodule.html">npm-submodule(3)</a></h2>
|
||||
|
||||
<h2 id="npm-submodule-3-"><a href="../api/npm-submodule.html">npm-submodule(3)</a></h2>
|
||||
<p>Add a package as a git submodule</p>
|
||||
|
||||
<h2 id="npm-tag-3"><a href="../api/npm-tag.html">npm-tag(3)</a></h2>
|
||||
|
||||
<h2 id="npm-tag-3-"><a href="../api/npm-tag.html">npm-tag(3)</a></h2>
|
||||
<p>Tag a published version</p>
|
||||
|
||||
<h2 id="npm-test-3"><a href="../api/npm-test.html">npm-test(3)</a></h2>
|
||||
|
||||
<h2 id="npm-test-3-"><a href="../api/npm-test.html">npm-test(3)</a></h2>
|
||||
<p>Test a package</p>
|
||||
|
||||
<h2 id="npm-uninstall-3"><a href="../api/npm-uninstall.html">npm-uninstall(3)</a></h2>
|
||||
|
||||
<h2 id="npm-uninstall-3-"><a href="../api/npm-uninstall.html">npm-uninstall(3)</a></h2>
|
||||
<p>uninstall a package programmatically</p>
|
||||
|
||||
<h2 id="npm-unpublish-3"><a href="../api/npm-unpublish.html">npm-unpublish(3)</a></h2>
|
||||
|
||||
<h2 id="npm-unpublish-3-"><a href="../api/npm-unpublish.html">npm-unpublish(3)</a></h2>
|
||||
<p>Remove a package from the registry</p>
|
||||
|
||||
<h2 id="npm-update-3"><a href="../api/npm-update.html">npm-update(3)</a></h2>
|
||||
|
||||
<h2 id="npm-update-3-"><a href="../api/npm-update.html">npm-update(3)</a></h2>
|
||||
<p>Update a package</p>
|
||||
|
||||
<h2 id="npm-version-3"><a href="../api/npm-version.html">npm-version(3)</a></h2>
|
||||
|
||||
<h2 id="npm-version-3-"><a href="../api/npm-version.html">npm-version(3)</a></h2>
|
||||
<p>Bump a package version</p>
|
||||
|
||||
<h2 id="npm-view-3"><a href="../api/npm-view.html">npm-view(3)</a></h2>
|
||||
|
||||
<h2 id="npm-view-3-"><a href="../api/npm-view.html">npm-view(3)</a></h2>
|
||||
<p>View registry info</p>
|
||||
|
||||
<h2 id="npm-whoami-3"><a href="../api/npm-whoami.html">npm-whoami(3)</a></h2>
|
||||
|
||||
<h2 id="npm-whoami-3-"><a href="../api/npm-whoami.html">npm-whoami(3)</a></h2>
|
||||
<p>Display npm username</p>
|
||||
|
||||
<h1>Files</h1>
|
||||
|
||||
<h2 id="npm-folders-5"><a href="../files/npm-folders.html">npm-folders(5)</a></h2>
|
||||
|
||||
<h1 id="files">Files</h1>
|
||||
<h2 id="npm-folders-5-"><a href="../files/npm-folders.html">npm-folders(5)</a></h2>
|
||||
<p>Folder Structures Used by npm</p>
|
||||
|
||||
<h2 id="npmrc-5"><a href="../files/npmrc.html">npmrc(5)</a></h2>
|
||||
|
||||
<h2 id="npmrc-5-"><a href="../files/npmrc.html">npmrc(5)</a></h2>
|
||||
<p>The npm config files</p>
|
||||
|
||||
<h2 id="package-json-5"><a href="../files/package.json.html">package.json(5)</a></h2>
|
||||
|
||||
<h2 id="package-json-5-"><a href="../files/package.json.html">package.json(5)</a></h2>
|
||||
<p>Specifics of npm's package.json handling</p>
|
||||
|
||||
<h1>Misc</h1>
|
||||
|
||||
<h2 id="npm-coding-style-7"><a href="../misc/npm-coding-style.html">npm-coding-style(7)</a></h2>
|
||||
|
||||
<h1 id="misc">Misc</h1>
|
||||
<h2 id="npm-coding-style-7-"><a href="../misc/npm-coding-style.html">npm-coding-style(7)</a></h2>
|
||||
<p>npm's "funny" coding style</p>
|
||||
|
||||
<h2 id="npm-config-7"><a href="../misc/npm-config.html">npm-config(7)</a></h2>
|
||||
|
||||
<h2 id="npm-config-7-"><a href="../misc/npm-config.html">npm-config(7)</a></h2>
|
||||
<p>More than you probably want to know about npm configuration</p>
|
||||
|
||||
<h2 id="npm-developers-7"><a href="../misc/npm-developers.html">npm-developers(7)</a></h2>
|
||||
|
||||
<h2 id="npm-developers-7-"><a href="../misc/npm-developers.html">npm-developers(7)</a></h2>
|
||||
<p>Developer Guide</p>
|
||||
|
||||
<h2 id="npm-disputes-7"><a href="../misc/npm-disputes.html">npm-disputes(7)</a></h2>
|
||||
|
||||
<h2 id="npm-disputes-7-"><a href="../misc/npm-disputes.html">npm-disputes(7)</a></h2>
|
||||
<p>Handling Module Name Disputes</p>
|
||||
|
||||
<h2 id="npm-faq-7"><a href="../misc/npm-faq.html">npm-faq(7)</a></h2>
|
||||
|
||||
<h2 id="npm-faq-7-"><a href="../misc/npm-faq.html">npm-faq(7)</a></h2>
|
||||
<p>Frequently Asked Questions</p>
|
||||
|
||||
<h2 id="npm-index-7"><a href="../misc/npm-index.html">npm-index(7)</a></h2>
|
||||
|
||||
<h2 id="npm-index-7-"><a href="../misc/npm-index.html">npm-index(7)</a></h2>
|
||||
<p>Index of all npm documentation</p>
|
||||
|
||||
<h2 id="npm-registry-7"><a href="../misc/npm-registry.html">npm-registry(7)</a></h2>
|
||||
|
||||
<h2 id="npm-registry-7-"><a href="../misc/npm-registry.html">npm-registry(7)</a></h2>
|
||||
<p>The JavaScript Package Registry</p>
|
||||
|
||||
<h2 id="npm-scripts-7"><a href="../misc/npm-scripts.html">npm-scripts(7)</a></h2>
|
||||
|
||||
<h2 id="npm-scripts-7-"><a href="../misc/npm-scripts.html">npm-scripts(7)</a></h2>
|
||||
<p>How npm handles the "scripts" field</p>
|
||||
|
||||
<h2 id="removing-npm-7"><a href="../misc/removing-npm.html">removing-npm(7)</a></h2>
|
||||
|
||||
<h2 id="removing-npm-7-"><a href="../misc/removing-npm.html">removing-npm(7)</a></h2>
|
||||
<p>Cleaning the Slate</p>
|
||||
|
||||
<h2 id="semver-7"><a href="../misc/semver.html">semver(7)</a></h2>
|
||||
|
||||
<h2 id="semver-7-"><a href="../misc/semver.html">semver(7)</a></h2>
|
||||
<p>The semantic versioner for npm</p>
|
||||
|
||||
</div>
|
||||
|
||||
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
|
||||
@ -429,5 +226,5 @@
|
||||
<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-index — npm@1.4.9</p>
|
||||
<p id="footer">npm-index — npm@1.4.10</p>
|
||||
|
||||
|
||||
Some files were not shown because too many files have changed in this diff Show More
Loading…
x
Reference in New Issue
Block a user