mirror of
https://github.com/S2-/minifyfromhtml.git
synced 2025-08-03 12:20:04 +02:00
update packages to latest version
This commit is contained in:
131
node_modules/npm/html/doc/README.html
generated
vendored
Normal file
131
node_modules/npm/html/doc/README.html
generated
vendored
Normal file
@@ -0,0 +1,131 @@
|
||||
<!doctype html>
|
||||
<html>
|
||||
<title>README</title>
|
||||
<meta charset="utf-8">
|
||||
<link rel="stylesheet" type="text/css" href="../static/style.css">
|
||||
<link rel="canonical" href="https://www.npmjs.org/doc/README.html">
|
||||
<script async=true src="../../static/toc.js"></script>
|
||||
|
||||
<body>
|
||||
<div id="wrapper">
|
||||
|
||||
<h1><a href="cli/npm.html">npm</a></h1> <p>a JavaScript package manager</p>
|
||||
<p><a href="https://travis-ci.org/npm/npm"><img src="https://img.shields.io/travis/npm/npm/master.svg" alt="Build Status"></a></p>
|
||||
<h2 id="synopsis">SYNOPSIS</h2>
|
||||
<p>This is just enough info to get you up and running.</p>
|
||||
<p>Much more info available via <code>npm help</code> once it's installed.</p>
|
||||
<h2 id="important">IMPORTANT</h2>
|
||||
<p><strong>You need node v0.10 or higher to run this program.</strong></p>
|
||||
<p>To install an old <strong>and unsupported</strong> version of npm that works on node 0.3
|
||||
and prior, clone the git repo and dig through the old tags and branches.</p>
|
||||
<p><strong>npm is configured to use npm, Inc.'s public package registry at
|
||||
<a href="https://registry.npmjs.org">https://registry.npmjs.org</a> by default.</strong></p>
|
||||
<p>You can configure npm to use any compatible registry you
|
||||
like, and even run your own registry. Check out the <a href="https://docs.npmjs.com/misc/registry">doc on
|
||||
registries</a>.</p>
|
||||
<p>Use of someone else's registry may be governed by terms of use. The
|
||||
terms of use for the default public registry are available at
|
||||
<a href="https://www.npmjs.com">https://www.npmjs.com</a>.</p>
|
||||
<h2 id="super-easy-install">Super Easy Install</h2>
|
||||
<p>npm is bundled with <a href="http://nodejs.org/download/">node</a>.</p>
|
||||
<h3 id="windows-computers">Windows Computers</h3>
|
||||
<p><a href="http://nodejs.org/download/">Get the MSI</a>. npm is in it.</p>
|
||||
<h3 id="apple-macintosh-computers">Apple Macintosh Computers</h3>
|
||||
<p><a href="http://nodejs.org/download/">Get the pkg</a>. npm is in it.</p>
|
||||
<h3 id="other-sorts-of-unices">Other Sorts of Unices</h3>
|
||||
<p>Run <code>make install</code>. npm will be installed with node.</p>
|
||||
<p>If you want a more fancy pants install (a different version, customized
|
||||
paths, etc.) then read on.</p>
|
||||
<h2 id="fancy-install-unix-">Fancy Install (Unix)</h2>
|
||||
<p>There's a pretty robust install script at
|
||||
<a href="https://www.npmjs.com/install.sh">https://www.npmjs.com/install.sh</a>. You can download that and run it.</p>
|
||||
<p>Here's an example using curl:</p>
|
||||
<pre><code class="lang-sh">curl -L https://www.npmjs.com/install.sh | sh
|
||||
</code></pre>
|
||||
<h3 id="slightly-fancier">Slightly Fancier</h3>
|
||||
<p>You can set any npm configuration params with that script:</p>
|
||||
<pre><code class="lang-sh">npm_config_prefix=/some/path sh install.sh
|
||||
</code></pre>
|
||||
<p>Or, you can run it in uber-debuggery mode:</p>
|
||||
<pre><code class="lang-sh">npm_debug=1 sh install.sh
|
||||
</code></pre>
|
||||
<h3 id="even-fancier">Even Fancier</h3>
|
||||
<p>Get the code with git. Use <code>make</code> to build the docs and do other stuff.
|
||||
If you plan on hacking on npm, <code>make link</code> is your friend.</p>
|
||||
<p>If you've got the npm source code, you can also semi-permanently set
|
||||
arbitrary config keys using the <code>./configure --key=val ...</code>, and then
|
||||
run npm commands by doing <code>node cli.js <cmd> <args></code>. (This is helpful
|
||||
for testing, or running stuff without actually installing npm itself.)</p>
|
||||
<h2 id="windows-install-or-upgrade">Windows Install or Upgrade</h2>
|
||||
<p>You can download a zip file from <a href="https://github.com/npm/npm/releases">https://github.com/npm/npm/releases</a>, and
|
||||
unpack it in the <code>node_modules\npm\</code> folder inside node's installation folder.</p>
|
||||
<p>To upgrade to npm 2, follow the Windows upgrade instructions in
|
||||
the npm Troubleshooting Guide:</p>
|
||||
<p><a href="https://github.com/npm/npm/wiki/Troubleshooting#upgrading-on-windows">https://github.com/npm/npm/wiki/Troubleshooting#upgrading-on-windows</a></p>
|
||||
<p>If that's not fancy enough for you, then you can fetch the code with
|
||||
git, and mess with it directly.</p>
|
||||
<h2 id="installing-on-cygwin">Installing on Cygwin</h2>
|
||||
<p>No.</p>
|
||||
<h2 id="uninstalling">Uninstalling</h2>
|
||||
<p>So sad to see you go.</p>
|
||||
<pre><code class="lang-sh">sudo npm uninstall npm -g
|
||||
</code></pre>
|
||||
<p>Or, if that fails,</p>
|
||||
<pre><code class="lang-sh">sudo make uninstall
|
||||
</code></pre>
|
||||
<h2 id="more-severe-uninstalling">More Severe Uninstalling</h2>
|
||||
<p>Usually, the above instructions are sufficient. That will remove
|
||||
npm, but leave behind anything you've installed.</p>
|
||||
<p>If you would like to remove all the packages that you have installed,
|
||||
then you can use the <code>npm ls</code> command to find them, and then <code>npm rm</code> to
|
||||
remove them.</p>
|
||||
<p>To remove cruft left behind by npm 0.x, you can use the included
|
||||
<code>clean-old.sh</code> script file. You can run it conveniently like this:</p>
|
||||
<pre><code class="lang-sh">npm explore npm -g -- sh scripts/clean-old.sh
|
||||
</code></pre>
|
||||
<p>npm uses two configuration files, one for per-user configs, and another
|
||||
for global (every-user) configs. You can view them by doing:</p>
|
||||
<pre><code class="lang-sh">npm config get userconfig # defaults to ~/.npmrc
|
||||
npm config get globalconfig # defaults to /usr/local/etc/npmrc
|
||||
</code></pre>
|
||||
<p>Uninstalling npm does not remove configuration files by default. You
|
||||
must remove them yourself manually if you want them gone. Note that
|
||||
this means that future npm installs will not remember the settings that
|
||||
you have chosen.</p>
|
||||
<h2 id="more-docs">More Docs</h2>
|
||||
<p>Check out the <a href="https://docs.npmjs.com/">docs</a>,
|
||||
especially the <a href="https://docs.npmjs.com/misc/faq">faq</a>.</p>
|
||||
<p>You can use the <code>npm help</code> command to read any of them.</p>
|
||||
<p>If you're a developer, and you want to use npm to publish your program,
|
||||
you should <a href="https://docs.npmjs.com/misc/developers">read this</a></p>
|
||||
<h2 id="bugs">BUGS</h2>
|
||||
<p>When you find issues, please report them:</p>
|
||||
<ul>
|
||||
<li>web:
|
||||
<a href="https://github.com/npm/npm/issues">https://github.com/npm/npm/issues</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="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>
|
||||
<li><a href="misc/npm-index.html">npm-index(7)</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
|
||||
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
|
||||
<tr><td style="width:180px;height:10px;background:rgb(237,127,127)" colspan=18> </td></tr>
|
||||
<tr><td rowspan=4 style="width:10px;height:10px;background:rgb(237,127,127)"> </td><td style="width:40px;height:10px;background:#fff" colspan=4> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=4> </td><td style="width:40px;height:10px;background:#fff" colspan=4> </td><td rowspan=4 style="width:10px;height:10px;background:rgb(237,127,127)"> </td><td colspan=6 style="width:60px;height:10px;background:#fff"> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=4> </td></tr>
|
||||
<tr><td colspan=2 style="width:20px;height:30px;background:#fff" rowspan=3> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:20px;height:10px;background:#fff" rowspan=4 colspan=2> </td><td style="width:10px;height:20px;background:rgb(237,127,127)" rowspan=2> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:20px;height:10px;background:#fff" rowspan=3 colspan=2> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td></tr>
|
||||
<tr><td style="width:10px;height:10px;background:#fff" rowspan=2> </td></tr>
|
||||
<tr><td style="width:10px;height:10px;background:#fff"> </td></tr>
|
||||
<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"><a href="../doc/README.html">README</a> — npm@2.15.12</p>
|
||||
|
||||
32
node_modules/npm/html/doc/api/npm-bin.html
generated
vendored
Normal file
32
node_modules/npm/html/doc/api/npm-bin.html
generated
vendored
Normal file
@@ -0,0 +1,32 @@
|
||||
<!doctype html>
|
||||
<html>
|
||||
<title>npm-bin</title>
|
||||
<meta charset="utf-8">
|
||||
<link rel="stylesheet" type="text/css" href="../../static/style.css">
|
||||
<link rel="canonical" href="https://www.npmjs.org/doc/api/npm-bin.html">
|
||||
<script async=true src="../../static/toc.js"></script>
|
||||
|
||||
<body>
|
||||
<div id="wrapper">
|
||||
|
||||
<h1><a href="../api/npm-bin.html">npm-bin</a></h1> <p>Display npm bin folder</p>
|
||||
<h2 id="synopsis">SYNOPSIS</h2>
|
||||
<pre><code>npm.commands.bin(args, cb)
|
||||
</code></pre><h2 id="description">DESCRIPTION</h2>
|
||||
<p>Print the folder where npm will install executables.</p>
|
||||
<p>This function should not be used programmatically. Instead, just refer
|
||||
to the <code>npm.bin</code> property.</p>
|
||||
|
||||
</div>
|
||||
|
||||
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
|
||||
<tr><td style="width:180px;height:10px;background:rgb(237,127,127)" colspan=18> </td></tr>
|
||||
<tr><td rowspan=4 style="width:10px;height:10px;background:rgb(237,127,127)"> </td><td style="width:40px;height:10px;background:#fff" colspan=4> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=4> </td><td style="width:40px;height:10px;background:#fff" colspan=4> </td><td rowspan=4 style="width:10px;height:10px;background:rgb(237,127,127)"> </td><td colspan=6 style="width:60px;height:10px;background:#fff"> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=4> </td></tr>
|
||||
<tr><td colspan=2 style="width:20px;height:30px;background:#fff" rowspan=3> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:20px;height:10px;background:#fff" rowspan=4 colspan=2> </td><td style="width:10px;height:20px;background:rgb(237,127,127)" rowspan=2> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:20px;height:10px;background:#fff" rowspan=3 colspan=2> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td></tr>
|
||||
<tr><td style="width:10px;height:10px;background:#fff" rowspan=2> </td></tr>
|
||||
<tr><td style="width:10px;height:10px;background:#fff"> </td></tr>
|
||||
<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@2.15.12</p>
|
||||
|
||||
37
node_modules/npm/html/doc/api/npm-bugs.html
generated
vendored
Normal file
37
node_modules/npm/html/doc/api/npm-bugs.html
generated
vendored
Normal file
@@ -0,0 +1,37 @@
|
||||
<!doctype html>
|
||||
<html>
|
||||
<title>npm-bugs</title>
|
||||
<meta charset="utf-8">
|
||||
<link rel="stylesheet" type="text/css" href="../../static/style.css">
|
||||
<link rel="canonical" href="https://www.npmjs.org/doc/api/npm-bugs.html">
|
||||
<script async=true src="../../static/toc.js"></script>
|
||||
|
||||
<body>
|
||||
<div id="wrapper">
|
||||
|
||||
<h1><a href="../api/npm-bugs.html">npm-bugs</a></h1> <p>Bugs for a package in a web browser maybe</p>
|
||||
<h2 id="synopsis">SYNOPSIS</h2>
|
||||
<pre><code>npm.commands.bugs(package, callback)
|
||||
</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.</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>
|
||||
<tr><td style="width:180px;height:10px;background:rgb(237,127,127)" colspan=18> </td></tr>
|
||||
<tr><td rowspan=4 style="width:10px;height:10px;background:rgb(237,127,127)"> </td><td style="width:40px;height:10px;background:#fff" colspan=4> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=4> </td><td style="width:40px;height:10px;background:#fff" colspan=4> </td><td rowspan=4 style="width:10px;height:10px;background:rgb(237,127,127)"> </td><td colspan=6 style="width:60px;height:10px;background:#fff"> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=4> </td></tr>
|
||||
<tr><td colspan=2 style="width:20px;height:30px;background:#fff" rowspan=3> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:20px;height:10px;background:#fff" rowspan=4 colspan=2> </td><td style="width:10px;height:20px;background:rgb(237,127,127)" rowspan=2> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:20px;height:10px;background:#fff" rowspan=3 colspan=2> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td></tr>
|
||||
<tr><td style="width:10px;height:10px;background:#fff" rowspan=2> </td></tr>
|
||||
<tr><td style="width:10px;height:10px;background:#fff"> </td></tr>
|
||||
<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@2.15.12</p>
|
||||
|
||||
46
node_modules/npm/html/doc/api/npm-cache.html
generated
vendored
Normal file
46
node_modules/npm/html/doc/api/npm-cache.html
generated
vendored
Normal file
@@ -0,0 +1,46 @@
|
||||
<!doctype html>
|
||||
<html>
|
||||
<title>npm-cache</title>
|
||||
<meta charset="utf-8">
|
||||
<link rel="stylesheet" type="text/css" href="../../static/style.css">
|
||||
<link rel="canonical" href="https://www.npmjs.org/doc/api/npm-cache.html">
|
||||
<script async=true src="../../static/toc.js"></script>
|
||||
|
||||
<body>
|
||||
<div id="wrapper">
|
||||
|
||||
<h1><a href="../api/npm-cache.html">npm-cache</a></h1> <p>manage the npm cache programmatically</p>
|
||||
<h2 id="synopsis">SYNOPSIS</h2>
|
||||
<pre><code>npm.commands.cache([args], callback)
|
||||
|
||||
// helpers
|
||||
npm.commands.cache.clean([args], callback)
|
||||
npm.commands.cache.add([args], callback)
|
||||
npm.commands.cache.read(name, version, forceBypass, callback)
|
||||
</code></pre><h2 id="description">DESCRIPTION</h2>
|
||||
<p>This acts much the same ways as the <a href="../cli/npm-cache.html">npm-cache(1)</a> command line
|
||||
functionality.</p>
|
||||
<p>The callback is called with the package.json data of the thing that is
|
||||
eventually added to or read from the cache.</p>
|
||||
<p>The top level <code>npm.commands.cache(...)</code> functionality is a public
|
||||
interface, and like all commands on the <code>npm.commands</code> object, it will
|
||||
match the command line behavior exactly.</p>
|
||||
<p>However, the cache folder structure and the cache helper functions are
|
||||
considered <strong>internal</strong> API surface, and as such, may change in future
|
||||
releases of npm, potentially without warning or significant version
|
||||
incrementation.</p>
|
||||
<p>Use at your own risk.</p>
|
||||
|
||||
</div>
|
||||
|
||||
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
|
||||
<tr><td style="width:180px;height:10px;background:rgb(237,127,127)" colspan=18> </td></tr>
|
||||
<tr><td rowspan=4 style="width:10px;height:10px;background:rgb(237,127,127)"> </td><td style="width:40px;height:10px;background:#fff" colspan=4> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=4> </td><td style="width:40px;height:10px;background:#fff" colspan=4> </td><td rowspan=4 style="width:10px;height:10px;background:rgb(237,127,127)"> </td><td colspan=6 style="width:60px;height:10px;background:#fff"> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=4> </td></tr>
|
||||
<tr><td colspan=2 style="width:20px;height:30px;background:#fff" rowspan=3> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:20px;height:10px;background:#fff" rowspan=4 colspan=2> </td><td style="width:10px;height:20px;background:rgb(237,127,127)" rowspan=2> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:20px;height:10px;background:#fff" rowspan=3 colspan=2> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td></tr>
|
||||
<tr><td style="width:10px;height:10px;background:#fff" rowspan=2> </td></tr>
|
||||
<tr><td style="width:10px;height:10px;background:#fff"> </td></tr>
|
||||
<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@2.15.12</p>
|
||||
|
||||
40
node_modules/npm/html/doc/api/npm-commands.html
generated
vendored
Normal file
40
node_modules/npm/html/doc/api/npm-commands.html
generated
vendored
Normal file
@@ -0,0 +1,40 @@
|
||||
<!doctype html>
|
||||
<html>
|
||||
<title>npm-commands</title>
|
||||
<meta charset="utf-8">
|
||||
<link rel="stylesheet" type="text/css" href="../../static/style.css">
|
||||
<link rel="canonical" href="https://www.npmjs.org/doc/api/npm-commands.html">
|
||||
<script async=true src="../../static/toc.js"></script>
|
||||
|
||||
<body>
|
||||
<div id="wrapper">
|
||||
|
||||
<h1><a href="../api/npm-commands.html">npm-commands</a></h1> <p>npm commands</p>
|
||||
<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>
|
||||
|
||||
</div>
|
||||
|
||||
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
|
||||
<tr><td style="width:180px;height:10px;background:rgb(237,127,127)" colspan=18> </td></tr>
|
||||
<tr><td rowspan=4 style="width:10px;height:10px;background:rgb(237,127,127)"> </td><td style="width:40px;height:10px;background:#fff" colspan=4> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=4> </td><td style="width:40px;height:10px;background:#fff" colspan=4> </td><td rowspan=4 style="width:10px;height:10px;background:rgb(237,127,127)"> </td><td colspan=6 style="width:60px;height:10px;background:#fff"> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=4> </td></tr>
|
||||
<tr><td colspan=2 style="width:20px;height:30px;background:#fff" rowspan=3> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:20px;height:10px;background:#fff" rowspan=4 colspan=2> </td><td style="width:10px;height:20px;background:rgb(237,127,127)" rowspan=2> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:20px;height:10px;background:#fff" rowspan=3 colspan=2> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td></tr>
|
||||
<tr><td style="width:10px;height:10px;background:#fff" rowspan=2> </td></tr>
|
||||
<tr><td style="width:10px;height:10px;background:#fff"> </td></tr>
|
||||
<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@2.15.12</p>
|
||||
|
||||
61
node_modules/npm/html/doc/api/npm-config.html
generated
vendored
Normal file
61
node_modules/npm/html/doc/api/npm-config.html
generated
vendored
Normal file
@@ -0,0 +1,61 @@
|
||||
<!doctype html>
|
||||
<html>
|
||||
<title>npm-config</title>
|
||||
<meta charset="utf-8">
|
||||
<link rel="stylesheet" type="text/css" href="../../static/style.css">
|
||||
<link rel="canonical" href="https://www.npmjs.org/doc/api/npm-config.html">
|
||||
<script async=true src="../../static/toc.js"></script>
|
||||
|
||||
<body>
|
||||
<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>
|
||||
<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>
|
||||
<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>
|
||||
<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>
|
||||
|
||||
</div>
|
||||
|
||||
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
|
||||
<tr><td style="width:180px;height:10px;background:rgb(237,127,127)" colspan=18> </td></tr>
|
||||
<tr><td rowspan=4 style="width:10px;height:10px;background:rgb(237,127,127)"> </td><td style="width:40px;height:10px;background:#fff" colspan=4> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=4> </td><td style="width:40px;height:10px;background:#fff" colspan=4> </td><td rowspan=4 style="width:10px;height:10px;background:rgb(237,127,127)"> </td><td colspan=6 style="width:60px;height:10px;background:#fff"> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=4> </td></tr>
|
||||
<tr><td colspan=2 style="width:20px;height:30px;background:#fff" rowspan=3> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:20px;height:10px;background:#fff" rowspan=4 colspan=2> </td><td style="width:10px;height:20px;background:rgb(237,127,127)" rowspan=2> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:20px;height:10px;background:#fff" rowspan=3 colspan=2> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td></tr>
|
||||
<tr><td style="width:10px;height:10px;background:#fff" rowspan=2> </td></tr>
|
||||
<tr><td style="width:10px;height:10px;background:#fff"> </td></tr>
|
||||
<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@2.15.12</p>
|
||||
|
||||
51
node_modules/npm/html/doc/api/npm-deprecate.html
generated
vendored
Normal file
51
node_modules/npm/html/doc/api/npm-deprecate.html
generated
vendored
Normal file
@@ -0,0 +1,51 @@
|
||||
<!doctype html>
|
||||
<html>
|
||||
<title>npm-deprecate</title>
|
||||
<meta charset="utf-8">
|
||||
<link rel="stylesheet" type="text/css" href="../../static/style.css">
|
||||
<link rel="canonical" href="https://www.npmjs.org/doc/api/npm-deprecate.html">
|
||||
<script async=true src="../../static/toc.js"></script>
|
||||
|
||||
<body>
|
||||
<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>
|
||||
<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>
|
||||
<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>
|
||||
|
||||
</div>
|
||||
|
||||
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
|
||||
<tr><td style="width:180px;height:10px;background:rgb(237,127,127)" colspan=18> </td></tr>
|
||||
<tr><td rowspan=4 style="width:10px;height:10px;background:rgb(237,127,127)"> </td><td style="width:40px;height:10px;background:#fff" colspan=4> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=4> </td><td style="width:40px;height:10px;background:#fff" colspan=4> </td><td rowspan=4 style="width:10px;height:10px;background:rgb(237,127,127)"> </td><td colspan=6 style="width:60px;height:10px;background:#fff"> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=4> </td></tr>
|
||||
<tr><td colspan=2 style="width:20px;height:30px;background:#fff" rowspan=3> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:20px;height:10px;background:#fff" rowspan=4 colspan=2> </td><td style="width:10px;height:20px;background:rgb(237,127,127)" rowspan=2> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:20px;height:10px;background:#fff" rowspan=3 colspan=2> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td></tr>
|
||||
<tr><td style="width:10px;height:10px;background:#fff" rowspan=2> </td></tr>
|
||||
<tr><td style="width:10px;height:10px;background:#fff"> </td></tr>
|
||||
<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@2.15.12</p>
|
||||
|
||||
37
node_modules/npm/html/doc/api/npm-docs.html
generated
vendored
Normal file
37
node_modules/npm/html/doc/api/npm-docs.html
generated
vendored
Normal file
@@ -0,0 +1,37 @@
|
||||
<!doctype html>
|
||||
<html>
|
||||
<title>npm-docs</title>
|
||||
<meta charset="utf-8">
|
||||
<link rel="stylesheet" type="text/css" href="../../static/style.css">
|
||||
<link rel="canonical" href="https://www.npmjs.org/doc/api/npm-docs.html">
|
||||
<script async=true src="../../static/toc.js"></script>
|
||||
|
||||
<body>
|
||||
<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>
|
||||
<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>
|
||||
<tr><td style="width:180px;height:10px;background:rgb(237,127,127)" colspan=18> </td></tr>
|
||||
<tr><td rowspan=4 style="width:10px;height:10px;background:rgb(237,127,127)"> </td><td style="width:40px;height:10px;background:#fff" colspan=4> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=4> </td><td style="width:40px;height:10px;background:#fff" colspan=4> </td><td rowspan=4 style="width:10px;height:10px;background:rgb(237,127,127)"> </td><td colspan=6 style="width:60px;height:10px;background:#fff"> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=4> </td></tr>
|
||||
<tr><td colspan=2 style="width:20px;height:30px;background:#fff" rowspan=3> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:20px;height:10px;background:#fff" rowspan=4 colspan=2> </td><td style="width:10px;height:20px;background:rgb(237,127,127)" rowspan=2> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:20px;height:10px;background:#fff" rowspan=3 colspan=2> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td></tr>
|
||||
<tr><td style="width:10px;height:10px;background:#fff" rowspan=2> </td></tr>
|
||||
<tr><td style="width:10px;height:10px;background:#fff"> </td></tr>
|
||||
<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@2.15.12</p>
|
||||
|
||||
40
node_modules/npm/html/doc/api/npm-edit.html
generated
vendored
Normal file
40
node_modules/npm/html/doc/api/npm-edit.html
generated
vendored
Normal file
@@ -0,0 +1,40 @@
|
||||
<!doctype html>
|
||||
<html>
|
||||
<title>npm-edit</title>
|
||||
<meta charset="utf-8">
|
||||
<link rel="stylesheet" type="text/css" href="../../static/style.css">
|
||||
<link rel="canonical" href="https://www.npmjs.org/doc/api/npm-edit.html">
|
||||
<script async=true src="../../static/toc.js"></script>
|
||||
|
||||
<body>
|
||||
<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>
|
||||
<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>
|
||||
<tr><td style="width:180px;height:10px;background:rgb(237,127,127)" colspan=18> </td></tr>
|
||||
<tr><td rowspan=4 style="width:10px;height:10px;background:rgb(237,127,127)"> </td><td style="width:40px;height:10px;background:#fff" colspan=4> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=4> </td><td style="width:40px;height:10px;background:#fff" colspan=4> </td><td rowspan=4 style="width:10px;height:10px;background:rgb(237,127,127)"> </td><td colspan=6 style="width:60px;height:10px;background:#fff"> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=4> </td></tr>
|
||||
<tr><td colspan=2 style="width:20px;height:30px;background:#fff" rowspan=3> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:20px;height:10px;background:#fff" rowspan=4 colspan=2> </td><td style="width:10px;height:20px;background:rgb(237,127,127)" rowspan=2> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:20px;height:10px;background:#fff" rowspan=3 colspan=2> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td></tr>
|
||||
<tr><td style="width:10px;height:10px;background:#fff" rowspan=2> </td></tr>
|
||||
<tr><td style="width:10px;height:10px;background:#fff"> </td></tr>
|
||||
<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@2.15.12</p>
|
||||
|
||||
35
node_modules/npm/html/doc/api/npm-explore.html
generated
vendored
Normal file
35
node_modules/npm/html/doc/api/npm-explore.html
generated
vendored
Normal file
@@ -0,0 +1,35 @@
|
||||
<!doctype html>
|
||||
<html>
|
||||
<title>npm-explore</title>
|
||||
<meta charset="utf-8">
|
||||
<link rel="stylesheet" type="text/css" href="../../static/style.css">
|
||||
<link rel="canonical" href="https://www.npmjs.org/doc/api/npm-explore.html">
|
||||
<script async=true src="../../static/toc.js"></script>
|
||||
|
||||
<body>
|
||||
<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>
|
||||
<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>
|
||||
<tr><td style="width:180px;height:10px;background:rgb(237,127,127)" colspan=18> </td></tr>
|
||||
<tr><td rowspan=4 style="width:10px;height:10px;background:rgb(237,127,127)"> </td><td style="width:40px;height:10px;background:#fff" colspan=4> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=4> </td><td style="width:40px;height:10px;background:#fff" colspan=4> </td><td rowspan=4 style="width:10px;height:10px;background:rgb(237,127,127)"> </td><td colspan=6 style="width:60px;height:10px;background:#fff"> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=4> </td></tr>
|
||||
<tr><td colspan=2 style="width:20px;height:30px;background:#fff" rowspan=3> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:20px;height:10px;background:#fff" rowspan=4 colspan=2> </td><td style="width:10px;height:20px;background:rgb(237,127,127)" rowspan=2> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:20px;height:10px;background:#fff" rowspan=3 colspan=2> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td></tr>
|
||||
<tr><td style="width:10px;height:10px;background:#fff" rowspan=2> </td></tr>
|
||||
<tr><td style="width:10px;height:10px;background:#fff"> </td></tr>
|
||||
<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@2.15.12</p>
|
||||
|
||||
48
node_modules/npm/html/doc/api/npm-help-search.html
generated
vendored
Normal file
48
node_modules/npm/html/doc/api/npm-help-search.html
generated
vendored
Normal file
@@ -0,0 +1,48 @@
|
||||
<!doctype html>
|
||||
<html>
|
||||
<title>npm-help-search</title>
|
||||
<meta charset="utf-8">
|
||||
<link rel="stylesheet" type="text/css" href="../../static/style.css">
|
||||
<link rel="canonical" href="https://www.npmjs.org/doc/api/npm-help-search.html">
|
||||
<script async=true src="../../static/toc.js"></script>
|
||||
|
||||
<body>
|
||||
<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>
|
||||
<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>
|
||||
<p>The silent parameter is not necessary not used, but it may in the future.</p>
|
||||
|
||||
</div>
|
||||
|
||||
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
|
||||
<tr><td style="width:180px;height:10px;background:rgb(237,127,127)" colspan=18> </td></tr>
|
||||
<tr><td rowspan=4 style="width:10px;height:10px;background:rgb(237,127,127)"> </td><td style="width:40px;height:10px;background:#fff" colspan=4> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=4> </td><td style="width:40px;height:10px;background:#fff" colspan=4> </td><td rowspan=4 style="width:10px;height:10px;background:rgb(237,127,127)"> </td><td colspan=6 style="width:60px;height:10px;background:#fff"> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=4> </td></tr>
|
||||
<tr><td colspan=2 style="width:20px;height:30px;background:#fff" rowspan=3> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:20px;height:10px;background:#fff" rowspan=4 colspan=2> </td><td style="width:10px;height:20px;background:rgb(237,127,127)" rowspan=2> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:20px;height:10px;background:#fff" rowspan=3 colspan=2> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td></tr>
|
||||
<tr><td style="width:10px;height:10px;background:#fff" rowspan=2> </td></tr>
|
||||
<tr><td style="width:10px;height:10px;background:#fff"> </td></tr>
|
||||
<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@2.15.12</p>
|
||||
|
||||
43
node_modules/npm/html/doc/api/npm-init.html
generated
vendored
Normal file
43
node_modules/npm/html/doc/api/npm-init.html
generated
vendored
Normal file
@@ -0,0 +1,43 @@
|
||||
<!doctype html>
|
||||
<html>
|
||||
<title>npm-init</title>
|
||||
<meta charset="utf-8">
|
||||
<link rel="stylesheet" type="text/css" href="../../static/style.css">
|
||||
<link rel="canonical" href="https://www.npmjs.org/doc/api/npm-init.html">
|
||||
<script async=true src="../../static/toc.js"></script>
|
||||
|
||||
<body>
|
||||
<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>
|
||||
<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>
|
||||
<p><a href="../files/package.json.html">package.json(5)</a></p>
|
||||
|
||||
</div>
|
||||
|
||||
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
|
||||
<tr><td style="width:180px;height:10px;background:rgb(237,127,127)" colspan=18> </td></tr>
|
||||
<tr><td rowspan=4 style="width:10px;height:10px;background:rgb(237,127,127)"> </td><td style="width:40px;height:10px;background:#fff" colspan=4> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=4> </td><td style="width:40px;height:10px;background:#fff" colspan=4> </td><td rowspan=4 style="width:10px;height:10px;background:rgb(237,127,127)"> </td><td colspan=6 style="width:60px;height:10px;background:#fff"> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=4> </td></tr>
|
||||
<tr><td colspan=2 style="width:20px;height:30px;background:#fff" rowspan=3> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:20px;height:10px;background:#fff" rowspan=4 colspan=2> </td><td style="width:10px;height:20px;background:rgb(237,127,127)" rowspan=2> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:20px;height:10px;background:#fff" rowspan=3 colspan=2> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td></tr>
|
||||
<tr><td style="width:10px;height:10px;background:#fff" rowspan=2> </td></tr>
|
||||
<tr><td style="width:10px;height:10px;background:#fff"> </td></tr>
|
||||
<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@2.15.12</p>
|
||||
|
||||
36
node_modules/npm/html/doc/api/npm-install.html
generated
vendored
Normal file
36
node_modules/npm/html/doc/api/npm-install.html
generated
vendored
Normal file
@@ -0,0 +1,36 @@
|
||||
<!doctype html>
|
||||
<html>
|
||||
<title>npm-install</title>
|
||||
<meta charset="utf-8">
|
||||
<link rel="stylesheet" type="text/css" href="../../static/style.css">
|
||||
<link rel="canonical" href="https://www.npmjs.org/doc/api/npm-install.html">
|
||||
<script async=true src="../../static/toc.js"></script>
|
||||
|
||||
<body>
|
||||
<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>
|
||||
<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>
|
||||
<tr><td style="width:180px;height:10px;background:rgb(237,127,127)" colspan=18> </td></tr>
|
||||
<tr><td rowspan=4 style="width:10px;height:10px;background:rgb(237,127,127)"> </td><td style="width:40px;height:10px;background:#fff" colspan=4> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=4> </td><td style="width:40px;height:10px;background:#fff" colspan=4> </td><td rowspan=4 style="width:10px;height:10px;background:rgb(237,127,127)"> </td><td colspan=6 style="width:60px;height:10px;background:#fff"> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=4> </td></tr>
|
||||
<tr><td colspan=2 style="width:20px;height:30px;background:#fff" rowspan=3> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:20px;height:10px;background:#fff" rowspan=4 colspan=2> </td><td style="width:10px;height:20px;background:rgb(237,127,127)" rowspan=2> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:20px;height:10px;background:#fff" rowspan=3 colspan=2> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td></tr>
|
||||
<tr><td style="width:10px;height:10px;background:#fff" rowspan=2> </td></tr>
|
||||
<tr><td style="width:10px;height:10px;background:#fff"> </td></tr>
|
||||
<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@2.15.12</p>
|
||||
|
||||
46
node_modules/npm/html/doc/api/npm-link.html
generated
vendored
Normal file
46
node_modules/npm/html/doc/api/npm-link.html
generated
vendored
Normal file
@@ -0,0 +1,46 @@
|
||||
<!doctype html>
|
||||
<html>
|
||||
<title>npm-link</title>
|
||||
<meta charset="utf-8">
|
||||
<link rel="stylesheet" type="text/css" href="../../static/style.css">
|
||||
<link rel="canonical" href="https://www.npmjs.org/doc/api/npm-link.html">
|
||||
<script async=true src="../../static/toc.js"></script>
|
||||
|
||||
<body>
|
||||
<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>
|
||||
<pre><code>npm.commands.link(callback)
|
||||
npm.commands.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
|
||||
the package in the current working directory</p>
|
||||
|
||||
</div>
|
||||
|
||||
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
|
||||
<tr><td style="width:180px;height:10px;background:rgb(237,127,127)" colspan=18> </td></tr>
|
||||
<tr><td rowspan=4 style="width:10px;height:10px;background:rgb(237,127,127)"> </td><td style="width:40px;height:10px;background:#fff" colspan=4> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=4> </td><td style="width:40px;height:10px;background:#fff" colspan=4> </td><td rowspan=4 style="width:10px;height:10px;background:rgb(237,127,127)"> </td><td colspan=6 style="width:60px;height:10px;background:#fff"> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=4> </td></tr>
|
||||
<tr><td colspan=2 style="width:20px;height:30px;background:#fff" rowspan=3> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:20px;height:10px;background:#fff" rowspan=4 colspan=2> </td><td style="width:10px;height:20px;background:rgb(237,127,127)" rowspan=2> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:20px;height:10px;background:#fff" rowspan=3 colspan=2> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td></tr>
|
||||
<tr><td style="width:10px;height:10px;background:#fff" rowspan=2> </td></tr>
|
||||
<tr><td style="width:10px;height:10px;background:#fff"> </td></tr>
|
||||
<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@2.15.12</p>
|
||||
|
||||
41
node_modules/npm/html/doc/api/npm-load.html
generated
vendored
Normal file
41
node_modules/npm/html/doc/api/npm-load.html
generated
vendored
Normal file
@@ -0,0 +1,41 @@
|
||||
<!doctype html>
|
||||
<html>
|
||||
<title>npm-load</title>
|
||||
<meta charset="utf-8">
|
||||
<link rel="stylesheet" type="text/css" href="../../static/style.css">
|
||||
<link rel="canonical" href="https://www.npmjs.org/doc/api/npm-load.html">
|
||||
<script async=true src="../../static/toc.js"></script>
|
||||
|
||||
<body>
|
||||
<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>
|
||||
<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 containing 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><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>
|
||||
<tr><td style="width:180px;height:10px;background:rgb(237,127,127)" colspan=18> </td></tr>
|
||||
<tr><td rowspan=4 style="width:10px;height:10px;background:rgb(237,127,127)"> </td><td style="width:40px;height:10px;background:#fff" colspan=4> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=4> </td><td style="width:40px;height:10px;background:#fff" colspan=4> </td><td rowspan=4 style="width:10px;height:10px;background:rgb(237,127,127)"> </td><td colspan=6 style="width:60px;height:10px;background:#fff"> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=4> </td></tr>
|
||||
<tr><td colspan=2 style="width:20px;height:30px;background:#fff" rowspan=3> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:20px;height:10px;background:#fff" rowspan=4 colspan=2> </td><td style="width:10px;height:20px;background:rgb(237,127,127)" rowspan=2> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:20px;height:10px;background:#fff" rowspan=3 colspan=2> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td></tr>
|
||||
<tr><td style="width:10px;height:10px;background:#fff" rowspan=2> </td></tr>
|
||||
<tr><td style="width:10px;height:10px;background:#fff"> </td></tr>
|
||||
<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@2.15.12</p>
|
||||
|
||||
67
node_modules/npm/html/doc/api/npm-ls.html
generated
vendored
Normal file
67
node_modules/npm/html/doc/api/npm-ls.html
generated
vendored
Normal file
@@ -0,0 +1,67 @@
|
||||
<!doctype html>
|
||||
<html>
|
||||
<title>npm-ls</title>
|
||||
<meta charset="utf-8">
|
||||
<link rel="stylesheet" type="text/css" href="../../static/style.css">
|
||||
<link rel="canonical" href="https://www.npmjs.org/doc/api/npm-ls.html">
|
||||
<script async=true src="../../static/toc.js"></script>
|
||||
|
||||
<body>
|
||||
<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>
|
||||
<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>
|
||||
<h3 id="long">long</h3>
|
||||
<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>
|
||||
<p>Show parseable output instead of tree view.</p>
|
||||
<h3 id="global">global</h3>
|
||||
<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 has the 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>
|
||||
<tr><td style="width:180px;height:10px;background:rgb(237,127,127)" colspan=18> </td></tr>
|
||||
<tr><td rowspan=4 style="width:10px;height:10px;background:rgb(237,127,127)"> </td><td style="width:40px;height:10px;background:#fff" colspan=4> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=4> </td><td style="width:40px;height:10px;background:#fff" colspan=4> </td><td rowspan=4 style="width:10px;height:10px;background:rgb(237,127,127)"> </td><td colspan=6 style="width:60px;height:10px;background:#fff"> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=4> </td></tr>
|
||||
<tr><td colspan=2 style="width:20px;height:30px;background:#fff" rowspan=3> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:20px;height:10px;background:#fff" rowspan=4 colspan=2> </td><td style="width:10px;height:20px;background:rgb(237,127,127)" rowspan=2> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:20px;height:10px;background:#fff" rowspan=3 colspan=2> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td></tr>
|
||||
<tr><td style="width:10px;height:10px;background:#fff" rowspan=2> </td></tr>
|
||||
<tr><td style="width:10px;height:10px;background:#fff"> </td></tr>
|
||||
<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@2.15.12</p>
|
||||
|
||||
32
node_modules/npm/html/doc/api/npm-outdated.html
generated
vendored
Normal file
32
node_modules/npm/html/doc/api/npm-outdated.html
generated
vendored
Normal file
@@ -0,0 +1,32 @@
|
||||
<!doctype html>
|
||||
<html>
|
||||
<title>npm-outdated</title>
|
||||
<meta charset="utf-8">
|
||||
<link rel="stylesheet" type="text/css" href="../../static/style.css">
|
||||
<link rel="canonical" href="https://www.npmjs.org/doc/api/npm-outdated.html">
|
||||
<script async=true src="../../static/toc.js"></script>
|
||||
|
||||
<body>
|
||||
<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>
|
||||
<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>
|
||||
<tr><td style="width:180px;height:10px;background:rgb(237,127,127)" colspan=18> </td></tr>
|
||||
<tr><td rowspan=4 style="width:10px;height:10px;background:rgb(237,127,127)"> </td><td style="width:40px;height:10px;background:#fff" colspan=4> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=4> </td><td style="width:40px;height:10px;background:#fff" colspan=4> </td><td rowspan=4 style="width:10px;height:10px;background:rgb(237,127,127)"> </td><td colspan=6 style="width:60px;height:10px;background:#fff"> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=4> </td></tr>
|
||||
<tr><td colspan=2 style="width:20px;height:30px;background:#fff" rowspan=3> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:20px;height:10px;background:#fff" rowspan=4 colspan=2> </td><td style="width:10px;height:20px;background:rgb(237,127,127)" rowspan=2> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:20px;height:10px;background:#fff" rowspan=3 colspan=2> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td></tr>
|
||||
<tr><td style="width:10px;height:10px;background:#fff" rowspan=2> </td></tr>
|
||||
<tr><td style="width:10px;height:10px;background:#fff"> </td></tr>
|
||||
<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@2.15.12</p>
|
||||
|
||||
51
node_modules/npm/html/doc/api/npm-owner.html
generated
vendored
Normal file
51
node_modules/npm/html/doc/api/npm-owner.html
generated
vendored
Normal file
@@ -0,0 +1,51 @@
|
||||
<!doctype html>
|
||||
<html>
|
||||
<title>npm-owner</title>
|
||||
<meta charset="utf-8">
|
||||
<link rel="stylesheet" type="text/css" href="../../static/style.css">
|
||||
<link rel="canonical" href="https://www.npmjs.org/doc/api/npm-owner.html">
|
||||
<script async=true src="../../static/toc.js"></script>
|
||||
|
||||
<body>
|
||||
<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>
|
||||
<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):
|
||||
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):
|
||||
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):
|
||||
Remove a user from the package owner list. This immediately revokes their
|
||||
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>
|
||||
|
||||
</div>
|
||||
|
||||
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
|
||||
<tr><td style="width:180px;height:10px;background:rgb(237,127,127)" colspan=18> </td></tr>
|
||||
<tr><td rowspan=4 style="width:10px;height:10px;background:rgb(237,127,127)"> </td><td style="width:40px;height:10px;background:#fff" colspan=4> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=4> </td><td style="width:40px;height:10px;background:#fff" colspan=4> </td><td rowspan=4 style="width:10px;height:10px;background:rgb(237,127,127)"> </td><td colspan=6 style="width:60px;height:10px;background:#fff"> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=4> </td></tr>
|
||||
<tr><td colspan=2 style="width:20px;height:30px;background:#fff" rowspan=3> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:20px;height:10px;background:#fff" rowspan=4 colspan=2> </td><td style="width:10px;height:20px;background:rgb(237,127,127)" rowspan=2> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:20px;height:10px;background:#fff" rowspan=3 colspan=2> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td></tr>
|
||||
<tr><td style="width:10px;height:10px;background:#fff" rowspan=2> </td></tr>
|
||||
<tr><td style="width:10px;height:10px;background:#fff"> </td></tr>
|
||||
<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@2.15.12</p>
|
||||
|
||||
37
node_modules/npm/html/doc/api/npm-pack.html
generated
vendored
Normal file
37
node_modules/npm/html/doc/api/npm-pack.html
generated
vendored
Normal file
@@ -0,0 +1,37 @@
|
||||
<!doctype html>
|
||||
<html>
|
||||
<title>npm-pack</title>
|
||||
<meta charset="utf-8">
|
||||
<link rel="stylesheet" type="text/css" href="../../static/style.css">
|
||||
<link rel="canonical" href="https://www.npmjs.org/doc/api/npm-pack.html">
|
||||
<script async=true src="../../static/toc.js"></script>
|
||||
|
||||
<body>
|
||||
<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>
|
||||
<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>
|
||||
<tr><td style="width:180px;height:10px;background:rgb(237,127,127)" colspan=18> </td></tr>
|
||||
<tr><td rowspan=4 style="width:10px;height:10px;background:rgb(237,127,127)"> </td><td style="width:40px;height:10px;background:#fff" colspan=4> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=4> </td><td style="width:40px;height:10px;background:#fff" colspan=4> </td><td rowspan=4 style="width:10px;height:10px;background:rgb(237,127,127)"> </td><td colspan=6 style="width:60px;height:10px;background:#fff"> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=4> </td></tr>
|
||||
<tr><td colspan=2 style="width:20px;height:30px;background:#fff" rowspan=3> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:20px;height:10px;background:#fff" rowspan=4 colspan=2> </td><td style="width:10px;height:20px;background:rgb(237,127,127)" rowspan=2> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:20px;height:10px;background:#fff" rowspan=3 colspan=2> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td></tr>
|
||||
<tr><td style="width:10px;height:10px;background:#fff" rowspan=2> </td></tr>
|
||||
<tr><td style="width:10px;height:10px;background:#fff"> </td></tr>
|
||||
<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@2.15.12</p>
|
||||
|
||||
33
node_modules/npm/html/doc/api/npm-ping.html
generated
vendored
Normal file
33
node_modules/npm/html/doc/api/npm-ping.html
generated
vendored
Normal file
@@ -0,0 +1,33 @@
|
||||
<!doctype html>
|
||||
<html>
|
||||
<title>npm-ping</title>
|
||||
<meta charset="utf-8">
|
||||
<link rel="stylesheet" type="text/css" href="../../static/style.css">
|
||||
<link rel="canonical" href="https://www.npmjs.org/doc/api/npm-ping.html">
|
||||
<script async=true src="../../static/toc.js"></script>
|
||||
|
||||
<body>
|
||||
<div id="wrapper">
|
||||
|
||||
<h1><a href="../api/npm-ping.html">npm-ping</a></h1> <p>Ping npm registry</p>
|
||||
<h2 id="synopsis">SYNOPSIS</h2>
|
||||
<pre><code>npm.registry.ping(registry, options, function (er, pong))
|
||||
</code></pre><h2 id="description">DESCRIPTION</h2>
|
||||
<p>Attempts to connect to the given registry, returning a <code>pong</code>
|
||||
object with various metadata if it succeeds.</p>
|
||||
<p>This function is primarily useful for debugging connection issues
|
||||
to npm registries.</p>
|
||||
|
||||
</div>
|
||||
|
||||
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
|
||||
<tr><td style="width:180px;height:10px;background:rgb(237,127,127)" colspan=18> </td></tr>
|
||||
<tr><td rowspan=4 style="width:10px;height:10px;background:rgb(237,127,127)"> </td><td style="width:40px;height:10px;background:#fff" colspan=4> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=4> </td><td style="width:40px;height:10px;background:#fff" colspan=4> </td><td rowspan=4 style="width:10px;height:10px;background:rgb(237,127,127)"> </td><td colspan=6 style="width:60px;height:10px;background:#fff"> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=4> </td></tr>
|
||||
<tr><td colspan=2 style="width:20px;height:30px;background:#fff" rowspan=3> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:20px;height:10px;background:#fff" rowspan=4 colspan=2> </td><td style="width:10px;height:20px;background:rgb(237,127,127)" rowspan=2> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:20px;height:10px;background:#fff" rowspan=3 colspan=2> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td></tr>
|
||||
<tr><td style="width:10px;height:10px;background:#fff" rowspan=2> </td></tr>
|
||||
<tr><td style="width:10px;height:10px;background:#fff"> </td></tr>
|
||||
<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-ping — npm@2.15.12</p>
|
||||
|
||||
33
node_modules/npm/html/doc/api/npm-prefix.html
generated
vendored
Normal file
33
node_modules/npm/html/doc/api/npm-prefix.html
generated
vendored
Normal file
@@ -0,0 +1,33 @@
|
||||
<!doctype html>
|
||||
<html>
|
||||
<title>npm-prefix</title>
|
||||
<meta charset="utf-8">
|
||||
<link rel="stylesheet" type="text/css" href="../../static/style.css">
|
||||
<link rel="canonical" href="https://www.npmjs.org/doc/api/npm-prefix.html">
|
||||
<script async=true src="../../static/toc.js"></script>
|
||||
|
||||
<body>
|
||||
<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>
|
||||
<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>
|
||||
<tr><td style="width:180px;height:10px;background:rgb(237,127,127)" colspan=18> </td></tr>
|
||||
<tr><td rowspan=4 style="width:10px;height:10px;background:rgb(237,127,127)"> </td><td style="width:40px;height:10px;background:#fff" colspan=4> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=4> </td><td style="width:40px;height:10px;background:#fff" colspan=4> </td><td rowspan=4 style="width:10px;height:10px;background:rgb(237,127,127)"> </td><td colspan=6 style="width:60px;height:10px;background:#fff"> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=4> </td></tr>
|
||||
<tr><td colspan=2 style="width:20px;height:30px;background:#fff" rowspan=3> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:20px;height:10px;background:#fff" rowspan=4 colspan=2> </td><td style="width:10px;height:20px;background:rgb(237,127,127)" rowspan=2> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:20px;height:10px;background:#fff" rowspan=3 colspan=2> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td></tr>
|
||||
<tr><td style="width:10px;height:10px;background:#fff" rowspan=2> </td></tr>
|
||||
<tr><td style="width:10px;height:10px;background:#fff"> </td></tr>
|
||||
<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@2.15.12</p>
|
||||
|
||||
34
node_modules/npm/html/doc/api/npm-prune.html
generated
vendored
Normal file
34
node_modules/npm/html/doc/api/npm-prune.html
generated
vendored
Normal file
@@ -0,0 +1,34 @@
|
||||
<!doctype html>
|
||||
<html>
|
||||
<title>npm-prune</title>
|
||||
<meta charset="utf-8">
|
||||
<link rel="stylesheet" type="text/css" href="../../static/style.css">
|
||||
<link rel="canonical" href="https://www.npmjs.org/doc/api/npm-prune.html">
|
||||
<script async=true src="../../static/toc.js"></script>
|
||||
|
||||
<body>
|
||||
<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>
|
||||
<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>
|
||||
<tr><td style="width:180px;height:10px;background:rgb(237,127,127)" colspan=18> </td></tr>
|
||||
<tr><td rowspan=4 style="width:10px;height:10px;background:rgb(237,127,127)"> </td><td style="width:40px;height:10px;background:#fff" colspan=4> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=4> </td><td style="width:40px;height:10px;background:#fff" colspan=4> </td><td rowspan=4 style="width:10px;height:10px;background:rgb(237,127,127)"> </td><td colspan=6 style="width:60px;height:10px;background:#fff"> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=4> </td></tr>
|
||||
<tr><td colspan=2 style="width:20px;height:30px;background:#fff" rowspan=3> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:20px;height:10px;background:#fff" rowspan=4 colspan=2> </td><td style="width:10px;height:20px;background:rgb(237,127,127)" rowspan=2> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:20px;height:10px;background:#fff" rowspan=3 colspan=2> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td></tr>
|
||||
<tr><td style="width:10px;height:10px;background:#fff" rowspan=2> </td></tr>
|
||||
<tr><td style="width:10px;height:10px;background:#fff"> </td></tr>
|
||||
<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@2.15.12</p>
|
||||
|
||||
50
node_modules/npm/html/doc/api/npm-publish.html
generated
vendored
Normal file
50
node_modules/npm/html/doc/api/npm-publish.html
generated
vendored
Normal file
@@ -0,0 +1,50 @@
|
||||
<!doctype html>
|
||||
<html>
|
||||
<title>npm-publish</title>
|
||||
<meta charset="utf-8">
|
||||
<link rel="stylesheet" type="text/css" href="../../static/style.css">
|
||||
<link rel="canonical" href="https://www.npmjs.org/doc/api/npm-publish.html">
|
||||
<script async=true src="../../static/toc.js"></script>
|
||||
|
||||
<body>
|
||||
<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>
|
||||
<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>:
|
||||
A url or file path to a gzipped tar archive containing a single folder
|
||||
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>
|
||||
|
||||
</div>
|
||||
|
||||
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
|
||||
<tr><td style="width:180px;height:10px;background:rgb(237,127,127)" colspan=18> </td></tr>
|
||||
<tr><td rowspan=4 style="width:10px;height:10px;background:rgb(237,127,127)"> </td><td style="width:40px;height:10px;background:#fff" colspan=4> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=4> </td><td style="width:40px;height:10px;background:#fff" colspan=4> </td><td rowspan=4 style="width:10px;height:10px;background:rgb(237,127,127)"> </td><td colspan=6 style="width:60px;height:10px;background:#fff"> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=4> </td></tr>
|
||||
<tr><td colspan=2 style="width:20px;height:30px;background:#fff" rowspan=3> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:20px;height:10px;background:#fff" rowspan=4 colspan=2> </td><td style="width:10px;height:20px;background:rgb(237,127,127)" rowspan=2> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:20px;height:10px;background:#fff" rowspan=3 colspan=2> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td></tr>
|
||||
<tr><td style="width:10px;height:10px;background:#fff" rowspan=2> </td></tr>
|
||||
<tr><td style="width:10px;height:10px;background:#fff"> </td></tr>
|
||||
<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@2.15.12</p>
|
||||
|
||||
34
node_modules/npm/html/doc/api/npm-rebuild.html
generated
vendored
Normal file
34
node_modules/npm/html/doc/api/npm-rebuild.html
generated
vendored
Normal file
@@ -0,0 +1,34 @@
|
||||
<!doctype html>
|
||||
<html>
|
||||
<title>npm-rebuild</title>
|
||||
<meta charset="utf-8">
|
||||
<link rel="stylesheet" type="text/css" href="../../static/style.css">
|
||||
<link rel="canonical" href="https://www.npmjs.org/doc/api/npm-rebuild.html">
|
||||
<script async=true src="../../static/toc.js"></script>
|
||||
|
||||
<body>
|
||||
<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>
|
||||
<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>
|
||||
<p>See <code>npm help build</code></p>
|
||||
|
||||
</div>
|
||||
|
||||
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
|
||||
<tr><td style="width:180px;height:10px;background:rgb(237,127,127)" colspan=18> </td></tr>
|
||||
<tr><td rowspan=4 style="width:10px;height:10px;background:rgb(237,127,127)"> </td><td style="width:40px;height:10px;background:#fff" colspan=4> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=4> </td><td style="width:40px;height:10px;background:#fff" colspan=4> </td><td rowspan=4 style="width:10px;height:10px;background:rgb(237,127,127)"> </td><td colspan=6 style="width:60px;height:10px;background:#fff"> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=4> </td></tr>
|
||||
<tr><td colspan=2 style="width:20px;height:30px;background:#fff" rowspan=3> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:20px;height:10px;background:#fff" rowspan=4 colspan=2> </td><td style="width:10px;height:20px;background:rgb(237,127,127)" rowspan=2> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:20px;height:10px;background:#fff" rowspan=3 colspan=2> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td></tr>
|
||||
<tr><td style="width:10px;height:10px;background:#fff" rowspan=2> </td></tr>
|
||||
<tr><td style="width:10px;height:10px;background:#fff"> </td></tr>
|
||||
<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@2.15.12</p>
|
||||
|
||||
37
node_modules/npm/html/doc/api/npm-repo.html
generated
vendored
Normal file
37
node_modules/npm/html/doc/api/npm-repo.html
generated
vendored
Normal file
@@ -0,0 +1,37 @@
|
||||
<!doctype html>
|
||||
<html>
|
||||
<title>npm-repo</title>
|
||||
<meta charset="utf-8">
|
||||
<link rel="stylesheet" type="text/css" href="../../static/style.css">
|
||||
<link rel="canonical" href="https://www.npmjs.org/doc/api/npm-repo.html">
|
||||
<script async=true src="../../static/toc.js"></script>
|
||||
|
||||
<body>
|
||||
<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>
|
||||
<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>
|
||||
<tr><td style="width:180px;height:10px;background:rgb(237,127,127)" colspan=18> </td></tr>
|
||||
<tr><td rowspan=4 style="width:10px;height:10px;background:rgb(237,127,127)"> </td><td style="width:40px;height:10px;background:#fff" colspan=4> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=4> </td><td style="width:40px;height:10px;background:#fff" colspan=4> </td><td rowspan=4 style="width:10px;height:10px;background:rgb(237,127,127)"> </td><td colspan=6 style="width:60px;height:10px;background:#fff"> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=4> </td></tr>
|
||||
<tr><td colspan=2 style="width:20px;height:30px;background:#fff" rowspan=3> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:20px;height:10px;background:#fff" rowspan=4 colspan=2> </td><td style="width:10px;height:20px;background:rgb(237,127,127)" rowspan=2> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:20px;height:10px;background:#fff" rowspan=3 colspan=2> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td></tr>
|
||||
<tr><td style="width:10px;height:10px;background:#fff" rowspan=2> </td></tr>
|
||||
<tr><td style="width:10px;height:10px;background:#fff"> </td></tr>
|
||||
<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@2.15.12</p>
|
||||
|
||||
56
node_modules/npm/html/doc/api/npm-restart.html
generated
vendored
Normal file
56
node_modules/npm/html/doc/api/npm-restart.html
generated
vendored
Normal file
@@ -0,0 +1,56 @@
|
||||
<!doctype html>
|
||||
<html>
|
||||
<title>npm-restart</title>
|
||||
<meta charset="utf-8">
|
||||
<link rel="stylesheet" type="text/css" href="../../static/style.css">
|
||||
<link rel="canonical" href="https://www.npmjs.org/doc/api/npm-restart.html">
|
||||
<script async=true src="../../static/toc.js"></script>
|
||||
|
||||
<body>
|
||||
<div id="wrapper">
|
||||
|
||||
<h1><a href="../api/npm-restart.html">npm-restart</a></h1> <p>Restart a package</p>
|
||||
<h2 id="synopsis">SYNOPSIS</h2>
|
||||
<pre><code>npm.commands.restart(packages, callback)
|
||||
</code></pre><h2 id="description">DESCRIPTION</h2>
|
||||
<p>This restarts a package (or multiple packages).</p>
|
||||
<p>This runs a package's "stop", "restart", and "start" scripts, and associated
|
||||
pre- and post- scripts, in the order given below:</p>
|
||||
<ol>
|
||||
<li>prerestart</li>
|
||||
<li>prestop</li>
|
||||
<li>stop</li>
|
||||
<li>poststop</li>
|
||||
<li>restart</li>
|
||||
<li>prestart</li>
|
||||
<li>start</li>
|
||||
<li>poststart</li>
|
||||
<li>postrestart</li>
|
||||
</ol>
|
||||
<p>If no version is specified, then it restarts the "active" version.</p>
|
||||
<p>npm can restart multiple packages. Just specify multiple packages in
|
||||
the <code>packages</code> parameter.</p>
|
||||
<h2 id="note">NOTE</h2>
|
||||
<p>Note that the "restart" script is run <strong>in addition to</strong> the "stop"
|
||||
and "start" scripts, not instead of them.</p>
|
||||
<p>This is the behavior as of <code>npm</code> major version 2. A change in this
|
||||
behavior will be accompanied by an increase in major version number</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>
|
||||
|
||||
</div>
|
||||
|
||||
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
|
||||
<tr><td style="width:180px;height:10px;background:rgb(237,127,127)" colspan=18> </td></tr>
|
||||
<tr><td rowspan=4 style="width:10px;height:10px;background:rgb(237,127,127)"> </td><td style="width:40px;height:10px;background:#fff" colspan=4> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=4> </td><td style="width:40px;height:10px;background:#fff" colspan=4> </td><td rowspan=4 style="width:10px;height:10px;background:rgb(237,127,127)"> </td><td colspan=6 style="width:60px;height:10px;background:#fff"> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=4> </td></tr>
|
||||
<tr><td colspan=2 style="width:20px;height:30px;background:#fff" rowspan=3> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:20px;height:10px;background:#fff" rowspan=4 colspan=2> </td><td style="width:10px;height:20px;background:rgb(237,127,127)" rowspan=2> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:20px;height:10px;background:#fff" rowspan=3 colspan=2> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td></tr>
|
||||
<tr><td style="width:10px;height:10px;background:#fff" rowspan=2> </td></tr>
|
||||
<tr><td style="width:10px;height:10px;background:#fff"> </td></tr>
|
||||
<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@2.15.12</p>
|
||||
|
||||
33
node_modules/npm/html/doc/api/npm-root.html
generated
vendored
Normal file
33
node_modules/npm/html/doc/api/npm-root.html
generated
vendored
Normal file
@@ -0,0 +1,33 @@
|
||||
<!doctype html>
|
||||
<html>
|
||||
<title>npm-root</title>
|
||||
<meta charset="utf-8">
|
||||
<link rel="stylesheet" type="text/css" href="../../static/style.css">
|
||||
<link rel="canonical" href="https://www.npmjs.org/doc/api/npm-root.html">
|
||||
<script async=true src="../../static/toc.js"></script>
|
||||
|
||||
<body>
|
||||
<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>
|
||||
<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>
|
||||
<tr><td style="width:180px;height:10px;background:rgb(237,127,127)" colspan=18> </td></tr>
|
||||
<tr><td rowspan=4 style="width:10px;height:10px;background:rgb(237,127,127)"> </td><td style="width:40px;height:10px;background:#fff" colspan=4> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=4> </td><td style="width:40px;height:10px;background:#fff" colspan=4> </td><td rowspan=4 style="width:10px;height:10px;background:rgb(237,127,127)"> </td><td colspan=6 style="width:60px;height:10px;background:#fff"> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=4> </td></tr>
|
||||
<tr><td colspan=2 style="width:20px;height:30px;background:#fff" rowspan=3> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:20px;height:10px;background:#fff" rowspan=4 colspan=2> </td><td style="width:10px;height:20px;background:rgb(237,127,127)" rowspan=2> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:20px;height:10px;background:#fff" rowspan=3 colspan=2> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td></tr>
|
||||
<tr><td style="width:10px;height:10px;background:#fff" rowspan=2> </td></tr>
|
||||
<tr><td style="width:10px;height:10px;background:#fff"> </td></tr>
|
||||
<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@2.15.12</p>
|
||||
|
||||
45
node_modules/npm/html/doc/api/npm-run-script.html
generated
vendored
Normal file
45
node_modules/npm/html/doc/api/npm-run-script.html
generated
vendored
Normal file
@@ -0,0 +1,45 @@
|
||||
<!doctype html>
|
||||
<html>
|
||||
<title>npm-run-script</title>
|
||||
<meta charset="utf-8">
|
||||
<link rel="stylesheet" type="text/css" href="../../static/style.css">
|
||||
<link rel="canonical" href="https://www.npmjs.org/doc/api/npm-run-script.html">
|
||||
<script async=true src="../../static/toc.js"></script>
|
||||
|
||||
<body>
|
||||
<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>
|
||||
<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>
|
||||
|
||||
</div>
|
||||
|
||||
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
|
||||
<tr><td style="width:180px;height:10px;background:rgb(237,127,127)" colspan=18> </td></tr>
|
||||
<tr><td rowspan=4 style="width:10px;height:10px;background:rgb(237,127,127)"> </td><td style="width:40px;height:10px;background:#fff" colspan=4> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=4> </td><td style="width:40px;height:10px;background:#fff" colspan=4> </td><td rowspan=4 style="width:10px;height:10px;background:rgb(237,127,127)"> </td><td colspan=6 style="width:60px;height:10px;background:#fff"> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=4> </td></tr>
|
||||
<tr><td colspan=2 style="width:20px;height:30px;background:#fff" rowspan=3> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:20px;height:10px;background:#fff" rowspan=4 colspan=2> </td><td style="width:10px;height:20px;background:rgb(237,127,127)" rowspan=2> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:20px;height:10px;background:#fff" rowspan=3 colspan=2> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td></tr>
|
||||
<tr><td style="width:10px;height:10px;background:#fff" rowspan=2> </td></tr>
|
||||
<tr><td style="width:10px;height:10px;background:#fff"> </td></tr>
|
||||
<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@2.15.12</p>
|
||||
|
||||
57
node_modules/npm/html/doc/api/npm-search.html
generated
vendored
Normal file
57
node_modules/npm/html/doc/api/npm-search.html
generated
vendored
Normal file
@@ -0,0 +1,57 @@
|
||||
<!doctype html>
|
||||
<html>
|
||||
<title>npm-search</title>
|
||||
<meta charset="utf-8">
|
||||
<link rel="stylesheet" type="text/css" href="../../static/style.css">
|
||||
<link rel="canonical" href="https://www.npmjs.org/doc/api/npm-search.html">
|
||||
<script async=true src="../../static/toc.js"></script>
|
||||
|
||||
<body>
|
||||
<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>
|
||||
<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:
|
||||
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:
|
||||
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>
|
||||
<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>
|
||||
<tr><td style="width:180px;height:10px;background:rgb(237,127,127)" colspan=18> </td></tr>
|
||||
<tr><td rowspan=4 style="width:10px;height:10px;background:rgb(237,127,127)"> </td><td style="width:40px;height:10px;background:#fff" colspan=4> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=4> </td><td style="width:40px;height:10px;background:#fff" colspan=4> </td><td rowspan=4 style="width:10px;height:10px;background:rgb(237,127,127)"> </td><td colspan=6 style="width:60px;height:10px;background:#fff"> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=4> </td></tr>
|
||||
<tr><td colspan=2 style="width:20px;height:30px;background:#fff" rowspan=3> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:20px;height:10px;background:#fff" rowspan=4 colspan=2> </td><td style="width:10px;height:20px;background:rgb(237,127,127)" rowspan=2> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:20px;height:10px;background:#fff" rowspan=3 colspan=2> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td></tr>
|
||||
<tr><td style="width:10px;height:10px;background:#fff" rowspan=2> </td></tr>
|
||||
<tr><td style="width:10px;height:10px;background:#fff"> </td></tr>
|
||||
<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@2.15.12</p>
|
||||
|
||||
37
node_modules/npm/html/doc/api/npm-shrinkwrap.html
generated
vendored
Normal file
37
node_modules/npm/html/doc/api/npm-shrinkwrap.html
generated
vendored
Normal file
@@ -0,0 +1,37 @@
|
||||
<!doctype html>
|
||||
<html>
|
||||
<title>npm-shrinkwrap</title>
|
||||
<meta charset="utf-8">
|
||||
<link rel="stylesheet" type="text/css" href="../../static/style.css">
|
||||
<link rel="canonical" href="https://www.npmjs.org/doc/api/npm-shrinkwrap.html">
|
||||
<script async=true src="../../static/toc.js"></script>
|
||||
|
||||
<body>
|
||||
<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>
|
||||
<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>
|
||||
<tr><td style="width:180px;height:10px;background:rgb(237,127,127)" colspan=18> </td></tr>
|
||||
<tr><td rowspan=4 style="width:10px;height:10px;background:rgb(237,127,127)"> </td><td style="width:40px;height:10px;background:#fff" colspan=4> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=4> </td><td style="width:40px;height:10px;background:#fff" colspan=4> </td><td rowspan=4 style="width:10px;height:10px;background:rgb(237,127,127)"> </td><td colspan=6 style="width:60px;height:10px;background:#fff"> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=4> </td></tr>
|
||||
<tr><td colspan=2 style="width:20px;height:30px;background:#fff" rowspan=3> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:20px;height:10px;background:#fff" rowspan=4 colspan=2> </td><td style="width:10px;height:20px;background:rgb(237,127,127)" rowspan=2> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:20px;height:10px;background:#fff" rowspan=3 colspan=2> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td></tr>
|
||||
<tr><td style="width:10px;height:10px;background:#fff" rowspan=2> </td></tr>
|
||||
<tr><td style="width:10px;height:10px;background:#fff"> </td></tr>
|
||||
<tr><td style="width:60px;height:10px;background:rgb(237,127,127)" colspan=6> </td><td colspan=10 style="width:10px;height:10px;background:rgb(237,127,127)"> </td></tr>
|
||||
<tr><td colspan=5 style="width:50px;height:10px;background:#fff"> </td><td style="width:40px;height:10px;background:rgb(237,127,127)" colspan=4> </td><td style="width:90px;height:10px;background:#fff" colspan=9> </td></tr>
|
||||
</table>
|
||||
<p id="footer">npm-shrinkwrap — npm@2.15.12</p>
|
||||
|
||||
32
node_modules/npm/html/doc/api/npm-start.html
generated
vendored
Normal file
32
node_modules/npm/html/doc/api/npm-start.html
generated
vendored
Normal file
@@ -0,0 +1,32 @@
|
||||
<!doctype html>
|
||||
<html>
|
||||
<title>npm-start</title>
|
||||
<meta charset="utf-8">
|
||||
<link rel="stylesheet" type="text/css" href="../../static/style.css">
|
||||
<link rel="canonical" href="https://www.npmjs.org/doc/api/npm-start.html">
|
||||
<script async=true src="../../static/toc.js"></script>
|
||||
|
||||
<body>
|
||||
<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>
|
||||
<p>This runs a package's "start" script, if one was provided.</p>
|
||||
<p>npm can start multiple packages. Just specify multiple packages in the
|
||||
<code>packages</code> parameter.</p>
|
||||
|
||||
</div>
|
||||
|
||||
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
|
||||
<tr><td style="width:180px;height:10px;background:rgb(237,127,127)" colspan=18> </td></tr>
|
||||
<tr><td rowspan=4 style="width:10px;height:10px;background:rgb(237,127,127)"> </td><td style="width:40px;height:10px;background:#fff" colspan=4> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=4> </td><td style="width:40px;height:10px;background:#fff" colspan=4> </td><td rowspan=4 style="width:10px;height:10px;background:rgb(237,127,127)"> </td><td colspan=6 style="width:60px;height:10px;background:#fff"> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=4> </td></tr>
|
||||
<tr><td colspan=2 style="width:20px;height:30px;background:#fff" rowspan=3> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:20px;height:10px;background:#fff" rowspan=4 colspan=2> </td><td style="width:10px;height:20px;background:rgb(237,127,127)" rowspan=2> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:20px;height:10px;background:#fff" rowspan=3 colspan=2> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td></tr>
|
||||
<tr><td style="width:10px;height:10px;background:#fff" rowspan=2> </td></tr>
|
||||
<tr><td style="width:10px;height:10px;background:#fff"> </td></tr>
|
||||
<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@2.15.12</p>
|
||||
|
||||
32
node_modules/npm/html/doc/api/npm-stop.html
generated
vendored
Normal file
32
node_modules/npm/html/doc/api/npm-stop.html
generated
vendored
Normal file
@@ -0,0 +1,32 @@
|
||||
<!doctype html>
|
||||
<html>
|
||||
<title>npm-stop</title>
|
||||
<meta charset="utf-8">
|
||||
<link rel="stylesheet" type="text/css" href="../../static/style.css">
|
||||
<link rel="canonical" href="https://www.npmjs.org/doc/api/npm-stop.html">
|
||||
<script async=true src="../../static/toc.js"></script>
|
||||
|
||||
<body>
|
||||
<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>
|
||||
<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>
|
||||
<tr><td style="width:180px;height:10px;background:rgb(237,127,127)" colspan=18> </td></tr>
|
||||
<tr><td rowspan=4 style="width:10px;height:10px;background:rgb(237,127,127)"> </td><td style="width:40px;height:10px;background:#fff" colspan=4> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=4> </td><td style="width:40px;height:10px;background:#fff" colspan=4> </td><td rowspan=4 style="width:10px;height:10px;background:rgb(237,127,127)"> </td><td colspan=6 style="width:60px;height:10px;background:#fff"> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=4> </td></tr>
|
||||
<tr><td colspan=2 style="width:20px;height:30px;background:#fff" rowspan=3> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:20px;height:10px;background:#fff" rowspan=4 colspan=2> </td><td style="width:10px;height:20px;background:rgb(237,127,127)" rowspan=2> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:20px;height:10px;background:#fff" rowspan=3 colspan=2> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td></tr>
|
||||
<tr><td style="width:10px;height:10px;background:#fff" rowspan=2> </td></tr>
|
||||
<tr><td style="width:10px;height:10px;background:#fff"> </td></tr>
|
||||
<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@2.15.12</p>
|
||||
|
||||
40
node_modules/npm/html/doc/api/npm-tag.html
generated
vendored
Normal file
40
node_modules/npm/html/doc/api/npm-tag.html
generated
vendored
Normal file
@@ -0,0 +1,40 @@
|
||||
<!doctype html>
|
||||
<html>
|
||||
<title>npm-tag</title>
|
||||
<meta charset="utf-8">
|
||||
<link rel="stylesheet" type="text/css" href="../../static/style.css">
|
||||
<link rel="canonical" href="https://www.npmjs.org/doc/api/npm-tag.html">
|
||||
<script async=true src="../../static/toc.js"></script>
|
||||
|
||||
<body>
|
||||
<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>
|
||||
<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 from 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>
|
||||
<tr><td style="width:180px;height:10px;background:rgb(237,127,127)" colspan=18> </td></tr>
|
||||
<tr><td rowspan=4 style="width:10px;height:10px;background:rgb(237,127,127)"> </td><td style="width:40px;height:10px;background:#fff" colspan=4> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=4> </td><td style="width:40px;height:10px;background:#fff" colspan=4> </td><td rowspan=4 style="width:10px;height:10px;background:rgb(237,127,127)"> </td><td colspan=6 style="width:60px;height:10px;background:#fff"> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=4> </td></tr>
|
||||
<tr><td colspan=2 style="width:20px;height:30px;background:#fff" rowspan=3> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:20px;height:10px;background:#fff" rowspan=4 colspan=2> </td><td style="width:10px;height:20px;background:rgb(237,127,127)" rowspan=2> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:20px;height:10px;background:#fff" rowspan=3 colspan=2> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td></tr>
|
||||
<tr><td style="width:10px;height:10px;background:#fff" rowspan=2> </td></tr>
|
||||
<tr><td style="width:10px;height:10px;background:#fff"> </td></tr>
|
||||
<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@2.15.12</p>
|
||||
|
||||
34
node_modules/npm/html/doc/api/npm-test.html
generated
vendored
Normal file
34
node_modules/npm/html/doc/api/npm-test.html
generated
vendored
Normal file
@@ -0,0 +1,34 @@
|
||||
<!doctype html>
|
||||
<html>
|
||||
<title>npm-test</title>
|
||||
<meta charset="utf-8">
|
||||
<link rel="stylesheet" type="text/css" href="../../static/style.css">
|
||||
<link rel="canonical" href="https://www.npmjs.org/doc/api/npm-test.html">
|
||||
<script async=true src="../../static/toc.js"></script>
|
||||
|
||||
<body>
|
||||
<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>
|
||||
<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>
|
||||
<tr><td style="width:180px;height:10px;background:rgb(237,127,127)" colspan=18> </td></tr>
|
||||
<tr><td rowspan=4 style="width:10px;height:10px;background:rgb(237,127,127)"> </td><td style="width:40px;height:10px;background:#fff" colspan=4> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=4> </td><td style="width:40px;height:10px;background:#fff" colspan=4> </td><td rowspan=4 style="width:10px;height:10px;background:rgb(237,127,127)"> </td><td colspan=6 style="width:60px;height:10px;background:#fff"> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=4> </td></tr>
|
||||
<tr><td colspan=2 style="width:20px;height:30px;background:#fff" rowspan=3> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:20px;height:10px;background:#fff" rowspan=4 colspan=2> </td><td style="width:10px;height:20px;background:rgb(237,127,127)" rowspan=2> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:20px;height:10px;background:#fff" rowspan=3 colspan=2> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td></tr>
|
||||
<tr><td style="width:10px;height:10px;background:#fff" rowspan=2> </td></tr>
|
||||
<tr><td style="width:10px;height:10px;background:#fff"> </td></tr>
|
||||
<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@2.15.12</p>
|
||||
|
||||
34
node_modules/npm/html/doc/api/npm-uninstall.html
generated
vendored
Normal file
34
node_modules/npm/html/doc/api/npm-uninstall.html
generated
vendored
Normal file
@@ -0,0 +1,34 @@
|
||||
<!doctype html>
|
||||
<html>
|
||||
<title>npm-uninstall</title>
|
||||
<meta charset="utf-8">
|
||||
<link rel="stylesheet" type="text/css" href="../../static/style.css">
|
||||
<link rel="canonical" href="https://www.npmjs.org/doc/api/npm-uninstall.html">
|
||||
<script async=true src="../../static/toc.js"></script>
|
||||
|
||||
<body>
|
||||
<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>
|
||||
<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>
|
||||
<tr><td style="width:180px;height:10px;background:rgb(237,127,127)" colspan=18> </td></tr>
|
||||
<tr><td rowspan=4 style="width:10px;height:10px;background:rgb(237,127,127)"> </td><td style="width:40px;height:10px;background:#fff" colspan=4> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=4> </td><td style="width:40px;height:10px;background:#fff" colspan=4> </td><td rowspan=4 style="width:10px;height:10px;background:rgb(237,127,127)"> </td><td colspan=6 style="width:60px;height:10px;background:#fff"> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=4> </td></tr>
|
||||
<tr><td colspan=2 style="width:20px;height:30px;background:#fff" rowspan=3> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:20px;height:10px;background:#fff" rowspan=4 colspan=2> </td><td style="width:10px;height:20px;background:rgb(237,127,127)" rowspan=2> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:20px;height:10px;background:#fff" rowspan=3 colspan=2> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td></tr>
|
||||
<tr><td style="width:10px;height:10px;background:#fff" rowspan=2> </td></tr>
|
||||
<tr><td style="width:10px;height:10px;background:#fff"> </td></tr>
|
||||
<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@2.15.12</p>
|
||||
|
||||
37
node_modules/npm/html/doc/api/npm-unpublish.html
generated
vendored
Normal file
37
node_modules/npm/html/doc/api/npm-unpublish.html
generated
vendored
Normal file
@@ -0,0 +1,37 @@
|
||||
<!doctype html>
|
||||
<html>
|
||||
<title>npm-unpublish</title>
|
||||
<meta charset="utf-8">
|
||||
<link rel="stylesheet" type="text/css" href="../../static/style.css">
|
||||
<link rel="canonical" href="https://www.npmjs.org/doc/api/npm-unpublish.html">
|
||||
<script async=true src="../../static/toc.js"></script>
|
||||
|
||||
<body>
|
||||
<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>
|
||||
<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>
|
||||
<tr><td style="width:180px;height:10px;background:rgb(237,127,127)" colspan=18> </td></tr>
|
||||
<tr><td rowspan=4 style="width:10px;height:10px;background:rgb(237,127,127)"> </td><td style="width:40px;height:10px;background:#fff" colspan=4> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=4> </td><td style="width:40px;height:10px;background:#fff" colspan=4> </td><td rowspan=4 style="width:10px;height:10px;background:rgb(237,127,127)"> </td><td colspan=6 style="width:60px;height:10px;background:#fff"> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=4> </td></tr>
|
||||
<tr><td colspan=2 style="width:20px;height:30px;background:#fff" rowspan=3> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:20px;height:10px;background:#fff" rowspan=4 colspan=2> </td><td style="width:10px;height:20px;background:rgb(237,127,127)" rowspan=2> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:20px;height:10px;background:#fff" rowspan=3 colspan=2> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td></tr>
|
||||
<tr><td style="width:10px;height:10px;background:#fff" rowspan=2> </td></tr>
|
||||
<tr><td style="width:10px;height:10px;background:#fff"> </td></tr>
|
||||
<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@2.15.12</p>
|
||||
|
||||
37
node_modules/npm/html/doc/api/npm-update.html
generated
vendored
Normal file
37
node_modules/npm/html/doc/api/npm-update.html
generated
vendored
Normal file
@@ -0,0 +1,37 @@
|
||||
<!doctype html>
|
||||
<html>
|
||||
<title>npm-update</title>
|
||||
<meta charset="utf-8">
|
||||
<link rel="stylesheet" type="text/css" href="../../static/style.css">
|
||||
<link rel="canonical" href="https://www.npmjs.org/doc/api/npm-update.html">
|
||||
<script async=true src="../../static/toc.js"></script>
|
||||
|
||||
<body>
|
||||
<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 id="description">DESCRIPTION</h1>
|
||||
<p>Updates a package, upgrading it to the latest version. It also installs any
|
||||
missing packages.</p>
|
||||
<p>The <code>packages</code> argument is an array of packages to update. The <code>callback</code>
|
||||
parameter will be called when done or when an error occurs.</p>
|
||||
<h2 id="see-also">SEE ALSO</h2>
|
||||
<ul>
|
||||
<li><a href="../cli/npm-update.html">npm-update(1)</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
|
||||
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
|
||||
<tr><td style="width:180px;height:10px;background:rgb(237,127,127)" colspan=18> </td></tr>
|
||||
<tr><td rowspan=4 style="width:10px;height:10px;background:rgb(237,127,127)"> </td><td style="width:40px;height:10px;background:#fff" colspan=4> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=4> </td><td style="width:40px;height:10px;background:#fff" colspan=4> </td><td rowspan=4 style="width:10px;height:10px;background:rgb(237,127,127)"> </td><td colspan=6 style="width:60px;height:10px;background:#fff"> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=4> </td></tr>
|
||||
<tr><td colspan=2 style="width:20px;height:30px;background:#fff" rowspan=3> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:20px;height:10px;background:#fff" rowspan=4 colspan=2> </td><td style="width:10px;height:20px;background:rgb(237,127,127)" rowspan=2> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:20px;height:10px;background:#fff" rowspan=3 colspan=2> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td></tr>
|
||||
<tr><td style="width:10px;height:10px;background:#fff" rowspan=2> </td></tr>
|
||||
<tr><td style="width:10px;height:10px;background:#fff"> </td></tr>
|
||||
<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@2.15.12</p>
|
||||
|
||||
36
node_modules/npm/html/doc/api/npm-version.html
generated
vendored
Normal file
36
node_modules/npm/html/doc/api/npm-version.html
generated
vendored
Normal file
@@ -0,0 +1,36 @@
|
||||
<!doctype html>
|
||||
<html>
|
||||
<title>npm-version</title>
|
||||
<meta charset="utf-8">
|
||||
<link rel="stylesheet" type="text/css" href="../../static/style.css">
|
||||
<link rel="canonical" href="https://www.npmjs.org/doc/api/npm-version.html">
|
||||
<script async=true src="../../static/toc.js"></script>
|
||||
|
||||
<body>
|
||||
<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>
|
||||
<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>
|
||||
<tr><td style="width:180px;height:10px;background:rgb(237,127,127)" colspan=18> </td></tr>
|
||||
<tr><td rowspan=4 style="width:10px;height:10px;background:rgb(237,127,127)"> </td><td style="width:40px;height:10px;background:#fff" colspan=4> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=4> </td><td style="width:40px;height:10px;background:#fff" colspan=4> </td><td rowspan=4 style="width:10px;height:10px;background:rgb(237,127,127)"> </td><td colspan=6 style="width:60px;height:10px;background:#fff"> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=4> </td></tr>
|
||||
<tr><td colspan=2 style="width:20px;height:30px;background:#fff" rowspan=3> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:20px;height:10px;background:#fff" rowspan=4 colspan=2> </td><td style="width:10px;height:20px;background:rgb(237,127,127)" rowspan=2> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:20px;height:10px;background:#fff" rowspan=3 colspan=2> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td></tr>
|
||||
<tr><td style="width:10px;height:10px;background:#fff" rowspan=2> </td></tr>
|
||||
<tr><td style="width:10px;height:10px;background:#fff"> </td></tr>
|
||||
<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@2.15.12</p>
|
||||
|
||||
85
node_modules/npm/html/doc/api/npm-view.html
generated
vendored
Normal file
85
node_modules/npm/html/doc/api/npm-view.html
generated
vendored
Normal file
@@ -0,0 +1,85 @@
|
||||
<!doctype html>
|
||||
<html>
|
||||
<title>npm-view</title>
|
||||
<meta charset="utf-8">
|
||||
<link rel="stylesheet" type="text/css" href="../../static/style.css">
|
||||
<link rel="canonical" href="https://www.npmjs.org/doc/api/npm-view.html">
|
||||
<script async=true src="../../static/toc.js"></script>
|
||||
|
||||
<body>
|
||||
<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>
|
||||
<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>
|
||||
<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.
|
||||
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
|
||||
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
|
||||
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.
|
||||
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
|
||||
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
|
||||
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>
|
||||
<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>
|
||||
<p>The data returned will be an object in this formation:</p>
|
||||
<pre><code>{ <version>:
|
||||
{ <field>: <value>
|
||||
, ... }
|
||||
, ... }
|
||||
</code></pre><p>corresponding to the list of fields selected.</p>
|
||||
|
||||
</div>
|
||||
|
||||
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
|
||||
<tr><td style="width:180px;height:10px;background:rgb(237,127,127)" colspan=18> </td></tr>
|
||||
<tr><td rowspan=4 style="width:10px;height:10px;background:rgb(237,127,127)"> </td><td style="width:40px;height:10px;background:#fff" colspan=4> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=4> </td><td style="width:40px;height:10px;background:#fff" colspan=4> </td><td rowspan=4 style="width:10px;height:10px;background:rgb(237,127,127)"> </td><td colspan=6 style="width:60px;height:10px;background:#fff"> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=4> </td></tr>
|
||||
<tr><td colspan=2 style="width:20px;height:30px;background:#fff" rowspan=3> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:20px;height:10px;background:#fff" rowspan=4 colspan=2> </td><td style="width:10px;height:20px;background:rgb(237,127,127)" rowspan=2> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:20px;height:10px;background:#fff" rowspan=3 colspan=2> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td></tr>
|
||||
<tr><td style="width:10px;height:10px;background:#fff" rowspan=2> </td></tr>
|
||||
<tr><td style="width:10px;height:10px;background:#fff"> </td></tr>
|
||||
<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@2.15.12</p>
|
||||
|
||||
33
node_modules/npm/html/doc/api/npm-whoami.html
generated
vendored
Normal file
33
node_modules/npm/html/doc/api/npm-whoami.html
generated
vendored
Normal file
@@ -0,0 +1,33 @@
|
||||
<!doctype html>
|
||||
<html>
|
||||
<title>npm-whoami</title>
|
||||
<meta charset="utf-8">
|
||||
<link rel="stylesheet" type="text/css" href="../../static/style.css">
|
||||
<link rel="canonical" href="https://www.npmjs.org/doc/api/npm-whoami.html">
|
||||
<script async=true src="../../static/toc.js"></script>
|
||||
|
||||
<body>
|
||||
<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>
|
||||
<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>
|
||||
<tr><td style="width:180px;height:10px;background:rgb(237,127,127)" colspan=18> </td></tr>
|
||||
<tr><td rowspan=4 style="width:10px;height:10px;background:rgb(237,127,127)"> </td><td style="width:40px;height:10px;background:#fff" colspan=4> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=4> </td><td style="width:40px;height:10px;background:#fff" colspan=4> </td><td rowspan=4 style="width:10px;height:10px;background:rgb(237,127,127)"> </td><td colspan=6 style="width:60px;height:10px;background:#fff"> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=4> </td></tr>
|
||||
<tr><td colspan=2 style="width:20px;height:30px;background:#fff" rowspan=3> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:20px;height:10px;background:#fff" rowspan=4 colspan=2> </td><td style="width:10px;height:20px;background:rgb(237,127,127)" rowspan=2> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:20px;height:10px;background:#fff" rowspan=3 colspan=2> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td></tr>
|
||||
<tr><td style="width:10px;height:10px;background:#fff" rowspan=2> </td></tr>
|
||||
<tr><td style="width:10px;height:10px;background:#fff"> </td></tr>
|
||||
<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@2.15.12</p>
|
||||
|
||||
113
node_modules/npm/html/doc/api/npm.html
generated
vendored
Normal file
113
node_modules/npm/html/doc/api/npm.html
generated
vendored
Normal file
@@ -0,0 +1,113 @@
|
||||
<!doctype html>
|
||||
<html>
|
||||
<title>npm</title>
|
||||
<meta charset="utf-8">
|
||||
<link rel="stylesheet" type="text/css" href="../../static/style.css">
|
||||
<link rel="canonical" href="https://www.npmjs.org/doc/api/npm.html">
|
||||
<script async=true src="../../static/toc.js"></script>
|
||||
|
||||
<body>
|
||||
<div id="wrapper">
|
||||
|
||||
<h1><a href="../api/npm.html">npm</a></h1> <p>javascript package manager</p>
|
||||
<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.
|
||||
|
||||
npm.config.set(key, val)
|
||||
val = npm.config.get(key)
|
||||
|
||||
console.log("prefix = %s", npm.prefix)
|
||||
|
||||
npm.commands.install(["package"], cb)
|
||||
})
|
||||
</code></pre><h2 id="version">VERSION</h2>
|
||||
<p>2.15.12</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 map of top-level configs, they override the values
|
||||
stored in the various config 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><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> object, 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>
|
||||
method will get called before the configuration load is completed.</p>
|
||||
<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>
|
||||
</div>
|
||||
|
||||
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
|
||||
<tr><td style="width:180px;height:10px;background:rgb(237,127,127)" colspan=18> </td></tr>
|
||||
<tr><td rowspan=4 style="width:10px;height:10px;background:rgb(237,127,127)"> </td><td style="width:40px;height:10px;background:#fff" colspan=4> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=4> </td><td style="width:40px;height:10px;background:#fff" colspan=4> </td><td rowspan=4 style="width:10px;height:10px;background:rgb(237,127,127)"> </td><td colspan=6 style="width:60px;height:10px;background:#fff"> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=4> </td></tr>
|
||||
<tr><td colspan=2 style="width:20px;height:30px;background:#fff" rowspan=3> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:20px;height:10px;background:#fff" rowspan=4 colspan=2> </td><td style="width:10px;height:20px;background:rgb(237,127,127)" rowspan=2> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:20px;height:10px;background:#fff" rowspan=3 colspan=2> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td></tr>
|
||||
<tr><td style="width:10px;height:10px;background:#fff" rowspan=2> </td></tr>
|
||||
<tr><td style="width:10px;height:10px;background:#fff"> </td></tr>
|
||||
<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@2.15.12</p>
|
||||
|
||||
88
node_modules/npm/html/doc/cli/npm-access.html
generated
vendored
Normal file
88
node_modules/npm/html/doc/cli/npm-access.html
generated
vendored
Normal file
@@ -0,0 +1,88 @@
|
||||
<!doctype html>
|
||||
<html>
|
||||
<title>npm-access</title>
|
||||
<meta charset="utf-8">
|
||||
<link rel="stylesheet" type="text/css" href="../../static/style.css">
|
||||
<link rel="canonical" href="https://www.npmjs.org/doc/cli/npm-access.html">
|
||||
<script async=true src="../../static/toc.js"></script>
|
||||
|
||||
<body>
|
||||
<div id="wrapper">
|
||||
|
||||
<h1><a href="../cli/npm-access.html">npm-access</a></h1> <p>Set access level on published packages</p>
|
||||
<h2 id="synopsis">SYNOPSIS</h2>
|
||||
<pre><code>npm access public [<package>]
|
||||
npm access restricted [<package>]
|
||||
|
||||
npm access grant <read-only|read-write> <scope:team> [<package>]
|
||||
npm access revoke <scope:team> [<package>]
|
||||
|
||||
npm access ls-packages [<user>|<scope>|<scope:team>]
|
||||
npm access ls-collaborators [<package> [<user>]]
|
||||
npm access edit [<package>]
|
||||
</code></pre><h2 id="description">DESCRIPTION</h2>
|
||||
<p>Used to set access controls on private packages.</p>
|
||||
<p>For all of the subcommands, <code>npm access</code> will perform actions on the packages
|
||||
in the current working directory if no package name is passed to the
|
||||
subcommand.</p>
|
||||
<ul>
|
||||
<li><p>public / restricted:
|
||||
Set a package to be either publicly accessible or restricted.</p>
|
||||
</li>
|
||||
<li><p>grant / revoke:
|
||||
Add or remove the ability of users and teams to have read-only or read-write
|
||||
access to a package.</p>
|
||||
</li>
|
||||
<li><p>ls-packages:</p>
|
||||
<p>Show all of the packages a user or a team is able to access, along with the
|
||||
access level, except for read-only public packages (it won't print the whole
|
||||
registry listing)</p>
|
||||
</li>
|
||||
<li><p>ls-collaborators:
|
||||
Show all of the access privileges for a package. Will only show permissions
|
||||
for packages to which you have at least read access. If <code><user></code> is passed in,
|
||||
the list is filtered only to teams <em>that</em> user happens to belong to.</p>
|
||||
</li>
|
||||
<li><p>edit:
|
||||
Set the access privileges for a package at once using <code>$EDITOR</code>.</p>
|
||||
</li>
|
||||
</ul>
|
||||
<h2 id="details">DETAILS</h2>
|
||||
<p><code>npm access</code> always operates directly on the current registry, configurable
|
||||
from the command line using <code>--registry=<registry url></code>.</p>
|
||||
<p>Unscoped packages are <em>always public</em>.</p>
|
||||
<p>Scoped packages <em>default to restricted</em>, but you can either publish them as
|
||||
public using <code>npm publish --access=public</code>, or set their access as public using
|
||||
<code>npm access public</code> after the initial publish.</p>
|
||||
<p>You must have privileges to set the access of a package:</p>
|
||||
<ul>
|
||||
<li>You are an owner of an unscoped or scoped package.</li>
|
||||
<li>You are a member of the team that owns a scope.</li>
|
||||
<li>You have been given read-write privileges for a package, either as a member
|
||||
of a team or directly as an owner.</li>
|
||||
</ul>
|
||||
<p>If your account is not paid, then attempts to publish scoped packages will fail
|
||||
with an HTTP 402 status code (logically enough), unless you use
|
||||
<code>--access=public</code>.</p>
|
||||
<p>Management of teams and team memberships is done with the <code>npm team</code> command.</p>
|
||||
<h2 id="see-also">SEE ALSO</h2>
|
||||
<ul>
|
||||
<li><a href="../cli/npm-team.html">npm-team(1)</a></li>
|
||||
<li><a href="../cli/npm-publish.html">npm-publish(1)</a></li>
|
||||
<li><a href="../misc/npm-config.html">npm-config(7)</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>
|
||||
<tr><td style="width:180px;height:10px;background:rgb(237,127,127)" colspan=18> </td></tr>
|
||||
<tr><td rowspan=4 style="width:10px;height:10px;background:rgb(237,127,127)"> </td><td style="width:40px;height:10px;background:#fff" colspan=4> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=4> </td><td style="width:40px;height:10px;background:#fff" colspan=4> </td><td rowspan=4 style="width:10px;height:10px;background:rgb(237,127,127)"> </td><td colspan=6 style="width:60px;height:10px;background:#fff"> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=4> </td></tr>
|
||||
<tr><td colspan=2 style="width:20px;height:30px;background:#fff" rowspan=3> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:20px;height:10px;background:#fff" rowspan=4 colspan=2> </td><td style="width:10px;height:20px;background:rgb(237,127,127)" rowspan=2> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:20px;height:10px;background:#fff" rowspan=3 colspan=2> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td></tr>
|
||||
<tr><td style="width:10px;height:10px;background:#fff" rowspan=2> </td></tr>
|
||||
<tr><td style="width:10px;height:10px;background:#fff"> </td></tr>
|
||||
<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-access — npm@2.15.12</p>
|
||||
|
||||
76
node_modules/npm/html/doc/cli/npm-adduser.html
generated
vendored
Normal file
76
node_modules/npm/html/doc/cli/npm-adduser.html
generated
vendored
Normal file
@@ -0,0 +1,76 @@
|
||||
<!doctype html>
|
||||
<html>
|
||||
<title>npm-adduser</title>
|
||||
<meta charset="utf-8">
|
||||
<link rel="stylesheet" type="text/css" href="../../static/style.css">
|
||||
<link rel="canonical" href="https://www.npmjs.org/doc/cli/npm-adduser.html">
|
||||
<script async=true src="../../static/toc.js"></script>
|
||||
|
||||
<body>
|
||||
<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 [--registry=url] [--scope=@orgname] [--always-auth]
|
||||
|
||||
aliases: login, add-user
|
||||
</code></pre><h2 id="description">DESCRIPTION</h2>
|
||||
<p>Create or verify a user named <code><username></code> in the specified registry, and
|
||||
save the credentials to the <code>.npmrc</code> file. If no registry is specified,
|
||||
the default registry will be used (see <code><a href="../misc/npm-config.html">npm-config(7)</a></code>).</p>
|
||||
<p>The username, password, and email are read in from prompts.</p>
|
||||
<p>To reset your password, go to <a href="https://www.npmjs.com/forgot">https://www.npmjs.com/forgot</a></p>
|
||||
<p>To change your email address, go to <a href="https://www.npmjs.com/email-edit">https://www.npmjs.com/email-edit</a></p>
|
||||
<p>You may use this command multiple times with the same user account to
|
||||
authorize on a new machine. When authenticating on a new machine,
|
||||
the username, password and email address must all match with
|
||||
your existing record.</p>
|
||||
<p><code>npm login</code> is an alias to <code>adduser</code> and behaves exactly the same way.</p>
|
||||
<h2 id="configuration">CONFIGURATION</h2>
|
||||
<h3 id="registry">registry</h3>
|
||||
<p>Default: <a href="https://registry.npmjs.org/">https://registry.npmjs.org/</a></p>
|
||||
<p>The base URL of the npm package registry. If <code>scope</code> is also specified,
|
||||
this registry will only be used for packages with that scope. See <code><a href="../misc/npm-scope.html">npm-scope(7)</a></code>.</p>
|
||||
<h3 id="scope">scope</h3>
|
||||
<p>Default: none</p>
|
||||
<p>If specified, the user and login credentials given will be associated
|
||||
with the specified scope. See <code><a href="../misc/npm-scope.html">npm-scope(7)</a></code>. You can use both at the same time,
|
||||
e.g.</p>
|
||||
<pre><code>npm adduser --registry=http://myregistry.example.com --scope=@myco
|
||||
</code></pre><p>This will set a registry for the given scope and login or create a user for
|
||||
that registry at the same time.</p>
|
||||
<h3 id="always-auth">always-auth</h3>
|
||||
<p>Default: false</p>
|
||||
<p>If specified, save configuration indicating that all requests to the given
|
||||
registry should include authorization information. Useful for private
|
||||
registries. Can be used with <code>--registry</code> and / or <code>--scope</code>, e.g.</p>
|
||||
<pre><code>npm adduser --registry=http://private-registry.example.com --always-auth
|
||||
</code></pre><p>This will ensure that all requests to that registry (including for tarballs)
|
||||
include an authorization header. This setting may be necessary for use with
|
||||
private registries where metadata and package tarballs are stored on hosts with
|
||||
different hostnames. See <code>always-auth</code> in <code><a href="../misc/npm-config.html">npm-config(7)</a></code> for more details on
|
||||
always-auth. Registry-specific configuration of <code>always-auth</code> takes precedence
|
||||
over any global configuration.</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>
|
||||
|
||||
</div>
|
||||
|
||||
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
|
||||
<tr><td style="width:180px;height:10px;background:rgb(237,127,127)" colspan=18> </td></tr>
|
||||
<tr><td rowspan=4 style="width:10px;height:10px;background:rgb(237,127,127)"> </td><td style="width:40px;height:10px;background:#fff" colspan=4> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=4> </td><td style="width:40px;height:10px;background:#fff" colspan=4> </td><td rowspan=4 style="width:10px;height:10px;background:rgb(237,127,127)"> </td><td colspan=6 style="width:60px;height:10px;background:#fff"> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=4> </td></tr>
|
||||
<tr><td colspan=2 style="width:20px;height:30px;background:#fff" rowspan=3> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:20px;height:10px;background:#fff" rowspan=4 colspan=2> </td><td style="width:10px;height:20px;background:rgb(237,127,127)" rowspan=2> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:20px;height:10px;background:#fff" rowspan=3 colspan=2> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td></tr>
|
||||
<tr><td style="width:10px;height:10px;background:#fff" rowspan=2> </td></tr>
|
||||
<tr><td style="width:10px;height:10px;background:#fff"> </td></tr>
|
||||
<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@2.15.12</p>
|
||||
|
||||
39
node_modules/npm/html/doc/cli/npm-bin.html
generated
vendored
Normal file
39
node_modules/npm/html/doc/cli/npm-bin.html
generated
vendored
Normal file
@@ -0,0 +1,39 @@
|
||||
<!doctype html>
|
||||
<html>
|
||||
<title>npm-bin</title>
|
||||
<meta charset="utf-8">
|
||||
<link rel="stylesheet" type="text/css" href="../../static/style.css">
|
||||
<link rel="canonical" href="https://www.npmjs.org/doc/cli/npm-bin.html">
|
||||
<script async=true src="../../static/toc.js"></script>
|
||||
|
||||
<body>
|
||||
<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>
|
||||
<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>
|
||||
|
||||
</div>
|
||||
|
||||
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
|
||||
<tr><td style="width:180px;height:10px;background:rgb(237,127,127)" colspan=18> </td></tr>
|
||||
<tr><td rowspan=4 style="width:10px;height:10px;background:rgb(237,127,127)"> </td><td style="width:40px;height:10px;background:#fff" colspan=4> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=4> </td><td style="width:40px;height:10px;background:#fff" colspan=4> </td><td rowspan=4 style="width:10px;height:10px;background:rgb(237,127,127)"> </td><td colspan=6 style="width:60px;height:10px;background:#fff"> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=4> </td></tr>
|
||||
<tr><td colspan=2 style="width:20px;height:30px;background:#fff" rowspan=3> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:20px;height:10px;background:#fff" rowspan=4 colspan=2> </td><td style="width:10px;height:20px;background:rgb(237,127,127)" rowspan=2> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:20px;height:10px;background:#fff" rowspan=3 colspan=2> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td></tr>
|
||||
<tr><td style="width:10px;height:10px;background:#fff" rowspan=2> </td></tr>
|
||||
<tr><td style="width:10px;height:10px;background:#fff"> </td></tr>
|
||||
<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@2.15.12</p>
|
||||
|
||||
60
node_modules/npm/html/doc/cli/npm-bugs.html
generated
vendored
Normal file
60
node_modules/npm/html/doc/cli/npm-bugs.html
generated
vendored
Normal file
@@ -0,0 +1,60 @@
|
||||
<!doctype html>
|
||||
<html>
|
||||
<title>npm-bugs</title>
|
||||
<meta charset="utf-8">
|
||||
<link rel="stylesheet" type="text/css" href="../../static/style.css">
|
||||
<link rel="canonical" href="https://www.npmjs.org/doc/cli/npm-bugs.html">
|
||||
<script async=true src="../../static/toc.js"></script>
|
||||
|
||||
<body>
|
||||
<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>
|
||||
<pre><code>npm bugs <pkgname>
|
||||
npm bugs (with no args in a package dir)
|
||||
|
||||
aliases: issues
|
||||
</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>
|
||||
<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>
|
||||
<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: <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>
|
||||
|
||||
</div>
|
||||
|
||||
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
|
||||
<tr><td style="width:180px;height:10px;background:rgb(237,127,127)" colspan=18> </td></tr>
|
||||
<tr><td rowspan=4 style="width:10px;height:10px;background:rgb(237,127,127)"> </td><td style="width:40px;height:10px;background:#fff" colspan=4> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=4> </td><td style="width:40px;height:10px;background:#fff" colspan=4> </td><td rowspan=4 style="width:10px;height:10px;background:rgb(237,127,127)"> </td><td colspan=6 style="width:60px;height:10px;background:#fff"> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=4> </td></tr>
|
||||
<tr><td colspan=2 style="width:20px;height:30px;background:#fff" rowspan=3> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:20px;height:10px;background:#fff" rowspan=4 colspan=2> </td><td style="width:10px;height:20px;background:rgb(237,127,127)" rowspan=2> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:20px;height:10px;background:#fff" rowspan=3 colspan=2> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td></tr>
|
||||
<tr><td style="width:10px;height:10px;background:#fff" rowspan=2> </td></tr>
|
||||
<tr><td style="width:10px;height:10px;background:#fff"> </td></tr>
|
||||
<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@2.15.12</p>
|
||||
|
||||
44
node_modules/npm/html/doc/cli/npm-build.html
generated
vendored
Normal file
44
node_modules/npm/html/doc/cli/npm-build.html
generated
vendored
Normal file
@@ -0,0 +1,44 @@
|
||||
<!doctype html>
|
||||
<html>
|
||||
<title>npm-build</title>
|
||||
<meta charset="utf-8">
|
||||
<link rel="stylesheet" type="text/css" href="../../static/style.css">
|
||||
<link rel="canonical" href="https://www.npmjs.org/doc/cli/npm-build.html">
|
||||
<script async=true src="../../static/toc.js"></script>
|
||||
|
||||
<body>
|
||||
<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>
|
||||
<p>This is the plumbing command called by <code>npm link</code> and <code>npm install</code>.</p>
|
||||
<p>It should generally be called during installation, but if you need to run it
|
||||
directly, run:</p>
|
||||
<pre><code>npm run-script build
|
||||
</code></pre><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>
|
||||
<tr><td style="width:180px;height:10px;background:rgb(237,127,127)" colspan=18> </td></tr>
|
||||
<tr><td rowspan=4 style="width:10px;height:10px;background:rgb(237,127,127)"> </td><td style="width:40px;height:10px;background:#fff" colspan=4> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=4> </td><td style="width:40px;height:10px;background:#fff" colspan=4> </td><td rowspan=4 style="width:10px;height:10px;background:rgb(237,127,127)"> </td><td colspan=6 style="width:60px;height:10px;background:#fff"> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=4> </td></tr>
|
||||
<tr><td colspan=2 style="width:20px;height:30px;background:#fff" rowspan=3> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:20px;height:10px;background:#fff" rowspan=4 colspan=2> </td><td style="width:10px;height:20px;background:rgb(237,127,127)" rowspan=2> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:20px;height:10px;background:#fff" rowspan=3 colspan=2> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td></tr>
|
||||
<tr><td style="width:10px;height:10px;background:#fff" rowspan=2> </td></tr>
|
||||
<tr><td style="width:10px;height:10px;background:#fff"> </td></tr>
|
||||
<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@2.15.12</p>
|
||||
|
||||
35
node_modules/npm/html/doc/cli/npm-bundle.html
generated
vendored
Normal file
35
node_modules/npm/html/doc/cli/npm-bundle.html
generated
vendored
Normal file
@@ -0,0 +1,35 @@
|
||||
<!doctype html>
|
||||
<html>
|
||||
<title>npm-bundle</title>
|
||||
<meta charset="utf-8">
|
||||
<link rel="stylesheet" type="text/css" href="../../static/style.css">
|
||||
<link rel="canonical" href="https://www.npmjs.org/doc/cli/npm-bundle.html">
|
||||
<script async=true src="../../static/toc.js"></script>
|
||||
|
||||
<body>
|
||||
<div id="wrapper">
|
||||
|
||||
<h1><a href="../cli/npm-bundle.html">npm-bundle</a></h1> <p>REMOVED</p>
|
||||
<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>
|
||||
|
||||
</div>
|
||||
|
||||
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
|
||||
<tr><td style="width:180px;height:10px;background:rgb(237,127,127)" colspan=18> </td></tr>
|
||||
<tr><td rowspan=4 style="width:10px;height:10px;background:rgb(237,127,127)"> </td><td style="width:40px;height:10px;background:#fff" colspan=4> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=4> </td><td style="width:40px;height:10px;background:#fff" colspan=4> </td><td rowspan=4 style="width:10px;height:10px;background:rgb(237,127,127)"> </td><td colspan=6 style="width:60px;height:10px;background:#fff"> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=4> </td></tr>
|
||||
<tr><td colspan=2 style="width:20px;height:30px;background:#fff" rowspan=3> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:20px;height:10px;background:#fff" rowspan=4 colspan=2> </td><td style="width:10px;height:20px;background:rgb(237,127,127)" rowspan=2> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:20px;height:10px;background:#fff" rowspan=3 colspan=2> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td></tr>
|
||||
<tr><td style="width:10px;height:10px;background:#fff" rowspan=2> </td></tr>
|
||||
<tr><td style="width:10px;height:10px;background:#fff"> </td></tr>
|
||||
<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@2.15.12</p>
|
||||
|
||||
85
node_modules/npm/html/doc/cli/npm-cache.html
generated
vendored
Normal file
85
node_modules/npm/html/doc/cli/npm-cache.html
generated
vendored
Normal file
@@ -0,0 +1,85 @@
|
||||
<!doctype html>
|
||||
<html>
|
||||
<title>npm-cache</title>
|
||||
<meta charset="utf-8">
|
||||
<link rel="stylesheet" type="text/css" href="../../static/style.css">
|
||||
<link rel="canonical" href="https://www.npmjs.org/doc/cli/npm-cache.html">
|
||||
<script async=true src="../../static/toc.js"></script>
|
||||
|
||||
<body>
|
||||
<div id="wrapper">
|
||||
|
||||
<h1><a href="../cli/npm-cache.html">npm-cache</a></h1> <p>Manipulates packages cache</p>
|
||||
<h2 id="synopsis">SYNOPSIS</h2>
|
||||
<pre><code>npm cache add <tarball file>
|
||||
npm cache add <folder>
|
||||
npm cache add <tarball url>
|
||||
npm cache add <name>@<version>
|
||||
|
||||
npm cache ls [<path>]
|
||||
|
||||
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:
|
||||
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:
|
||||
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:
|
||||
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>
|
||||
<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/package.json:
|
||||
The package.json file, as npm sees it.</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. This is stored in <code>{cache}/{hostname}/{path}/.cache.json</code>.</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>
|
||||
<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>
|
||||
|
||||
</div>
|
||||
|
||||
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
|
||||
<tr><td style="width:180px;height:10px;background:rgb(237,127,127)" colspan=18> </td></tr>
|
||||
<tr><td rowspan=4 style="width:10px;height:10px;background:rgb(237,127,127)"> </td><td style="width:40px;height:10px;background:#fff" colspan=4> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=4> </td><td style="width:40px;height:10px;background:#fff" colspan=4> </td><td rowspan=4 style="width:10px;height:10px;background:rgb(237,127,127)"> </td><td colspan=6 style="width:60px;height:10px;background:#fff"> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=4> </td></tr>
|
||||
<tr><td colspan=2 style="width:20px;height:30px;background:#fff" rowspan=3> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:20px;height:10px;background:#fff" rowspan=4 colspan=2> </td><td style="width:10px;height:20px;background:rgb(237,127,127)" rowspan=2> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:20px;height:10px;background:#fff" rowspan=3 colspan=2> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td></tr>
|
||||
<tr><td style="width:10px;height:10px;background:#fff" rowspan=2> </td></tr>
|
||||
<tr><td style="width:10px;height:10px;background:#fff"> </td></tr>
|
||||
<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@2.15.12</p>
|
||||
|
||||
46
node_modules/npm/html/doc/cli/npm-completion.html
generated
vendored
Normal file
46
node_modules/npm/html/doc/cli/npm-completion.html
generated
vendored
Normal file
@@ -0,0 +1,46 @@
|
||||
<!doctype html>
|
||||
<html>
|
||||
<title>npm-completion</title>
|
||||
<meta charset="utf-8">
|
||||
<link rel="stylesheet" type="text/css" href="../../static/style.css">
|
||||
<link rel="canonical" href="https://www.npmjs.org/doc/cli/npm-completion.html">
|
||||
<script async=true src="../../static/toc.js"></script>
|
||||
|
||||
<body>
|
||||
<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>
|
||||
<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>
|
||||
|
||||
</div>
|
||||
|
||||
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
|
||||
<tr><td style="width:180px;height:10px;background:rgb(237,127,127)" colspan=18> </td></tr>
|
||||
<tr><td rowspan=4 style="width:10px;height:10px;background:rgb(237,127,127)"> </td><td style="width:40px;height:10px;background:#fff" colspan=4> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=4> </td><td style="width:40px;height:10px;background:#fff" colspan=4> </td><td rowspan=4 style="width:10px;height:10px;background:rgb(237,127,127)"> </td><td colspan=6 style="width:60px;height:10px;background:#fff"> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=4> </td></tr>
|
||||
<tr><td colspan=2 style="width:20px;height:30px;background:#fff" rowspan=3> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:20px;height:10px;background:#fff" rowspan=4 colspan=2> </td><td style="width:10px;height:20px;background:rgb(237,127,127)" rowspan=2> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:20px;height:10px;background:#fff" rowspan=3 colspan=2> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td></tr>
|
||||
<tr><td style="width:10px;height:10px;background:#fff" rowspan=2> </td></tr>
|
||||
<tr><td style="width:10px;height:10px;background:#fff"> </td></tr>
|
||||
<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@2.15.12</p>
|
||||
|
||||
72
node_modules/npm/html/doc/cli/npm-config.html
generated
vendored
Normal file
72
node_modules/npm/html/doc/cli/npm-config.html
generated
vendored
Normal file
@@ -0,0 +1,72 @@
|
||||
<!doctype html>
|
||||
<html>
|
||||
<title>npm-config</title>
|
||||
<meta charset="utf-8">
|
||||
<link rel="stylesheet" type="text/css" href="../../static/style.css">
|
||||
<link rel="canonical" href="https://www.npmjs.org/doc/cli/npm-config.html">
|
||||
<script async=true src="../../static/toc.js"></script>
|
||||
|
||||
<body>
|
||||
<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>
|
||||
<pre><code>npm config set <key> <value> [--global]
|
||||
npm config get <key>
|
||||
npm config delete <key>
|
||||
npm config list
|
||||
npm config edit
|
||||
npm c [set|get|delete|list]
|
||||
npm get <key>
|
||||
npm set <key> <value> [--global]
|
||||
|
||||
aliases: c
|
||||
</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>
|
||||
<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>
|
||||
<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>
|
||||
<h3 id="list">list</h3>
|
||||
<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>
|
||||
<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
|
||||
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>
|
||||
|
||||
</div>
|
||||
|
||||
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
|
||||
<tr><td style="width:180px;height:10px;background:rgb(237,127,127)" colspan=18> </td></tr>
|
||||
<tr><td rowspan=4 style="width:10px;height:10px;background:rgb(237,127,127)"> </td><td style="width:40px;height:10px;background:#fff" colspan=4> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=4> </td><td style="width:40px;height:10px;background:#fff" colspan=4> </td><td rowspan=4 style="width:10px;height:10px;background:rgb(237,127,127)"> </td><td colspan=6 style="width:60px;height:10px;background:#fff"> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=4> </td></tr>
|
||||
<tr><td colspan=2 style="width:20px;height:30px;background:#fff" rowspan=3> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:20px;height:10px;background:#fff" rowspan=4 colspan=2> </td><td style="width:10px;height:20px;background:rgb(237,127,127)" rowspan=2> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:20px;height:10px;background:#fff" rowspan=3 colspan=2> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td></tr>
|
||||
<tr><td style="width:10px;height:10px;background:#fff" rowspan=2> </td></tr>
|
||||
<tr><td style="width:10px;height:10px;background:#fff"> </td></tr>
|
||||
<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@2.15.12</p>
|
||||
|
||||
69
node_modules/npm/html/doc/cli/npm-dedupe.html
generated
vendored
Normal file
69
node_modules/npm/html/doc/cli/npm-dedupe.html
generated
vendored
Normal file
@@ -0,0 +1,69 @@
|
||||
<!doctype html>
|
||||
<html>
|
||||
<title>npm-dedupe</title>
|
||||
<meta charset="utf-8">
|
||||
<link rel="stylesheet" type="text/css" href="../../static/style.css">
|
||||
<link rel="canonical" href="https://www.npmjs.org/doc/cli/npm-dedupe.html">
|
||||
<script async=true src="../../static/toc.js"></script>
|
||||
|
||||
<body>
|
||||
<div id="wrapper">
|
||||
|
||||
<h1><a href="../cli/npm-dedupe.html">npm-dedupe</a></h1> <p>Reduce duplication</p>
|
||||
<h2 id="synopsis">SYNOPSIS</h2>
|
||||
<pre><code>npm dedupe [package names...]
|
||||
npm ddp [package names...]
|
||||
|
||||
aliases: find-dupes, ddp
|
||||
</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>
|
||||
<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
|
||||
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>
|
||||
|
||||
</div>
|
||||
|
||||
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
|
||||
<tr><td style="width:180px;height:10px;background:rgb(237,127,127)" colspan=18> </td></tr>
|
||||
<tr><td rowspan=4 style="width:10px;height:10px;background:rgb(237,127,127)"> </td><td style="width:40px;height:10px;background:#fff" colspan=4> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=4> </td><td style="width:40px;height:10px;background:#fff" colspan=4> </td><td rowspan=4 style="width:10px;height:10px;background:rgb(237,127,127)"> </td><td colspan=6 style="width:60px;height:10px;background:#fff"> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=4> </td></tr>
|
||||
<tr><td colspan=2 style="width:20px;height:30px;background:#fff" rowspan=3> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:20px;height:10px;background:#fff" rowspan=4 colspan=2> </td><td style="width:10px;height:20px;background:rgb(237,127,127)" rowspan=2> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:20px;height:10px;background:#fff" rowspan=3 colspan=2> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td></tr>
|
||||
<tr><td style="width:10px;height:10px;background:#fff" rowspan=2> </td></tr>
|
||||
<tr><td style="width:10px;height:10px;background:#fff"> </td></tr>
|
||||
<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@2.15.12</p>
|
||||
|
||||
42
node_modules/npm/html/doc/cli/npm-deprecate.html
generated
vendored
Normal file
42
node_modules/npm/html/doc/cli/npm-deprecate.html
generated
vendored
Normal file
@@ -0,0 +1,42 @@
|
||||
<!doctype html>
|
||||
<html>
|
||||
<title>npm-deprecate</title>
|
||||
<meta charset="utf-8">
|
||||
<link rel="stylesheet" type="text/css" href="../../static/style.css">
|
||||
<link rel="canonical" href="https://www.npmjs.org/doc/cli/npm-deprecate.html">
|
||||
<script async=true src="../../static/toc.js"></script>
|
||||
|
||||
<body>
|
||||
<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>
|
||||
<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
|
||||
<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>
|
||||
|
||||
</div>
|
||||
|
||||
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
|
||||
<tr><td style="width:180px;height:10px;background:rgb(237,127,127)" colspan=18> </td></tr>
|
||||
<tr><td rowspan=4 style="width:10px;height:10px;background:rgb(237,127,127)"> </td><td style="width:40px;height:10px;background:#fff" colspan=4> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=4> </td><td style="width:40px;height:10px;background:#fff" colspan=4> </td><td rowspan=4 style="width:10px;height:10px;background:rgb(237,127,127)"> </td><td colspan=6 style="width:60px;height:10px;background:#fff"> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=4> </td></tr>
|
||||
<tr><td colspan=2 style="width:20px;height:30px;background:#fff" rowspan=3> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:20px;height:10px;background:#fff" rowspan=4 colspan=2> </td><td style="width:10px;height:20px;background:rgb(237,127,127)" rowspan=2> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:20px;height:10px;background:#fff" rowspan=3 colspan=2> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td></tr>
|
||||
<tr><td style="width:10px;height:10px;background:#fff" rowspan=2> </td></tr>
|
||||
<tr><td style="width:10px;height:10px;background:#fff"> </td></tr>
|
||||
<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@2.15.12</p>
|
||||
|
||||
91
node_modules/npm/html/doc/cli/npm-dist-tag.html
generated
vendored
Normal file
91
node_modules/npm/html/doc/cli/npm-dist-tag.html
generated
vendored
Normal file
@@ -0,0 +1,91 @@
|
||||
<!doctype html>
|
||||
<html>
|
||||
<title>npm-dist-tag</title>
|
||||
<meta charset="utf-8">
|
||||
<link rel="stylesheet" type="text/css" href="../../static/style.css">
|
||||
<link rel="canonical" href="https://www.npmjs.org/doc/cli/npm-dist-tag.html">
|
||||
<script async=true src="../../static/toc.js"></script>
|
||||
|
||||
<body>
|
||||
<div id="wrapper">
|
||||
|
||||
<h1><a href="../cli/npm-dist-tag.html">npm-dist-tag</a></h1> <p>Modify package distribution tags</p>
|
||||
<h2 id="synopsis">SYNOPSIS</h2>
|
||||
<pre><code>npm dist-tag add <pkg>@<version> [<tag>]
|
||||
npm dist-tag rm <pkg> <tag>
|
||||
npm dist-tag ls [<pkg>]
|
||||
|
||||
aliases: dist-tags
|
||||
</code></pre><h2 id="description">DESCRIPTION</h2>
|
||||
<p>Add, remove, and enumerate distribution tags on a package:</p>
|
||||
<ul>
|
||||
<li><p>add:
|
||||
Tags the specified version of the package with the specified tag, or the
|
||||
<code>--tag</code> config if not specified.</p>
|
||||
</li>
|
||||
<li><p>rm:
|
||||
Clear a tag that is no longer in use from the package.</p>
|
||||
</li>
|
||||
<li><p>ls:
|
||||
Show all of the dist-tags for a package, defaulting to the package in
|
||||
the current prefix.</p>
|
||||
</li>
|
||||
</ul>
|
||||
<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>
|
||||
<p>Publishing a package sets the <code>latest</code> tag to the published version unless the
|
||||
<code>--tag</code> option is used. For example, <code>npm publish --tag=beta</code>.</p>
|
||||
<p>By default, <code>npm install <pkg></code> (without any <code>@<version></code> or <code>@<tag></code>
|
||||
specifier) installs the <code>latest</code> tag.</p>
|
||||
<h2 id="purpose">PURPOSE</h2>
|
||||
<p>Tags can be used to provide an alias instead of version numbers.</p>
|
||||
<p>For example, a project might choose to have multiple streams of development
|
||||
and use a different tag for each stream,
|
||||
e.g., <code>stable</code>, <code>beta</code>, <code>dev</code>, <code>canary</code>.</p>
|
||||
<p>By default, the <code>latest</code> tag is used by npm to identify the current version of
|
||||
a package, and <code>npm install <pkg></code> (without any <code>@<version></code> or <code>@<tag></code>
|
||||
specifier) installs the <code>latest</code> tag. Typically, projects only use the <code>latest</code>
|
||||
tag for stable release versions, and use other tags for unstable versions such
|
||||
as prereleases.</p>
|
||||
<p>The <code>next</code> tag is used by some projects to identify the upcoming version.</p>
|
||||
<p>By default, other than <code>latest</code>, no tag has any special significance to npm
|
||||
itself.</p>
|
||||
<h2 id="caveats">CAVEATS</h2>
|
||||
<p>This command used to be known as <code>npm tag</code>, which only created new tags, and so
|
||||
had a different syntax.</p>
|
||||
<p>Tags must share a namespace with version numbers, because they are specified in
|
||||
the same slot: <code>npm install <pkg>@<version></code> vs <code>npm install <pkg>@<tag></code>.</p>
|
||||
<p>Tags that can be interpreted as valid semver ranges will be rejected. For
|
||||
example, <code>v1.4</code> cannot be used as a tag, because it is interpreted by semver as
|
||||
<code>>=1.4.0 <1.5.0</code>. See <a href="https://github.com/npm/npm/issues/6082">https://github.com/npm/npm/issues/6082</a>.</p>
|
||||
<p>The simplest way to avoid semver problems with tags is to use tags that do not
|
||||
begin with a number or the letter <code>v</code>.</p>
|
||||
<h2 id="see-also">SEE ALSO</h2>
|
||||
<ul>
|
||||
<li><a href="../cli/npm-tag.html">npm-tag(1)</a></li>
|
||||
<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>
|
||||
<tr><td style="width:180px;height:10px;background:rgb(237,127,127)" colspan=18> </td></tr>
|
||||
<tr><td rowspan=4 style="width:10px;height:10px;background:rgb(237,127,127)"> </td><td style="width:40px;height:10px;background:#fff" colspan=4> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=4> </td><td style="width:40px;height:10px;background:#fff" colspan=4> </td><td rowspan=4 style="width:10px;height:10px;background:rgb(237,127,127)"> </td><td colspan=6 style="width:60px;height:10px;background:#fff"> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=4> </td></tr>
|
||||
<tr><td colspan=2 style="width:20px;height:30px;background:#fff" rowspan=3> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:20px;height:10px;background:#fff" rowspan=4 colspan=2> </td><td style="width:10px;height:20px;background:rgb(237,127,127)" rowspan=2> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:20px;height:10px;background:#fff" rowspan=3 colspan=2> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td></tr>
|
||||
<tr><td style="width:10px;height:10px;background:#fff" rowspan=2> </td></tr>
|
||||
<tr><td style="width:10px;height:10px;background:#fff"> </td></tr>
|
||||
<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-dist-tag — npm@2.15.12</p>
|
||||
|
||||
60
node_modules/npm/html/doc/cli/npm-docs.html
generated
vendored
Normal file
60
node_modules/npm/html/doc/cli/npm-docs.html
generated
vendored
Normal file
@@ -0,0 +1,60 @@
|
||||
<!doctype html>
|
||||
<html>
|
||||
<title>npm-docs</title>
|
||||
<meta charset="utf-8">
|
||||
<link rel="stylesheet" type="text/css" href="../../static/style.css">
|
||||
<link rel="canonical" href="https://www.npmjs.org/doc/cli/npm-docs.html">
|
||||
<script async=true src="../../static/toc.js"></script>
|
||||
|
||||
<body>
|
||||
<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>
|
||||
<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>
|
||||
<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>
|
||||
<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>
|
||||
<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: <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>
|
||||
|
||||
</div>
|
||||
|
||||
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
|
||||
<tr><td style="width:180px;height:10px;background:rgb(237,127,127)" colspan=18> </td></tr>
|
||||
<tr><td rowspan=4 style="width:10px;height:10px;background:rgb(237,127,127)"> </td><td style="width:40px;height:10px;background:#fff" colspan=4> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=4> </td><td style="width:40px;height:10px;background:#fff" colspan=4> </td><td rowspan=4 style="width:10px;height:10px;background:rgb(237,127,127)"> </td><td colspan=6 style="width:60px;height:10px;background:#fff"> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=4> </td></tr>
|
||||
<tr><td colspan=2 style="width:20px;height:30px;background:#fff" rowspan=3> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:20px;height:10px;background:#fff" rowspan=4 colspan=2> </td><td style="width:10px;height:20px;background:rgb(237,127,127)" rowspan=2> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:20px;height:10px;background:#fff" rowspan=3 colspan=2> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td></tr>
|
||||
<tr><td style="width:10px;height:10px;background:#fff" rowspan=2> </td></tr>
|
||||
<tr><td style="width:10px;height:10px;background:#fff"> </td></tr>
|
||||
<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@2.15.12</p>
|
||||
|
||||
53
node_modules/npm/html/doc/cli/npm-edit.html
generated
vendored
Normal file
53
node_modules/npm/html/doc/cli/npm-edit.html
generated
vendored
Normal file
@@ -0,0 +1,53 @@
|
||||
<!doctype html>
|
||||
<html>
|
||||
<title>npm-edit</title>
|
||||
<meta charset="utf-8">
|
||||
<link rel="stylesheet" type="text/css" href="../../static/style.css">
|
||||
<link rel="canonical" href="https://www.npmjs.org/doc/cli/npm-edit.html">
|
||||
<script async=true src="../../static/toc.js"></script>
|
||||
|
||||
<body>
|
||||
<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>
|
||||
<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>
|
||||
<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>
|
||||
<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>
|
||||
|
||||
</div>
|
||||
|
||||
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
|
||||
<tr><td style="width:180px;height:10px;background:rgb(237,127,127)" colspan=18> </td></tr>
|
||||
<tr><td rowspan=4 style="width:10px;height:10px;background:rgb(237,127,127)"> </td><td style="width:40px;height:10px;background:#fff" colspan=4> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=4> </td><td style="width:40px;height:10px;background:#fff" colspan=4> </td><td rowspan=4 style="width:10px;height:10px;background:rgb(237,127,127)"> </td><td colspan=6 style="width:60px;height:10px;background:#fff"> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=4> </td></tr>
|
||||
<tr><td colspan=2 style="width:20px;height:30px;background:#fff" rowspan=3> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:20px;height:10px;background:#fff" rowspan=4 colspan=2> </td><td style="width:10px;height:20px;background:rgb(237,127,127)" rowspan=2> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:20px;height:10px;background:#fff" rowspan=3 colspan=2> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td></tr>
|
||||
<tr><td style="width:10px;height:10px;background:#fff" rowspan=2> </td></tr>
|
||||
<tr><td style="width:10px;height:10px;background:#fff"> </td></tr>
|
||||
<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@2.15.12</p>
|
||||
|
||||
53
node_modules/npm/html/doc/cli/npm-explore.html
generated
vendored
Normal file
53
node_modules/npm/html/doc/cli/npm-explore.html
generated
vendored
Normal file
@@ -0,0 +1,53 @@
|
||||
<!doctype html>
|
||||
<html>
|
||||
<title>npm-explore</title>
|
||||
<meta charset="utf-8">
|
||||
<link rel="stylesheet" type="text/css" href="../../static/style.css">
|
||||
<link rel="canonical" href="https://www.npmjs.org/doc/cli/npm-explore.html">
|
||||
<script async=true src="../../static/toc.js"></script>
|
||||
|
||||
<body>
|
||||
<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> [ -- <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
|
||||
sure to use <code>npm rebuild <pkg></code> if you make any changes.</p>
|
||||
<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>
|
||||
<p>The shell to run for the <code>npm explore</code> command.</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-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>
|
||||
<tr><td style="width:180px;height:10px;background:rgb(237,127,127)" colspan=18> </td></tr>
|
||||
<tr><td rowspan=4 style="width:10px;height:10px;background:rgb(237,127,127)"> </td><td style="width:40px;height:10px;background:#fff" colspan=4> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=4> </td><td style="width:40px;height:10px;background:#fff" colspan=4> </td><td rowspan=4 style="width:10px;height:10px;background:rgb(237,127,127)"> </td><td colspan=6 style="width:60px;height:10px;background:#fff"> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=4> </td></tr>
|
||||
<tr><td colspan=2 style="width:20px;height:30px;background:#fff" rowspan=3> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:20px;height:10px;background:#fff" rowspan=4 colspan=2> </td><td style="width:10px;height:20px;background:rgb(237,127,127)" rowspan=2> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:20px;height:10px;background:#fff" rowspan=3 colspan=2> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td></tr>
|
||||
<tr><td style="width:10px;height:10px;background:#fff" rowspan=2> </td></tr>
|
||||
<tr><td style="width:10px;height:10px;background:#fff"> </td></tr>
|
||||
<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@2.15.12</p>
|
||||
|
||||
50
node_modules/npm/html/doc/cli/npm-help-search.html
generated
vendored
Normal file
50
node_modules/npm/html/doc/cli/npm-help-search.html
generated
vendored
Normal file
@@ -0,0 +1,50 @@
|
||||
<!doctype html>
|
||||
<html>
|
||||
<title>npm-help-search</title>
|
||||
<meta charset="utf-8">
|
||||
<link rel="stylesheet" type="text/css" href="../../static/style.css">
|
||||
<link rel="canonical" href="https://www.npmjs.org/doc/cli/npm-help-search.html">
|
||||
<script async=true src="../../static/toc.js"></script>
|
||||
|
||||
<body>
|
||||
<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>
|
||||
<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>
|
||||
<h3 id="long">long</h3>
|
||||
<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>
|
||||
|
||||
</div>
|
||||
|
||||
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
|
||||
<tr><td style="width:180px;height:10px;background:rgb(237,127,127)" colspan=18> </td></tr>
|
||||
<tr><td rowspan=4 style="width:10px;height:10px;background:rgb(237,127,127)"> </td><td style="width:40px;height:10px;background:#fff" colspan=4> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=4> </td><td style="width:40px;height:10px;background:#fff" colspan=4> </td><td rowspan=4 style="width:10px;height:10px;background:rgb(237,127,127)"> </td><td colspan=6 style="width:60px;height:10px;background:#fff"> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=4> </td></tr>
|
||||
<tr><td colspan=2 style="width:20px;height:30px;background:#fff" rowspan=3> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:20px;height:10px;background:#fff" rowspan=4 colspan=2> </td><td style="width:10px;height:20px;background:rgb(237,127,127)" rowspan=2> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:20px;height:10px;background:#fff" rowspan=3 colspan=2> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td></tr>
|
||||
<tr><td style="width:10px;height:10px;background:#fff" rowspan=2> </td></tr>
|
||||
<tr><td style="width:10px;height:10px;background:#fff"> </td></tr>
|
||||
<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@2.15.12</p>
|
||||
|
||||
56
node_modules/npm/html/doc/cli/npm-help.html
generated
vendored
Normal file
56
node_modules/npm/html/doc/cli/npm-help.html
generated
vendored
Normal file
@@ -0,0 +1,56 @@
|
||||
<!doctype html>
|
||||
<html>
|
||||
<title>npm-help</title>
|
||||
<meta charset="utf-8">
|
||||
<link rel="stylesheet" type="text/css" href="../../static/style.css">
|
||||
<link rel="canonical" href="https://www.npmjs.org/doc/cli/npm-help.html">
|
||||
<script async=true src="../../static/toc.js"></script>
|
||||
|
||||
<body>
|
||||
<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>
|
||||
<pre><code>npm help <topic>
|
||||
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>
|
||||
<h3 id="viewer">viewer</h3>
|
||||
<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>
|
||||
|
||||
</div>
|
||||
|
||||
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
|
||||
<tr><td style="width:180px;height:10px;background:rgb(237,127,127)" colspan=18> </td></tr>
|
||||
<tr><td rowspan=4 style="width:10px;height:10px;background:rgb(237,127,127)"> </td><td style="width:40px;height:10px;background:#fff" colspan=4> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=4> </td><td style="width:40px;height:10px;background:#fff" colspan=4> </td><td rowspan=4 style="width:10px;height:10px;background:rgb(237,127,127)"> </td><td colspan=6 style="width:60px;height:10px;background:#fff"> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=4> </td></tr>
|
||||
<tr><td colspan=2 style="width:20px;height:30px;background:#fff" rowspan=3> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:20px;height:10px;background:#fff" rowspan=4 colspan=2> </td><td style="width:10px;height:20px;background:rgb(237,127,127)" rowspan=2> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:20px;height:10px;background:#fff" rowspan=3 colspan=2> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td></tr>
|
||||
<tr><td style="width:10px;height:10px;background:#fff" rowspan=2> </td></tr>
|
||||
<tr><td style="width:10px;height:10px;background:#fff"> </td></tr>
|
||||
<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@2.15.12</p>
|
||||
|
||||
52
node_modules/npm/html/doc/cli/npm-init.html
generated
vendored
Normal file
52
node_modules/npm/html/doc/cli/npm-init.html
generated
vendored
Normal file
@@ -0,0 +1,52 @@
|
||||
<!doctype html>
|
||||
<html>
|
||||
<title>npm-init</title>
|
||||
<meta charset="utf-8">
|
||||
<link rel="stylesheet" type="text/css" href="../../static/style.css">
|
||||
<link rel="canonical" href="https://www.npmjs.org/doc/cli/npm-init.html">
|
||||
<script async=true src="../../static/toc.js"></script>
|
||||
|
||||
<body>
|
||||
<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 [-f|--force|-y|--yes]
|
||||
</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>If you invoke it with <code>-f</code>, <code>--force</code>, <code>-y</code>, or <code>--yes</code>, it will use only
|
||||
defaults and not prompt you for any options.</p>
|
||||
<h2 id="configuration">CONFIGURATION</h2>
|
||||
<h3 id="scope">scope</h3>
|
||||
<ul>
|
||||
<li>Default: none</li>
|
||||
<li>Type: String</li>
|
||||
</ul>
|
||||
<p>The scope under which the new module should be created.</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>
|
||||
<li><a href="../misc/npm-scope.html">npm-scope(7)</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
|
||||
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
|
||||
<tr><td style="width:180px;height:10px;background:rgb(237,127,127)" colspan=18> </td></tr>
|
||||
<tr><td rowspan=4 style="width:10px;height:10px;background:rgb(237,127,127)"> </td><td style="width:40px;height:10px;background:#fff" colspan=4> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=4> </td><td style="width:40px;height:10px;background:#fff" colspan=4> </td><td rowspan=4 style="width:10px;height:10px;background:rgb(237,127,127)"> </td><td colspan=6 style="width:60px;height:10px;background:#fff"> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=4> </td></tr>
|
||||
<tr><td colspan=2 style="width:20px;height:30px;background:#fff" rowspan=3> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:20px;height:10px;background:#fff" rowspan=4 colspan=2> </td><td style="width:10px;height:20px;background:rgb(237,127,127)" rowspan=2> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:20px;height:10px;background:#fff" rowspan=3 colspan=2> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td></tr>
|
||||
<tr><td style="width:10px;height:10px;background:#fff" rowspan=2> </td></tr>
|
||||
<tr><td style="width:10px;height:10px;background:#fff"> </td></tr>
|
||||
<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@2.15.12</p>
|
||||
|
||||
286
node_modules/npm/html/doc/cli/npm-install.html
generated
vendored
Normal file
286
node_modules/npm/html/doc/cli/npm-install.html
generated
vendored
Normal file
@@ -0,0 +1,286 @@
|
||||
<!doctype html>
|
||||
<html>
|
||||
<title>npm-install</title>
|
||||
<meta charset="utf-8">
|
||||
<link rel="stylesheet" type="text/css" href="../../static/style.css">
|
||||
<link rel="canonical" href="https://www.npmjs.org/doc/cli/npm-install.html">
|
||||
<script async=true src="../../static/toc.js"></script>
|
||||
|
||||
<body>
|
||||
<div id="wrapper">
|
||||
|
||||
<h1><a href="../cli/npm-install.html">npm-install</a></h1> <p>Install a package</p>
|
||||
<h2 id="synopsis">SYNOPSIS</h2>
|
||||
<pre><code>npm install (with no args in a package dir)
|
||||
npm install <tarball file>
|
||||
npm install <tarball url>
|
||||
npm install <folder>
|
||||
npm install [@<scope>/]<name> [--save|--save-dev|--save-optional] [--save-exact] [--save-bundle]
|
||||
npm install [@<scope>/]<name>@<tag>
|
||||
npm install [@<scope>/]<name>@<version>
|
||||
npm install [@<scope>/]<name>@<version range>
|
||||
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 <code><a href="../files/package.json.html">package.json(5)</a></code> 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> (see <code><a href="../cli/npm-dist-tag.html">npm-dist-tag(1)</a></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
|
||||
in <code><a href="../files/package.json.html">package.json(5)</a></code>.</p>
|
||||
<p> With the <code>--production</code> flag (or when the <code>NODE_ENV</code> environment variable
|
||||
is set to <code>production</code>), 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 [@<scope>/]<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>. The config's default value is <code>latest</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 are two additional, optional flags:</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>
|
||||
</li>
|
||||
<li><p><code>-B, --save-bundle</code>: Saved dependencies will also be added to your <code>bundleDependencies</code> list.</p>
|
||||
<p>Note: if you do not include the @-symbol on your scope name, npm will
|
||||
interpret this as a GitHub repository instead, see below. Scopes names
|
||||
must also be followed by a slash.</p>
|
||||
<p>Examples:</p>
|
||||
<pre><code>npm install sax --save
|
||||
npm install githubname/reponame
|
||||
npm install @myorg/privatepackage
|
||||
npm install node-tap --save-dev
|
||||
npm install dtrace-provider --save-optional
|
||||
npm install readable-stream --save --save-exact
|
||||
npm install ansi-regex --save --save-bundle
|
||||
</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.
|
||||
</code></pre><ul>
|
||||
<li><p><code>npm install [@<scope>/]<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
|
||||
npm install @myorg/mypackage@latest
|
||||
</code></pre></li>
|
||||
<li><p><code>npm install [@<scope>/]<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
|
||||
npm install @myorg/privatepackage@1.5.0
|
||||
</code></pre></li>
|
||||
<li><p><code>npm install [@<scope>/]<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"
|
||||
npm install @myorg/privatepackage@">=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>[:<password>]@]<hostname>[:<port>][:/]<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> The following git environment variables are recognized by npm and will be added
|
||||
to the environment when running git:</p>
|
||||
<ul>
|
||||
<li><code>GIT_ASKPASS</code></li>
|
||||
<li><code>GIT_EXEC_PATH</code></li>
|
||||
<li><code>GIT_PROXY_COMMAND</code></li>
|
||||
<li><code>GIT_SSH</code></li>
|
||||
<li><code>GIT_SSH_COMMAND</code></li>
|
||||
<li><code>GIT_SSL_CAINFO</code></li>
|
||||
<li><p><code>GIT_SSL_NO_VERIFY</code></p>
|
||||
<p>See the git man page for details.</p>
|
||||
<p>Examples:</p>
|
||||
<pre><code>npm install git+ssh://git@github.com:npm/npm.git#v1.0.27
|
||||
npm install git+https://isaacs@github.com/npm/npm.git
|
||||
npm install git://github.com/npm/npm.git#v1.0.27
|
||||
GIT_SSH_COMMAND='ssh -i ~/.ssh/custom_ident' npm install git+ssh://git@github.com:npm/npm.git
|
||||
</code></pre></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><p><code>npm install <githubname>/<githubrepo>[#<commit-ish>]</code>:</p>
|
||||
</li>
|
||||
<li><p><code>npm install github:<githubname>/<githubrepo>[#<commit-ish>]</code>:</p>
|
||||
<p> Install the package at <code>https://github.com/githubname/githubrepo</code> by
|
||||
attempting to clone it using <code>git</code>.</p>
|
||||
<p> If you don't specify a <em>commit-ish</em> then <code>master</code> will be used.</p>
|
||||
<p> Examples:</p>
|
||||
<pre><code> npm install mygithubuser/myproject
|
||||
npm install github:mygithubuser/myproject
|
||||
</code></pre></li>
|
||||
<li><p><code>npm install gist:[<githubname>/]<gistID>[#<commit-ish>]</code>:</p>
|
||||
<p> Install the package at <code>https://gist.github.com/gistID</code> by attempting to
|
||||
clone it using <code>git</code>. The GitHub username associated with the gist is
|
||||
optional and will not be saved in <code>package.json</code> if <code>--save</code> is used.</p>
|
||||
<p> If you don't specify a <em>commit-ish</em> then <code>master</code> will be used.</p>
|
||||
<p> Example:</p>
|
||||
<pre><code> npm install gist:101a11beef
|
||||
</code></pre></li>
|
||||
<li><p><code>npm install bitbucket:<bitbucketname>/<bitbucketrepo>[#<commit-ish>]</code>:</p>
|
||||
<p> Install the package at <code>https://bitbucket.org/bitbucketname/bitbucketrepo</code>
|
||||
by attempting to clone it using <code>git</code>.</p>
|
||||
<p> If you don't specify a <em>commit-ish</em> then <code>master</code> will be used.</p>
|
||||
<p> Example:</p>
|
||||
<pre><code> npm install bitbucket:mybitbucketuser/myproject
|
||||
</code></pre></li>
|
||||
<li><p><code>npm install gitlab:<gitlabname>/<gitlabrepo>[#<commit-ish>]</code>:</p>
|
||||
<p> Install the package at <code>https://gitlab.com/gitlabname/gitlabrepo</code>
|
||||
by attempting to clone it using <code>git</code>.</p>
|
||||
<p> If you don't specify a <em>commit-ish</em> then <code>master</code> will be used.</p>
|
||||
<p> Example:</p>
|
||||
<pre><code> npm install gitlab:mygitlabuser/myproject
|
||||
</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
|
||||
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
|
||||
rather than locally. See <code><a href="../files/npm-folders.html">npm-folders(5)</a></code>.</p>
|
||||
<p>The <code>--ignore-scripts</code> argument will cause npm to not execute any
|
||||
scripts defined in the package.json. See <code><a href="../misc/npm-scripts.html">npm-scripts(7)</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>
|
||||
<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
|
||||
resolve dep to precise version
|
||||
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>,
|
||||
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
|
||||
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>
|
||||
<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
|
||||
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-uninstall.html">npm-uninstall(1)</a></li>
|
||||
<li><a href="../cli/npm-shrinkwrap.html">npm-shrinkwrap(1)</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>
|
||||
<tr><td style="width:180px;height:10px;background:rgb(237,127,127)" colspan=18> </td></tr>
|
||||
<tr><td rowspan=4 style="width:10px;height:10px;background:rgb(237,127,127)"> </td><td style="width:40px;height:10px;background:#fff" colspan=4> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=4> </td><td style="width:40px;height:10px;background:#fff" colspan=4> </td><td rowspan=4 style="width:10px;height:10px;background:rgb(237,127,127)"> </td><td colspan=6 style="width:60px;height:10px;background:#fff"> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=4> </td></tr>
|
||||
<tr><td colspan=2 style="width:20px;height:30px;background:#fff" rowspan=3> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:20px;height:10px;background:#fff" rowspan=4 colspan=2> </td><td style="width:10px;height:20px;background:rgb(237,127,127)" rowspan=2> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:20px;height:10px;background:#fff" rowspan=3 colspan=2> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td></tr>
|
||||
<tr><td style="width:10px;height:10px;background:#fff" rowspan=2> </td></tr>
|
||||
<tr><td style="width:10px;height:10px;background:#fff"> </td></tr>
|
||||
<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@2.15.12</p>
|
||||
|
||||
78
node_modules/npm/html/doc/cli/npm-link.html
generated
vendored
Normal file
78
node_modules/npm/html/doc/cli/npm-link.html
generated
vendored
Normal file
@@ -0,0 +1,78 @@
|
||||
<!doctype html>
|
||||
<html>
|
||||
<title>npm-link</title>
|
||||
<meta charset="utf-8">
|
||||
<link rel="stylesheet" type="text/css" href="../../static/style.css">
|
||||
<link rel="canonical" href="https://www.npmjs.org/doc/cli/npm-link.html">
|
||||
<script async=true src="../../static/toc.js"></script>
|
||||
|
||||
<body>
|
||||
<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>
|
||||
<pre><code>npm link (in package folder)
|
||||
npm link [@<scope>/]<pkgname>
|
||||
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 symlink in the global folder
|
||||
<code>{prefix}/lib/node_modules/<package></code> that links to the package where the <code>npm
|
||||
link</code> command was executed. (see <code><a href="../misc/npm-config.html">npm-config(7)</a></code> for the value of <code>prefix</code>). It
|
||||
will also link any bins in the package to <code>{prefix}/bin/{name}</code>.</p>
|
||||
<p>Next, in some other location, <code>npm link package-name</code> will create a
|
||||
symbolic link from globally-installed <code>package-name</code> to <code>node_modules/</code>
|
||||
of the current folder.</p>
|
||||
<p>Note that <code>package-name</code> is taken from <code>package.json</code>,
|
||||
not from directory name.</p>
|
||||
<p>The package name can be optionally prefixed with a scope. See <code><a href="../misc/npm-scope.html">npm-scope(7)</a></code>.
|
||||
The scope must be preceded by an @-symbol and followed by a slash.</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
|
||||
~/projects/node-bloggy/node_modules/node-redis/. Note that the link should
|
||||
be to the package name, not the directory name for that package.</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>
|
||||
<pre><code>(cd ../node-redis; npm link)
|
||||
npm link node-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>
|
||||
<p>If your linked package is scoped (see <code><a href="../misc/npm-scope.html">npm-scope(7)</a></code>) your link command must
|
||||
include that scope, e.g.</p>
|
||||
<pre><code>npm link @myorg/privatepackage
|
||||
</code></pre><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>
|
||||
<tr><td style="width:180px;height:10px;background:rgb(237,127,127)" colspan=18> </td></tr>
|
||||
<tr><td rowspan=4 style="width:10px;height:10px;background:rgb(237,127,127)"> </td><td style="width:40px;height:10px;background:#fff" colspan=4> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=4> </td><td style="width:40px;height:10px;background:#fff" colspan=4> </td><td rowspan=4 style="width:10px;height:10px;background:rgb(237,127,127)"> </td><td colspan=6 style="width:60px;height:10px;background:#fff"> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=4> </td></tr>
|
||||
<tr><td colspan=2 style="width:20px;height:30px;background:#fff" rowspan=3> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:20px;height:10px;background:#fff" rowspan=4 colspan=2> </td><td style="width:10px;height:20px;background:rgb(237,127,127)" rowspan=2> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:20px;height:10px;background:#fff" rowspan=3 colspan=2> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td></tr>
|
||||
<tr><td style="width:10px;height:10px;background:#fff" rowspan=2> </td></tr>
|
||||
<tr><td style="width:10px;height:10px;background:#fff"> </td></tr>
|
||||
<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@2.15.12</p>
|
||||
|
||||
55
node_modules/npm/html/doc/cli/npm-logout.html
generated
vendored
Normal file
55
node_modules/npm/html/doc/cli/npm-logout.html
generated
vendored
Normal file
@@ -0,0 +1,55 @@
|
||||
<!doctype html>
|
||||
<html>
|
||||
<title>npm-logout</title>
|
||||
<meta charset="utf-8">
|
||||
<link rel="stylesheet" type="text/css" href="../../static/style.css">
|
||||
<link rel="canonical" href="https://www.npmjs.org/doc/cli/npm-logout.html">
|
||||
<script async=true src="../../static/toc.js"></script>
|
||||
|
||||
<body>
|
||||
<div id="wrapper">
|
||||
|
||||
<h1><a href="../cli/npm-logout.html">npm-logout</a></h1> <p>Log out of the registry</p>
|
||||
<h2 id="synopsis">SYNOPSIS</h2>
|
||||
<pre><code>npm logout [--registry=url] [--scope=@orgname]
|
||||
</code></pre><h2 id="description">DESCRIPTION</h2>
|
||||
<p>When logged into a registry that supports token-based authentication, tell the
|
||||
server to end this token's session. This will invalidate the token everywhere
|
||||
you're using it, not just for the current environment.</p>
|
||||
<p>When logged into a legacy registry that uses username and password authentication, this will
|
||||
clear the credentials in your user configuration. In this case, it will <em>only</em> affect
|
||||
the current environment.</p>
|
||||
<p>If <code>--scope</code> is provided, this will find the credentials for the registry
|
||||
connected to that scope, if set.</p>
|
||||
<h2 id="configuration">CONFIGURATION</h2>
|
||||
<h3 id="registry">registry</h3>
|
||||
<p>Default: <a href="https://registry.npmjs.org/">https://registry.npmjs.org/</a></p>
|
||||
<p>The base URL of the npm package registry. If <code>scope</code> is also specified,
|
||||
it takes precedence.</p>
|
||||
<h3 id="scope">scope</h3>
|
||||
<p>Default: none</p>
|
||||
<p>If specified, you will be logged out of the specified scope. See <code><a href="../misc/npm-scope.html">npm-scope(7)</a></code>.</p>
|
||||
<pre><code>npm logout --scope=@myco
|
||||
</code></pre><h2 id="see-also">SEE ALSO</h2>
|
||||
<ul>
|
||||
<li><a href="../cli/npm-adduser.html">npm-adduser(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-whoami.html">npm-whoami(1)</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
|
||||
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
|
||||
<tr><td style="width:180px;height:10px;background:rgb(237,127,127)" colspan=18> </td></tr>
|
||||
<tr><td rowspan=4 style="width:10px;height:10px;background:rgb(237,127,127)"> </td><td style="width:40px;height:10px;background:#fff" colspan=4> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=4> </td><td style="width:40px;height:10px;background:#fff" colspan=4> </td><td rowspan=4 style="width:10px;height:10px;background:rgb(237,127,127)"> </td><td colspan=6 style="width:60px;height:10px;background:#fff"> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=4> </td></tr>
|
||||
<tr><td colspan=2 style="width:20px;height:30px;background:#fff" rowspan=3> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:20px;height:10px;background:#fff" rowspan=4 colspan=2> </td><td style="width:10px;height:20px;background:rgb(237,127,127)" rowspan=2> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:20px;height:10px;background:#fff" rowspan=3 colspan=2> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td></tr>
|
||||
<tr><td style="width:10px;height:10px;background:#fff" rowspan=2> </td></tr>
|
||||
<tr><td style="width:10px;height:10px;background:#fff"> </td></tr>
|
||||
<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-logout — npm@2.15.12</p>
|
||||
|
||||
101
node_modules/npm/html/doc/cli/npm-ls.html
generated
vendored
Normal file
101
node_modules/npm/html/doc/cli/npm-ls.html
generated
vendored
Normal file
@@ -0,0 +1,101 @@
|
||||
<!doctype html>
|
||||
<html>
|
||||
<title>npm-ls</title>
|
||||
<meta charset="utf-8">
|
||||
<link rel="stylesheet" type="text/css" href="../../static/style.css">
|
||||
<link rel="canonical" href="https://www.npmjs.org/doc/cli/npm-ls.html">
|
||||
<script async=true src="../../static/toc.js"></script>
|
||||
|
||||
<body>
|
||||
<div id="wrapper">
|
||||
|
||||
<h1><a href="../cli/npm-ls.html">npm-ls</a></h1> <p>List installed packages</p>
|
||||
<h2 id="synopsis">SYNOPSIS</h2>
|
||||
<pre><code>npm list [[@<scope>/]<pkg> ...]
|
||||
npm ls [[@<scope>/]<pkg> ...]
|
||||
npm la [[@<scope>/]<pkg> ...]
|
||||
npm ll [[@<scope>/]<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@2.15.12 /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>
|
||||
<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>
|
||||
<h3 id="json">json</h3>
|
||||
<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>
|
||||
<p>Show extended information.</p>
|
||||
<h3 id="parseable">parseable</h3>
|
||||
<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>
|
||||
<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>
|
||||
<p>Max display depth of the dependency tree.</p>
|
||||
<h3 id="prod-production">prod / production</h3>
|
||||
<ul>
|
||||
<li>Type: Boolean</li>
|
||||
<li>Default: false</li>
|
||||
</ul>
|
||||
<p>Display only the dependency tree for packages in <code>dependencies</code>.</p>
|
||||
<h3 id="dev">dev</h3>
|
||||
<ul>
|
||||
<li>Type: Boolean</li>
|
||||
<li>Default: false</li>
|
||||
</ul>
|
||||
<p>Display only the dependency tree for packages in <code>devDependencies</code>.</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>
|
||||
|
||||
</div>
|
||||
|
||||
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
|
||||
<tr><td style="width:180px;height:10px;background:rgb(237,127,127)" colspan=18> </td></tr>
|
||||
<tr><td rowspan=4 style="width:10px;height:10px;background:rgb(237,127,127)"> </td><td style="width:40px;height:10px;background:#fff" colspan=4> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=4> </td><td style="width:40px;height:10px;background:#fff" colspan=4> </td><td rowspan=4 style="width:10px;height:10px;background:rgb(237,127,127)"> </td><td colspan=6 style="width:60px;height:10px;background:#fff"> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=4> </td></tr>
|
||||
<tr><td colspan=2 style="width:20px;height:30px;background:#fff" rowspan=3> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:20px;height:10px;background:#fff" rowspan=4 colspan=2> </td><td style="width:10px;height:20px;background:rgb(237,127,127)" rowspan=2> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:20px;height:10px;background:#fff" rowspan=3 colspan=2> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td></tr>
|
||||
<tr><td style="width:10px;height:10px;background:#fff" rowspan=2> </td></tr>
|
||||
<tr><td style="width:10px;height:10px;background:#fff"> </td></tr>
|
||||
<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@2.15.12</p>
|
||||
|
||||
120
node_modules/npm/html/doc/cli/npm-outdated.html
generated
vendored
Normal file
120
node_modules/npm/html/doc/cli/npm-outdated.html
generated
vendored
Normal file
@@ -0,0 +1,120 @@
|
||||
<!doctype html>
|
||||
<html>
|
||||
<title>npm-outdated</title>
|
||||
<meta charset="utf-8">
|
||||
<link rel="stylesheet" type="text/css" href="../../static/style.css">
|
||||
<link rel="canonical" href="https://www.npmjs.org/doc/cli/npm-outdated.html">
|
||||
<script async=true src="../../static/toc.js"></script>
|
||||
|
||||
<body>
|
||||
<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>
|
||||
<p>This command will check the registry to see if any (or, specific) installed
|
||||
packages are currently outdated.</p>
|
||||
<p>In the output:</p>
|
||||
<ul>
|
||||
<li><code>wanted</code> is the maximum version of the package that satisfies the semver
|
||||
range specified in <code>package.json</code>. If there's no available semver range (i.e.
|
||||
you're running <code>npm outdated --global</code>, or the package isn't included in
|
||||
<code>package.json</code>), then <code>wanted</code> shows the currently-installed version.</li>
|
||||
<li><code>latest</code> is the version of the package tagged as latest in the registry.
|
||||
Running <code>npm publish</code> with no special configuration will publish the package
|
||||
with a dist-tag of <code>latest</code>. This may or may not be the maximum version of
|
||||
the package, or the most-recently published version of the package, depending
|
||||
on how the package's developer manages the latest <a href="../cli/dist-tag.html">dist-tag(1)</a>.</li>
|
||||
<li><code>location</code> is where in the dependency tree the package is located. Note that
|
||||
<code>npm outdated</code> defaults to a depth of 0, so unless you override that, you'll
|
||||
always be seeing only top-level dependencies that are outdated.</li>
|
||||
<li><code>package type</code> (when using <code>--long</code> / <code>-l</code>) tells you whether this package is
|
||||
a <code>dependency</code> or a <code>devDependency</code>. Packages not included in <code>package.json</code>
|
||||
are always marked <code>dependencies</code>.</li>
|
||||
</ul>
|
||||
<h3 id="an-example">An example</h3>
|
||||
<pre><code>$ npm outdated
|
||||
Package Current Wanted Latest Location
|
||||
glob 5.0.15 5.0.15 6.0.1 test-outdated-output
|
||||
nothingness 0.0.3 git git test-outdated-output
|
||||
npm 3.5.1 3.5.2 3.5.1 test-outdated-output
|
||||
local-dev 0.0.3 linked linked test-outdated-output
|
||||
once 1.3.2 1.3.3 1.3.3 test-outdated-output
|
||||
</code></pre><p>With these <code>dependencies</code>:</p>
|
||||
<pre><code class="lang-json">{
|
||||
"glob": "^5.0.15",
|
||||
"nothingness": "github:othiym23/nothingness#master",
|
||||
"npm": "^3.5.1",
|
||||
"once": "^1.3.1"
|
||||
}
|
||||
</code></pre>
|
||||
<p>A few things to note:</p>
|
||||
<ul>
|
||||
<li><code>glob</code> requires <code>^5</code>, which prevents npm from installing <code>glob@6</code>, which is
|
||||
outside the semver range.</li>
|
||||
<li>Git dependencies will always be reinstalled, because of how they're specified.
|
||||
The installed committish might satisfy the dependency specifier (if it's
|
||||
something immutable, like a commit SHA), or it might not, so <code>npm outdated</code> and
|
||||
<code>npm update</code> have to fetch Git repos to check. This is why currently doing a
|
||||
reinstall of a Git dependency always forces a new clone and install.</li>
|
||||
<li><code>npm@3.5.2</code> is marked as "wanted", but "latest" is <code>npm@3.5.1</code> because npm
|
||||
uses dist-tags to manage its <code>latest</code> and <code>next</code> release channels. <code>npm update</code>
|
||||
will install the <em>newest</em> version, but <code>npm install npm</code> (with no semver range)
|
||||
will install whatever's tagged as <code>latest</code>.</li>
|
||||
<li><code>once</code> is just plain out of date. Reinstalling <code>node_modules</code> from scratch or
|
||||
running <code>npm update</code> will bring it up to spec.</li>
|
||||
</ul>
|
||||
<h2 id="configuration">CONFIGURATION</h2>
|
||||
<h3 id="json">json</h3>
|
||||
<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>
|
||||
<p>Show extended information.</p>
|
||||
<h3 id="parseable">parseable</h3>
|
||||
<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>
|
||||
<p>Check packages in the global install prefix instead of in the current
|
||||
project.</p>
|
||||
<h3 id="depth">depth</h3>
|
||||
<ul>
|
||||
<li>Default: 0</li>
|
||||
<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="../cli/npm-dist-tag.html">npm-dist-tag(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>
|
||||
<tr><td style="width:180px;height:10px;background:rgb(237,127,127)" colspan=18> </td></tr>
|
||||
<tr><td rowspan=4 style="width:10px;height:10px;background:rgb(237,127,127)"> </td><td style="width:40px;height:10px;background:#fff" colspan=4> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=4> </td><td style="width:40px;height:10px;background:#fff" colspan=4> </td><td rowspan=4 style="width:10px;height:10px;background:rgb(237,127,127)"> </td><td colspan=6 style="width:60px;height:10px;background:#fff"> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=4> </td></tr>
|
||||
<tr><td colspan=2 style="width:20px;height:30px;background:#fff" rowspan=3> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:20px;height:10px;background:#fff" rowspan=4 colspan=2> </td><td style="width:10px;height:20px;background:rgb(237,127,127)" rowspan=2> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:20px;height:10px;background:#fff" rowspan=3 colspan=2> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td></tr>
|
||||
<tr><td style="width:10px;height:10px;background:#fff" rowspan=2> </td></tr>
|
||||
<tr><td style="width:10px;height:10px;background:#fff"> </td></tr>
|
||||
<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@2.15.12</p>
|
||||
|
||||
55
node_modules/npm/html/doc/cli/npm-owner.html
generated
vendored
Normal file
55
node_modules/npm/html/doc/cli/npm-owner.html
generated
vendored
Normal file
@@ -0,0 +1,55 @@
|
||||
<!doctype html>
|
||||
<html>
|
||||
<title>npm-owner</title>
|
||||
<meta charset="utf-8">
|
||||
<link rel="stylesheet" type="text/css" href="../../static/style.css">
|
||||
<link rel="canonical" href="https://www.npmjs.org/doc/cli/npm-owner.html">
|
||||
<script async=true src="../../static/toc.js"></script>
|
||||
|
||||
<body>
|
||||
<div id="wrapper">
|
||||
|
||||
<h1><a href="../cli/npm-owner.html">npm-owner</a></h1> <p>Manage package owners</p>
|
||||
<h2 id="synopsis">SYNOPSIS</h2>
|
||||
<pre><code>npm owner ls <package name>
|
||||
npm owner add <user> <package name>
|
||||
npm owner rm <user> <package name>
|
||||
|
||||
aliases: author
|
||||
</code></pre><h2 id="description">DESCRIPTION</h2>
|
||||
<p>Manage ownership of published packages.</p>
|
||||
<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:
|
||||
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:
|
||||
Remove a user from the package owner list. This immediately revokes their
|
||||
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>
|
||||
|
||||
</div>
|
||||
|
||||
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
|
||||
<tr><td style="width:180px;height:10px;background:rgb(237,127,127)" colspan=18> </td></tr>
|
||||
<tr><td rowspan=4 style="width:10px;height:10px;background:rgb(237,127,127)"> </td><td style="width:40px;height:10px;background:#fff" colspan=4> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=4> </td><td style="width:40px;height:10px;background:#fff" colspan=4> </td><td rowspan=4 style="width:10px;height:10px;background:rgb(237,127,127)"> </td><td colspan=6 style="width:60px;height:10px;background:#fff"> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=4> </td></tr>
|
||||
<tr><td colspan=2 style="width:20px;height:30px;background:#fff" rowspan=3> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:20px;height:10px;background:#fff" rowspan=4 colspan=2> </td><td style="width:10px;height:20px;background:rgb(237,127,127)" rowspan=2> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:20px;height:10px;background:#fff" rowspan=3 colspan=2> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td></tr>
|
||||
<tr><td style="width:10px;height:10px;background:#fff" rowspan=2> </td></tr>
|
||||
<tr><td style="width:10px;height:10px;background:#fff"> </td></tr>
|
||||
<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@2.15.12</p>
|
||||
|
||||
45
node_modules/npm/html/doc/cli/npm-pack.html
generated
vendored
Normal file
45
node_modules/npm/html/doc/cli/npm-pack.html
generated
vendored
Normal file
@@ -0,0 +1,45 @@
|
||||
<!doctype html>
|
||||
<html>
|
||||
<title>npm-pack</title>
|
||||
<meta charset="utf-8">
|
||||
<link rel="stylesheet" type="text/css" href="../../static/style.css">
|
||||
<link rel="canonical" href="https://www.npmjs.org/doc/cli/npm-pack.html">
|
||||
<script async=true src="../../static/toc.js"></script>
|
||||
|
||||
<body>
|
||||
<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>
|
||||
<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>
|
||||
|
||||
</div>
|
||||
|
||||
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
|
||||
<tr><td style="width:180px;height:10px;background:rgb(237,127,127)" colspan=18> </td></tr>
|
||||
<tr><td rowspan=4 style="width:10px;height:10px;background:rgb(237,127,127)"> </td><td style="width:40px;height:10px;background:#fff" colspan=4> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=4> </td><td style="width:40px;height:10px;background:#fff" colspan=4> </td><td rowspan=4 style="width:10px;height:10px;background:rgb(237,127,127)"> </td><td colspan=6 style="width:60px;height:10px;background:#fff"> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=4> </td></tr>
|
||||
<tr><td colspan=2 style="width:20px;height:30px;background:#fff" rowspan=3> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:20px;height:10px;background:#fff" rowspan=4 colspan=2> </td><td style="width:10px;height:20px;background:rgb(237,127,127)" rowspan=2> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:20px;height:10px;background:#fff" rowspan=3 colspan=2> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td></tr>
|
||||
<tr><td style="width:10px;height:10px;background:#fff" rowspan=2> </td></tr>
|
||||
<tr><td style="width:10px;height:10px;background:#fff"> </td></tr>
|
||||
<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@2.15.12</p>
|
||||
|
||||
36
node_modules/npm/html/doc/cli/npm-ping.html
generated
vendored
Normal file
36
node_modules/npm/html/doc/cli/npm-ping.html
generated
vendored
Normal file
@@ -0,0 +1,36 @@
|
||||
<!doctype html>
|
||||
<html>
|
||||
<title>npm-ping</title>
|
||||
<meta charset="utf-8">
|
||||
<link rel="stylesheet" type="text/css" href="../../static/style.css">
|
||||
<link rel="canonical" href="https://www.npmjs.org/doc/cli/npm-ping.html">
|
||||
<script async=true src="../../static/toc.js"></script>
|
||||
|
||||
<body>
|
||||
<div id="wrapper">
|
||||
|
||||
<h1><a href="../cli/npm-ping.html">npm-ping</a></h1> <p>Ping npm registry</p>
|
||||
<h2 id="synopsis">SYNOPSIS</h2>
|
||||
<pre><code>npm ping [--registry <registry>]
|
||||
</code></pre><h2 id="description">DESCRIPTION</h2>
|
||||
<p>Ping the configured or given npm registry and verify authentication.</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>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
|
||||
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
|
||||
<tr><td style="width:180px;height:10px;background:rgb(237,127,127)" colspan=18> </td></tr>
|
||||
<tr><td rowspan=4 style="width:10px;height:10px;background:rgb(237,127,127)"> </td><td style="width:40px;height:10px;background:#fff" colspan=4> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=4> </td><td style="width:40px;height:10px;background:#fff" colspan=4> </td><td rowspan=4 style="width:10px;height:10px;background:rgb(237,127,127)"> </td><td colspan=6 style="width:60px;height:10px;background:#fff"> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=4> </td></tr>
|
||||
<tr><td colspan=2 style="width:20px;height:30px;background:#fff" rowspan=3> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:20px;height:10px;background:#fff" rowspan=4 colspan=2> </td><td style="width:10px;height:20px;background:rgb(237,127,127)" rowspan=2> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:20px;height:10px;background:#fff" rowspan=3 colspan=2> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td></tr>
|
||||
<tr><td style="width:10px;height:10px;background:#fff" rowspan=2> </td></tr>
|
||||
<tr><td style="width:10px;height:10px;background:#fff"> </td></tr>
|
||||
<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-ping — npm@2.15.12</p>
|
||||
|
||||
42
node_modules/npm/html/doc/cli/npm-prefix.html
generated
vendored
Normal file
42
node_modules/npm/html/doc/cli/npm-prefix.html
generated
vendored
Normal file
@@ -0,0 +1,42 @@
|
||||
<!doctype html>
|
||||
<html>
|
||||
<title>npm-prefix</title>
|
||||
<meta charset="utf-8">
|
||||
<link rel="stylesheet" type="text/css" href="../../static/style.css">
|
||||
<link rel="canonical" href="https://www.npmjs.org/doc/cli/npm-prefix.html">
|
||||
<script async=true src="../../static/toc.js"></script>
|
||||
|
||||
<body>
|
||||
<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 [-g]
|
||||
</code></pre><h2 id="description">DESCRIPTION</h2>
|
||||
<p>Print the local prefix to standard out. This is the closest parent directory
|
||||
to contain a package.json file unless <code>-g</code> is also specified.</p>
|
||||
<p>If <code>-g</code> is specified, this will be the value of the global prefix. See
|
||||
<code><a href="../misc/npm-config.html">npm-config(7)</a></code> for more detail.</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>
|
||||
|
||||
</div>
|
||||
|
||||
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
|
||||
<tr><td style="width:180px;height:10px;background:rgb(237,127,127)" colspan=18> </td></tr>
|
||||
<tr><td rowspan=4 style="width:10px;height:10px;background:rgb(237,127,127)"> </td><td style="width:40px;height:10px;background:#fff" colspan=4> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=4> </td><td style="width:40px;height:10px;background:#fff" colspan=4> </td><td rowspan=4 style="width:10px;height:10px;background:rgb(237,127,127)"> </td><td colspan=6 style="width:60px;height:10px;background:#fff"> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=4> </td></tr>
|
||||
<tr><td colspan=2 style="width:20px;height:30px;background:#fff" rowspan=3> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:20px;height:10px;background:#fff" rowspan=4 colspan=2> </td><td style="width:10px;height:20px;background:rgb(237,127,127)" rowspan=2> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:20px;height:10px;background:#fff" rowspan=3 colspan=2> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td></tr>
|
||||
<tr><td style="width:10px;height:10px;background:#fff" rowspan=2> </td></tr>
|
||||
<tr><td style="width:10px;height:10px;background:#fff"> </td></tr>
|
||||
<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@2.15.12</p>
|
||||
|
||||
45
node_modules/npm/html/doc/cli/npm-prune.html
generated
vendored
Normal file
45
node_modules/npm/html/doc/cli/npm-prune.html
generated
vendored
Normal file
@@ -0,0 +1,45 @@
|
||||
<!doctype html>
|
||||
<html>
|
||||
<title>npm-prune</title>
|
||||
<meta charset="utf-8">
|
||||
<link rel="stylesheet" type="text/css" href="../../static/style.css">
|
||||
<link rel="canonical" href="https://www.npmjs.org/doc/cli/npm-prune.html">
|
||||
<script async=true src="../../static/toc.js"></script>
|
||||
|
||||
<body>
|
||||
<div id="wrapper">
|
||||
|
||||
<h1><a href="../cli/npm-prune.html">npm-prune</a></h1> <p>Remove extraneous packages</p>
|
||||
<h2 id="synopsis">SYNOPSIS</h2>
|
||||
<pre><code>npm prune [<name> [<name ...]]
|
||||
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 or the <code>NODE_ENV</code> environment
|
||||
variable is set to <code>production</code>, this command will remove the packages
|
||||
specified in your <code>devDependencies</code>. Setting <code>--production=false</code> will
|
||||
negate <code>NODE_ENV</code> being set to <code>production</code>.</p>
|
||||
<h2 id="see-also">SEE ALSO</h2>
|
||||
<ul>
|
||||
<li><a href="../cli/npm-uninstall.html">npm-uninstall(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>
|
||||
<tr><td style="width:180px;height:10px;background:rgb(237,127,127)" colspan=18> </td></tr>
|
||||
<tr><td rowspan=4 style="width:10px;height:10px;background:rgb(237,127,127)"> </td><td style="width:40px;height:10px;background:#fff" colspan=4> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=4> </td><td style="width:40px;height:10px;background:#fff" colspan=4> </td><td rowspan=4 style="width:10px;height:10px;background:rgb(237,127,127)"> </td><td colspan=6 style="width:60px;height:10px;background:#fff"> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=4> </td></tr>
|
||||
<tr><td colspan=2 style="width:20px;height:30px;background:#fff" rowspan=3> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:20px;height:10px;background:#fff" rowspan=4 colspan=2> </td><td style="width:10px;height:20px;background:rgb(237,127,127)" rowspan=2> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:20px;height:10px;background:#fff" rowspan=3 colspan=2> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td></tr>
|
||||
<tr><td style="width:10px;height:10px;background:#fff" rowspan=2> </td></tr>
|
||||
<tr><td style="width:10px;height:10px;background:#fff"> </td></tr>
|
||||
<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@2.15.12</p>
|
||||
|
||||
73
node_modules/npm/html/doc/cli/npm-publish.html
generated
vendored
Normal file
73
node_modules/npm/html/doc/cli/npm-publish.html
generated
vendored
Normal file
@@ -0,0 +1,73 @@
|
||||
<!doctype html>
|
||||
<html>
|
||||
<title>npm-publish</title>
|
||||
<meta charset="utf-8">
|
||||
<link rel="stylesheet" type="text/css" href="../../static/style.css">
|
||||
<link rel="canonical" href="https://www.npmjs.org/doc/cli/npm-publish.html">
|
||||
<script async=true src="../../static/toc.js"></script>
|
||||
|
||||
<body>
|
||||
<div id="wrapper">
|
||||
|
||||
<h1><a href="../cli/npm-publish.html">npm-publish</a></h1> <p>Publish a package</p>
|
||||
<h2 id="synopsis">SYNOPSIS</h2>
|
||||
<pre><code>npm publish <tarball> [--tag <tag>] [--access <public|restricted>]
|
||||
npm publish <folder> [--tag <tag>] [--access <public|restricted>]
|
||||
</code></pre><h2 id="description">DESCRIPTION</h2>
|
||||
<p>Publishes a package to the registry so that it can be installed by name. All
|
||||
files in the package directory are included if no local <code>.gitignore</code> or
|
||||
<code>.npmignore</code> file is present. See <code><a href="../misc/npm-developers.html">npm-developers(7)</a></code> for full details on
|
||||
what's included in the published package, as well as details on how the package
|
||||
is built.</p>
|
||||
<p>By default npm will publish to the public registry. This can be overridden by
|
||||
specifying a different default registry or using a <code><a href="../misc/npm-scope.html">npm-scope(7)</a></code> in the name
|
||||
(see <code><a href="../files/package.json.html">package.json(5)</a></code>).</p>
|
||||
<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>
|
||||
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. See <code><a href="../cli/npm-dist-tag.html">npm-dist-tag(1)</a></code> for
|
||||
details about tags.</p>
|
||||
</li>
|
||||
<li><p><code>[--access <public|restricted>]</code>
|
||||
Tells the registry whether this package should be published as public or
|
||||
restricted. Only applies to scoped packages, which default to <code>restricted</code>.
|
||||
If you don't have a paid account, you must publish with <code>--access public</code>
|
||||
to publish scoped packages.</p>
|
||||
</li>
|
||||
</ul>
|
||||
<p>Fails if the package name and version combination already exists in
|
||||
the specified 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="../misc/npm-scope.html">npm-scope(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>
|
||||
<tr><td style="width:180px;height:10px;background:rgb(237,127,127)" colspan=18> </td></tr>
|
||||
<tr><td rowspan=4 style="width:10px;height:10px;background:rgb(237,127,127)"> </td><td style="width:40px;height:10px;background:#fff" colspan=4> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=4> </td><td style="width:40px;height:10px;background:#fff" colspan=4> </td><td rowspan=4 style="width:10px;height:10px;background:rgb(237,127,127)"> </td><td colspan=6 style="width:60px;height:10px;background:#fff"> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=4> </td></tr>
|
||||
<tr><td colspan=2 style="width:20px;height:30px;background:#fff" rowspan=3> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:20px;height:10px;background:#fff" rowspan=4 colspan=2> </td><td style="width:10px;height:20px;background:rgb(237,127,127)" rowspan=2> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:20px;height:10px;background:#fff" rowspan=3 colspan=2> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td></tr>
|
||||
<tr><td style="width:10px;height:10px;background:#fff" rowspan=2> </td></tr>
|
||||
<tr><td style="width:10px;height:10px;background:#fff"> </td></tr>
|
||||
<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@2.15.12</p>
|
||||
|
||||
42
node_modules/npm/html/doc/cli/npm-rebuild.html
generated
vendored
Normal file
42
node_modules/npm/html/doc/cli/npm-rebuild.html
generated
vendored
Normal file
@@ -0,0 +1,42 @@
|
||||
<!doctype html>
|
||||
<html>
|
||||
<title>npm-rebuild</title>
|
||||
<meta charset="utf-8">
|
||||
<link rel="stylesheet" type="text/css" href="../../static/style.css">
|
||||
<link rel="canonical" href="https://www.npmjs.org/doc/cli/npm-rebuild.html">
|
||||
<script async=true src="../../static/toc.js"></script>
|
||||
|
||||
<body>
|
||||
<div id="wrapper">
|
||||
|
||||
<h1><a href="../cli/npm-rebuild.html">npm-rebuild</a></h1> <p>Rebuild a package</p>
|
||||
<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>
|
||||
<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>
|
||||
|
||||
</div>
|
||||
|
||||
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
|
||||
<tr><td style="width:180px;height:10px;background:rgb(237,127,127)" colspan=18> </td></tr>
|
||||
<tr><td rowspan=4 style="width:10px;height:10px;background:rgb(237,127,127)"> </td><td style="width:40px;height:10px;background:#fff" colspan=4> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=4> </td><td style="width:40px;height:10px;background:#fff" colspan=4> </td><td rowspan=4 style="width:10px;height:10px;background:rgb(237,127,127)"> </td><td colspan=6 style="width:60px;height:10px;background:#fff"> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=4> </td></tr>
|
||||
<tr><td colspan=2 style="width:20px;height:30px;background:#fff" rowspan=3> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:20px;height:10px;background:#fff" rowspan=4 colspan=2> </td><td style="width:10px;height:20px;background:rgb(237,127,127)" rowspan=2> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:20px;height:10px;background:#fff" rowspan=3 colspan=2> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td></tr>
|
||||
<tr><td style="width:10px;height:10px;background:#fff" rowspan=2> </td></tr>
|
||||
<tr><td style="width:10px;height:10px;background:#fff"> </td></tr>
|
||||
<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@2.15.12</p>
|
||||
|
||||
46
node_modules/npm/html/doc/cli/npm-repo.html
generated
vendored
Normal file
46
node_modules/npm/html/doc/cli/npm-repo.html
generated
vendored
Normal file
@@ -0,0 +1,46 @@
|
||||
<!doctype html>
|
||||
<html>
|
||||
<title>npm-repo</title>
|
||||
<meta charset="utf-8">
|
||||
<link rel="stylesheet" type="text/css" href="../../static/style.css">
|
||||
<link rel="canonical" href="https://www.npmjs.org/doc/cli/npm-repo.html">
|
||||
<script async=true src="../../static/toc.js"></script>
|
||||
|
||||
<body>
|
||||
<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>
|
||||
<pre><code>npm repo <pkgname>
|
||||
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>
|
||||
<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>
|
||||
<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>
|
||||
|
||||
</div>
|
||||
|
||||
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
|
||||
<tr><td style="width:180px;height:10px;background:rgb(237,127,127)" colspan=18> </td></tr>
|
||||
<tr><td rowspan=4 style="width:10px;height:10px;background:rgb(237,127,127)"> </td><td style="width:40px;height:10px;background:#fff" colspan=4> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=4> </td><td style="width:40px;height:10px;background:#fff" colspan=4> </td><td rowspan=4 style="width:10px;height:10px;background:rgb(237,127,127)"> </td><td colspan=6 style="width:60px;height:10px;background:#fff"> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=4> </td></tr>
|
||||
<tr><td colspan=2 style="width:20px;height:30px;background:#fff" rowspan=3> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:20px;height:10px;background:#fff" rowspan=4 colspan=2> </td><td style="width:10px;height:20px;background:rgb(237,127,127)" rowspan=2> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:20px;height:10px;background:#fff" rowspan=3 colspan=2> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td></tr>
|
||||
<tr><td style="width:10px;height:10px;background:#fff" rowspan=2> </td></tr>
|
||||
<tr><td style="width:10px;height:10px;background:#fff"> </td></tr>
|
||||
<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@2.15.12</p>
|
||||
|
||||
57
node_modules/npm/html/doc/cli/npm-restart.html
generated
vendored
Normal file
57
node_modules/npm/html/doc/cli/npm-restart.html
generated
vendored
Normal file
@@ -0,0 +1,57 @@
|
||||
<!doctype html>
|
||||
<html>
|
||||
<title>npm-restart</title>
|
||||
<meta charset="utf-8">
|
||||
<link rel="stylesheet" type="text/css" href="../../static/style.css">
|
||||
<link rel="canonical" href="https://www.npmjs.org/doc/cli/npm-restart.html">
|
||||
<script async=true src="../../static/toc.js"></script>
|
||||
|
||||
<body>
|
||||
<div id="wrapper">
|
||||
|
||||
<h1><a href="../cli/npm-restart.html">npm-restart</a></h1> <p>Restart a package</p>
|
||||
<h2 id="synopsis">SYNOPSIS</h2>
|
||||
<pre><code>npm restart [-- <args>]
|
||||
</code></pre><h2 id="description">DESCRIPTION</h2>
|
||||
<p>This restarts a package.</p>
|
||||
<p>This runs a package's "stop", "restart", and "start" scripts, and associated
|
||||
pre- and post- scripts, in the order given below:</p>
|
||||
<ol>
|
||||
<li>prerestart</li>
|
||||
<li>prestop</li>
|
||||
<li>stop</li>
|
||||
<li>poststop</li>
|
||||
<li>restart</li>
|
||||
<li>prestart</li>
|
||||
<li>start</li>
|
||||
<li>poststart</li>
|
||||
<li>postrestart</li>
|
||||
</ol>
|
||||
<h2 id="note">NOTE</h2>
|
||||
<p>Note that the "restart" script is run <strong>in addition to</strong> the "stop"
|
||||
and "start" scripts, not instead of them.</p>
|
||||
<p>This is the behavior as of <code>npm</code> major version 2. A change in this
|
||||
behavior will be accompanied by an increase in major version number</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>
|
||||
<li><a href="../api/npm-restart.html">npm-restart(3)</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
|
||||
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
|
||||
<tr><td style="width:180px;height:10px;background:rgb(237,127,127)" colspan=18> </td></tr>
|
||||
<tr><td rowspan=4 style="width:10px;height:10px;background:rgb(237,127,127)"> </td><td style="width:40px;height:10px;background:#fff" colspan=4> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=4> </td><td style="width:40px;height:10px;background:#fff" colspan=4> </td><td rowspan=4 style="width:10px;height:10px;background:rgb(237,127,127)"> </td><td colspan=6 style="width:60px;height:10px;background:#fff"> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=4> </td></tr>
|
||||
<tr><td colspan=2 style="width:20px;height:30px;background:#fff" rowspan=3> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:20px;height:10px;background:#fff" rowspan=4 colspan=2> </td><td style="width:10px;height:20px;background:rgb(237,127,127)" rowspan=2> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:20px;height:10px;background:#fff" rowspan=3 colspan=2> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td></tr>
|
||||
<tr><td style="width:10px;height:10px;background:#fff" rowspan=2> </td></tr>
|
||||
<tr><td style="width:10px;height:10px;background:#fff"> </td></tr>
|
||||
<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@2.15.12</p>
|
||||
|
||||
43
node_modules/npm/html/doc/cli/npm-rm.html
generated
vendored
Normal file
43
node_modules/npm/html/doc/cli/npm-rm.html
generated
vendored
Normal file
@@ -0,0 +1,43 @@
|
||||
<!doctype html>
|
||||
<html>
|
||||
<title>npm-rm</title>
|
||||
<meta charset="utf-8">
|
||||
<link rel="stylesheet" type="text/css" href="../../static/style.css">
|
||||
<link rel="canonical" href="https://www.npmjs.org/doc/cli/npm-rm.html">
|
||||
<script async=true src="../../static/toc.js"></script>
|
||||
|
||||
<body>
|
||||
<div id="wrapper">
|
||||
|
||||
<h1><a href="../cli/npm-rm.html">npm-rm</a></h1> <p>Remove a package</p>
|
||||
<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>
|
||||
<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>
|
||||
|
||||
</div>
|
||||
|
||||
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
|
||||
<tr><td style="width:180px;height:10px;background:rgb(237,127,127)" colspan=18> </td></tr>
|
||||
<tr><td rowspan=4 style="width:10px;height:10px;background:rgb(237,127,127)"> </td><td style="width:40px;height:10px;background:#fff" colspan=4> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=4> </td><td style="width:40px;height:10px;background:#fff" colspan=4> </td><td rowspan=4 style="width:10px;height:10px;background:rgb(237,127,127)"> </td><td colspan=6 style="width:60px;height:10px;background:#fff"> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=4> </td></tr>
|
||||
<tr><td colspan=2 style="width:20px;height:30px;background:#fff" rowspan=3> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:20px;height:10px;background:#fff" rowspan=4 colspan=2> </td><td style="width:10px;height:20px;background:rgb(237,127,127)" rowspan=2> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:20px;height:10px;background:#fff" rowspan=3 colspan=2> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td></tr>
|
||||
<tr><td style="width:10px;height:10px;background:#fff" rowspan=2> </td></tr>
|
||||
<tr><td style="width:10px;height:10px;background:#fff"> </td></tr>
|
||||
<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@2.15.12</p>
|
||||
|
||||
39
node_modules/npm/html/doc/cli/npm-root.html
generated
vendored
Normal file
39
node_modules/npm/html/doc/cli/npm-root.html
generated
vendored
Normal file
@@ -0,0 +1,39 @@
|
||||
<!doctype html>
|
||||
<html>
|
||||
<title>npm-root</title>
|
||||
<meta charset="utf-8">
|
||||
<link rel="stylesheet" type="text/css" href="../../static/style.css">
|
||||
<link rel="canonical" href="https://www.npmjs.org/doc/cli/npm-root.html">
|
||||
<script async=true src="../../static/toc.js"></script>
|
||||
|
||||
<body>
|
||||
<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>
|
||||
<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>
|
||||
|
||||
</div>
|
||||
|
||||
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
|
||||
<tr><td style="width:180px;height:10px;background:rgb(237,127,127)" colspan=18> </td></tr>
|
||||
<tr><td rowspan=4 style="width:10px;height:10px;background:rgb(237,127,127)"> </td><td style="width:40px;height:10px;background:#fff" colspan=4> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=4> </td><td style="width:40px;height:10px;background:#fff" colspan=4> </td><td rowspan=4 style="width:10px;height:10px;background:rgb(237,127,127)"> </td><td colspan=6 style="width:60px;height:10px;background:#fff"> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=4> </td></tr>
|
||||
<tr><td colspan=2 style="width:20px;height:30px;background:#fff" rowspan=3> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:20px;height:10px;background:#fff" rowspan=4 colspan=2> </td><td style="width:10px;height:20px;background:rgb(237,127,127)" rowspan=2> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:20px;height:10px;background:#fff" rowspan=3 colspan=2> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td></tr>
|
||||
<tr><td style="width:10px;height:10px;background:#fff" rowspan=2> </td></tr>
|
||||
<tr><td style="width:10px;height:10px;background:#fff"> </td></tr>
|
||||
<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@2.15.12</p>
|
||||
|
||||
61
node_modules/npm/html/doc/cli/npm-run-script.html
generated
vendored
Normal file
61
node_modules/npm/html/doc/cli/npm-run-script.html
generated
vendored
Normal file
@@ -0,0 +1,61 @@
|
||||
<!doctype html>
|
||||
<html>
|
||||
<title>npm-run-script</title>
|
||||
<meta charset="utf-8">
|
||||
<link rel="stylesheet" type="text/css" href="../../static/style.css">
|
||||
<link rel="canonical" href="https://www.npmjs.org/doc/cli/npm-run-script.html">
|
||||
<script async=true src="../../static/toc.js"></script>
|
||||
|
||||
<body>
|
||||
<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 [command] [-- <args>]
|
||||
npm run [command] [-- <args>]
|
||||
</code></pre><h2 id="description">DESCRIPTION</h2>
|
||||
<p>This runs an arbitrary command from a package's <code>"scripts"</code> object. If no
|
||||
<code>"command"</code> is provided, it will list the available scripts. <code>run[-script]</code> is
|
||||
used by the test, start, restart, and stop commands, but can be called
|
||||
directly, as well. When the scripts in the package are printed out, they're
|
||||
separated into lifecycle (test, start, restart) and directly-run scripts.</p>
|
||||
<p>As of <a href="http://blog.npmjs.org/post/98131109725/npm-2-0-0"><code>npm@2.0.0</code></a>, you can
|
||||
use custom arguments when executing scripts. The special option <code>--</code> is used by
|
||||
<a href="http://goo.gl/KxMmtG">getopt</a> to delimit the end of the options. npm will pass
|
||||
all the arguments after the <code>--</code> directly to your script:</p>
|
||||
<pre><code>npm run test -- --grep="pattern"
|
||||
</code></pre><p>The arguments will only be passed to the script specified after <code>npm run</code>
|
||||
and not to any pre or post script.</p>
|
||||
<p>The <code>env</code> script is a special built-in command that can be used to list
|
||||
environment variables that will be available to the script at runtime. If an
|
||||
"env" command is defined in your package it will take precedence over the
|
||||
built-in.</p>
|
||||
<p>In addition to the shell's pre-existing <code>PATH</code>, <code>npm run</code> adds
|
||||
<code>node_modules/.bin</code> to the <code>PATH</code> provided to scripts. Any binaries provided by
|
||||
locally-installed dependencies can be used without the <code>node_modules/.bin</code>
|
||||
prefix. For example, if there is a <code>devDependency</code> on <code>tap</code> in your package,
|
||||
you should write:</p>
|
||||
<pre><code>"scripts": {"test": "tap test/\*.js"}
|
||||
</code></pre><p>instead of <code>"scripts": {"test": "node_modules/.bin/tap test/\*.js"}</code> to run your tests.</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>
|
||||
|
||||
</div>
|
||||
|
||||
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
|
||||
<tr><td style="width:180px;height:10px;background:rgb(237,127,127)" colspan=18> </td></tr>
|
||||
<tr><td rowspan=4 style="width:10px;height:10px;background:rgb(237,127,127)"> </td><td style="width:40px;height:10px;background:#fff" colspan=4> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=4> </td><td style="width:40px;height:10px;background:#fff" colspan=4> </td><td rowspan=4 style="width:10px;height:10px;background:rgb(237,127,127)"> </td><td colspan=6 style="width:60px;height:10px;background:#fff"> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=4> </td></tr>
|
||||
<tr><td colspan=2 style="width:20px;height:30px;background:#fff" rowspan=3> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:20px;height:10px;background:#fff" rowspan=4 colspan=2> </td><td style="width:10px;height:20px;background:rgb(237,127,127)" rowspan=2> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:20px;height:10px;background:#fff" rowspan=3 colspan=2> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td></tr>
|
||||
<tr><td style="width:10px;height:10px;background:#fff" rowspan=2> </td></tr>
|
||||
<tr><td style="width:10px;height:10px;background:#fff"> </td></tr>
|
||||
<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@2.15.12</p>
|
||||
|
||||
61
node_modules/npm/html/doc/cli/npm-search.html
generated
vendored
Normal file
61
node_modules/npm/html/doc/cli/npm-search.html
generated
vendored
Normal file
@@ -0,0 +1,61 @@
|
||||
<!doctype html>
|
||||
<html>
|
||||
<title>npm-search</title>
|
||||
<meta charset="utf-8">
|
||||
<link rel="stylesheet" type="text/css" href="../../static/style.css">
|
||||
<link rel="canonical" href="https://www.npmjs.org/doc/cli/npm-search.html">
|
||||
<script async=true src="../../static/toc.js"></script>
|
||||
|
||||
<body>
|
||||
<div id="wrapper">
|
||||
|
||||
<h1><a href="../cli/npm-search.html">npm-search</a></h1> <p>Search for packages</p>
|
||||
<h2 id="synopsis">SYNOPSIS</h2>
|
||||
<pre><code>npm search [-l|--long] [search terms ...]
|
||||
|
||||
aliases: s, se, find
|
||||
</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>
|
||||
<h3 id="long">long</h3>
|
||||
<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>
|
||||
<h3 id="registry">registry</h3>
|
||||
<ul>
|
||||
<li>Default: <a href="https://registry.npmjs.org/">https://registry.npmjs.org/</a></li>
|
||||
<li>Type : url</li>
|
||||
</ul>
|
||||
<p>Search the specified registry for modules. If you have configured npm to point to a different default registry,
|
||||
such as your internal private module repository, <code>npm search</code> will default to that registry when searching.
|
||||
Pass a different registry url such as the default above in order to override this setting.</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>
|
||||
|
||||
</div>
|
||||
|
||||
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
|
||||
<tr><td style="width:180px;height:10px;background:rgb(237,127,127)" colspan=18> </td></tr>
|
||||
<tr><td rowspan=4 style="width:10px;height:10px;background:rgb(237,127,127)"> </td><td style="width:40px;height:10px;background:#fff" colspan=4> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=4> </td><td style="width:40px;height:10px;background:#fff" colspan=4> </td><td rowspan=4 style="width:10px;height:10px;background:rgb(237,127,127)"> </td><td colspan=6 style="width:60px;height:10px;background:#fff"> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=4> </td></tr>
|
||||
<tr><td colspan=2 style="width:20px;height:30px;background:#fff" rowspan=3> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:20px;height:10px;background:#fff" rowspan=4 colspan=2> </td><td style="width:10px;height:20px;background:rgb(237,127,127)" rowspan=2> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:20px;height:10px;background:#fff" rowspan=3 colspan=2> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td></tr>
|
||||
<tr><td style="width:10px;height:10px;background:#fff" rowspan=2> </td></tr>
|
||||
<tr><td style="width:10px;height:10px;background:#fff"> </td></tr>
|
||||
<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@2.15.12</p>
|
||||
|
||||
172
node_modules/npm/html/doc/cli/npm-shrinkwrap.html
generated
vendored
Normal file
172
node_modules/npm/html/doc/cli/npm-shrinkwrap.html
generated
vendored
Normal file
@@ -0,0 +1,172 @@
|
||||
<!doctype html>
|
||||
<html>
|
||||
<title>npm-shrinkwrap</title>
|
||||
<meta charset="utf-8">
|
||||
<link rel="stylesheet" type="text/css" href="../../static/style.css">
|
||||
<link rel="canonical" href="https://www.npmjs.org/doc/cli/npm-shrinkwrap.html">
|
||||
<script async=true src="../../static/toc.js"></script>
|
||||
|
||||
<body>
|
||||
<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>
|
||||
<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 <code>package.json</code> file is still
|
||||
required if you want to use <code>npm install</code>.</p>
|
||||
<p>By default, <code>npm install</code> recursively installs the target's
|
||||
dependencies (as specified in <code>package.json</code>), choosing the latest
|
||||
available version that satisfies the dependency's semver pattern. In
|
||||
some situations, particularly when shipping software where each change
|
||||
is tightly managed, it's desirable to fully specify each version of
|
||||
each dependency recursively so that subsequent builds and deploys do
|
||||
not inadvertently pick up newer versions of a dependency that satisfy
|
||||
the semver pattern. Specifying specific semver patterns in each
|
||||
dependency's <code>package.json</code> 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>
|
||||
<pre><code>{
|
||||
"name": "B",
|
||||
"version": "0.0.1",
|
||||
"dependencies": {
|
||||
"C": "<0.1.0"
|
||||
}
|
||||
}
|
||||
</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
|
||||
registry, then a normal <code>npm install A</code> will install:</p>
|
||||
<pre><code>A@0.1.0
|
||||
`-- B@0.0.1
|
||||
`-- C@0.0.1
|
||||
</code></pre><p>However, if B@0.0.2 is published, then a fresh <code>npm install A</code> 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,
|
||||
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 <code>npm-shrinkwrap.json</code>, which will look something like this:</p>
|
||||
<pre><code>{
|
||||
"name": "A",
|
||||
"version": "0.1.0",
|
||||
"dependencies": {
|
||||
"B": {
|
||||
"version": "0.0.1",
|
||||
"from": "B@^0.0.1",
|
||||
"resolved": "https://registry.npmjs.org/B/-/B-0.0.1.tgz",
|
||||
"dependencies": {
|
||||
"C": {
|
||||
"version": "0.0.1",
|
||||
"from": "org/C#v0.0.1",
|
||||
"resolved": "git://github.com/org/C.git#5c380ae319fc4efe9e7f2d9c78b0faa588fd99b4"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
</code></pre><p>The shrinkwrap command has locked down the dependencies based on
|
||||
what's currently installed in node_modules. When <code>npm install</code>
|
||||
installs a package with an <code>npm-shrinkwrap.json</code> in the package
|
||||
root, the shrinkwrap file (rather than <code>package.json</code> files) completely
|
||||
drives the installation of that package and all of its dependencies
|
||||
(recursively). So now the author publishes A@0.1.0, and subsequent
|
||||
installs of this package will use B@0.0.1 and C@0.0.1, regardless the
|
||||
dependencies and versions listed in A's, B's, and C's <code>package.json</code>
|
||||
files.</p>
|
||||
<h3 id="using-shrinkwrapped-packages">Using shrinkwrapped packages</h3>
|
||||
<p>Using a shrinkwrapped package is no different than using any other
|
||||
package: you can <code>npm install</code> it by hand, or add a dependency to your
|
||||
<code>package.json</code> file and <code>npm install</code> it.</p>
|
||||
<h3 id="building-shrinkwrapped-packages">Building shrinkwrapped packages</h3>
|
||||
<p>To shrinkwrap an existing package:</p>
|
||||
<ol>
|
||||
<li>Run <code>npm install</code> in the package root to install the current
|
||||
versions of all dependencies.</li>
|
||||
<li>Validate that the package works as expected with these versions.</li>
|
||||
<li>Run <code>npm shrinkwrap</code>, add <code>npm-shrinkwrap.json</code> to git, and publish
|
||||
your package.</li>
|
||||
</ol>
|
||||
<p>To add or update a dependency in a shrinkwrapped package:</p>
|
||||
<ol>
|
||||
<li>Run <code>npm install</code> in the package root to install the current
|
||||
versions of all dependencies.</li>
|
||||
<li>Add or update dependencies. <code>npm install</code> each new or updated
|
||||
package individually and then update <code>package.json</code>. 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 <code>npm shrinkwrap</code>, commit the new <code>npm-shrinkwrap.json</code>, 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>
|
||||
<p>A shrinkwrap file must be consistent with the package's <code>package.json</code>
|
||||
file. <code>npm shrinkwrap</code> will fail if required dependencies are not
|
||||
already installed, since that would result in a shrinkwrap that
|
||||
wouldn't actually work. Similarly, the command will fail if there are
|
||||
extraneous packages (not referenced by <code>package.json</code>), since that would
|
||||
indicate that <code>package.json</code> is not correct.</p>
|
||||
<p>Since <code>npm shrinkwrap</code> is intended to lock down your dependencies for
|
||||
production use, <code>devDependencies</code> will not be included unless you
|
||||
explicitly set the <code>--dev</code> flag when you run <code>npm shrinkwrap</code>. If
|
||||
installed <code>devDependencies</code> are excluded, then npm will print a
|
||||
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>
|
||||
<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>
|
||||
|
||||
</div>
|
||||
|
||||
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
|
||||
<tr><td style="width:180px;height:10px;background:rgb(237,127,127)" colspan=18> </td></tr>
|
||||
<tr><td rowspan=4 style="width:10px;height:10px;background:rgb(237,127,127)"> </td><td style="width:40px;height:10px;background:#fff" colspan=4> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=4> </td><td style="width:40px;height:10px;background:#fff" colspan=4> </td><td rowspan=4 style="width:10px;height:10px;background:rgb(237,127,127)"> </td><td colspan=6 style="width:60px;height:10px;background:#fff"> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=4> </td></tr>
|
||||
<tr><td colspan=2 style="width:20px;height:30px;background:#fff" rowspan=3> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:20px;height:10px;background:#fff" rowspan=4 colspan=2> </td><td style="width:10px;height:20px;background:rgb(237,127,127)" rowspan=2> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:20px;height:10px;background:#fff" rowspan=3 colspan=2> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td></tr>
|
||||
<tr><td style="width:10px;height:10px;background:#fff" rowspan=2> </td></tr>
|
||||
<tr><td style="width:10px;height:10px;background:#fff"> </td></tr>
|
||||
<tr><td style="width:60px;height:10px;background:rgb(237,127,127)" colspan=6> </td><td colspan=10 style="width:10px;height:10px;background:rgb(237,127,127)"> </td></tr>
|
||||
<tr><td colspan=5 style="width:50px;height:10px;background:#fff"> </td><td style="width:40px;height:10px;background:rgb(237,127,127)" colspan=4> </td><td style="width:90px;height:10px;background:#fff" colspan=9> </td></tr>
|
||||
</table>
|
||||
<p id="footer">npm-shrinkwrap — npm@2.15.12</p>
|
||||
|
||||
40
node_modules/npm/html/doc/cli/npm-star.html
generated
vendored
Normal file
40
node_modules/npm/html/doc/cli/npm-star.html
generated
vendored
Normal file
@@ -0,0 +1,40 @@
|
||||
<!doctype html>
|
||||
<html>
|
||||
<title>npm-star</title>
|
||||
<meta charset="utf-8">
|
||||
<link rel="stylesheet" type="text/css" href="../../static/style.css">
|
||||
<link rel="canonical" href="https://www.npmjs.org/doc/cli/npm-star.html">
|
||||
<script async=true src="../../static/toc.js"></script>
|
||||
|
||||
<body>
|
||||
<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>
|
||||
<pre><code>npm star <pkgname> [<pkg>, ...]
|
||||
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>
|
||||
|
||||
</div>
|
||||
|
||||
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
|
||||
<tr><td style="width:180px;height:10px;background:rgb(237,127,127)" colspan=18> </td></tr>
|
||||
<tr><td rowspan=4 style="width:10px;height:10px;background:rgb(237,127,127)"> </td><td style="width:40px;height:10px;background:#fff" colspan=4> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=4> </td><td style="width:40px;height:10px;background:#fff" colspan=4> </td><td rowspan=4 style="width:10px;height:10px;background:rgb(237,127,127)"> </td><td colspan=6 style="width:60px;height:10px;background:#fff"> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=4> </td></tr>
|
||||
<tr><td colspan=2 style="width:20px;height:30px;background:#fff" rowspan=3> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:20px;height:10px;background:#fff" rowspan=4 colspan=2> </td><td style="width:10px;height:20px;background:rgb(237,127,127)" rowspan=2> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:20px;height:10px;background:#fff" rowspan=3 colspan=2> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td></tr>
|
||||
<tr><td style="width:10px;height:10px;background:#fff" rowspan=2> </td></tr>
|
||||
<tr><td style="width:10px;height:10px;background:#fff"> </td></tr>
|
||||
<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@2.15.12</p>
|
||||
|
||||
41
node_modules/npm/html/doc/cli/npm-stars.html
generated
vendored
Normal file
41
node_modules/npm/html/doc/cli/npm-stars.html
generated
vendored
Normal file
@@ -0,0 +1,41 @@
|
||||
<!doctype html>
|
||||
<html>
|
||||
<title>npm-stars</title>
|
||||
<meta charset="utf-8">
|
||||
<link rel="stylesheet" type="text/css" href="../../static/style.css">
|
||||
<link rel="canonical" href="https://www.npmjs.org/doc/cli/npm-stars.html">
|
||||
<script async=true src="../../static/toc.js"></script>
|
||||
|
||||
<body>
|
||||
<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>
|
||||
<pre><code>npm stars
|
||||
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>
|
||||
|
||||
</div>
|
||||
|
||||
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
|
||||
<tr><td style="width:180px;height:10px;background:rgb(237,127,127)" colspan=18> </td></tr>
|
||||
<tr><td rowspan=4 style="width:10px;height:10px;background:rgb(237,127,127)"> </td><td style="width:40px;height:10px;background:#fff" colspan=4> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=4> </td><td style="width:40px;height:10px;background:#fff" colspan=4> </td><td rowspan=4 style="width:10px;height:10px;background:rgb(237,127,127)"> </td><td colspan=6 style="width:60px;height:10px;background:#fff"> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=4> </td></tr>
|
||||
<tr><td colspan=2 style="width:20px;height:30px;background:#fff" rowspan=3> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:20px;height:10px;background:#fff" rowspan=4 colspan=2> </td><td style="width:10px;height:20px;background:rgb(237,127,127)" rowspan=2> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:20px;height:10px;background:#fff" rowspan=3 colspan=2> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td></tr>
|
||||
<tr><td style="width:10px;height:10px;background:#fff" rowspan=2> </td></tr>
|
||||
<tr><td style="width:10px;height:10px;background:#fff"> </td></tr>
|
||||
<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@2.15.12</p>
|
||||
|
||||
43
node_modules/npm/html/doc/cli/npm-start.html
generated
vendored
Normal file
43
node_modules/npm/html/doc/cli/npm-start.html
generated
vendored
Normal file
@@ -0,0 +1,43 @@
|
||||
<!doctype html>
|
||||
<html>
|
||||
<title>npm-start</title>
|
||||
<meta charset="utf-8">
|
||||
<link rel="stylesheet" type="text/css" href="../../static/style.css">
|
||||
<link rel="canonical" href="https://www.npmjs.org/doc/cli/npm-start.html">
|
||||
<script async=true src="../../static/toc.js"></script>
|
||||
|
||||
<body>
|
||||
<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 [-- <args>]
|
||||
</code></pre><h2 id="description">DESCRIPTION</h2>
|
||||
<p>This runs an arbitrary command specified in the package's <code>"start"</code> property of
|
||||
its <code>"scripts"</code> object. If no <code>"start"</code> property is specified on the
|
||||
<code>"scripts"</code> object, it will run <code>node server.js</code>.</p>
|
||||
<p>As of <a href="http://blog.npmjs.org/post/98131109725/npm-2-0-0"><code>npm@2.0.0</code></a>, you can
|
||||
use custom arguments when executing scripts. Refer to <a href="../cli/npm-run-script.html">npm-run-script(1)</a> for
|
||||
more details.</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>
|
||||
|
||||
</div>
|
||||
|
||||
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
|
||||
<tr><td style="width:180px;height:10px;background:rgb(237,127,127)" colspan=18> </td></tr>
|
||||
<tr><td rowspan=4 style="width:10px;height:10px;background:rgb(237,127,127)"> </td><td style="width:40px;height:10px;background:#fff" colspan=4> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=4> </td><td style="width:40px;height:10px;background:#fff" colspan=4> </td><td rowspan=4 style="width:10px;height:10px;background:rgb(237,127,127)"> </td><td colspan=6 style="width:60px;height:10px;background:#fff"> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=4> </td></tr>
|
||||
<tr><td colspan=2 style="width:20px;height:30px;background:#fff" rowspan=3> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:20px;height:10px;background:#fff" rowspan=4 colspan=2> </td><td style="width:10px;height:20px;background:rgb(237,127,127)" rowspan=2> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:20px;height:10px;background:#fff" rowspan=3 colspan=2> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td></tr>
|
||||
<tr><td style="width:10px;height:10px;background:#fff" rowspan=2> </td></tr>
|
||||
<tr><td style="width:10px;height:10px;background:#fff"> </td></tr>
|
||||
<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@2.15.12</p>
|
||||
|
||||
38
node_modules/npm/html/doc/cli/npm-stop.html
generated
vendored
Normal file
38
node_modules/npm/html/doc/cli/npm-stop.html
generated
vendored
Normal file
@@ -0,0 +1,38 @@
|
||||
<!doctype html>
|
||||
<html>
|
||||
<title>npm-stop</title>
|
||||
<meta charset="utf-8">
|
||||
<link rel="stylesheet" type="text/css" href="../../static/style.css">
|
||||
<link rel="canonical" href="https://www.npmjs.org/doc/cli/npm-stop.html">
|
||||
<script async=true src="../../static/toc.js"></script>
|
||||
|
||||
<body>
|
||||
<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 [-- <args>]
|
||||
</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>
|
||||
|
||||
</div>
|
||||
|
||||
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
|
||||
<tr><td style="width:180px;height:10px;background:rgb(237,127,127)" colspan=18> </td></tr>
|
||||
<tr><td rowspan=4 style="width:10px;height:10px;background:rgb(237,127,127)"> </td><td style="width:40px;height:10px;background:#fff" colspan=4> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=4> </td><td style="width:40px;height:10px;background:#fff" colspan=4> </td><td rowspan=4 style="width:10px;height:10px;background:rgb(237,127,127)"> </td><td colspan=6 style="width:60px;height:10px;background:#fff"> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=4> </td></tr>
|
||||
<tr><td colspan=2 style="width:20px;height:30px;background:#fff" rowspan=3> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:20px;height:10px;background:#fff" rowspan=4 colspan=2> </td><td style="width:10px;height:20px;background:rgb(237,127,127)" rowspan=2> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:20px;height:10px;background:#fff" rowspan=3 colspan=2> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td></tr>
|
||||
<tr><td style="width:10px;height:10px;background:#fff" rowspan=2> </td></tr>
|
||||
<tr><td style="width:10px;height:10px;background:#fff"> </td></tr>
|
||||
<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@2.15.12</p>
|
||||
|
||||
66
node_modules/npm/html/doc/cli/npm-tag.html
generated
vendored
Normal file
66
node_modules/npm/html/doc/cli/npm-tag.html
generated
vendored
Normal file
@@ -0,0 +1,66 @@
|
||||
<!doctype html>
|
||||
<html>
|
||||
<title>npm-tag</title>
|
||||
<meta charset="utf-8">
|
||||
<link rel="stylesheet" type="text/css" href="../../static/style.css">
|
||||
<link rel="canonical" href="https://www.npmjs.org/doc/cli/npm-tag.html">
|
||||
<script async=true src="../../static/toc.js"></script>
|
||||
|
||||
<body>
|
||||
<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>
|
||||
<p>THIS COMMAND IS DEPRECATED. See <a href="../cli/npm-dist-tag.html">npm-dist-tag(1)</a> for details.</p>
|
||||
<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>
|
||||
<p>Publishing a package always sets the "latest" tag to the published version.</p>
|
||||
<h2 id="purpose">PURPOSE</h2>
|
||||
<p>Tags can be used to provide an alias instead of version numbers. For
|
||||
example, <code>npm</code> currently uses the tag "next" to identify the upcoming
|
||||
version, and the tag "latest" to identify the current version.</p>
|
||||
<p>A project might choose to have multiple streams of development, e.g.,
|
||||
"stable", "canary".</p>
|
||||
<h2 id="caveats">CAVEATS</h2>
|
||||
<p>Tags must share a namespace with version numbers, because they are
|
||||
specified in the same slot: <code>npm install <pkg>@<version></code> vs <code>npm
|
||||
install <pkg>@<tag></code>.</p>
|
||||
<p>Tags that can be interpreted as valid semver ranges will be
|
||||
rejected. For example, <code>v1.4</code> cannot be used as a tag, because it is
|
||||
interpreted by semver as <code>>=1.4.0 <1.5.0</code>. See
|
||||
<a href="https://github.com/npm/npm/issues/6082">https://github.com/npm/npm/issues/6082</a>.</p>
|
||||
<p>The simplest way to avoid semver problems with tags is to use tags
|
||||
that do not begin with a number or the letter <code>v</code>.</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="../cli/npm-dist-tag.html">npm-dist-tag(1)</a></li>
|
||||
<li><a href="../files/npmrc.html">npmrc(5)</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
|
||||
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
|
||||
<tr><td style="width:180px;height:10px;background:rgb(237,127,127)" colspan=18> </td></tr>
|
||||
<tr><td rowspan=4 style="width:10px;height:10px;background:rgb(237,127,127)"> </td><td style="width:40px;height:10px;background:#fff" colspan=4> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=4> </td><td style="width:40px;height:10px;background:#fff" colspan=4> </td><td rowspan=4 style="width:10px;height:10px;background:rgb(237,127,127)"> </td><td colspan=6 style="width:60px;height:10px;background:#fff"> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=4> </td></tr>
|
||||
<tr><td colspan=2 style="width:20px;height:30px;background:#fff" rowspan=3> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:20px;height:10px;background:#fff" rowspan=4 colspan=2> </td><td style="width:10px;height:20px;background:rgb(237,127,127)" rowspan=2> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:20px;height:10px;background:#fff" rowspan=3 colspan=2> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td></tr>
|
||||
<tr><td style="width:10px;height:10px;background:#fff" rowspan=2> </td></tr>
|
||||
<tr><td style="width:10px;height:10px;background:#fff"> </td></tr>
|
||||
<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@2.15.12</p>
|
||||
|
||||
71
node_modules/npm/html/doc/cli/npm-team.html
generated
vendored
Normal file
71
node_modules/npm/html/doc/cli/npm-team.html
generated
vendored
Normal file
@@ -0,0 +1,71 @@
|
||||
<!doctype html>
|
||||
<html>
|
||||
<title>npm-team</title>
|
||||
<meta charset="utf-8">
|
||||
<link rel="stylesheet" type="text/css" href="../../static/style.css">
|
||||
<link rel="canonical" href="https://www.npmjs.org/doc/cli/npm-team.html">
|
||||
<script async=true src="../../static/toc.js"></script>
|
||||
|
||||
<body>
|
||||
<div id="wrapper">
|
||||
|
||||
<h1><a href="../cli/npm-team.html">npm-team</a></h1> <p>Manage organization teams and team memberships</p>
|
||||
<h2 id="synopsis">SYNOPSIS</h2>
|
||||
<pre><code>npm team create <scope:team>
|
||||
npm team destroy <scope:team>
|
||||
|
||||
npm team add <scope:team> <user>
|
||||
npm team rm <scope:team> <user>
|
||||
|
||||
npm team ls <scope>|<scope:team>
|
||||
|
||||
npm team edit <scope:team>
|
||||
</code></pre><h2 id="description">DESCRIPTION</h2>
|
||||
<p>Used to manage teams in organizations, and change team memberships. Does not
|
||||
handle permissions for packages.</p>
|
||||
<p>Teams must always be fully qualified with the organization/scope they belond to
|
||||
when operating on them, separated by a colon (<code>:</code>). That is, if you have a
|
||||
<code>developers</code> team on a <code>foo</code> organization, you must always refer to that team as
|
||||
<code>foo:developers</code> in these commands.</p>
|
||||
<ul>
|
||||
<li><p>create / destroy:
|
||||
Create a new team, or destroy an existing one.</p>
|
||||
</li>
|
||||
<li><p>add / rm:
|
||||
Add a user to an existing team, or remove a user from a team they belong to.</p>
|
||||
</li>
|
||||
<li><p>ls:
|
||||
If performed on an organization name, will return a list of existing teams
|
||||
under that organization. If performed on a team, it will instead return a list
|
||||
of all users belonging to that particular team.</p>
|
||||
</li>
|
||||
</ul>
|
||||
<h2 id="details">DETAILS</h2>
|
||||
<p><code>npm team</code> always operates directly on the current registry, configurable from
|
||||
the command line using <code>--registry=<registry url></code>.</p>
|
||||
<p>In order to create teams and manage team membership, you must be a <em>team admin</em>
|
||||
under the given organization. Listing teams and team memberships may be done by
|
||||
any member of the organizations.</p>
|
||||
<p>Organization creation and management of team admins and <em>organization</em> members
|
||||
is done through the website, not the npm CLI.</p>
|
||||
<p>To use teams to manage permissions on packages belonging to your organization,
|
||||
use the <code>npm access</code> command to grant or revoke the appropriate permissions.</p>
|
||||
<h2 id="see-also">SEE ALSO</h2>
|
||||
<ul>
|
||||
<li><a href="../cli/npm-access.html">npm-access(1)</a></li>
|
||||
<li><a href="../misc/npm-registr.html">npm-registr(7)</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
|
||||
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
|
||||
<tr><td style="width:180px;height:10px;background:rgb(237,127,127)" colspan=18> </td></tr>
|
||||
<tr><td rowspan=4 style="width:10px;height:10px;background:rgb(237,127,127)"> </td><td style="width:40px;height:10px;background:#fff" colspan=4> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=4> </td><td style="width:40px;height:10px;background:#fff" colspan=4> </td><td rowspan=4 style="width:10px;height:10px;background:rgb(237,127,127)"> </td><td colspan=6 style="width:60px;height:10px;background:#fff"> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=4> </td></tr>
|
||||
<tr><td colspan=2 style="width:20px;height:30px;background:#fff" rowspan=3> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:20px;height:10px;background:#fff" rowspan=4 colspan=2> </td><td style="width:10px;height:20px;background:rgb(237,127,127)" rowspan=2> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:20px;height:10px;background:#fff" rowspan=3 colspan=2> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td></tr>
|
||||
<tr><td style="width:10px;height:10px;background:#fff" rowspan=2> </td></tr>
|
||||
<tr><td style="width:10px;height:10px;background:#fff"> </td></tr>
|
||||
<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-team — npm@2.15.12</p>
|
||||
|
||||
42
node_modules/npm/html/doc/cli/npm-test.html
generated
vendored
Normal file
42
node_modules/npm/html/doc/cli/npm-test.html
generated
vendored
Normal file
@@ -0,0 +1,42 @@
|
||||
<!doctype html>
|
||||
<html>
|
||||
<title>npm-test</title>
|
||||
<meta charset="utf-8">
|
||||
<link rel="stylesheet" type="text/css" href="../../static/style.css">
|
||||
<link rel="canonical" href="https://www.npmjs.org/doc/cli/npm-test.html">
|
||||
<script async=true src="../../static/toc.js"></script>
|
||||
|
||||
<body>
|
||||
<div id="wrapper">
|
||||
|
||||
<h1><a href="../cli/npm-test.html">npm-test</a></h1> <p>Test a package</p>
|
||||
<h2 id="synopsis">SYNOPSIS</h2>
|
||||
<pre><code> npm test [-- <args>]
|
||||
|
||||
aliases: t, tst
|
||||
</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>
|
||||
|
||||
</div>
|
||||
|
||||
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
|
||||
<tr><td style="width:180px;height:10px;background:rgb(237,127,127)" colspan=18> </td></tr>
|
||||
<tr><td rowspan=4 style="width:10px;height:10px;background:rgb(237,127,127)"> </td><td style="width:40px;height:10px;background:#fff" colspan=4> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=4> </td><td style="width:40px;height:10px;background:#fff" colspan=4> </td><td rowspan=4 style="width:10px;height:10px;background:rgb(237,127,127)"> </td><td colspan=6 style="width:60px;height:10px;background:#fff"> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=4> </td></tr>
|
||||
<tr><td colspan=2 style="width:20px;height:30px;background:#fff" rowspan=3> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:20px;height:10px;background:#fff" rowspan=4 colspan=2> </td><td style="width:10px;height:20px;background:rgb(237,127,127)" rowspan=2> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:20px;height:10px;background:#fff" rowspan=3 colspan=2> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td></tr>
|
||||
<tr><td style="width:10px;height:10px;background:#fff" rowspan=2> </td></tr>
|
||||
<tr><td style="width:10px;height:10px;background:#fff"> </td></tr>
|
||||
<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@2.15.12</p>
|
||||
|
||||
61
node_modules/npm/html/doc/cli/npm-uninstall.html
generated
vendored
Normal file
61
node_modules/npm/html/doc/cli/npm-uninstall.html
generated
vendored
Normal file
@@ -0,0 +1,61 @@
|
||||
<!doctype html>
|
||||
<html>
|
||||
<title>npm-uninstall</title>
|
||||
<meta charset="utf-8">
|
||||
<link rel="stylesheet" type="text/css" href="../../static/style.css">
|
||||
<link rel="canonical" href="https://www.npmjs.org/doc/cli/npm-uninstall.html">
|
||||
<script async=true src="../../static/toc.js"></script>
|
||||
|
||||
<body>
|
||||
<div id="wrapper">
|
||||
|
||||
<h1><a href="../cli/npm-uninstall.html">npm-uninstall</a></h1> <p>Remove a package</p>
|
||||
<h2 id="synopsis">SYNOPSIS</h2>
|
||||
<pre><code>npm uninstall [@<scope>/]<package> [--save|--save-dev|--save-optional]
|
||||
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),
|
||||
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>
|
||||
<p>Scope is optional and follows the usual rules for <code><a href="../misc/npm-scope.html">npm-scope(7)</a></code>.</p>
|
||||
<p>Examples:</p>
|
||||
<pre><code>npm uninstall sax --save
|
||||
npm uninstall @myorg/privatepackage --save
|
||||
npm uninstall node-tap --save-dev
|
||||
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>
|
||||
|
||||
</div>
|
||||
|
||||
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
|
||||
<tr><td style="width:180px;height:10px;background:rgb(237,127,127)" colspan=18> </td></tr>
|
||||
<tr><td rowspan=4 style="width:10px;height:10px;background:rgb(237,127,127)"> </td><td style="width:40px;height:10px;background:#fff" colspan=4> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=4> </td><td style="width:40px;height:10px;background:#fff" colspan=4> </td><td rowspan=4 style="width:10px;height:10px;background:rgb(237,127,127)"> </td><td colspan=6 style="width:60px;height:10px;background:#fff"> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=4> </td></tr>
|
||||
<tr><td colspan=2 style="width:20px;height:30px;background:#fff" rowspan=3> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:20px;height:10px;background:#fff" rowspan=4 colspan=2> </td><td style="width:10px;height:20px;background:rgb(237,127,127)" rowspan=2> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:20px;height:10px;background:#fff" rowspan=3 colspan=2> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td></tr>
|
||||
<tr><td style="width:10px;height:10px;background:#fff" rowspan=2> </td></tr>
|
||||
<tr><td style="width:10px;height:10px;background:#fff"> </td></tr>
|
||||
<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@2.15.12</p>
|
||||
|
||||
51
node_modules/npm/html/doc/cli/npm-unpublish.html
generated
vendored
Normal file
51
node_modules/npm/html/doc/cli/npm-unpublish.html
generated
vendored
Normal file
@@ -0,0 +1,51 @@
|
||||
<!doctype html>
|
||||
<html>
|
||||
<title>npm-unpublish</title>
|
||||
<meta charset="utf-8">
|
||||
<link rel="stylesheet" type="text/css" href="../../static/style.css">
|
||||
<link rel="canonical" href="https://www.npmjs.org/doc/cli/npm-unpublish.html">
|
||||
<script async=true src="../../static/toc.js"></script>
|
||||
|
||||
<body>
|
||||
<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 [@<scope>/]<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>
|
||||
<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>
|
||||
<p>The scope is optional and follows the usual rules for <code><a href="../misc/npm-scope.html">npm-scope(7)</a></code>.</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>
|
||||
|
||||
</div>
|
||||
|
||||
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
|
||||
<tr><td style="width:180px;height:10px;background:rgb(237,127,127)" colspan=18> </td></tr>
|
||||
<tr><td rowspan=4 style="width:10px;height:10px;background:rgb(237,127,127)"> </td><td style="width:40px;height:10px;background:#fff" colspan=4> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=4> </td><td style="width:40px;height:10px;background:#fff" colspan=4> </td><td rowspan=4 style="width:10px;height:10px;background:rgb(237,127,127)"> </td><td colspan=6 style="width:60px;height:10px;background:#fff"> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=4> </td></tr>
|
||||
<tr><td colspan=2 style="width:20px;height:30px;background:#fff" rowspan=3> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:20px;height:10px;background:#fff" rowspan=4 colspan=2> </td><td style="width:10px;height:20px;background:rgb(237,127,127)" rowspan=2> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:20px;height:10px;background:#fff" rowspan=3 colspan=2> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td></tr>
|
||||
<tr><td style="width:10px;height:10px;background:#fff" rowspan=2> </td></tr>
|
||||
<tr><td style="width:10px;height:10px;background:#fff"> </td></tr>
|
||||
<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@2.15.12</p>
|
||||
|
||||
121
node_modules/npm/html/doc/cli/npm-update.html
generated
vendored
Normal file
121
node_modules/npm/html/doc/cli/npm-update.html
generated
vendored
Normal file
@@ -0,0 +1,121 @@
|
||||
<!doctype html>
|
||||
<html>
|
||||
<title>npm-update</title>
|
||||
<meta charset="utf-8">
|
||||
<link rel="stylesheet" type="text/css" href="../../static/style.css">
|
||||
<link rel="canonical" href="https://www.npmjs.org/doc/cli/npm-update.html">
|
||||
<script async=true src="../../static/toc.js"></script>
|
||||
|
||||
<body>
|
||||
<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> ...]]
|
||||
|
||||
aliases: up, upgrade
|
||||
</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), respecting semver.</p>
|
||||
<p>It will also install missing packages. As with all commands that install
|
||||
packages, the <code>--dev</code> flag will cause <code>devDependencies</code> to be processed
|
||||
as well.</p>
|
||||
<p>If the <code>-g</code> flag is specified, this command will update globally installed
|
||||
packages.</p>
|
||||
<p>If no package name is specified, all packages in the specified location (global
|
||||
or local) will be updated.</p>
|
||||
<p>As of <code>npm@2.6.1</code>, the <code>npm update</code> will only inspect top-level packages.
|
||||
Prior versions of <code>npm</code> would also recursively inspect all dependencies.
|
||||
To get the old behavior, use <code>npm --depth 9999 update</code>.</p>
|
||||
<h2 id="examples">EXAMPLES</h2>
|
||||
<p>IMPORTANT VERSION NOTE: these examples assume <code>npm@2.6.1</code> or later. For
|
||||
older versions of <code>npm</code>, you must specify <code>--depth 0</code> to get the behavior
|
||||
described below.</p>
|
||||
<p>For the examples below, assume that the current package is <code>app</code> and it depends
|
||||
on dependencies, <code>dep1</code> (<code>dep2</code>, .. etc.). The published versions of <code>dep1</code> are:</p>
|
||||
<pre><code>{
|
||||
"dist-tags": { "latest": "1.2.2" },
|
||||
"versions": [
|
||||
"1.2.2",
|
||||
"1.2.1",
|
||||
"1.2.0",
|
||||
"1.1.2",
|
||||
"1.1.1",
|
||||
"1.0.0",
|
||||
"0.4.1",
|
||||
"0.4.0",
|
||||
"0.2.0"
|
||||
]
|
||||
}
|
||||
</code></pre><h3 id="caret-dependencies">Caret Dependencies</h3>
|
||||
<p>If <code>app</code>'s <code>package.json</code> contains:</p>
|
||||
<pre><code>"dependencies": {
|
||||
"dep1": "^1.1.1"
|
||||
}
|
||||
</code></pre><p>Then <code>npm update</code> will install <code>dep1@1.2.2</code>, because <code>1.2.2</code> is <code>latest</code> and
|
||||
<code>1.2.2</code> satisfies <code>^1.1.1</code>.</p>
|
||||
<h3 id="tilde-dependencies">Tilde Dependencies</h3>
|
||||
<p>However, if <code>app</code>'s <code>package.json</code> contains:</p>
|
||||
<pre><code>"dependencies": {
|
||||
"dep1": "~1.1.1"
|
||||
}
|
||||
</code></pre><p>In this case, running <code>npm update</code> will install <code>dep1@1.1.2</code>. Even though the <code>latest</code>
|
||||
tag points to <code>1.2.2</code>, this version does not satisfy <code>~1.1.1</code>, which is equivalent
|
||||
to <code>>=1.1.1 <1.2.0</code>. So the highest-sorting version that satisfies <code>~1.1.1</code> is used,
|
||||
which is <code>1.1.2</code>.</p>
|
||||
<h3 id="caret-dependencies-below-1-0-0">Caret Dependencies below 1.0.0</h3>
|
||||
<p>Suppose <code>app</code> has a caret dependency on a version below <code>1.0.0</code>, for example:</p>
|
||||
<pre><code>"dependencies": {
|
||||
"dep1": "^0.2.0"
|
||||
}
|
||||
</code></pre><p><code>npm update</code> will install <code>dep1@0.2.0</code>, because there are no other
|
||||
versions which satisfy <code>^0.2.0</code>.</p>
|
||||
<p>If the dependence were on <code>^0.4.0</code>:</p>
|
||||
<pre><code>"dependencies": {
|
||||
"dep1": "^0.4.0"
|
||||
}
|
||||
</code></pre><p>Then <code>npm update</code> will install <code>dep1@0.4.1</code>, because that is the highest-sorting
|
||||
version that satisfies <code>^0.4.0</code> (<code>>= 0.4.0 <0.5.0</code>)</p>
|
||||
<h3 id="recording-updates-with-save-">Recording Updates with <code>--save</code></h3>
|
||||
<p>When you want to update a package and save the new version as
|
||||
the minimum required dependency in <code>package.json</code>, you can use
|
||||
<code>npm update --save</code>. For example if <code>package.json</code> contains</p>
|
||||
<pre><code>"dependencies": {
|
||||
"dep1": "^1.1.1"
|
||||
}
|
||||
</code></pre><p>Then <code>npm update --save</code> will install <code>dep1@1.2.2</code> (i.e., <code>latest</code>),
|
||||
and <code>package.json</code> will be modified:</p>
|
||||
<pre><code>"dependencies": {
|
||||
"dep1": "^1.2.2"
|
||||
}
|
||||
</code></pre><p>Note that <code>npm</code> will only write an updated version to <code>package.json</code>
|
||||
if it installs a new package.</p>
|
||||
<h3 id="updating-globally-installed-packages">Updating Globally-Installed Packages</h3>
|
||||
<p><code>npm update -g</code> will apply the <code>update</code> action to each globally installed
|
||||
package that is <code>outdated</code> -- that is, has a version that is different from
|
||||
<code>latest</code>.</p>
|
||||
<p>NOTE: If a package has been upgraded to a version newer than <code>latest</code>, it will
|
||||
be <em>downgraded</em>.</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="../cli/npm-shrinkwrap.html">npm-shrinkwrap(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>
|
||||
<tr><td style="width:180px;height:10px;background:rgb(237,127,127)" colspan=18> </td></tr>
|
||||
<tr><td rowspan=4 style="width:10px;height:10px;background:rgb(237,127,127)"> </td><td style="width:40px;height:10px;background:#fff" colspan=4> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=4> </td><td style="width:40px;height:10px;background:#fff" colspan=4> </td><td rowspan=4 style="width:10px;height:10px;background:rgb(237,127,127)"> </td><td colspan=6 style="width:60px;height:10px;background:#fff"> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=4> </td></tr>
|
||||
<tr><td colspan=2 style="width:20px;height:30px;background:#fff" rowspan=3> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:20px;height:10px;background:#fff" rowspan=4 colspan=2> </td><td style="width:10px;height:20px;background:rgb(237,127,127)" rowspan=2> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:20px;height:10px;background:#fff" rowspan=3 colspan=2> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td></tr>
|
||||
<tr><td style="width:10px;height:10px;background:#fff" rowspan=2> </td></tr>
|
||||
<tr><td style="width:10px;height:10px;background:#fff"> </td></tr>
|
||||
<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@2.15.12</p>
|
||||
|
||||
99
node_modules/npm/html/doc/cli/npm-version.html
generated
vendored
Normal file
99
node_modules/npm/html/doc/cli/npm-version.html
generated
vendored
Normal file
@@ -0,0 +1,99 @@
|
||||
<!doctype html>
|
||||
<html>
|
||||
<title>npm-version</title>
|
||||
<meta charset="utf-8">
|
||||
<link rel="stylesheet" type="text/css" href="../../static/style.css">
|
||||
<link rel="canonical" href="https://www.npmjs.org/doc/cli/npm-version.html">
|
||||
<script async=true src="../../static/toc.js"></script>
|
||||
|
||||
<body>
|
||||
<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 | premajor | preminor | prepatch | prerelease]
|
||||
</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 <code>package.json</code> and, if present, <code>npm-shrinkwrap.json</code>.</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 <code>patch</code>, <code>minor</code>, <code>major</code>,
|
||||
<code>prepatch</code>, <code>preminor</code>, <code>premajor</code>, <code>prerelease</code>). 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.
|
||||
This behavior is controlled by <code>git-tag-version</code> (see below), and can
|
||||
be disabled on the command line by running <code>npm --no-git-tag-version version</code>.
|
||||
It will fail if the working directory is not clean, unless the <code>--force</code>
|
||||
flag is set.</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
|
||||
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
|
||||
|
||||
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><p>If <code>preversion</code>, <code>version</code>, or <code>postversion</code> are in the <code>scripts</code> property of
|
||||
the package.json, they will be executed as part of running <code>npm version</code>.</p>
|
||||
<p>The exact order of execution is as follows:</p>
|
||||
<ol>
|
||||
<li>Check to make sure the git working directory is clean before we get started.
|
||||
Your scripts may add files to the commit in future steps.
|
||||
This step is skipped if the <code>--force</code> flag is set.</li>
|
||||
<li>Run the <code>preversion</code> script. These scripts have access to the old <code>version</code> in package.json.
|
||||
A typical use would be running your full test suite before deploying.
|
||||
Any files you want added to the commit should be explicitly added using <code>git add</code>.</li>
|
||||
<li>Bump <code>version</code> in <code>package.json</code> as requested (<code>patch</code>, <code>minor</code>, <code>major</code>, etc). </li>
|
||||
<li>Run the <code>version</code> script. These scripts have access to the new <code>version</code> in package.json
|
||||
(so they can incorporate it into file headers in generated files for example).
|
||||
Again, scripts should explicitly add generated files to the commit using <code>git add</code>.</li>
|
||||
<li>Commit and tag.</li>
|
||||
<li>Run the <code>postversion</code> script. Use it to clean up the file system or automatically push
|
||||
the commit and/or tag.</li>
|
||||
</ol>
|
||||
<p>Take the following example:</p>
|
||||
<pre><code>"scripts": {
|
||||
"preversion": "npm test",
|
||||
"version": "npm run build && git add -A dist",
|
||||
"postversion": "git push && git push --tags && rm -rf build/temp"
|
||||
}
|
||||
</code></pre><p>This runs all your tests, and proceeds only if they pass. Then runs your <code>build</code> script, and
|
||||
adds everything in the <code>dist</code> directory to the commit. After the commit, it pushes the new commit
|
||||
and tag up to the server, and deletes the <code>build/temp</code> directory.</p>
|
||||
<h2 id="configuration">CONFIGURATION</h2>
|
||||
<h3 id="git-tag-version">git-tag-version</h3>
|
||||
<ul>
|
||||
<li>Default: true</li>
|
||||
<li>Type: Boolean</li>
|
||||
</ul>
|
||||
<p>Commit and tag the version change.</p>
|
||||
<h2 id="see-also">SEE ALSO</h2>
|
||||
<ul>
|
||||
<li><a href="../cli/npm-init.html">npm-init(1)</a></li>
|
||||
<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="../files/package.json.html">package.json(5)</a></li>
|
||||
<li><a href="../misc/semver.html">semver(7)</a></li>
|
||||
<li><a href="../misc/config.html">config(7)</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
|
||||
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
|
||||
<tr><td style="width:180px;height:10px;background:rgb(237,127,127)" colspan=18> </td></tr>
|
||||
<tr><td rowspan=4 style="width:10px;height:10px;background:rgb(237,127,127)"> </td><td style="width:40px;height:10px;background:#fff" colspan=4> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=4> </td><td style="width:40px;height:10px;background:#fff" colspan=4> </td><td rowspan=4 style="width:10px;height:10px;background:rgb(237,127,127)"> </td><td colspan=6 style="width:60px;height:10px;background:#fff"> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=4> </td></tr>
|
||||
<tr><td colspan=2 style="width:20px;height:30px;background:#fff" rowspan=3> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:20px;height:10px;background:#fff" rowspan=4 colspan=2> </td><td style="width:10px;height:20px;background:rgb(237,127,127)" rowspan=2> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:20px;height:10px;background:#fff" rowspan=3 colspan=2> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td></tr>
|
||||
<tr><td style="width:10px;height:10px;background:#fff" rowspan=2> </td></tr>
|
||||
<tr><td style="width:10px;height:10px;background:#fff"> </td></tr>
|
||||
<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@2.15.12</p>
|
||||
|
||||
89
node_modules/npm/html/doc/cli/npm-view.html
generated
vendored
Normal file
89
node_modules/npm/html/doc/cli/npm-view.html
generated
vendored
Normal file
@@ -0,0 +1,89 @@
|
||||
<!doctype html>
|
||||
<html>
|
||||
<title>npm-view</title>
|
||||
<meta charset="utf-8">
|
||||
<link rel="stylesheet" type="text/css" href="../../static/style.css">
|
||||
<link rel="canonical" href="https://www.npmjs.org/doc/cli/npm-view.html">
|
||||
<script async=true src="../../static/toc.js"></script>
|
||||
|
||||
<body>
|
||||
<div id="wrapper">
|
||||
|
||||
<h1><a href="../cli/npm-view.html">npm-view</a></h1> <p>View registry info</p>
|
||||
<h2 id="synopsis">SYNOPSIS</h2>
|
||||
<pre><code>npm view [@<scope>/]<name>[@<version>] [<field>[.<subfield>]...]
|
||||
npm v [@<scope>/]<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>
|
||||
<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 fields 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
|
||||
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
|
||||
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
|
||||
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.
|
||||
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
|
||||
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
|
||||
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><p>To show the <code>connect</code> package version history, you can do
|
||||
this:</p>
|
||||
<pre><code>npm view connect versions
|
||||
</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>
|
||||
|
||||
</div>
|
||||
|
||||
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
|
||||
<tr><td style="width:180px;height:10px;background:rgb(237,127,127)" colspan=18> </td></tr>
|
||||
<tr><td rowspan=4 style="width:10px;height:10px;background:rgb(237,127,127)"> </td><td style="width:40px;height:10px;background:#fff" colspan=4> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=4> </td><td style="width:40px;height:10px;background:#fff" colspan=4> </td><td rowspan=4 style="width:10px;height:10px;background:rgb(237,127,127)"> </td><td colspan=6 style="width:60px;height:10px;background:#fff"> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=4> </td></tr>
|
||||
<tr><td colspan=2 style="width:20px;height:30px;background:#fff" rowspan=3> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:20px;height:10px;background:#fff" rowspan=4 colspan=2> </td><td style="width:10px;height:20px;background:rgb(237,127,127)" rowspan=2> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:20px;height:10px;background:#fff" rowspan=3 colspan=2> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td></tr>
|
||||
<tr><td style="width:10px;height:10px;background:#fff" rowspan=2> </td></tr>
|
||||
<tr><td style="width:10px;height:10px;background:#fff"> </td></tr>
|
||||
<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@2.15.12</p>
|
||||
|
||||
37
node_modules/npm/html/doc/cli/npm-whoami.html
generated
vendored
Normal file
37
node_modules/npm/html/doc/cli/npm-whoami.html
generated
vendored
Normal file
@@ -0,0 +1,37 @@
|
||||
<!doctype html>
|
||||
<html>
|
||||
<title>npm-whoami</title>
|
||||
<meta charset="utf-8">
|
||||
<link rel="stylesheet" type="text/css" href="../../static/style.css">
|
||||
<link rel="canonical" href="https://www.npmjs.org/doc/cli/npm-whoami.html">
|
||||
<script async=true src="../../static/toc.js"></script>
|
||||
|
||||
<body>
|
||||
<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>
|
||||
<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>
|
||||
|
||||
</div>
|
||||
|
||||
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
|
||||
<tr><td style="width:180px;height:10px;background:rgb(237,127,127)" colspan=18> </td></tr>
|
||||
<tr><td rowspan=4 style="width:10px;height:10px;background:rgb(237,127,127)"> </td><td style="width:40px;height:10px;background:#fff" colspan=4> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=4> </td><td style="width:40px;height:10px;background:#fff" colspan=4> </td><td rowspan=4 style="width:10px;height:10px;background:rgb(237,127,127)"> </td><td colspan=6 style="width:60px;height:10px;background:#fff"> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=4> </td></tr>
|
||||
<tr><td colspan=2 style="width:20px;height:30px;background:#fff" rowspan=3> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:20px;height:10px;background:#fff" rowspan=4 colspan=2> </td><td style="width:10px;height:20px;background:rgb(237,127,127)" rowspan=2> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:20px;height:10px;background:#fff" rowspan=3 colspan=2> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td></tr>
|
||||
<tr><td style="width:10px;height:10px;background:#fff" rowspan=2> </td></tr>
|
||||
<tr><td style="width:10px;height:10px;background:#fff"> </td></tr>
|
||||
<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@2.15.12</p>
|
||||
|
||||
156
node_modules/npm/html/doc/cli/npm.html
generated
vendored
Normal file
156
node_modules/npm/html/doc/cli/npm.html
generated
vendored
Normal file
@@ -0,0 +1,156 @@
|
||||
<!doctype html>
|
||||
<html>
|
||||
<title>npm</title>
|
||||
<meta charset="utf-8">
|
||||
<link rel="stylesheet" type="text/css" href="../../static/style.css">
|
||||
<link rel="canonical" href="https://www.npmjs.org/doc/cli/npm.html">
|
||||
<script async=true src="../../static/toc.js"></script>
|
||||
|
||||
<body>
|
||||
<div id="wrapper">
|
||||
|
||||
<h1><a href="../cli/npm.html">npm</a></h1> <p>javascript package manager</p>
|
||||
<h2 id="synopsis">SYNOPSIS</h2>
|
||||
<pre><code>npm <command> [args]
|
||||
</code></pre><h2 id="version">VERSION</h2>
|
||||
<p>2.15.12</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>
|
||||
<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="dependencies">DEPENDENCIES</h2>
|
||||
<p>If a package references to another package with a git URL, npm depends
|
||||
on a preinstalled git.</p>
|
||||
<p>If one of the packages npm tries to install is a native node module and
|
||||
requires compiling of C++ Code, npm will use
|
||||
<a href="https://github.com/TooTallNate/node-gyp">node-gyp</a> for that task.
|
||||
For a Unix system, <a href="https://github.com/TooTallNate/node-gyp">node-gyp</a>
|
||||
needs Python, make and a buildchain like GCC. On Windows,
|
||||
Python and Microsoft Visual Studio C++ are needed. Python 3 is
|
||||
not supported by <a href="https://github.com/TooTallNate/node-gyp">node-gyp</a>.
|
||||
For more information visit
|
||||
<a href="https://github.com/TooTallNate/node-gyp">the node-gyp repository</a> and
|
||||
the <a href="https://github.com/TooTallNate/node-gyp/wiki">node-gyp Wiki</a>.</p>
|
||||
<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
|
||||
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>
|
||||
<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>
|
||||
<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:
|
||||
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:
|
||||
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:
|
||||
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>
|
||||
<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
|
||||
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
|
||||
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
|
||||
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>
|
||||
<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>
|
||||
<p>Patches welcome!</p>
|
||||
<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:
|
||||
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>
|
||||
<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, read
|
||||
the contributing guidelines and check the issues list.</p>
|
||||
<ul>
|
||||
<li><a href="https://github.com/npm/npm/wiki/Contributing-Guidelines">https://github.com/npm/npm/wiki/Contributing-Guidelines</a></li>
|
||||
<li><a href="https://github.com/npm/npm/issues">https://github.com/npm/npm/issues</a></li>
|
||||
</ul>
|
||||
<h2 id="bugs">BUGS</h2>
|
||||
<p>When you find issues, please report them:</p>
|
||||
<ul>
|
||||
<li>web:
|
||||
<a href="https://github.com/npm/npm/issues">https://github.com/npm/npm/issues</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>
|
||||
<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>
|
||||
<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>
|
||||
<tr><td style="width:180px;height:10px;background:rgb(237,127,127)" colspan=18> </td></tr>
|
||||
<tr><td rowspan=4 style="width:10px;height:10px;background:rgb(237,127,127)"> </td><td style="width:40px;height:10px;background:#fff" colspan=4> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=4> </td><td style="width:40px;height:10px;background:#fff" colspan=4> </td><td rowspan=4 style="width:10px;height:10px;background:rgb(237,127,127)"> </td><td colspan=6 style="width:60px;height:10px;background:#fff"> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=4> </td></tr>
|
||||
<tr><td colspan=2 style="width:20px;height:30px;background:#fff" rowspan=3> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:20px;height:10px;background:#fff" rowspan=4 colspan=2> </td><td style="width:10px;height:20px;background:rgb(237,127,127)" rowspan=2> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:20px;height:10px;background:#fff" rowspan=3 colspan=2> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td></tr>
|
||||
<tr><td style="width:10px;height:10px;background:#fff" rowspan=2> </td></tr>
|
||||
<tr><td style="width:10px;height:10px;background:#fff"> </td></tr>
|
||||
<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@2.15.12</p>
|
||||
|
||||
187
node_modules/npm/html/doc/files/npm-folders.html
generated
vendored
Normal file
187
node_modules/npm/html/doc/files/npm-folders.html
generated
vendored
Normal file
@@ -0,0 +1,187 @@
|
||||
<!doctype html>
|
||||
<html>
|
||||
<title>npm-folders</title>
|
||||
<meta charset="utf-8">
|
||||
<link rel="stylesheet" type="text/css" href="../../static/style.css">
|
||||
<link rel="canonical" href="https://www.npmjs.org/doc/files/npm-folders.html">
|
||||
<script async=true src="../../static/toc.js"></script>
|
||||
|
||||
<body>
|
||||
<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>
|
||||
<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>
|
||||
<p>The <code>prefix</code> config defaults to the location where node is installed.
|
||||
On most systems, this is <code>/usr/local</code>. 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>
|
||||
<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>Scoped packages are installed the same way, except they are grouped together
|
||||
in a sub-folder of the relevant <code>node_modules</code> folder with the name of that
|
||||
scope prefix by the @ symbol, e.g. <code>npm install @myorg/package</code> would place
|
||||
the package in <code>{prefix}/node_modules/@myorg/package</code>. See <code><a href="../misc/scope.html">scope(7)</a></code> for
|
||||
more details.</p>
|
||||
<p>If you wish to <code>require()</code> a package, then install it locally.</p>
|
||||
<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>
|
||||
<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>
|
||||
<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>
|
||||
<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>
|
||||
<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>
|
||||
<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>
|
||||
<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
|
||||
structure is: <code>foo/node_modules/bar/node_modules/baz</code>, there's no need to
|
||||
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>
|
||||
<p>Consider this dependency graph:</p>
|
||||
<pre><code>foo
|
||||
+-- blerg@1.2.5
|
||||
+-- bar@1.2.3
|
||||
| +-- blerg@1.x (latest=1.3.7)
|
||||
| +-- baz@2.x
|
||||
| | `-- quux@3.x
|
||||
| | `-- bar@1.2.3 (cycle)
|
||||
| `-- asdf@*
|
||||
`-- baz@1.2.3
|
||||
`-- quux@3.x
|
||||
`-- 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]
|
||||
+-- bar (1.2.3) <---[B]
|
||||
| `-- node_modules
|
||||
| +-- baz (2.0.2) <---[C]
|
||||
| | `-- node_modules
|
||||
| | `-- quux (3.2.0)
|
||||
| `-- 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
|
||||
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>
|
||||
<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>
|
||||
|
||||
</div>
|
||||
|
||||
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
|
||||
<tr><td style="width:180px;height:10px;background:rgb(237,127,127)" colspan=18> </td></tr>
|
||||
<tr><td rowspan=4 style="width:10px;height:10px;background:rgb(237,127,127)"> </td><td style="width:40px;height:10px;background:#fff" colspan=4> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=4> </td><td style="width:40px;height:10px;background:#fff" colspan=4> </td><td rowspan=4 style="width:10px;height:10px;background:rgb(237,127,127)"> </td><td colspan=6 style="width:60px;height:10px;background:#fff"> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=4> </td></tr>
|
||||
<tr><td colspan=2 style="width:20px;height:30px;background:#fff" rowspan=3> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:20px;height:10px;background:#fff" rowspan=4 colspan=2> </td><td style="width:10px;height:20px;background:rgb(237,127,127)" rowspan=2> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:20px;height:10px;background:#fff" rowspan=3 colspan=2> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td></tr>
|
||||
<tr><td style="width:10px;height:10px;background:#fff" rowspan=2> </td></tr>
|
||||
<tr><td style="width:10px;height:10px;background:#fff"> </td></tr>
|
||||
<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@2.15.12</p>
|
||||
|
||||
187
node_modules/npm/html/doc/files/npm-global.html
generated
vendored
Normal file
187
node_modules/npm/html/doc/files/npm-global.html
generated
vendored
Normal file
@@ -0,0 +1,187 @@
|
||||
<!doctype html>
|
||||
<html>
|
||||
<title>npm-folders</title>
|
||||
<meta charset="utf-8">
|
||||
<link rel="stylesheet" type="text/css" href="../../static/style.css">
|
||||
<link rel="canonical" href="https://www.npmjs.org/doc/files/npm-folders.html">
|
||||
<script async=true src="../../static/toc.js"></script>
|
||||
|
||||
<body>
|
||||
<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>
|
||||
<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>
|
||||
<p>The <code>prefix</code> config defaults to the location where node is installed.
|
||||
On most systems, this is <code>/usr/local</code>. 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>
|
||||
<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>Scoped packages are installed the same way, except they are grouped together
|
||||
in a sub-folder of the relevant <code>node_modules</code> folder with the name of that
|
||||
scope prefix by the @ symbol, e.g. <code>npm install @myorg/package</code> would place
|
||||
the package in <code>{prefix}/node_modules/@myorg/package</code>. See <code><a href="../misc/scope.html">scope(7)</a></code> for
|
||||
more details.</p>
|
||||
<p>If you wish to <code>require()</code> a package, then install it locally.</p>
|
||||
<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>
|
||||
<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>
|
||||
<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>
|
||||
<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>
|
||||
<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>
|
||||
<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>
|
||||
<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
|
||||
structure is: <code>foo/node_modules/bar/node_modules/baz</code>, there's no need to
|
||||
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>
|
||||
<p>Consider this dependency graph:</p>
|
||||
<pre><code>foo
|
||||
+-- blerg@1.2.5
|
||||
+-- bar@1.2.3
|
||||
| +-- blerg@1.x (latest=1.3.7)
|
||||
| +-- baz@2.x
|
||||
| | `-- quux@3.x
|
||||
| | `-- bar@1.2.3 (cycle)
|
||||
| `-- asdf@*
|
||||
`-- baz@1.2.3
|
||||
`-- quux@3.x
|
||||
`-- 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]
|
||||
+-- bar (1.2.3) <---[B]
|
||||
| `-- node_modules
|
||||
| +-- baz (2.0.2) <---[C]
|
||||
| | `-- node_modules
|
||||
| | `-- quux (3.2.0)
|
||||
| `-- 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
|
||||
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>
|
||||
<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>
|
||||
|
||||
</div>
|
||||
|
||||
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
|
||||
<tr><td style="width:180px;height:10px;background:rgb(237,127,127)" colspan=18> </td></tr>
|
||||
<tr><td rowspan=4 style="width:10px;height:10px;background:rgb(237,127,127)"> </td><td style="width:40px;height:10px;background:#fff" colspan=4> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=4> </td><td style="width:40px;height:10px;background:#fff" colspan=4> </td><td rowspan=4 style="width:10px;height:10px;background:rgb(237,127,127)"> </td><td colspan=6 style="width:60px;height:10px;background:#fff"> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=4> </td></tr>
|
||||
<tr><td colspan=2 style="width:20px;height:30px;background:#fff" rowspan=3> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:20px;height:10px;background:#fff" rowspan=4 colspan=2> </td><td style="width:10px;height:20px;background:rgb(237,127,127)" rowspan=2> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:20px;height:10px;background:#fff" rowspan=3 colspan=2> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td></tr>
|
||||
<tr><td style="width:10px;height:10px;background:#fff" rowspan=2> </td></tr>
|
||||
<tr><td style="width:10px;height:10px;background:#fff"> </td></tr>
|
||||
<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@2.15.12</p>
|
||||
|
||||
589
node_modules/npm/html/doc/files/npm-json.html
generated
vendored
Normal file
589
node_modules/npm/html/doc/files/npm-json.html
generated
vendored
Normal file
@@ -0,0 +1,589 @@
|
||||
<!doctype html>
|
||||
<html>
|
||||
<title>package.json</title>
|
||||
<meta charset="utf-8">
|
||||
<link rel="stylesheet" type="text/css" href="../../static/style.css">
|
||||
<link rel="canonical" href="https://www.npmjs.org/doc/files/package.json.html">
|
||||
<script async=true src="../../static/toc.js"></script>
|
||||
|
||||
<body>
|
||||
<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>
|
||||
<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.</p>
|
||||
<p>Some rules:</p>
|
||||
<ul>
|
||||
<li>The name must be less than or equal to 214 characters. This includes the scope for
|
||||
scoped packages.</li>
|
||||
<li>The name can't start with a dot or an underscore.</li>
|
||||
<li>New packages must not have uppercase letters in the name.</li>
|
||||
<li>The name ends up being part of a URL, an argument on the command line, and a
|
||||
folder name. Therefore, the name can't contain any non-URL-safe characters.</li>
|
||||
</ul>
|
||||
<p>Some tips:</p>
|
||||
<ul>
|
||||
<li>Don't use the same name as a core Node module.</li>
|
||||
<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 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="https://www.npmjs.com/">https://www.npmjs.com/</a></li>
|
||||
</ul>
|
||||
<p>A name can be optionally prefixed by a scope, e.g. <code>@myorg/mypackage</code>. See
|
||||
<code><a href="../misc/npm-scope.html">npm-scope(7)</a></code> for more detail.</p>
|
||||
<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" : "https://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,
|
||||
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>If you're using a common license such as BSD-2-Clause or MIT, add a
|
||||
current SPDX license identifier for 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>.
|
||||
Ideally you should pick one that is
|
||||
<a href="https://opensource.org/licenses/alphabetical">OSI</a> approved.</p>
|
||||
<p>If your package is licensed under multiple common licenses, use an <a href="https://npmjs.com/package/spdx">SPDX license
|
||||
expression syntax version 2.0 string</a>, like this:</p>
|
||||
<pre><code>{ "license" : "(ISC OR GPL-3.0)" }
|
||||
</code></pre><p>If you are using a license that hasn't been assigned an SPDX identifier, or if
|
||||
you are using a custom license, use a string value like this one:</p>
|
||||
<pre><code>{ "license" : "SEE LICENSE IN <filename>" }
|
||||
</code></pre><p>Then include a file named <code><filename></code> at the top level of the package.</p>
|
||||
<p>Some old packages used license objects or a "licenses" property containing an
|
||||
array of license objects:</p>
|
||||
<pre><code>// Not valid metadata
|
||||
{ "license" :
|
||||
{ "type" : "ISC"
|
||||
, "url" : "http://opensource.org/licenses/ISC"
|
||||
}
|
||||
}
|
||||
|
||||
// Not valid metadata
|
||||
{ "licenses" :
|
||||
[
|
||||
{ "type": "MIT"
|
||||
, "url": "http://www.opensource.org/licenses/mit-license.php"
|
||||
}
|
||||
, { "type": "Apache-2.0"
|
||||
, "url": "http://opensource.org/licenses/apache2.0.php"
|
||||
}
|
||||
]
|
||||
}
|
||||
</code></pre><p>Those styles are now deprecated. Instead, use SPDX expressions, like this:</p>
|
||||
<pre><code>{ "license": "ISC" }
|
||||
|
||||
{ "license": "(MIT OR Apache-2.0)" }
|
||||
</code></pre><p>Finally, if you do not wish to grant others the right to use a private or
|
||||
unpublished package under any terms:</p>
|
||||
<pre><code>{ "license": "UNLICENSED"}
|
||||
</code></pre><p>Consider also setting <code>"private": true</code> to prevent accidental publication.</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>
|
||||
<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 or
|
||||
in subdirectories, which will keep files from being included, even
|
||||
if they would be picked up by the files array. The <code>.npmignore</code> file
|
||||
works just like a <code>.gitignore</code>.</p>
|
||||
<p>Certain files are always included, regardless of settings:</p>
|
||||
<ul>
|
||||
<li><code>package.json</code></li>
|
||||
<li><code><a href="../../doc/README.html">README</a></code></li>
|
||||
<li><code>CHANGES</code> / <code>CHANGELOG</code> / <code>HISTORY</code> (any casing and file extension)</li>
|
||||
<li><code>LICENSE</code> / <code>LICENCE</code></li>
|
||||
<li>The file in the "main" field</li>
|
||||
</ul>
|
||||
<p>Conversely, some files are always ignored:</p>
|
||||
<ul>
|
||||
<li><code>.git</code></li>
|
||||
<li><code>CVS</code></li>
|
||||
<li><code>.svn</code></li>
|
||||
<li><code>.hg</code></li>
|
||||
<li><code>.lock-wscript</code></li>
|
||||
<li><code>.wafpickle-N</code></li>
|
||||
<li><code>.*.swp</code></li>
|
||||
<li><code>.DS_Store</code></li>
|
||||
<li><code>._*</code></li>
|
||||
<li><code>npm-debug.log</code></li>
|
||||
<li><code>.npmrc</code></li>
|
||||
<li><code>node_modules</code></li>
|
||||
</ul>
|
||||
<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, myapp could have this:</p>
|
||||
<pre><code>{ "bin" : { "myapp" : "./cli.js" } }
|
||||
</code></pre><p>So, when you install myapp, it'll create a symlink from the <code>cli.js</code> script to
|
||||
<code>/usr/local/bin/myapp</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>
|
||||
<pre><code>{ "name": "my-program"
|
||||
, "version": "1.2.5"
|
||||
, "bin" : { "my-program" : "./path/to/program" } }
|
||||
</code></pre><p>Please make sure that your file(s) referenced in <code>bin</code> starts with
|
||||
<code>#!/usr/bin/env node</code>, otherwise the scripts are started without the node
|
||||
executable!</p>
|
||||
<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>
|
||||
<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>
|
||||
<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>
|
||||
<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>
|
||||
object. If you look at <a href="https://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 <code>bin</code> directory in <code>directories.bin</code>, all the files in
|
||||
that folder will be added.</p>
|
||||
<p>Because of the way the <code>bin</code> directive works, specifying both a
|
||||
<code>bin</code> path and setting <code>directories.bin</code> is an error. If you want to
|
||||
specify individual files, use <code>bin</code>, and for all the files in an
|
||||
existing <code>bin</code> directory, use <code>directories.bin</code>.</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>
|
||||
<h3 id="directories-test">directories.test</h3>
|
||||
<p>Put your tests in here. It is currently not exposed, but it might be in the
|
||||
future.</p>
|
||||
<h2 id="repository">repository</h2>
|
||||
<p>Specify the place where your code lives. This is helpful for people who
|
||||
want to contribute. If the git repo is on GitHub, then the <code>npm docs</code>
|
||||
command will be able to find you.</p>
|
||||
<p>Do it like this:</p>
|
||||
<pre><code>"repository" :
|
||||
{ "type" : "git"
|
||||
, "url" : "https://github.com/npm/npm.git"
|
||||
}
|
||||
|
||||
"repository" :
|
||||
{ "type" : "svn"
|
||||
, "url" : "https://v8.googlecode.com/svn/trunk/"
|
||||
}
|
||||
</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>
|
||||
<p>For GitHub, GitHub gist, Bitbucket, or GitLab repositories you can use the same
|
||||
shortcut syntax you use for <code>npm install</code>:</p>
|
||||
<pre><code>"repository": "npm/npm"
|
||||
|
||||
"repository": "gist:11081aaa281"
|
||||
|
||||
"repository": "bitbucket:example/repo"
|
||||
|
||||
"repository": "gitlab:another/repo"
|
||||
</code></pre><h2 id="scripts">scripts</h2>
|
||||
<p>The "scripts" property is a dictionary containing 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" object 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
|
||||
<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 in a simple object that maps a package name to a
|
||||
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> object.</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>
|
||||
<li><code>tag</code> A specific version tagged and published as <code>tag</code> See <code><a href="../cli/npm-tag.html">npm-tag(1)</a></code></li>
|
||||
<li><code>path/path/path</code> See <a href="#local-paths">Local Paths</a> 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"
|
||||
, "baz" : ">1.0.2 <=2.3.4"
|
||||
, "boo" : "2.0.1"
|
||||
, "qux" : "<1.0.0 || >=2.3.1 <2.4.5 || >=2.5.2 <3.0.0"
|
||||
, "asd" : "http://asdf.com/asdf.tar.gz"
|
||||
, "til" : "~1.2"
|
||||
, "elf" : "~1.2.3"
|
||||
, "two" : "2.x"
|
||||
, "thr" : "3.3.x"
|
||||
, "lat" : "latest"
|
||||
, "dyl" : "file:../dyl"
|
||||
}
|
||||
}
|
||||
</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>
|
||||
<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
|
||||
an argument to <code>git checkout</code>. The default is <code>master</code>.</p>
|
||||
<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". Just as with git URLs, a <code>commit-ish</code> suffix can be
|
||||
included. For example:</p>
|
||||
<pre><code>{
|
||||
"name": "foo",
|
||||
"version": "0.0.0",
|
||||
"dependencies": {
|
||||
"express": "visionmedia/express",
|
||||
"mocha": "visionmedia/mocha#4727d357ea"
|
||||
}
|
||||
}
|
||||
</code></pre><h2 id="local-paths">Local Paths</h2>
|
||||
<p>As of version 2.0.0 you can provide a path to a local directory that contains a
|
||||
package. Local paths can be saved using <code>npm install --save</code>, using any of
|
||||
these forms:</p>
|
||||
<pre><code>../foo/bar
|
||||
~/foo/bar
|
||||
./foo/bar
|
||||
/foo/bar
|
||||
</code></pre><p>in which case they will be normalized to a relative path and added to your
|
||||
<code>package.json</code>. For example:</p>
|
||||
<pre><code>{
|
||||
"name": "baz",
|
||||
"dependencies": {
|
||||
"bar": "file:../foo/bar"
|
||||
}
|
||||
}
|
||||
</code></pre><p>This feature is helpful for local offline development and creating
|
||||
tests that require npm installing where you don't want to hit an
|
||||
external server, but should not be used when publishing packages
|
||||
to the public registry.</p>
|
||||
<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 map these additional items in a <code>devDependencies</code>
|
||||
object.</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",
|
||||
"devDependencies": {
|
||||
"coffee-script": "~1.6.3"
|
||||
},
|
||||
"scripts": {
|
||||
"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
|
||||
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>
|
||||
<p>In some cases, you want to express the compatibility of your package with a
|
||||
host tool or library, while not necessarily doing a <code>require</code> of this host.
|
||||
This is usually referred 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
|
||||
major version of the host package <code>tea</code> only. <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><strong>NOTE: npm versions 1 and 2 will automatically install <code>peerDependencies</code> if
|
||||
they are not explicitly depended upon higher in the dependency tree. In the
|
||||
next major version of npm (npm@3), this will no longer be the case. You will
|
||||
receive a warning that the peerDependency is not installed instead.</strong> The
|
||||
behavior in npms 1 & 2 was frequently confusing and could easily put you into
|
||||
dependency hell, a situation that npm is designed to avoid as much as possible.</p>
|
||||
<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>
|
||||
<p>This defines an array of package names that will be bundled when publishing the package.</p>
|
||||
<p>In cases where you need to preserve npm packages locally or have them available through a single file download, you can bundle the packages in a tarball file by specifying the package names in the <code>bundledDependencies</code> array and executing <code>npm pack</code>.</p>
|
||||
<p>For example:
|
||||
If we define a package.json like this:</p>
|
||||
<pre><code>{
|
||||
"name": "awesome-web-framework",
|
||||
"version": "1.0.0",
|
||||
"bundledDependencies": [
|
||||
'renderized', 'super-streams'
|
||||
]
|
||||
}
|
||||
</code></pre><p>we can obtain <code>awesome-web-framework-1.0.0.tgz</code> file by running <code>npm pack</code>. This file contains the dependencies <code>renderized</code> and <code>super-streams</code> which can be installed in a new project by executing <code>npm install awesome-web-framework-1.0.0.tgz</code>.</p>
|
||||
<p>If this is spelled <code>"bundleDependencies"</code>, then that is also honored.</p>
|
||||
<h2 id="optionaldependencies">optionalDependencies</h2>
|
||||
<p>If a dependency can be used, but you would like npm to proceed if it cannot be
|
||||
found or fails to install, then you may put it in the <code>optionalDependencies</code>
|
||||
object. This is a map of package name to version or url, just like the
|
||||
<code>dependencies</code> object. The difference is that build failures do not cause
|
||||
installation to fail.</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
|
||||
} catch (er) {
|
||||
foo = null
|
||||
}
|
||||
if ( notGoodFooVersion(fooVersion) ) {
|
||||
foo = null
|
||||
}
|
||||
|
||||
// .. then later in your program ..
|
||||
|
||||
if (foo) {
|
||||
foo.doFooThings()
|
||||
}
|
||||
</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
|
||||
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>Unless the user has set the <code>engine-strict</code> config flag, this
|
||||
field is advisory only will produce warnings when your package is installed as a dependency.</p>
|
||||
<h2 id="enginestrict">engineStrict</h2>
|
||||
<p><strong>NOTE: This feature is deprecated and will be removed in npm 3.0.0.</strong></p>
|
||||
<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> object,
|
||||
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 object 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.</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,
|
||||
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>
|
||||
<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>
|
||||
<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> dictionary described below to override the <code>registry</code> config
|
||||
param at publish-time.</p>
|
||||
<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, registry or access, so that
|
||||
you can ensure that a given package is not tagged with "latest", published
|
||||
to the global public registry or that a scoped module is private by default.</p>
|
||||
<p>Any config values can be overridden, but of course only "tag", "registry" and
|
||||
"access" 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>
|
||||
<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":{"install": "node-gyp rebuild"}</code></p>
|
||||
<p>If there is a <code>binding.gyp</code> file in the root of your package and you have not defined an <code>install</code> or <code>preinstall</code> script, npm will
|
||||
default the <code>install</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>
|
||||
<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-uninstall.html">npm-uninstall(1)</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
|
||||
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
|
||||
<tr><td style="width:180px;height:10px;background:rgb(237,127,127)" colspan=18> </td></tr>
|
||||
<tr><td rowspan=4 style="width:10px;height:10px;background:rgb(237,127,127)"> </td><td style="width:40px;height:10px;background:#fff" colspan=4> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=4> </td><td style="width:40px;height:10px;background:#fff" colspan=4> </td><td rowspan=4 style="width:10px;height:10px;background:rgb(237,127,127)"> </td><td colspan=6 style="width:60px;height:10px;background:#fff"> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=4> </td></tr>
|
||||
<tr><td colspan=2 style="width:20px;height:30px;background:#fff" rowspan=3> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:20px;height:10px;background:#fff" rowspan=4 colspan=2> </td><td style="width:10px;height:20px;background:rgb(237,127,127)" rowspan=2> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:20px;height:10px;background:#fff" rowspan=3 colspan=2> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td></tr>
|
||||
<tr><td style="width:10px;height:10px;background:#fff" rowspan=2> </td></tr>
|
||||
<tr><td style="width:10px;height:10px;background:#fff"> </td></tr>
|
||||
<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@2.15.12</p>
|
||||
|
||||
93
node_modules/npm/html/doc/files/npmrc.html
generated
vendored
Normal file
93
node_modules/npm/html/doc/files/npmrc.html
generated
vendored
Normal file
@@ -0,0 +1,93 @@
|
||||
<!doctype html>
|
||||
<html>
|
||||
<title>npmrc</title>
|
||||
<meta charset="utf-8">
|
||||
<link rel="stylesheet" type="text/css" href="../../static/style.css">
|
||||
<link rel="canonical" href="https://www.npmjs.org/doc/files/npmrc.html">
|
||||
<script async=true src="../../static/toc.js"></script>
|
||||
|
||||
<body>
|
||||
<div id="wrapper">
|
||||
|
||||
<h1><a href="../files/npmrc.html">npmrc</a></h1> <p>The npm config files</p>
|
||||
<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>
|
||||
<p>The four relevant files are:</p>
|
||||
<ul>
|
||||
<li>per-project config file (/path/to/my/project/.npmrc)</li>
|
||||
<li>per-user config file (~/.npmrc)</li>
|
||||
<li>global config file ($PREFIX/etc/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
|
||||
priority order. For example, a setting in the userconfig file would
|
||||
override the setting in the globalconfig file.</p>
|
||||
<p>Array values are specified by adding "[]" after the key name. For
|
||||
example:</p>
|
||||
<pre><code>key[] = "first value"
|
||||
key[] = "second value"
|
||||
</code></pre><p><strong>NOTE:</strong> Because local (per-project or per-user) <code>.npmrc</code> files can contain
|
||||
sensitive credentials, they must be readable and writable <em>only</em> by your user
|
||||
account (i.e. must have a mode of <code>0600</code>), otherwise they <em>will be ignored by
|
||||
npm!</em></p>
|
||||
<h4 id="comments">Comments</h4>
|
||||
<p>Lines in <code>.npmrc</code> files are interpreted as comments when they begin with a <code>;</code> or <code>#</code> character. <code>.npmrc</code> files are parsed by <a href="https://github.com/npm/ini">npm/ini</a>, which specifies this comment syntax.</p>
|
||||
<p>For example:</p>
|
||||
<pre><code># last modified: 01 Jan 2016
|
||||
; Set a new registry for a scoped package
|
||||
@myscope:registry=https://mycustomregistry.example.org
|
||||
</code></pre><h3 id="per-project-config-file">Per-project config file</h3>
|
||||
<p>When working locally in a project, a <code>.npmrc</code> file in the root of the
|
||||
project (ie, a sibling of <code>node_modules</code> and <code>package.json</code>) will set
|
||||
config values specific to this project.</p>
|
||||
<p>Note that this only applies to the root of the project that you're
|
||||
running npm in. It has no effect when your module is published. For
|
||||
example, you can't publish a module that forces itself to install
|
||||
globally, or in a different location.</p>
|
||||
<p>Additionally, this file is not read in global mode, such as when running
|
||||
<code>npm install -g</code>.</p>
|
||||
<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>
|
||||
<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>
|
||||
<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>
|
||||
|
||||
</div>
|
||||
|
||||
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
|
||||
<tr><td style="width:180px;height:10px;background:rgb(237,127,127)" colspan=18> </td></tr>
|
||||
<tr><td rowspan=4 style="width:10px;height:10px;background:rgb(237,127,127)"> </td><td style="width:40px;height:10px;background:#fff" colspan=4> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=4> </td><td style="width:40px;height:10px;background:#fff" colspan=4> </td><td rowspan=4 style="width:10px;height:10px;background:rgb(237,127,127)"> </td><td colspan=6 style="width:60px;height:10px;background:#fff"> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=4> </td></tr>
|
||||
<tr><td colspan=2 style="width:20px;height:30px;background:#fff" rowspan=3> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:20px;height:10px;background:#fff" rowspan=4 colspan=2> </td><td style="width:10px;height:20px;background:rgb(237,127,127)" rowspan=2> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:20px;height:10px;background:#fff" rowspan=3 colspan=2> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td></tr>
|
||||
<tr><td style="width:10px;height:10px;background:#fff" rowspan=2> </td></tr>
|
||||
<tr><td style="width:10px;height:10px;background:#fff"> </td></tr>
|
||||
<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@2.15.12</p>
|
||||
|
||||
589
node_modules/npm/html/doc/files/package.json.html
generated
vendored
Normal file
589
node_modules/npm/html/doc/files/package.json.html
generated
vendored
Normal file
@@ -0,0 +1,589 @@
|
||||
<!doctype html>
|
||||
<html>
|
||||
<title>package.json</title>
|
||||
<meta charset="utf-8">
|
||||
<link rel="stylesheet" type="text/css" href="../../static/style.css">
|
||||
<link rel="canonical" href="https://www.npmjs.org/doc/files/package.json.html">
|
||||
<script async=true src="../../static/toc.js"></script>
|
||||
|
||||
<body>
|
||||
<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>
|
||||
<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.</p>
|
||||
<p>Some rules:</p>
|
||||
<ul>
|
||||
<li>The name must be less than or equal to 214 characters. This includes the scope for
|
||||
scoped packages.</li>
|
||||
<li>The name can't start with a dot or an underscore.</li>
|
||||
<li>New packages must not have uppercase letters in the name.</li>
|
||||
<li>The name ends up being part of a URL, an argument on the command line, and a
|
||||
folder name. Therefore, the name can't contain any non-URL-safe characters.</li>
|
||||
</ul>
|
||||
<p>Some tips:</p>
|
||||
<ul>
|
||||
<li>Don't use the same name as a core Node module.</li>
|
||||
<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 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="https://www.npmjs.com/">https://www.npmjs.com/</a></li>
|
||||
</ul>
|
||||
<p>A name can be optionally prefixed by a scope, e.g. <code>@myorg/mypackage</code>. See
|
||||
<code><a href="../misc/npm-scope.html">npm-scope(7)</a></code> for more detail.</p>
|
||||
<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" : "https://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,
|
||||
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>If you're using a common license such as BSD-2-Clause or MIT, add a
|
||||
current SPDX license identifier for 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>.
|
||||
Ideally you should pick one that is
|
||||
<a href="https://opensource.org/licenses/alphabetical">OSI</a> approved.</p>
|
||||
<p>If your package is licensed under multiple common licenses, use an <a href="https://npmjs.com/package/spdx">SPDX license
|
||||
expression syntax version 2.0 string</a>, like this:</p>
|
||||
<pre><code>{ "license" : "(ISC OR GPL-3.0)" }
|
||||
</code></pre><p>If you are using a license that hasn't been assigned an SPDX identifier, or if
|
||||
you are using a custom license, use a string value like this one:</p>
|
||||
<pre><code>{ "license" : "SEE LICENSE IN <filename>" }
|
||||
</code></pre><p>Then include a file named <code><filename></code> at the top level of the package.</p>
|
||||
<p>Some old packages used license objects or a "licenses" property containing an
|
||||
array of license objects:</p>
|
||||
<pre><code>// Not valid metadata
|
||||
{ "license" :
|
||||
{ "type" : "ISC"
|
||||
, "url" : "http://opensource.org/licenses/ISC"
|
||||
}
|
||||
}
|
||||
|
||||
// Not valid metadata
|
||||
{ "licenses" :
|
||||
[
|
||||
{ "type": "MIT"
|
||||
, "url": "http://www.opensource.org/licenses/mit-license.php"
|
||||
}
|
||||
, { "type": "Apache-2.0"
|
||||
, "url": "http://opensource.org/licenses/apache2.0.php"
|
||||
}
|
||||
]
|
||||
}
|
||||
</code></pre><p>Those styles are now deprecated. Instead, use SPDX expressions, like this:</p>
|
||||
<pre><code>{ "license": "ISC" }
|
||||
|
||||
{ "license": "(MIT OR Apache-2.0)" }
|
||||
</code></pre><p>Finally, if you do not wish to grant others the right to use a private or
|
||||
unpublished package under any terms:</p>
|
||||
<pre><code>{ "license": "UNLICENSED"}
|
||||
</code></pre><p>Consider also setting <code>"private": true</code> to prevent accidental publication.</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>
|
||||
<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 or
|
||||
in subdirectories, which will keep files from being included, even
|
||||
if they would be picked up by the files array. The <code>.npmignore</code> file
|
||||
works just like a <code>.gitignore</code>.</p>
|
||||
<p>Certain files are always included, regardless of settings:</p>
|
||||
<ul>
|
||||
<li><code>package.json</code></li>
|
||||
<li><code><a href="../../doc/README.html">README</a></code></li>
|
||||
<li><code>CHANGES</code> / <code>CHANGELOG</code> / <code>HISTORY</code> (any casing and file extension)</li>
|
||||
<li><code>LICENSE</code> / <code>LICENCE</code></li>
|
||||
<li>The file in the "main" field</li>
|
||||
</ul>
|
||||
<p>Conversely, some files are always ignored:</p>
|
||||
<ul>
|
||||
<li><code>.git</code></li>
|
||||
<li><code>CVS</code></li>
|
||||
<li><code>.svn</code></li>
|
||||
<li><code>.hg</code></li>
|
||||
<li><code>.lock-wscript</code></li>
|
||||
<li><code>.wafpickle-N</code></li>
|
||||
<li><code>.*.swp</code></li>
|
||||
<li><code>.DS_Store</code></li>
|
||||
<li><code>._*</code></li>
|
||||
<li><code>npm-debug.log</code></li>
|
||||
<li><code>.npmrc</code></li>
|
||||
<li><code>node_modules</code></li>
|
||||
</ul>
|
||||
<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, myapp could have this:</p>
|
||||
<pre><code>{ "bin" : { "myapp" : "./cli.js" } }
|
||||
</code></pre><p>So, when you install myapp, it'll create a symlink from the <code>cli.js</code> script to
|
||||
<code>/usr/local/bin/myapp</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>
|
||||
<pre><code>{ "name": "my-program"
|
||||
, "version": "1.2.5"
|
||||
, "bin" : { "my-program" : "./path/to/program" } }
|
||||
</code></pre><p>Please make sure that your file(s) referenced in <code>bin</code> starts with
|
||||
<code>#!/usr/bin/env node</code>, otherwise the scripts are started without the node
|
||||
executable!</p>
|
||||
<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>
|
||||
<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>
|
||||
<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>
|
||||
<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>
|
||||
object. If you look at <a href="https://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 <code>bin</code> directory in <code>directories.bin</code>, all the files in
|
||||
that folder will be added.</p>
|
||||
<p>Because of the way the <code>bin</code> directive works, specifying both a
|
||||
<code>bin</code> path and setting <code>directories.bin</code> is an error. If you want to
|
||||
specify individual files, use <code>bin</code>, and for all the files in an
|
||||
existing <code>bin</code> directory, use <code>directories.bin</code>.</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>
|
||||
<h3 id="directories-test">directories.test</h3>
|
||||
<p>Put your tests in here. It is currently not exposed, but it might be in the
|
||||
future.</p>
|
||||
<h2 id="repository">repository</h2>
|
||||
<p>Specify the place where your code lives. This is helpful for people who
|
||||
want to contribute. If the git repo is on GitHub, then the <code>npm docs</code>
|
||||
command will be able to find you.</p>
|
||||
<p>Do it like this:</p>
|
||||
<pre><code>"repository" :
|
||||
{ "type" : "git"
|
||||
, "url" : "https://github.com/npm/npm.git"
|
||||
}
|
||||
|
||||
"repository" :
|
||||
{ "type" : "svn"
|
||||
, "url" : "https://v8.googlecode.com/svn/trunk/"
|
||||
}
|
||||
</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>
|
||||
<p>For GitHub, GitHub gist, Bitbucket, or GitLab repositories you can use the same
|
||||
shortcut syntax you use for <code>npm install</code>:</p>
|
||||
<pre><code>"repository": "npm/npm"
|
||||
|
||||
"repository": "gist:11081aaa281"
|
||||
|
||||
"repository": "bitbucket:example/repo"
|
||||
|
||||
"repository": "gitlab:another/repo"
|
||||
</code></pre><h2 id="scripts">scripts</h2>
|
||||
<p>The "scripts" property is a dictionary containing 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" object 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
|
||||
<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 in a simple object that maps a package name to a
|
||||
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> object.</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>
|
||||
<li><code>tag</code> A specific version tagged and published as <code>tag</code> See <code><a href="../cli/npm-tag.html">npm-tag(1)</a></code></li>
|
||||
<li><code>path/path/path</code> See <a href="#local-paths">Local Paths</a> 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"
|
||||
, "baz" : ">1.0.2 <=2.3.4"
|
||||
, "boo" : "2.0.1"
|
||||
, "qux" : "<1.0.0 || >=2.3.1 <2.4.5 || >=2.5.2 <3.0.0"
|
||||
, "asd" : "http://asdf.com/asdf.tar.gz"
|
||||
, "til" : "~1.2"
|
||||
, "elf" : "~1.2.3"
|
||||
, "two" : "2.x"
|
||||
, "thr" : "3.3.x"
|
||||
, "lat" : "latest"
|
||||
, "dyl" : "file:../dyl"
|
||||
}
|
||||
}
|
||||
</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>
|
||||
<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
|
||||
an argument to <code>git checkout</code>. The default is <code>master</code>.</p>
|
||||
<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". Just as with git URLs, a <code>commit-ish</code> suffix can be
|
||||
included. For example:</p>
|
||||
<pre><code>{
|
||||
"name": "foo",
|
||||
"version": "0.0.0",
|
||||
"dependencies": {
|
||||
"express": "visionmedia/express",
|
||||
"mocha": "visionmedia/mocha#4727d357ea"
|
||||
}
|
||||
}
|
||||
</code></pre><h2 id="local-paths">Local Paths</h2>
|
||||
<p>As of version 2.0.0 you can provide a path to a local directory that contains a
|
||||
package. Local paths can be saved using <code>npm install --save</code>, using any of
|
||||
these forms:</p>
|
||||
<pre><code>../foo/bar
|
||||
~/foo/bar
|
||||
./foo/bar
|
||||
/foo/bar
|
||||
</code></pre><p>in which case they will be normalized to a relative path and added to your
|
||||
<code>package.json</code>. For example:</p>
|
||||
<pre><code>{
|
||||
"name": "baz",
|
||||
"dependencies": {
|
||||
"bar": "file:../foo/bar"
|
||||
}
|
||||
}
|
||||
</code></pre><p>This feature is helpful for local offline development and creating
|
||||
tests that require npm installing where you don't want to hit an
|
||||
external server, but should not be used when publishing packages
|
||||
to the public registry.</p>
|
||||
<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 map these additional items in a <code>devDependencies</code>
|
||||
object.</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",
|
||||
"devDependencies": {
|
||||
"coffee-script": "~1.6.3"
|
||||
},
|
||||
"scripts": {
|
||||
"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
|
||||
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>
|
||||
<p>In some cases, you want to express the compatibility of your package with a
|
||||
host tool or library, while not necessarily doing a <code>require</code> of this host.
|
||||
This is usually referred 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
|
||||
major version of the host package <code>tea</code> only. <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><strong>NOTE: npm versions 1 and 2 will automatically install <code>peerDependencies</code> if
|
||||
they are not explicitly depended upon higher in the dependency tree. In the
|
||||
next major version of npm (npm@3), this will no longer be the case. You will
|
||||
receive a warning that the peerDependency is not installed instead.</strong> The
|
||||
behavior in npms 1 & 2 was frequently confusing and could easily put you into
|
||||
dependency hell, a situation that npm is designed to avoid as much as possible.</p>
|
||||
<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>
|
||||
<p>This defines an array of package names that will be bundled when publishing the package.</p>
|
||||
<p>In cases where you need to preserve npm packages locally or have them available through a single file download, you can bundle the packages in a tarball file by specifying the package names in the <code>bundledDependencies</code> array and executing <code>npm pack</code>.</p>
|
||||
<p>For example:
|
||||
If we define a package.json like this:</p>
|
||||
<pre><code>{
|
||||
"name": "awesome-web-framework",
|
||||
"version": "1.0.0",
|
||||
"bundledDependencies": [
|
||||
'renderized', 'super-streams'
|
||||
]
|
||||
}
|
||||
</code></pre><p>we can obtain <code>awesome-web-framework-1.0.0.tgz</code> file by running <code>npm pack</code>. This file contains the dependencies <code>renderized</code> and <code>super-streams</code> which can be installed in a new project by executing <code>npm install awesome-web-framework-1.0.0.tgz</code>.</p>
|
||||
<p>If this is spelled <code>"bundleDependencies"</code>, then that is also honored.</p>
|
||||
<h2 id="optionaldependencies">optionalDependencies</h2>
|
||||
<p>If a dependency can be used, but you would like npm to proceed if it cannot be
|
||||
found or fails to install, then you may put it in the <code>optionalDependencies</code>
|
||||
object. This is a map of package name to version or url, just like the
|
||||
<code>dependencies</code> object. The difference is that build failures do not cause
|
||||
installation to fail.</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
|
||||
} catch (er) {
|
||||
foo = null
|
||||
}
|
||||
if ( notGoodFooVersion(fooVersion) ) {
|
||||
foo = null
|
||||
}
|
||||
|
||||
// .. then later in your program ..
|
||||
|
||||
if (foo) {
|
||||
foo.doFooThings()
|
||||
}
|
||||
</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
|
||||
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>Unless the user has set the <code>engine-strict</code> config flag, this
|
||||
field is advisory only will produce warnings when your package is installed as a dependency.</p>
|
||||
<h2 id="enginestrict">engineStrict</h2>
|
||||
<p><strong>NOTE: This feature is deprecated and will be removed in npm 3.0.0.</strong></p>
|
||||
<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> object,
|
||||
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 object 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.</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,
|
||||
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>
|
||||
<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>
|
||||
<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> dictionary described below to override the <code>registry</code> config
|
||||
param at publish-time.</p>
|
||||
<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, registry or access, so that
|
||||
you can ensure that a given package is not tagged with "latest", published
|
||||
to the global public registry or that a scoped module is private by default.</p>
|
||||
<p>Any config values can be overridden, but of course only "tag", "registry" and
|
||||
"access" 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>
|
||||
<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":{"install": "node-gyp rebuild"}</code></p>
|
||||
<p>If there is a <code>binding.gyp</code> file in the root of your package and you have not defined an <code>install</code> or <code>preinstall</code> script, npm will
|
||||
default the <code>install</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>
|
||||
<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-uninstall.html">npm-uninstall(1)</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
|
||||
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
|
||||
<tr><td style="width:180px;height:10px;background:rgb(237,127,127)" colspan=18> </td></tr>
|
||||
<tr><td rowspan=4 style="width:10px;height:10px;background:rgb(237,127,127)"> </td><td style="width:40px;height:10px;background:#fff" colspan=4> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=4> </td><td style="width:40px;height:10px;background:#fff" colspan=4> </td><td rowspan=4 style="width:10px;height:10px;background:rgb(237,127,127)"> </td><td colspan=6 style="width:60px;height:10px;background:#fff"> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=4> </td></tr>
|
||||
<tr><td colspan=2 style="width:20px;height:30px;background:#fff" rowspan=3> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:20px;height:10px;background:#fff" rowspan=4 colspan=2> </td><td style="width:10px;height:20px;background:rgb(237,127,127)" rowspan=2> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:20px;height:10px;background:#fff" rowspan=3 colspan=2> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td></tr>
|
||||
<tr><td style="width:10px;height:10px;background:#fff" rowspan=2> </td></tr>
|
||||
<tr><td style="width:10px;height:10px;background:#fff"> </td></tr>
|
||||
<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@2.15.12</p>
|
||||
|
||||
246
node_modules/npm/html/doc/index.html
generated
vendored
Normal file
246
node_modules/npm/html/doc/index.html
generated
vendored
Normal file
@@ -0,0 +1,246 @@
|
||||
<!doctype html>
|
||||
<html>
|
||||
<title>npm-index</title>
|
||||
<meta charset="utf-8">
|
||||
<link rel="stylesheet" type="text/css" href="../static/style.css">
|
||||
<link rel="canonical" href="https://www.npmjs.org/doc/index.html">
|
||||
<script async=true src="../../static/toc.js"></script>
|
||||
|
||||
<body>
|
||||
<div id="wrapper">
|
||||
|
||||
<h1><a href="misc/npm-index.html">npm-index</a></h1> <p>Index of all npm documentation</p>
|
||||
<h3 id="readme-1-"><a href="../doc/README.html">README</a></h3>
|
||||
<p>a JavaScript package manager</p>
|
||||
<h2 id="command-line-documentation">Command Line Documentation</h2>
|
||||
<p>Using npm on the command line</p>
|
||||
<h3 id="npm-1-"><a href="cli/npm.html">npm(1)</a></h3>
|
||||
<p>javascript package manager</p>
|
||||
<h3 id="npm-access-1-"><a href="cli/npm-access.html">npm-access(1)</a></h3>
|
||||
<p>Set access level on published packages</p>
|
||||
<h3 id="npm-adduser-1-"><a href="cli/npm-adduser.html">npm-adduser(1)</a></h3>
|
||||
<p>Add a registry user account</p>
|
||||
<h3 id="npm-bin-1-"><a href="cli/npm-bin.html">npm-bin(1)</a></h3>
|
||||
<p>Display npm bin folder</p>
|
||||
<h3 id="npm-bugs-1-"><a href="cli/npm-bugs.html">npm-bugs(1)</a></h3>
|
||||
<p>Bugs for a package in a web browser maybe</p>
|
||||
<h3 id="npm-build-1-"><a href="cli/npm-build.html">npm-build(1)</a></h3>
|
||||
<p>Build a package</p>
|
||||
<h3 id="npm-bundle-1-"><a href="cli/npm-bundle.html">npm-bundle(1)</a></h3>
|
||||
<p>REMOVED</p>
|
||||
<h3 id="npm-cache-1-"><a href="cli/npm-cache.html">npm-cache(1)</a></h3>
|
||||
<p>Manipulates packages cache</p>
|
||||
<h3 id="npm-completion-1-"><a href="cli/npm-completion.html">npm-completion(1)</a></h3>
|
||||
<p>Tab Completion for npm</p>
|
||||
<h3 id="npm-config-1-"><a href="cli/npm-config.html">npm-config(1)</a></h3>
|
||||
<p>Manage the npm configuration files</p>
|
||||
<h3 id="npm-dedupe-1-"><a href="cli/npm-dedupe.html">npm-dedupe(1)</a></h3>
|
||||
<p>Reduce duplication</p>
|
||||
<h3 id="npm-deprecate-1-"><a href="cli/npm-deprecate.html">npm-deprecate(1)</a></h3>
|
||||
<p>Deprecate a version of a package</p>
|
||||
<h3 id="npm-dist-tag-1-"><a href="cli/npm-dist-tag.html">npm-dist-tag(1)</a></h3>
|
||||
<p>Modify package distribution tags</p>
|
||||
<h3 id="npm-docs-1-"><a href="cli/npm-docs.html">npm-docs(1)</a></h3>
|
||||
<p>Docs for a package in a web browser maybe</p>
|
||||
<h3 id="npm-edit-1-"><a href="cli/npm-edit.html">npm-edit(1)</a></h3>
|
||||
<p>Edit an installed package</p>
|
||||
<h3 id="npm-explore-1-"><a href="cli/npm-explore.html">npm-explore(1)</a></h3>
|
||||
<p>Browse an installed package</p>
|
||||
<h3 id="npm-help-search-1-"><a href="cli/npm-help-search.html">npm-help-search(1)</a></h3>
|
||||
<p>Search npm help documentation</p>
|
||||
<h3 id="npm-help-1-"><a href="cli/npm-help.html">npm-help(1)</a></h3>
|
||||
<p>Get help on npm</p>
|
||||
<h3 id="npm-init-1-"><a href="cli/npm-init.html">npm-init(1)</a></h3>
|
||||
<p>Interactively create a package.json file</p>
|
||||
<h3 id="npm-install-1-"><a href="cli/npm-install.html">npm-install(1)</a></h3>
|
||||
<p>Install a package</p>
|
||||
<h3 id="npm-link-1-"><a href="cli/npm-link.html">npm-link(1)</a></h3>
|
||||
<p>Symlink a package folder</p>
|
||||
<h3 id="npm-logout-1-"><a href="cli/npm-logout.html">npm-logout(1)</a></h3>
|
||||
<p>Log out of the registry</p>
|
||||
<h3 id="npm-ls-1-"><a href="cli/npm-ls.html">npm-ls(1)</a></h3>
|
||||
<p>List installed packages</p>
|
||||
<h3 id="npm-outdated-1-"><a href="cli/npm-outdated.html">npm-outdated(1)</a></h3>
|
||||
<p>Check for outdated packages</p>
|
||||
<h3 id="npm-owner-1-"><a href="cli/npm-owner.html">npm-owner(1)</a></h3>
|
||||
<p>Manage package owners</p>
|
||||
<h3 id="npm-pack-1-"><a href="cli/npm-pack.html">npm-pack(1)</a></h3>
|
||||
<p>Create a tarball from a package</p>
|
||||
<h3 id="npm-ping-1-"><a href="cli/npm-ping.html">npm-ping(1)</a></h3>
|
||||
<p>Ping npm registry</p>
|
||||
<h3 id="npm-prefix-1-"><a href="cli/npm-prefix.html">npm-prefix(1)</a></h3>
|
||||
<p>Display prefix</p>
|
||||
<h3 id="npm-prune-1-"><a href="cli/npm-prune.html">npm-prune(1)</a></h3>
|
||||
<p>Remove extraneous packages</p>
|
||||
<h3 id="npm-publish-1-"><a href="cli/npm-publish.html">npm-publish(1)</a></h3>
|
||||
<p>Publish a package</p>
|
||||
<h3 id="npm-rebuild-1-"><a href="cli/npm-rebuild.html">npm-rebuild(1)</a></h3>
|
||||
<p>Rebuild a package</p>
|
||||
<h3 id="npm-repo-1-"><a href="cli/npm-repo.html">npm-repo(1)</a></h3>
|
||||
<p>Open package repository page in the browser</p>
|
||||
<h3 id="npm-restart-1-"><a href="cli/npm-restart.html">npm-restart(1)</a></h3>
|
||||
<p>Restart a package</p>
|
||||
<h3 id="npm-rm-1-"><a href="cli/npm-rm.html">npm-rm(1)</a></h3>
|
||||
<p>Remove a package</p>
|
||||
<h3 id="npm-root-1-"><a href="cli/npm-root.html">npm-root(1)</a></h3>
|
||||
<p>Display npm root</p>
|
||||
<h3 id="npm-run-script-1-"><a href="cli/npm-run-script.html">npm-run-script(1)</a></h3>
|
||||
<p>Run arbitrary package scripts</p>
|
||||
<h3 id="npm-search-1-"><a href="cli/npm-search.html">npm-search(1)</a></h3>
|
||||
<p>Search for packages</p>
|
||||
<h3 id="npm-shrinkwrap-1-"><a href="cli/npm-shrinkwrap.html">npm-shrinkwrap(1)</a></h3>
|
||||
<p>Lock down dependency versions</p>
|
||||
<h3 id="npm-star-1-"><a href="cli/npm-star.html">npm-star(1)</a></h3>
|
||||
<p>Mark your favorite packages</p>
|
||||
<h3 id="npm-stars-1-"><a href="cli/npm-stars.html">npm-stars(1)</a></h3>
|
||||
<p>View packages marked as favorites</p>
|
||||
<h3 id="npm-start-1-"><a href="cli/npm-start.html">npm-start(1)</a></h3>
|
||||
<p>Start a package</p>
|
||||
<h3 id="npm-stop-1-"><a href="cli/npm-stop.html">npm-stop(1)</a></h3>
|
||||
<p>Stop a package</p>
|
||||
<h3 id="npm-tag-1-"><a href="cli/npm-tag.html">npm-tag(1)</a></h3>
|
||||
<p>Tag a published version</p>
|
||||
<h3 id="npm-team-1-"><a href="cli/npm-team.html">npm-team(1)</a></h3>
|
||||
<p>Manage organization teams and team memberships</p>
|
||||
<h3 id="npm-test-1-"><a href="cli/npm-test.html">npm-test(1)</a></h3>
|
||||
<p>Test a package</p>
|
||||
<h3 id="npm-uninstall-1-"><a href="cli/npm-uninstall.html">npm-uninstall(1)</a></h3>
|
||||
<p>Remove a package</p>
|
||||
<h3 id="npm-unpublish-1-"><a href="cli/npm-unpublish.html">npm-unpublish(1)</a></h3>
|
||||
<p>Remove a package from the registry</p>
|
||||
<h3 id="npm-update-1-"><a href="cli/npm-update.html">npm-update(1)</a></h3>
|
||||
<p>Update a package</p>
|
||||
<h3 id="npm-version-1-"><a href="cli/npm-version.html">npm-version(1)</a></h3>
|
||||
<p>Bump a package version</p>
|
||||
<h3 id="npm-view-1-"><a href="cli/npm-view.html">npm-view(1)</a></h3>
|
||||
<p>View registry info</p>
|
||||
<h3 id="npm-whoami-1-"><a href="cli/npm-whoami.html">npm-whoami(1)</a></h3>
|
||||
<p>Display npm username</p>
|
||||
<h2 id="api-documentation">API Documentation</h2>
|
||||
<p>Using npm in your Node programs</p>
|
||||
<h3 id="npm-3-"><a href="api/npm.html">npm(3)</a></h3>
|
||||
<p>javascript package manager</p>
|
||||
<h3 id="npm-bin-3-"><a href="api/npm-bin.html">npm-bin(3)</a></h3>
|
||||
<p>Display npm bin folder</p>
|
||||
<h3 id="npm-bugs-3-"><a href="api/npm-bugs.html">npm-bugs(3)</a></h3>
|
||||
<p>Bugs for a package in a web browser maybe</p>
|
||||
<h3 id="npm-cache-3-"><a href="api/npm-cache.html">npm-cache(3)</a></h3>
|
||||
<p>manage the npm cache programmatically</p>
|
||||
<h3 id="npm-commands-3-"><a href="api/npm-commands.html">npm-commands(3)</a></h3>
|
||||
<p>npm commands</p>
|
||||
<h3 id="npm-config-3-"><a href="api/npm-config.html">npm-config(3)</a></h3>
|
||||
<p>Manage the npm configuration files</p>
|
||||
<h3 id="npm-deprecate-3-"><a href="api/npm-deprecate.html">npm-deprecate(3)</a></h3>
|
||||
<p>Deprecate a version of a package</p>
|
||||
<h3 id="npm-docs-3-"><a href="api/npm-docs.html">npm-docs(3)</a></h3>
|
||||
<p>Docs for a package in a web browser maybe</p>
|
||||
<h3 id="npm-edit-3-"><a href="api/npm-edit.html">npm-edit(3)</a></h3>
|
||||
<p>Edit an installed package</p>
|
||||
<h3 id="npm-explore-3-"><a href="api/npm-explore.html">npm-explore(3)</a></h3>
|
||||
<p>Browse an installed package</p>
|
||||
<h3 id="npm-help-search-3-"><a href="api/npm-help-search.html">npm-help-search(3)</a></h3>
|
||||
<p>Search the help pages</p>
|
||||
<h3 id="npm-init-3-"><a href="api/npm-init.html">npm-init(3)</a></h3>
|
||||
<p>Interactively create a package.json file</p>
|
||||
<h3 id="npm-install-3-"><a href="api/npm-install.html">npm-install(3)</a></h3>
|
||||
<p>install a package programmatically</p>
|
||||
<h3 id="npm-link-3-"><a href="api/npm-link.html">npm-link(3)</a></h3>
|
||||
<p>Symlink a package folder</p>
|
||||
<h3 id="npm-load-3-"><a href="api/npm-load.html">npm-load(3)</a></h3>
|
||||
<p>Load config settings</p>
|
||||
<h3 id="npm-ls-3-"><a href="api/npm-ls.html">npm-ls(3)</a></h3>
|
||||
<p>List installed packages</p>
|
||||
<h3 id="npm-outdated-3-"><a href="api/npm-outdated.html">npm-outdated(3)</a></h3>
|
||||
<p>Check for outdated packages</p>
|
||||
<h3 id="npm-owner-3-"><a href="api/npm-owner.html">npm-owner(3)</a></h3>
|
||||
<p>Manage package owners</p>
|
||||
<h3 id="npm-pack-3-"><a href="api/npm-pack.html">npm-pack(3)</a></h3>
|
||||
<p>Create a tarball from a package</p>
|
||||
<h3 id="npm-ping-3-"><a href="api/npm-ping.html">npm-ping(3)</a></h3>
|
||||
<p>Ping npm registry</p>
|
||||
<h3 id="npm-prefix-3-"><a href="api/npm-prefix.html">npm-prefix(3)</a></h3>
|
||||
<p>Display prefix</p>
|
||||
<h3 id="npm-prune-3-"><a href="api/npm-prune.html">npm-prune(3)</a></h3>
|
||||
<p>Remove extraneous packages</p>
|
||||
<h3 id="npm-publish-3-"><a href="api/npm-publish.html">npm-publish(3)</a></h3>
|
||||
<p>Publish a package</p>
|
||||
<h3 id="npm-rebuild-3-"><a href="api/npm-rebuild.html">npm-rebuild(3)</a></h3>
|
||||
<p>Rebuild a package</p>
|
||||
<h3 id="npm-repo-3-"><a href="api/npm-repo.html">npm-repo(3)</a></h3>
|
||||
<p>Open package repository page in the browser</p>
|
||||
<h3 id="npm-restart-3-"><a href="api/npm-restart.html">npm-restart(3)</a></h3>
|
||||
<p>Restart a package</p>
|
||||
<h3 id="npm-root-3-"><a href="api/npm-root.html">npm-root(3)</a></h3>
|
||||
<p>Display npm root</p>
|
||||
<h3 id="npm-run-script-3-"><a href="api/npm-run-script.html">npm-run-script(3)</a></h3>
|
||||
<p>Run arbitrary package scripts</p>
|
||||
<h3 id="npm-search-3-"><a href="api/npm-search.html">npm-search(3)</a></h3>
|
||||
<p>Search for packages</p>
|
||||
<h3 id="npm-shrinkwrap-3-"><a href="api/npm-shrinkwrap.html">npm-shrinkwrap(3)</a></h3>
|
||||
<p>programmatically generate package shrinkwrap file</p>
|
||||
<h3 id="npm-start-3-"><a href="api/npm-start.html">npm-start(3)</a></h3>
|
||||
<p>Start a package</p>
|
||||
<h3 id="npm-stop-3-"><a href="api/npm-stop.html">npm-stop(3)</a></h3>
|
||||
<p>Stop a package</p>
|
||||
<h3 id="npm-tag-3-"><a href="api/npm-tag.html">npm-tag(3)</a></h3>
|
||||
<p>Tag a published version</p>
|
||||
<h3 id="npm-test-3-"><a href="api/npm-test.html">npm-test(3)</a></h3>
|
||||
<p>Test a package</p>
|
||||
<h3 id="npm-uninstall-3-"><a href="api/npm-uninstall.html">npm-uninstall(3)</a></h3>
|
||||
<p>uninstall a package programmatically</p>
|
||||
<h3 id="npm-unpublish-3-"><a href="api/npm-unpublish.html">npm-unpublish(3)</a></h3>
|
||||
<p>Remove a package from the registry</p>
|
||||
<h3 id="npm-update-3-"><a href="api/npm-update.html">npm-update(3)</a></h3>
|
||||
<p>Update a package</p>
|
||||
<h3 id="npm-version-3-"><a href="api/npm-version.html">npm-version(3)</a></h3>
|
||||
<p>Bump a package version</p>
|
||||
<h3 id="npm-view-3-"><a href="api/npm-view.html">npm-view(3)</a></h3>
|
||||
<p>View registry info</p>
|
||||
<h3 id="npm-whoami-3-"><a href="api/npm-whoami.html">npm-whoami(3)</a></h3>
|
||||
<p>Display npm username</p>
|
||||
<h2 id="files">Files</h2>
|
||||
<p>File system structures npm uses</p>
|
||||
<h3 id="npm-folders-5-"><a href="files/npm-folders.html">npm-folders(5)</a></h3>
|
||||
<p>Folder Structures Used by npm</p>
|
||||
<h3 id="npmrc-5-"><a href="files/npmrc.html">npmrc(5)</a></h3>
|
||||
<p>The npm config files</p>
|
||||
<h3 id="package-json-5-"><a href="files/package.json.html">package.json(5)</a></h3>
|
||||
<p>Specifics of npm's package.json handling</p>
|
||||
<h2 id="misc">Misc</h2>
|
||||
<p>Various other bits and bobs</p>
|
||||
<h3 id="npm-coding-style-7-"><a href="misc/npm-coding-style.html">npm-coding-style(7)</a></h3>
|
||||
<p>npm's "funny" coding style</p>
|
||||
<h3 id="npm-config-7-"><a href="misc/npm-config.html">npm-config(7)</a></h3>
|
||||
<p>More than you probably want to know about npm configuration</p>
|
||||
<h3 id="npm-developers-7-"><a href="misc/npm-developers.html">npm-developers(7)</a></h3>
|
||||
<p>Developer Guide</p>
|
||||
<h3 id="npm-disputes-7-"><a href="misc/npm-disputes.html">npm-disputes(7)</a></h3>
|
||||
<p>Handling Module Name Disputes</p>
|
||||
<h3 id="npm-index-7-"><a href="misc/npm-index.html">npm-index(7)</a></h3>
|
||||
<p>Index of all npm documentation</p>
|
||||
<h3 id="npm-orgs-7-"><a href="misc/npm-orgs.html">npm-orgs(7)</a></h3>
|
||||
<p>Working with Teams & Orgs</p>
|
||||
<h3 id="npm-registry-7-"><a href="misc/npm-registry.html">npm-registry(7)</a></h3>
|
||||
<p>The JavaScript Package Registry</p>
|
||||
<h3 id="npm-scope-7-"><a href="misc/npm-scope.html">npm-scope(7)</a></h3>
|
||||
<p>Scoped packages</p>
|
||||
<h3 id="npm-scripts-7-"><a href="misc/npm-scripts.html">npm-scripts(7)</a></h3>
|
||||
<p>How npm handles the "scripts" field</p>
|
||||
<h3 id="removing-npm-7-"><a href="misc/removing-npm.html">removing-npm(7)</a></h3>
|
||||
<p>Cleaning the Slate</p>
|
||||
<h3 id="semver-7-"><a href="misc/semver.html">semver(7)</a></h3>
|
||||
<p>The semantic versioner for npm</p>
|
||||
|
||||
</div>
|
||||
|
||||
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
|
||||
<tr><td style="width:180px;height:10px;background:rgb(237,127,127)" colspan=18> </td></tr>
|
||||
<tr><td rowspan=4 style="width:10px;height:10px;background:rgb(237,127,127)"> </td><td style="width:40px;height:10px;background:#fff" colspan=4> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=4> </td><td style="width:40px;height:10px;background:#fff" colspan=4> </td><td rowspan=4 style="width:10px;height:10px;background:rgb(237,127,127)"> </td><td colspan=6 style="width:60px;height:10px;background:#fff"> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=4> </td></tr>
|
||||
<tr><td colspan=2 style="width:20px;height:30px;background:#fff" rowspan=3> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:20px;height:10px;background:#fff" rowspan=4 colspan=2> </td><td style="width:10px;height:20px;background:rgb(237,127,127)" rowspan=2> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:20px;height:10px;background:#fff" rowspan=3 colspan=2> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td></tr>
|
||||
<tr><td style="width:10px;height:10px;background:#fff" rowspan=2> </td></tr>
|
||||
<tr><td style="width:10px;height:10px;background:#fff"> </td></tr>
|
||||
<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@2.15.12</p>
|
||||
|
||||
151
node_modules/npm/html/doc/misc/npm-coding-style.html
generated
vendored
Normal file
151
node_modules/npm/html/doc/misc/npm-coding-style.html
generated
vendored
Normal file
@@ -0,0 +1,151 @@
|
||||
<!doctype html>
|
||||
<html>
|
||||
<title>npm-coding-style</title>
|
||||
<meta charset="utf-8">
|
||||
<link rel="stylesheet" type="text/css" href="../../static/style.css">
|
||||
<link rel="canonical" href="https://www.npmjs.org/doc/misc/npm-coding-style.html">
|
||||
<script async=true src="../../static/toc.js"></script>
|
||||
|
||||
<body>
|
||||
<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>
|
||||
<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 that you can download from the npm registry.</p>
|
||||
<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>
|
||||
<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>
|
||||
<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
|
||||
use it if it doesn't.</p>
|
||||
<p>Bad:</p>
|
||||
<pre><code>if (foo) { bar() }
|
||||
while (foo)
|
||||
bar()
|
||||
</code></pre><p>Good:</p>
|
||||
<pre><code>if (foo) bar()
|
||||
while (foo) {
|
||||
bar()
|
||||
}
|
||||
</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.
|
||||
This prevents the expression from being interpreted
|
||||
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 ++) {
|
||||
switch (state) {
|
||||
case "begin": start(); continue
|
||||
case "end": finish(); break
|
||||
default: throw new Error("unknown state")
|
||||
}
|
||||
end()
|
||||
}
|
||||
</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>
|
||||
<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"
|
||||
]
|
||||
, spells = { "fireball" : function () { setOnFire() }
|
||||
, "water" : function () { putOut() }
|
||||
}
|
||||
, a = 1
|
||||
, b = "abc"
|
||||
, etc
|
||||
, 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>
|
||||
<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>
|
||||
<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>
|
||||
<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>
|
||||
<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>
|
||||
<p>Use <code>lowerCamelCase</code> for multiword identifiers when they refer to objects,
|
||||
functions, methods, properties, 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>
|
||||
|
||||
</div>
|
||||
|
||||
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
|
||||
<tr><td style="width:180px;height:10px;background:rgb(237,127,127)" colspan=18> </td></tr>
|
||||
<tr><td rowspan=4 style="width:10px;height:10px;background:rgb(237,127,127)"> </td><td style="width:40px;height:10px;background:#fff" colspan=4> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=4> </td><td style="width:40px;height:10px;background:#fff" colspan=4> </td><td rowspan=4 style="width:10px;height:10px;background:rgb(237,127,127)"> </td><td colspan=6 style="width:60px;height:10px;background:#fff"> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=4> </td></tr>
|
||||
<tr><td colspan=2 style="width:20px;height:30px;background:#fff" rowspan=3> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:20px;height:10px;background:#fff" rowspan=4 colspan=2> </td><td style="width:10px;height:20px;background:rgb(237,127,127)" rowspan=2> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:20px;height:10px;background:#fff" rowspan=3 colspan=2> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td></tr>
|
||||
<tr><td style="width:10px;height:10px;background:#fff" rowspan=2> </td></tr>
|
||||
<tr><td style="width:10px;height:10px;background:#fff"> </td></tr>
|
||||
<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@2.15.12</p>
|
||||
|
||||
818
node_modules/npm/html/doc/misc/npm-config.html
generated
vendored
Normal file
818
node_modules/npm/html/doc/misc/npm-config.html
generated
vendored
Normal file
@@ -0,0 +1,818 @@
|
||||
<!doctype html>
|
||||
<html>
|
||||
<title>npm-config</title>
|
||||
<meta charset="utf-8">
|
||||
<link rel="stylesheet" type="text/css" href="../../static/style.css">
|
||||
<link rel="canonical" href="https://www.npmjs.org/doc/misc/npm-config.html">
|
||||
<script async=true src="../../static/toc.js"></script>
|
||||
|
||||
<body>
|
||||
<div id="wrapper">
|
||||
|
||||
<h1><a href="../misc/npm-config.html">npm-config</a></h1> <p>More than you probably want to know about npm configuration</p>
|
||||
<h2 id="description">DESCRIPTION</h2>
|
||||
<p>npm gets its configuration values from the following sources, sorted by priority:</p>
|
||||
<h3 id="command-line-flags">Command Line Flags</h3>
|
||||
<p>Putting <code>--foo bar</code> on the command line sets the <code>foo</code> configuration
|
||||
parameter to <code>"bar"</code>. A <code>--</code> argument tells the cli parser to stop
|
||||
reading flags. A <code>--flag</code> parameter that is at the <em>end</em> of the
|
||||
command will be given the value of <code>true</code>.</p>
|
||||
<h3 id="environment-variables">Environment Variables</h3>
|
||||
<p>Any environment variables that start with <code>npm_config_</code> will be
|
||||
interpreted as a configuration parameter. For example, putting
|
||||
<code>npm_config_foo=bar</code> in your environment will set the <code>foo</code>
|
||||
configuration parameter to <code>bar</code>. Any environment configurations that
|
||||
are not given a value will be given the value of <code>true</code>. Config
|
||||
values are case-insensitive, so <code>NPM_CONFIG_FOO=bar</code> will work the
|
||||
same.</p>
|
||||
<h3 id="npmrc-files">npmrc Files</h3>
|
||||
<p>The four relevant files are:</p>
|
||||
<ul>
|
||||
<li>per-project configuration file (<code>/path/to/my/project/.npmrc</code>)</li>
|
||||
<li>per-user configuration file (defaults to <code>$HOME/.npmrc</code>; configurable via CLI
|
||||
option <code>--userconfig</code> or environment variable <code>$NPM_CONF_USERCONFIG</code>)</li>
|
||||
<li>global configuration file (defaults to <code>$PREFIX/etc/npmrc</code>; configurable via
|
||||
CLI option <code>--globalconfig</code> or environment variable <code>$NPM_CONF_GLOBALCONFIG</code>)</li>
|
||||
<li>npm's built-in configuration file (<code>/path/to/npm/npmrc</code>)</li>
|
||||
</ul>
|
||||
<p>See <a href="../files/npmrc.html">npmrc(5)</a> for more details.</p>
|
||||
<h3 id="default-configs">Default Configs</h3>
|
||||
<p>A set of configuration parameters that are internal to npm, and are
|
||||
defaults if nothing else is specified.</p>
|
||||
<h2 id="shorthands-and-other-cli-niceties">Shorthands and Other CLI Niceties</h2>
|
||||
<p>The following shorthands are parsed on the command-line:</p>
|
||||
<ul>
|
||||
<li><code>-v</code>: <code>--version</code></li>
|
||||
<li><code>-h</code>, <code>-?</code>, <code>--help</code>, <code>-H</code>: <code>--usage</code></li>
|
||||
<li><code>-s</code>, <code>--silent</code>: <code>--loglevel silent</code></li>
|
||||
<li><code>-q</code>, <code>--quiet</code>: <code>--loglevel warn</code></li>
|
||||
<li><code>-d</code>: <code>--loglevel info</code></li>
|
||||
<li><code>-dd</code>, <code>--verbose</code>: <code>--loglevel verbose</code></li>
|
||||
<li><code>-ddd</code>: <code>--loglevel silly</code></li>
|
||||
<li><code>-g</code>: <code>--global</code></li>
|
||||
<li><code>-C</code>: <code>--prefix</code></li>
|
||||
<li><code>-l</code>: <code>--long</code></li>
|
||||
<li><code>-m</code>: <code>--message</code></li>
|
||||
<li><code>-p</code>, <code>--porcelain</code>: <code>--parseable</code></li>
|
||||
<li><code>-reg</code>: <code>--registry</code></li>
|
||||
<li><code>-f</code>: <code>--force</code></li>
|
||||
<li><code>-desc</code>: <code>--description</code></li>
|
||||
<li><code>-S</code>: <code>--save</code></li>
|
||||
<li><code>-D</code>: <code>--save-dev</code></li>
|
||||
<li><code>-O</code>: <code>--save-optional</code></li>
|
||||
<li><code>-B</code>: <code>--save-bundle</code></li>
|
||||
<li><code>-E</code>: <code>--save-exact</code></li>
|
||||
<li><code>-y</code>: <code>--yes</code></li>
|
||||
<li><code>-n</code>: <code>--yes false</code></li>
|
||||
<li><code>ll</code> and <code>la</code> commands: <code>ls --long</code></li>
|
||||
</ul>
|
||||
<p>If the specified configuration param resolves unambiguously to a known
|
||||
configuration parameter, then it is expanded to that configuration
|
||||
parameter. For example:</p>
|
||||
<pre><code>npm ls --par
|
||||
# same as:
|
||||
npm ls --parseable
|
||||
</code></pre><p>If multiple single-character shorthands are strung together, and the
|
||||
resulting combination is unambiguously not some other configuration
|
||||
param, then it is expanded to its various component pieces. For
|
||||
example:</p>
|
||||
<pre><code>npm ls -gpld
|
||||
# same as:
|
||||
npm ls --global --parseable --long --loglevel info
|
||||
</code></pre><h2 id="per-package-config-settings">Per-Package Config Settings</h2>
|
||||
<p>When running scripts (see <code><a href="../misc/npm-scripts.html">npm-scripts(7)</a></code>) the package.json "config"
|
||||
keys are overwritten in the environment if there is a config param of
|
||||
<code><name>[@<version>]:<key></code>. For example, if the package.json has
|
||||
this:</p>
|
||||
<pre><code>{ "name" : "foo"
|
||||
, "config" : { "port" : "8080" }
|
||||
, "scripts" : { "start" : "node server.js" } }
|
||||
</code></pre><p>and the server.js is this:</p>
|
||||
<pre><code>http.createServer(...).listen(process.env.npm_package_config_port)
|
||||
</code></pre><p>then the user could change the behavior by doing:</p>
|
||||
<pre><code>npm config set foo:port 80
|
||||
</code></pre><p>See <a href="../files/package.json.html">package.json(5)</a> for more information.</p>
|
||||
<h2 id="config-settings">Config Settings</h2>
|
||||
<h3 id="access">access</h3>
|
||||
<ul>
|
||||
<li>Default: <code>restricted</code></li>
|
||||
<li>Type: Access</li>
|
||||
</ul>
|
||||
<p>When publishing scoped packages, the access level defaults to <code>restricted</code>. If
|
||||
you want your scoped package to be publicly viewable (and installable) set
|
||||
<code>--access=public</code>. The only valid values for <code>access</code> are <code>public</code> and
|
||||
<code>restricted</code>. Unscoped packages <em>always</em> have an access level of <code>public</code>.</p>
|
||||
<h3 id="always-auth">always-auth</h3>
|
||||
<ul>
|
||||
<li>Default: false</li>
|
||||
<li>Type: Boolean</li>
|
||||
</ul>
|
||||
<p>Force npm to always require authentication when accessing the registry,
|
||||
even for <code>GET</code> requests.</p>
|
||||
<h3 id="bin-links">bin-links</h3>
|
||||
<ul>
|
||||
<li>Default: <code>true</code></li>
|
||||
<li>Type: Boolean</li>
|
||||
</ul>
|
||||
<p>Tells npm to create symlinks (or <code>.cmd</code> shims on Windows) for package
|
||||
executables.</p>
|
||||
<p>Set to false to have it not do this. This can be used to work around
|
||||
the fact that some file systems don't support symlinks, even on
|
||||
ostensibly Unix systems.</p>
|
||||
<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>
|
||||
<p>The browser that is called by the <code>npm docs</code> command to open websites.</p>
|
||||
<h3 id="ca">ca</h3>
|
||||
<ul>
|
||||
<li>Default: The npm CA certificate</li>
|
||||
<li>Type: String, Array or null</li>
|
||||
</ul>
|
||||
<p>The Certificate Authority signing certificate that is trusted for SSL
|
||||
connections to the registry. Values should be in PEM format with newlines
|
||||
replaced by the string "\n". For example:</p>
|
||||
<pre><code>ca="-----BEGIN CERTIFICATE-----\nXXXX\nXXXX\n-----END CERTIFICATE-----"
|
||||
</code></pre><p>Set to <code>null</code> to only allow "known" registrars, or to a specific CA cert
|
||||
to trust only that specific signing authority.</p>
|
||||
<p>Multiple CAs can be trusted by specifying an array of certificates:</p>
|
||||
<pre><code>ca[]="..."
|
||||
ca[]="..."
|
||||
</code></pre><p>See also the <code>strict-ssl</code> config.</p>
|
||||
<h3 id="cafile">cafile</h3>
|
||||
<ul>
|
||||
<li>Default: <code>null</code></li>
|
||||
<li>Type: path</li>
|
||||
</ul>
|
||||
<p>A path to a file containing one or multiple Certificate Authority signing
|
||||
certificates. Similar to the <code>ca</code> setting, but allows for multiple CA's, as
|
||||
well as for the CA information to be stored in a file on disk.</p>
|
||||
<h3 id="cache">cache</h3>
|
||||
<ul>
|
||||
<li>Default: Windows: <code>%AppData%\npm-cache</code>, Posix: <code>~/.npm</code></li>
|
||||
<li>Type: path</li>
|
||||
</ul>
|
||||
<p>The location of npm's cache directory. See <code><a href="../cli/npm-cache.html">npm-cache(1)</a></code></p>
|
||||
<h3 id="cache-lock-stale">cache-lock-stale</h3>
|
||||
<ul>
|
||||
<li>Default: 60000 (1 minute)</li>
|
||||
<li>Type: Number</li>
|
||||
</ul>
|
||||
<p>The number of ms before cache folder lockfiles are considered stale.</p>
|
||||
<h3 id="cache-lock-retries">cache-lock-retries</h3>
|
||||
<ul>
|
||||
<li>Default: 10</li>
|
||||
<li>Type: Number</li>
|
||||
</ul>
|
||||
<p>Number of times to retry to acquire a lock on cache folder lockfiles.</p>
|
||||
<h3 id="cache-lock-wait">cache-lock-wait</h3>
|
||||
<ul>
|
||||
<li>Default: 10000 (10 seconds)</li>
|
||||
<li>Type: Number</li>
|
||||
</ul>
|
||||
<p>Number of ms to wait for cache lock files to expire.</p>
|
||||
<h3 id="cache-max">cache-max</h3>
|
||||
<ul>
|
||||
<li>Default: Infinity</li>
|
||||
<li>Type: Number</li>
|
||||
</ul>
|
||||
<p>The maximum time (in seconds) to keep items in the registry cache before
|
||||
re-checking against the registry.</p>
|
||||
<p>Note that no purging is done unless the <code>npm cache clean</code> command is
|
||||
explicitly used, and that only GET requests use the cache.</p>
|
||||
<h3 id="cache-min">cache-min</h3>
|
||||
<ul>
|
||||
<li>Default: 10</li>
|
||||
<li>Type: Number</li>
|
||||
</ul>
|
||||
<p>The minimum time (in seconds) to keep items in the registry cache before
|
||||
re-checking against the registry.</p>
|
||||
<p>Note that no purging is done unless the <code>npm cache clean</code> command is
|
||||
explicitly used, and that only GET requests use the cache.</p>
|
||||
<h3 id="cert">cert</h3>
|
||||
<ul>
|
||||
<li>Default: <code>null</code></li>
|
||||
<li>Type: String</li>
|
||||
</ul>
|
||||
<p>A client certificate to pass when accessing the registry. Values should be in
|
||||
PEM format with newlines replaced by the string "\n". For example:</p>
|
||||
<pre><code>cert="-----BEGIN CERTIFICATE-----\nXXXX\nXXXX\n-----END CERTIFICATE-----"
|
||||
</code></pre><p>It is <em>not</em> the path to a certificate file (and there is no "certfile" option).</p>
|
||||
<h3 id="color">color</h3>
|
||||
<ul>
|
||||
<li>Default: true</li>
|
||||
<li>Type: Boolean or <code>"always"</code></li>
|
||||
</ul>
|
||||
<p>If false, never shows colors. If <code>"always"</code> then always shows colors.
|
||||
If true, then only prints color codes for tty file descriptors.</p>
|
||||
<h3 id="depth">depth</h3>
|
||||
<ul>
|
||||
<li>Default: Infinity</li>
|
||||
<li>Type: Number</li>
|
||||
</ul>
|
||||
<p>The depth to go when recursing directories for <code>npm ls</code>,
|
||||
<code>npm cache ls</code>, and <code>npm outdated</code>.</p>
|
||||
<p>For <code>npm outdated</code>, a setting of <code>Infinity</code> will be treated as <code>0</code>
|
||||
since that gives more useful information. To show the outdated status
|
||||
of all packages and dependents, use a large integer value,
|
||||
e.g., <code>npm outdated --depth 9999</code></p>
|
||||
<h3 id="description">description</h3>
|
||||
<ul>
|
||||
<li>Default: true</li>
|
||||
<li>Type: Boolean</li>
|
||||
</ul>
|
||||
<p>Show the description in <code>npm search</code></p>
|
||||
<h3 id="dev">dev</h3>
|
||||
<ul>
|
||||
<li>Default: false</li>
|
||||
<li>Type: Boolean</li>
|
||||
</ul>
|
||||
<p>Install <code>dev-dependencies</code> along with packages.</p>
|
||||
<p>Note that <code>dev-dependencies</code> are also installed if the <code>npat</code> flag is
|
||||
set.</p>
|
||||
<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>
|
||||
<p>The command to run for <code>npm edit</code> or <code>npm config edit</code>.</p>
|
||||
<h3 id="engine-strict">engine-strict</h3>
|
||||
<ul>
|
||||
<li>Default: false</li>
|
||||
<li>Type: Boolean</li>
|
||||
</ul>
|
||||
<p>If set to true, then npm will stubbornly refuse to install (or even
|
||||
consider installing) any package that claims to not be compatible with
|
||||
the current Node.js version.</p>
|
||||
<h3 id="force">force</h3>
|
||||
<ul>
|
||||
<li>Default: false</li>
|
||||
<li>Type: Boolean</li>
|
||||
</ul>
|
||||
<p>Makes various commands more forceful.</p>
|
||||
<ul>
|
||||
<li>lifecycle script failure does not block progress.</li>
|
||||
<li>publishing clobbers previously published versions.</li>
|
||||
<li>skips cache when requesting from the registry.</li>
|
||||
<li>prevents checks against clobbering non-npm files.</li>
|
||||
</ul>
|
||||
<h3 id="fetch-retries">fetch-retries</h3>
|
||||
<ul>
|
||||
<li>Default: 2</li>
|
||||
<li>Type: Number</li>
|
||||
</ul>
|
||||
<p>The "retries" config for the <code>retry</code> module to use when fetching
|
||||
packages from the registry.</p>
|
||||
<h3 id="fetch-retry-factor">fetch-retry-factor</h3>
|
||||
<ul>
|
||||
<li>Default: 10</li>
|
||||
<li>Type: Number</li>
|
||||
</ul>
|
||||
<p>The "factor" config for the <code>retry</code> module to use when fetching
|
||||
packages.</p>
|
||||
<h3 id="fetch-retry-mintimeout">fetch-retry-mintimeout</h3>
|
||||
<ul>
|
||||
<li>Default: 10000 (10 seconds)</li>
|
||||
<li>Type: Number</li>
|
||||
</ul>
|
||||
<p>The "minTimeout" config for the <code>retry</code> module to use when fetching
|
||||
packages.</p>
|
||||
<h3 id="fetch-retry-maxtimeout">fetch-retry-maxtimeout</h3>
|
||||
<ul>
|
||||
<li>Default: 60000 (1 minute)</li>
|
||||
<li>Type: Number</li>
|
||||
</ul>
|
||||
<p>The "maxTimeout" config for the <code>retry</code> module to use when fetching
|
||||
packages.</p>
|
||||
<h3 id="git">git</h3>
|
||||
<ul>
|
||||
<li>Default: <code>"git"</code></li>
|
||||
<li>Type: String</li>
|
||||
</ul>
|
||||
<p>The command to use for git commands. If git is installed on the
|
||||
computer, but is not in the <code>PATH</code>, then set this to the full path to
|
||||
the git binary.</p>
|
||||
<h3 id="git-tag-version">git-tag-version</h3>
|
||||
<ul>
|
||||
<li>Default: <code>true</code></li>
|
||||
<li>Type: Boolean</li>
|
||||
</ul>
|
||||
<p>Tag the commit when using the <code>npm version</code> command.</p>
|
||||
<h3 id="global">global</h3>
|
||||
<ul>
|
||||
<li>Default: false</li>
|
||||
<li>Type: Boolean</li>
|
||||
</ul>
|
||||
<p>Operates in "global" mode, so that packages are installed into the
|
||||
<code>prefix</code> folder instead of the current working directory. See
|
||||
<code><a href="../files/npm-folders.html">npm-folders(5)</a></code> for more on the differences in behavior.</p>
|
||||
<ul>
|
||||
<li>packages are installed into the <code>{prefix}/lib/node_modules</code> folder, instead of the
|
||||
current working directory.</li>
|
||||
<li>bin files are linked to <code>{prefix}/bin</code></li>
|
||||
<li>man pages are linked to <code>{prefix}/share/man</code></li>
|
||||
</ul>
|
||||
<h3 id="globalconfig">globalconfig</h3>
|
||||
<ul>
|
||||
<li>Default: {prefix}/etc/npmrc</li>
|
||||
<li>Type: path</li>
|
||||
</ul>
|
||||
<p>The config file to read for global config options.</p>
|
||||
<h3 id="group">group</h3>
|
||||
<ul>
|
||||
<li>Default: GID of the current process</li>
|
||||
<li>Type: String or Number</li>
|
||||
</ul>
|
||||
<p>The group to use when running package scripts in global mode as the root
|
||||
user.</p>
|
||||
<h3 id="heading">heading</h3>
|
||||
<ul>
|
||||
<li>Default: <code>"npm"</code></li>
|
||||
<li>Type: String</li>
|
||||
</ul>
|
||||
<p>The string that starts all the debugging log output.</p>
|
||||
<h3 id="https-proxy">https-proxy</h3>
|
||||
<ul>
|
||||
<li>Default: null</li>
|
||||
<li>Type: url</li>
|
||||
</ul>
|
||||
<p>A proxy to use for outgoing https requests. If the <code>HTTPS_PROXY</code> or
|
||||
<code>https_proxy</code> or <code>HTTP_PROXY</code> or <code>http_proxy</code> environment variables are set,
|
||||
proxy settings will be honored by the underlying <code>request</code> library.</p>
|
||||
<h3 id="if-present">if-present</h3>
|
||||
<ul>
|
||||
<li>Default: false</li>
|
||||
<li>Type: Boolean</li>
|
||||
</ul>
|
||||
<p>If true, npm will not exit with an error code when <code>run-script</code> is invoked for
|
||||
a script that isn't defined in the <code>scripts</code> section of <code>package.json</code>. This
|
||||
option can be used when it's desirable to optionally run a script when it's
|
||||
present and fail if the script fails. This is useful, for example, when running
|
||||
scripts that may only apply for some builds in an otherwise generic CI setup.</p>
|
||||
<h3 id="ignore-scripts">ignore-scripts</h3>
|
||||
<ul>
|
||||
<li>Default: false</li>
|
||||
<li>Type: Boolean</li>
|
||||
</ul>
|
||||
<p>If true, npm does not run scripts specified in package.json files.</p>
|
||||
<h3 id="init-module">init-module</h3>
|
||||
<ul>
|
||||
<li>Default: ~/.npm-init.js</li>
|
||||
<li>Type: path</li>
|
||||
</ul>
|
||||
<p>A module that will be loaded by the <code>npm init</code> command. See the
|
||||
documentation for the
|
||||
<a href="https://github.com/isaacs/init-package-json">init-package-json</a> module
|
||||
for more information, or <a href="../cli/npm-init.html">npm-init(1)</a>.</p>
|
||||
<h3 id="init-author-name">init-author-name</h3>
|
||||
<ul>
|
||||
<li>Default: ""</li>
|
||||
<li>Type: String</li>
|
||||
</ul>
|
||||
<p>The value <code>npm init</code> should use by default for the package author's name.</p>
|
||||
<h3 id="init-author-email">init-author-email</h3>
|
||||
<ul>
|
||||
<li>Default: ""</li>
|
||||
<li>Type: String</li>
|
||||
</ul>
|
||||
<p>The value <code>npm init</code> should use by default for the package author's email.</p>
|
||||
<h3 id="init-author-url">init-author-url</h3>
|
||||
<ul>
|
||||
<li>Default: ""</li>
|
||||
<li>Type: String</li>
|
||||
</ul>
|
||||
<p>The value <code>npm init</code> should use by default for the package author's homepage.</p>
|
||||
<h3 id="init-license">init-license</h3>
|
||||
<ul>
|
||||
<li>Default: "ISC"</li>
|
||||
<li>Type: String</li>
|
||||
</ul>
|
||||
<p>The value <code>npm init</code> should use by default for the package license.</p>
|
||||
<h3 id="init-version">init-version</h3>
|
||||
<ul>
|
||||
<li>Default: "1.0.0"</li>
|
||||
<li>Type: semver</li>
|
||||
</ul>
|
||||
<p>The value that <code>npm init</code> should use by default for the package
|
||||
version number, if not already set in package.json.</p>
|
||||
<h3 id="json">json</h3>
|
||||
<ul>
|
||||
<li>Default: false</li>
|
||||
<li>Type: Boolean</li>
|
||||
</ul>
|
||||
<p>Whether or not to output JSON data, rather than the normal output.</p>
|
||||
<p>This feature is currently experimental, and the output data structures
|
||||
for many commands is either not implemented in JSON yet, or subject to
|
||||
change. Only the output from <code>npm ls --json</code> is currently valid.</p>
|
||||
<h3 id="key">key</h3>
|
||||
<ul>
|
||||
<li>Default: <code>null</code></li>
|
||||
<li>Type: String</li>
|
||||
</ul>
|
||||
<p>A client key to pass when accessing the registry. Values should be in PEM
|
||||
format with newlines replaced by the string "\n". For example:</p>
|
||||
<pre><code>key="-----BEGIN PRIVATE KEY-----\nXXXX\nXXXX\n-----END PRIVATE KEY-----"
|
||||
</code></pre><p>It is <em>not</em> the path to a key file (and there is no "keyfile" option).</p>
|
||||
<h3 id="link">link</h3>
|
||||
<ul>
|
||||
<li>Default: false</li>
|
||||
<li>Type: Boolean</li>
|
||||
</ul>
|
||||
<p>If true, then local installs will link if there is a suitable globally
|
||||
installed package.</p>
|
||||
<p>Note that this means that local installs can cause things to be
|
||||
installed into the global space at the same time. The link is only done
|
||||
if one of the two conditions are met:</p>
|
||||
<ul>
|
||||
<li>The package is not already installed globally, or</li>
|
||||
<li>the globally installed version is identical to the version that is
|
||||
being installed locally.</li>
|
||||
</ul>
|
||||
<h3 id="local-address">local-address</h3>
|
||||
<ul>
|
||||
<li>Default: undefined</li>
|
||||
<li>Type: IP Address</li>
|
||||
</ul>
|
||||
<p>The IP address of the local interface to use when making connections
|
||||
to the npm registry. Must be IPv4 in versions of Node prior to 0.12.</p>
|
||||
<h3 id="loglevel">loglevel</h3>
|
||||
<ul>
|
||||
<li>Default: "warn"</li>
|
||||
<li>Type: String</li>
|
||||
<li>Values: "silent", "error", "warn", "http", "info", "verbose", "silly"</li>
|
||||
</ul>
|
||||
<p>What level of logs to report. On failure, <em>all</em> logs are written to
|
||||
<code>npm-debug.log</code> in the current working directory.</p>
|
||||
<p>Any logs of a higher level than the setting are shown.
|
||||
The default is "warn", which shows warn and error output.</p>
|
||||
<h3 id="logstream">logstream</h3>
|
||||
<ul>
|
||||
<li>Default: process.stderr</li>
|
||||
<li>Type: Stream</li>
|
||||
</ul>
|
||||
<p>This is the stream that is passed to the
|
||||
<a href="https://github.com/npm/npmlog">npmlog</a> module at run time.</p>
|
||||
<p>It cannot be set from the command line, but if you are using npm
|
||||
programmatically, you may wish to send logs to somewhere other than
|
||||
stderr.</p>
|
||||
<p>If the <code>color</code> config is set to true, then this stream will receive
|
||||
colored output if it is a TTY.</p>
|
||||
<h3 id="long">long</h3>
|
||||
<ul>
|
||||
<li>Default: false</li>
|
||||
<li>Type: Boolean</li>
|
||||
</ul>
|
||||
<p>Show extended information in <code>npm ls</code> and <code>npm search</code>.</p>
|
||||
<h3 id="maxsockets">maxsockets</h3>
|
||||
<ul>
|
||||
<li>Default: 50</li>
|
||||
<li>Type: Number</li>
|
||||
</ul>
|
||||
<p>The maximum number of connections to use per origin (protocol/host/port
|
||||
combination). Passed to the <code>http</code> <code>Agent</code> used to make the request.</p>
|
||||
<h3 id="message">message</h3>
|
||||
<ul>
|
||||
<li>Default: "%s"</li>
|
||||
<li>Type: String</li>
|
||||
</ul>
|
||||
<p>Commit message which is used by <code>npm version</code> when creating version commit.</p>
|
||||
<p>Any "%s" in the message will be replaced with the version number.</p>
|
||||
<h3 id="node-version">node-version</h3>
|
||||
<ul>
|
||||
<li>Default: process.version</li>
|
||||
<li>Type: semver or false</li>
|
||||
</ul>
|
||||
<p>The node version to use when checking a package's <code>engines</code> map.</p>
|
||||
<h3 id="npat">npat</h3>
|
||||
<ul>
|
||||
<li>Default: false</li>
|
||||
<li>Type: Boolean</li>
|
||||
</ul>
|
||||
<p>Run tests on installation.</p>
|
||||
<h3 id="onload-script">onload-script</h3>
|
||||
<ul>
|
||||
<li>Default: false</li>
|
||||
<li>Type: path</li>
|
||||
</ul>
|
||||
<p>A node module to <code>require()</code> when npm loads. Useful for programmatic
|
||||
usage.</p>
|
||||
<h3 id="optional">optional</h3>
|
||||
<ul>
|
||||
<li>Default: true</li>
|
||||
<li>Type: Boolean</li>
|
||||
</ul>
|
||||
<p>Attempt to install packages in the <code>optionalDependencies</code> object. Note
|
||||
that if these packages fail to install, the overall installation
|
||||
process is not aborted.</p>
|
||||
<h3 id="parseable">parseable</h3>
|
||||
<ul>
|
||||
<li>Default: false</li>
|
||||
<li>Type: Boolean</li>
|
||||
</ul>
|
||||
<p>Output parseable results from commands that write to
|
||||
standard output.</p>
|
||||
<h3 id="prefix">prefix</h3>
|
||||
<ul>
|
||||
<li>Default: see <a href="../files/npm-folders.html">npm-folders(5)</a></li>
|
||||
<li>Type: path</li>
|
||||
</ul>
|
||||
<p>The location to install global items. If set on the command line, then
|
||||
it forces non-global commands to run in the specified folder.</p>
|
||||
<h3 id="production">production</h3>
|
||||
<ul>
|
||||
<li>Default: false</li>
|
||||
<li>Type: Boolean</li>
|
||||
</ul>
|
||||
<p>Set to true to run in "production" mode.</p>
|
||||
<ol>
|
||||
<li>devDependencies are not installed at the topmost level when running
|
||||
local <code>npm install</code> without any arguments.</li>
|
||||
<li>Set the NODE_ENV="production" for lifecycle scripts.</li>
|
||||
</ol>
|
||||
<h3 id="proprietary-attribs">proprietary-attribs</h3>
|
||||
<ul>
|
||||
<li>Default: true</li>
|
||||
<li>Type: Boolean</li>
|
||||
</ul>
|
||||
<p>Whether or not to include proprietary extended attributes in the
|
||||
tarballs created by npm.</p>
|
||||
<p>Unless you are expecting to unpack package tarballs with something other
|
||||
than npm -- particularly a very outdated tar implementation -- leave
|
||||
this as true.</p>
|
||||
<h3 id="proxy">proxy</h3>
|
||||
<ul>
|
||||
<li>Default: null</li>
|
||||
<li>Type: url</li>
|
||||
</ul>
|
||||
<p>A proxy to use for outgoing http requests. If the <code>HTTP_PROXY</code> or
|
||||
<code>http_proxy</code> environment variables are set, proxy settings will be
|
||||
honored by the underlying <code>request</code> library.</p>
|
||||
<h3 id="rebuild-bundle">rebuild-bundle</h3>
|
||||
<ul>
|
||||
<li>Default: true</li>
|
||||
<li>Type: Boolean</li>
|
||||
</ul>
|
||||
<p>Rebuild bundled dependencies after installation.</p>
|
||||
<h3 id="registry">registry</h3>
|
||||
<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>
|
||||
<h3 id="rollback">rollback</h3>
|
||||
<ul>
|
||||
<li>Default: true</li>
|
||||
<li>Type: Boolean</li>
|
||||
</ul>
|
||||
<p>Remove failed installs.</p>
|
||||
<h3 id="save">save</h3>
|
||||
<ul>
|
||||
<li>Default: false</li>
|
||||
<li>Type: Boolean</li>
|
||||
</ul>
|
||||
<p>Save installed packages to a package.json file as dependencies.</p>
|
||||
<p>When used with the <code>npm rm</code> command, it removes it from the <code>dependencies</code>
|
||||
object.</p>
|
||||
<p>Only works if there is already a package.json file present.</p>
|
||||
<h3 id="save-bundle">save-bundle</h3>
|
||||
<ul>
|
||||
<li>Default: false</li>
|
||||
<li>Type: Boolean</li>
|
||||
</ul>
|
||||
<p>If a package would be saved at install time by the use of <code>--save</code>,
|
||||
<code>--save-dev</code>, or <code>--save-optional</code>, then also put it in the
|
||||
<code>bundleDependencies</code> list.</p>
|
||||
<p>When used with the <code>npm rm</code> command, it removes it from the
|
||||
bundledDependencies list.</p>
|
||||
<h3 id="save-dev">save-dev</h3>
|
||||
<ul>
|
||||
<li>Default: false</li>
|
||||
<li>Type: Boolean</li>
|
||||
</ul>
|
||||
<p>Save installed packages to a package.json file as <code>devDependencies</code>.</p>
|
||||
<p>When used with the <code>npm rm</code> command, it removes it from the
|
||||
<code>devDependencies</code> object.</p>
|
||||
<p>Only works if there is already a package.json file present.</p>
|
||||
<h3 id="save-exact">save-exact</h3>
|
||||
<ul>
|
||||
<li>Default: false</li>
|
||||
<li>Type: Boolean</li>
|
||||
</ul>
|
||||
<p>Dependencies saved to package.json using <code>--save</code>, <code>--save-dev</code> or
|
||||
<code>--save-optional</code> will be configured with an exact version rather than
|
||||
using npm's default semver range operator.</p>
|
||||
<h3 id="save-optional">save-optional</h3>
|
||||
<ul>
|
||||
<li>Default: false</li>
|
||||
<li>Type: Boolean</li>
|
||||
</ul>
|
||||
<p>Save installed packages to a package.json file as
|
||||
optionalDependencies.</p>
|
||||
<p>When used with the <code>npm rm</code> command, it removes it from the
|
||||
<code>devDependencies</code> object.</p>
|
||||
<p>Only works if there is already a package.json file present.</p>
|
||||
<h3 id="save-prefix">save-prefix</h3>
|
||||
<ul>
|
||||
<li>Default: '^'</li>
|
||||
<li>Type: String</li>
|
||||
</ul>
|
||||
<p>Configure how versions of packages installed to a package.json file via
|
||||
<code>--save</code> or <code>--save-dev</code> get prefixed.</p>
|
||||
<p>For example if a package has version <code>1.2.3</code>, by default its version is
|
||||
set to <code>^1.2.3</code> which allows minor upgrades for that package, but after
|
||||
<code>npm config set save-prefix='~'</code> it would be set to <code>~1.2.3</code> which only allows
|
||||
patch upgrades.</p>
|
||||
<h3 id="scope">scope</h3>
|
||||
<ul>
|
||||
<li>Default: ""</li>
|
||||
<li>Type: String</li>
|
||||
</ul>
|
||||
<p>Associate an operation with a scope for a scoped registry. Useful when logging
|
||||
in to a private registry for the first time:
|
||||
<code>npm login --scope=@organization --registry=registry.organization.com</code>, which
|
||||
will cause <code>@organization</code> to be mapped to the registry for future installation
|
||||
of packages specified according to the pattern <code>@organization/package</code>.</p>
|
||||
<h3 id="searchopts">searchopts</h3>
|
||||
<ul>
|
||||
<li>Default: ""</li>
|
||||
<li>Type: String</li>
|
||||
</ul>
|
||||
<p>Space-separated options that are always passed to search.</p>
|
||||
<h3 id="searchexclude">searchexclude</h3>
|
||||
<ul>
|
||||
<li>Default: ""</li>
|
||||
<li>Type: String</li>
|
||||
</ul>
|
||||
<p>Space-separated options that limit the results from search.</p>
|
||||
<h3 id="searchsort">searchsort</h3>
|
||||
<ul>
|
||||
<li>Default: "name"</li>
|
||||
<li>Type: String</li>
|
||||
<li>Values: "name", "-name", "date", "-date", "description",
|
||||
"-description", "keywords", "-keywords"</li>
|
||||
</ul>
|
||||
<p>Indication of which field to sort search results by. Prefix with a <code>-</code>
|
||||
character to indicate reverse sort.</p>
|
||||
<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>
|
||||
<p>The shell to run for the <code>npm explore</code> command.</p>
|
||||
<h3 id="shrinkwrap">shrinkwrap</h3>
|
||||
<ul>
|
||||
<li>Default: true</li>
|
||||
<li>Type: Boolean</li>
|
||||
</ul>
|
||||
<p>If set to false, then ignore <code>npm-shrinkwrap.json</code> files when
|
||||
installing.</p>
|
||||
<h3 id="sign-git-tag">sign-git-tag</h3>
|
||||
<ul>
|
||||
<li>Default: false</li>
|
||||
<li>Type: Boolean</li>
|
||||
</ul>
|
||||
<p>If set to true, then the <code>npm version</code> command will tag the version
|
||||
using <code>-s</code> to add a signature.</p>
|
||||
<p>Note that git requires you to have set up GPG keys in your git configs
|
||||
for this to work properly.</p>
|
||||
<h3 id="spin">spin</h3>
|
||||
<ul>
|
||||
<li>Default: true</li>
|
||||
<li>Type: Boolean or <code>"always"</code></li>
|
||||
</ul>
|
||||
<p>When set to <code>true</code>, npm will display an ascii spinner while it is doing
|
||||
things, if <code>process.stderr</code> is a TTY.</p>
|
||||
<p>Set to <code>false</code> to suppress the spinner, or set to <code>always</code> to output
|
||||
the spinner even for non-TTY outputs.</p>
|
||||
<h3 id="strict-ssl">strict-ssl</h3>
|
||||
<ul>
|
||||
<li>Default: true</li>
|
||||
<li>Type: Boolean</li>
|
||||
</ul>
|
||||
<p>Whether or not to do SSL key validation when making requests to the
|
||||
registry via https.</p>
|
||||
<p>See also the <code>ca</code> config.</p>
|
||||
<h3 id="tag">tag</h3>
|
||||
<ul>
|
||||
<li>Default: latest</li>
|
||||
<li>Type: String</li>
|
||||
</ul>
|
||||
<p>If you ask npm to install a package and don't tell it a specific version, then
|
||||
it will install the specified tag.</p>
|
||||
<p>Also the tag that is added to the package@version specified by the <code>npm
|
||||
tag</code> command, if no explicit tag is given.</p>
|
||||
<h3 id="tag-version-prefix">tag-version-prefix</h3>
|
||||
<ul>
|
||||
<li>Default: <code>"v"</code></li>
|
||||
<li>Type: String</li>
|
||||
</ul>
|
||||
<p>If set, alters the prefix used when tagging a new version when performing a
|
||||
version increment using <code>npm-version</code>. To remove the prefix altogether, set it
|
||||
to the empty string: <code>""</code>.</p>
|
||||
<p>Because other tools may rely on the convention that npm version tags look like
|
||||
<code>v1.0.0</code>, <em>only use this property if it is absolutely necessary</em>. In
|
||||
particular, use care when overriding this setting for public packages.</p>
|
||||
<h3 id="tmp">tmp</h3>
|
||||
<ul>
|
||||
<li>Default: TMPDIR environment variable, or "/tmp"</li>
|
||||
<li>Type: path</li>
|
||||
</ul>
|
||||
<p>Where to store temporary files and folders. All temp files are deleted
|
||||
on success, but left behind on failure for forensic purposes.</p>
|
||||
<h3 id="unicode">unicode</h3>
|
||||
<ul>
|
||||
<li>Default: true</li>
|
||||
<li>Type: Boolean</li>
|
||||
</ul>
|
||||
<p>When set to true, npm uses unicode characters in the tree output. When
|
||||
false, it uses ascii characters to draw trees.</p>
|
||||
<h3 id="unsafe-perm">unsafe-perm</h3>
|
||||
<ul>
|
||||
<li>Default: false if running as root, true otherwise</li>
|
||||
<li>Type: Boolean</li>
|
||||
</ul>
|
||||
<p>Set to true to suppress the UID/GID switching when running package
|
||||
scripts. If set explicitly to false, then installing as a non-root user
|
||||
will fail.</p>
|
||||
<h3 id="usage">usage</h3>
|
||||
<ul>
|
||||
<li>Default: false</li>
|
||||
<li>Type: Boolean</li>
|
||||
</ul>
|
||||
<p>Set to show short usage output (like the -H output)
|
||||
instead of complete help when doing <code><a href="../cli/npm-help.html">npm-help(1)</a></code>.</p>
|
||||
<h3 id="user">user</h3>
|
||||
<ul>
|
||||
<li>Default: "nobody"</li>
|
||||
<li>Type: String or Number</li>
|
||||
</ul>
|
||||
<p>The UID to set to when running package scripts as root.</p>
|
||||
<h3 id="userconfig">userconfig</h3>
|
||||
<ul>
|
||||
<li>Default: ~/.npmrc</li>
|
||||
<li>Type: path</li>
|
||||
</ul>
|
||||
<p>The location of user-level configuration settings.</p>
|
||||
<h3 id="umask">umask</h3>
|
||||
<ul>
|
||||
<li>Default: 022</li>
|
||||
<li>Type: Octal numeric string in range 0000..0777 (0..511)</li>
|
||||
</ul>
|
||||
<p>The "umask" value to use when setting the file creation mode on files
|
||||
and folders.</p>
|
||||
<p>Folders and executables are given a mode which is <code>0777</code> masked against
|
||||
this value. Other files are given a mode which is <code>0666</code> masked against
|
||||
this value. Thus, the defaults are <code>0755</code> and <code>0644</code> respectively.</p>
|
||||
<h3 id="user-agent">user-agent</h3>
|
||||
<ul>
|
||||
<li>Default: node/{process.version} {process.platform} {process.arch}</li>
|
||||
<li>Type: String</li>
|
||||
</ul>
|
||||
<p>Sets a User-Agent to the request header</p>
|
||||
<h3 id="version">version</h3>
|
||||
<ul>
|
||||
<li>Default: false</li>
|
||||
<li>Type: boolean</li>
|
||||
</ul>
|
||||
<p>If true, output the npm version and exit successfully.</p>
|
||||
<p>Only relevant when specified explicitly on the command line.</p>
|
||||
<h3 id="versions">versions</h3>
|
||||
<ul>
|
||||
<li>Default: false</li>
|
||||
<li>Type: boolean</li>
|
||||
</ul>
|
||||
<p>If true, output the npm version as well as node's <code>process.versions</code> map, and
|
||||
exit successfully.</p>
|
||||
<p>Only relevant when specified explicitly on the command line.</p>
|
||||
<h3 id="viewer">viewer</h3>
|
||||
<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-config.html">npm-config(1)</a></li>
|
||||
<li><a href="../files/npmrc.html">npmrc(5)</a></li>
|
||||
<li><a href="../misc/npm-scripts.html">npm-scripts(7)</a></li>
|
||||
<li><a href="../files/npm-folders.html">npm-folders(5)</a></li>
|
||||
<li><a href="../cli/npm.html">npm(1)</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
|
||||
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
|
||||
<tr><td style="width:180px;height:10px;background:rgb(237,127,127)" colspan=18> </td></tr>
|
||||
<tr><td rowspan=4 style="width:10px;height:10px;background:rgb(237,127,127)"> </td><td style="width:40px;height:10px;background:#fff" colspan=4> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=4> </td><td style="width:40px;height:10px;background:#fff" colspan=4> </td><td rowspan=4 style="width:10px;height:10px;background:rgb(237,127,127)"> </td><td colspan=6 style="width:60px;height:10px;background:#fff"> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=4> </td></tr>
|
||||
<tr><td colspan=2 style="width:20px;height:30px;background:#fff" rowspan=3> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:20px;height:10px;background:#fff" rowspan=4 colspan=2> </td><td style="width:10px;height:20px;background:rgb(237,127,127)" rowspan=2> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:20px;height:10px;background:#fff" rowspan=3 colspan=2> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td></tr>
|
||||
<tr><td style="width:10px;height:10px;background:#fff" rowspan=2> </td></tr>
|
||||
<tr><td style="width:10px;height:10px;background:#fff"> </td></tr>
|
||||
<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@2.15.12</p>
|
||||
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user