diff options
Diffstat (limited to 'deps/npm/html/partial/doc')
| -rw-r--r-- | deps/npm/html/partial/doc/README.html | 2 | ||||
| -rw-r--r-- | deps/npm/html/partial/doc/api/npm-submodule.html | 21 | ||||
| -rw-r--r-- | deps/npm/html/partial/doc/api/npm.html | 2 | ||||
| -rw-r--r-- | deps/npm/html/partial/doc/cli/npm-ls.html | 2 | ||||
| -rw-r--r-- | deps/npm/html/partial/doc/cli/npm-submodule.html | 21 | ||||
| -rw-r--r-- | deps/npm/html/partial/doc/cli/npm-version.html | 42 | ||||
| -rw-r--r-- | deps/npm/html/partial/doc/cli/npm.html | 8 | ||||
| -rw-r--r-- | deps/npm/html/partial/doc/files/npm-json.html | 9 | ||||
| -rw-r--r-- | deps/npm/html/partial/doc/files/package.json.html | 9 | ||||
| -rw-r--r-- | deps/npm/html/partial/doc/index.html | 4 | ||||
| -rw-r--r-- | deps/npm/html/partial/doc/misc/npm-disputes.html | 6 | ||||
| -rw-r--r-- | deps/npm/html/partial/doc/misc/npm-faq.html | 3 | ||||
| -rw-r--r-- | deps/npm/html/partial/doc/misc/npm-index.html | 4 |
13 files changed, 106 insertions, 27 deletions
diff --git a/deps/npm/html/partial/doc/README.html b/deps/npm/html/partial/doc/README.html index f64b9a1d9a..7c737060f7 100644 --- a/deps/npm/html/partial/doc/README.html +++ b/deps/npm/html/partial/doc/README.html @@ -129,7 +129,7 @@ specific purpose, or lack of malice in any given npm package.</p> <p>If you have a complaint about a package in the public npm registry, and cannot <a href="https://docs.npmjs.com/misc/disputes">resolve it with the package owner</a>, please email -<a href="mailto:support@npmjs.com">support@npmjs.com</a> and explain the situation.</p> +<a href="mailto:support@npmjs.com">support@npmjs.com</a> and explain the situation.</p> <p>Any data published to The npm Registry (including user account information) may be removed or modified at the sole discretion of the npm server administrators.</p> diff --git a/deps/npm/html/partial/doc/api/npm-submodule.html b/deps/npm/html/partial/doc/api/npm-submodule.html new file mode 100644 index 0000000000..cc7dd822ad --- /dev/null +++ b/deps/npm/html/partial/doc/api/npm-submodule.html @@ -0,0 +1,21 @@ +<h1><a href="../api/npm-submodule.html">npm-submodule</a></h1> <p>Add a package as a git submodule</p> +<h2 id="synopsis">SYNOPSIS</h2> +<pre><code>npm.commands.submodule(packages, callback) +</code></pre><h2 id="description">DESCRIPTION</h2> +<p>For each package specified, npm will check if it has a git repository url +in its package.json description then add it as a git submodule at +<code>node_modules/<pkg name></code>.</p> +<p>This is a convenience only. From then on, it's up to you to manage +updates by using the appropriate git commands. npm will stubbornly +refuse to update, modify, or remove anything with a <code>.git</code> subfolder +in it.</p> +<p>This command also does not install missing dependencies, if the package +does not include them in its git repository. If <code>npm ls</code> reports that +things are missing, you can either install, link, or submodule them yourself, +or you can do <code>npm explore <pkgname> -- npm install</code> to install the +dependencies into the submodule folder.</p> +<h2 id="see-also">SEE ALSO</h2> +<ul> +<li>npm help json</li> +<li>git help submodule</li> +</ul> diff --git a/deps/npm/html/partial/doc/api/npm.html b/deps/npm/html/partial/doc/api/npm.html index a1bb5c8487..b97af0bc72 100644 --- a/deps/npm/html/partial/doc/api/npm.html +++ b/deps/npm/html/partial/doc/api/npm.html @@ -12,7 +12,7 @@ npm.load([configObject, ]function (er, npm) { npm.commands.install(["package"], cb) }) </code></pre><h2 id="version">VERSION</h2> -<p>2.12.1</p> +<p>2.13.0</p> <h2 id="description">DESCRIPTION</h2> <p>This is the API documentation for npm. To find documentation of the command line diff --git a/deps/npm/html/partial/doc/cli/npm-ls.html b/deps/npm/html/partial/doc/cli/npm-ls.html index 764efd448f..c44acae99d 100644 --- a/deps/npm/html/partial/doc/cli/npm-ls.html +++ b/deps/npm/html/partial/doc/cli/npm-ls.html @@ -11,7 +11,7 @@ installed, as well as their dependencies, in a tree-structure.</p> 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.12.1 /path/to/npm +<pre><code>npm@2.13.0 /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> diff --git a/deps/npm/html/partial/doc/cli/npm-submodule.html b/deps/npm/html/partial/doc/cli/npm-submodule.html new file mode 100644 index 0000000000..dd7c7e8878 --- /dev/null +++ b/deps/npm/html/partial/doc/cli/npm-submodule.html @@ -0,0 +1,21 @@ +<h1><a href="../cli/npm-submodule.html">npm-submodule</a></h1> <p>Add a package as a git submodule</p> +<h2 id="synopsis">SYNOPSIS</h2> +<pre><code>npm submodule <pkg> +</code></pre><h2 id="description">DESCRIPTION</h2> +<p>If the specified package has a git repository url in its package.json +description, then this command will add it as a git submodule at +<code>node_modules/<pkg name></code>.</p> +<p>This is a convenience only. From then on, it's up to you to manage +updates by using the appropriate git commands. npm will stubbornly +refuse to update, modify, or remove anything with a <code>.git</code> subfolder +in it.</p> +<p>This command also does not install missing dependencies, if the package +does not include them in its git repository. If <code>npm ls</code> reports that +things are missing, you can either install, link, or submodule them yourself, +or you can do <code>npm explore <pkgname> -- npm install</code> to install the +dependencies into the submodule folder.</p> +<h2 id="see-also">SEE ALSO</h2> +<ul> +<li><a href="../files/package.json.html">package.json(5)</a></li> +<li>git help submodule</li> +</ul> diff --git a/deps/npm/html/partial/doc/cli/npm-version.html b/deps/npm/html/partial/doc/cli/npm-version.html index ba4ac5a7b0..1beda3d288 100644 --- a/deps/npm/html/partial/doc/cli/npm-version.html +++ b/deps/npm/html/partial/doc/cli/npm-version.html @@ -8,10 +8,11 @@ data back to <code>package.json</code> and, if present, <code>npm-shrinkwrap.jso 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, and fail if -the repo is not clean. 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></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 @@ -29,12 +30,33 @@ user: "isaacs (http://blog.izs.me/) <i@izs.me>" 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>. -<code>preversion</code> and <code>version</code> are executed before bumping the package version, and -<code>postversion</code> is executed afterwards. For example, to run <code>npm version</code> only if -all tests pass:</p> -<pre><code>"scripts": { "preversion": "npm test" } -</code></pre><h2 id="configuration">CONFIGURATION</h2> +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> diff --git a/deps/npm/html/partial/doc/cli/npm.html b/deps/npm/html/partial/doc/cli/npm.html index 87ef252b9b..daf061f3c2 100644 --- a/deps/npm/html/partial/doc/cli/npm.html +++ b/deps/npm/html/partial/doc/cli/npm.html @@ -2,7 +2,7 @@ <h2 id="synopsis">SYNOPSIS</h2> <pre><code>npm <command> [args] </code></pre><h2 id="version">VERSION</h2> -<p>2.12.1</p> +<p>2.13.0</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 @@ -99,7 +99,7 @@ easily by doing <code>npm view npm contributors</code>.</p> the issues list or ask on the mailing list.</p> <ul> <li><a href="http://github.com/npm/npm/issues">http://github.com/npm/npm/issues</a></li> -<li><a href="mailto:npm-@googlegroups.com">npm-@googlegroups.com</a></li> +<li><a href="mailto:npm-@googlegroups.com">npm-@googlegroups.com</a></li> </ul> <h2 id="bugs">BUGS</h2> <p>When you find issues, please report them:</p> @@ -107,7 +107,7 @@ the issues list or ask on the mailing list.</p> <li>web: <a href="http://github.com/npm/npm/issues">http://github.com/npm/npm/issues</a></li> <li>email: -<a href="mailto:npm-@googlegroups.com">npm-@googlegroups.com</a></li> +<a href="mailto:npm-@googlegroups.com">npm-@googlegroups.com</a></li> </ul> <p>Be sure to include <em>all</em> of the output from the npm command that didn't work as expected. The <code>npm-debug.log</code> file is also helpful to provide.</p> @@ -117,7 +117,7 @@ will no doubt tell you to put the output in a gist or email.</p> <p><a href="http://blog.izs.me/">Isaac Z. Schlueter</a> :: <a href="https://github.com/isaacs/">isaacs</a> :: <a href="http://twitter.com/izs">@izs</a> :: -<a href="mailto:i@izs.me">i@izs.me</a></p> +<a href="mailto:i@izs.me">i@izs.me</a></p> <h2 id="see-also">SEE ALSO</h2> <ul> <li><a href="../cli/npm-help.html">npm-help(1)</a></li> diff --git a/deps/npm/html/partial/doc/files/npm-json.html b/deps/npm/html/partial/doc/files/npm-json.html index 7de449e656..a9877dcce3 100644 --- a/deps/npm/html/partial/doc/files/npm-json.html +++ b/deps/npm/html/partial/doc/files/npm-json.html @@ -197,9 +197,12 @@ you'll see that it has directories for doc, lib, and man.</p> <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, then all the files in that folder will -be added as children of the <code>bin</code> path.</p> -<p>If you have a <code>bin</code> path already, then this has no effect.</p> +<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> diff --git a/deps/npm/html/partial/doc/files/package.json.html b/deps/npm/html/partial/doc/files/package.json.html index 7de449e656..a9877dcce3 100644 --- a/deps/npm/html/partial/doc/files/package.json.html +++ b/deps/npm/html/partial/doc/files/package.json.html @@ -197,9 +197,12 @@ you'll see that it has directories for doc, lib, and man.</p> <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, then all the files in that folder will -be added as children of the <code>bin</code> path.</p> -<p>If you have a <code>bin</code> path already, then this has no effect.</p> +<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> diff --git a/deps/npm/html/partial/doc/index.html b/deps/npm/html/partial/doc/index.html index 2048487ee2..d074d9127b 100644 --- a/deps/npm/html/partial/doc/index.html +++ b/deps/npm/html/partial/doc/index.html @@ -55,6 +55,8 @@ <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> @@ -141,6 +143,8 @@ <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> diff --git a/deps/npm/html/partial/doc/misc/npm-disputes.html b/deps/npm/html/partial/doc/misc/npm-disputes.html index ff65285819..8359c9eb41 100644 --- a/deps/npm/html/partial/doc/misc/npm-disputes.html +++ b/deps/npm/html/partial/doc/misc/npm-disputes.html @@ -2,7 +2,7 @@ <h2 id="synopsis">SYNOPSIS</h2> <ol> <li>Get the author email with <code>npm owner ls <pkgname></code></li> -<li>Email the author, CC <a href="mailto:support@npmjs.com">support@npmjs.com</a></li> +<li>Email the author, CC <a href="mailto:support@npmjs.com">support@npmjs.com</a></li> <li>After a few weeks, if there's no resolution, we'll sort it out.</li> </ol> <p>Don't squat on package names. Publish code or move out of the way.</p> @@ -40,12 +40,12 @@ Joe's appropriate course of action in each case is the same.</p> owner (Bob).</li> <li>Joe emails Bob, explaining the situation <strong>as respectfully as possible</strong>, and what he would like to do with the module name. He -adds the npm support staff <a href="mailto:support@npmjs.com">support@npmjs.com</a> to the CC list of +adds the npm support staff <a href="mailto:support@npmjs.com">support@npmjs.com</a> to the CC list of the email. Mention in the email that Bob can run <code>npm owner add joe foo</code> to add Joe as an owner of the <code>foo</code> package.</li> <li>After a reasonable amount of time, if Bob has not responded, or if Bob and Joe can't come to any sort of resolution, email support -<a href="mailto:support@npmjs.com">support@npmjs.com</a> and we'll sort it out. ("Reasonable" is +<a href="mailto:support@npmjs.com">support@npmjs.com</a> and we'll sort it out. ("Reasonable" is usually at least 4 weeks, but extra time is allowed around common holidays.)</li> </ol> diff --git a/deps/npm/html/partial/doc/misc/npm-faq.html b/deps/npm/html/partial/doc/misc/npm-faq.html index 5452d1731a..22fb496ae6 100644 --- a/deps/npm/html/partial/doc/misc/npm-faq.html +++ b/deps/npm/html/partial/doc/misc/npm-faq.html @@ -202,6 +202,7 @@ of Node 0.3.</p> <p>Windows:</p> <ul> <li><a href="http://github.com/marcelklehr/nodist">http://github.com/marcelklehr/nodist</a></li> +<li><a href="https://github.com/coreybutler/nvm-windows">https://github.com/coreybutler/nvm-windows</a></li> <li><a href="https://github.com/hakobera/nvmw">https://github.com/hakobera/nvmw</a></li> <li><a href="https://github.com/nanjingboy/nvmw">https://github.com/nanjingboy/nvmw</a></li> </ul> @@ -225,7 +226,7 @@ that has a package.json in its root, or a git url. <p>To check if the registry is down, open up <a href="https://registry.npmjs.org/">https://registry.npmjs.org/</a> in a web browser. This will also tell you if you are just unable to access the internet for some reason.</p> -<p>If the registry IS down, let us know by emailing <a href="mailto:support@npmjs.com">support@npmjs.com</a> +<p>If the registry IS down, let us know by emailing <a href="mailto:support@npmjs.com">support@npmjs.com</a> or posting an issue at <a href="https://github.com/npm/npm/issues">https://github.com/npm/npm/issues</a>. If it's down for the world (and not just on your local network) then we're probably already being pinged about it.</p> diff --git a/deps/npm/html/partial/doc/misc/npm-index.html b/deps/npm/html/partial/doc/misc/npm-index.html index feeb5792cd..a75c025771 100644 --- a/deps/npm/html/partial/doc/misc/npm-index.html +++ b/deps/npm/html/partial/doc/misc/npm-index.html @@ -55,6 +55,8 @@ <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> @@ -141,6 +143,8 @@ <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> |