diff options
Diffstat (limited to 'deps/npm/html/doc/misc')
| -rw-r--r-- | deps/npm/html/doc/misc/index.html | 438 | ||||
| -rw-r--r-- | deps/npm/html/doc/misc/npm-coding-style.html | 2 | ||||
| -rw-r--r-- | deps/npm/html/doc/misc/npm-config.html | 36 | ||||
| -rw-r--r-- | deps/npm/html/doc/misc/npm-developers.html | 2 | ||||
| -rw-r--r-- | deps/npm/html/doc/misc/npm-disputes.html | 8 | ||||
| -rw-r--r-- | deps/npm/html/doc/misc/npm-faq.html | 25 | ||||
| -rw-r--r-- | deps/npm/html/doc/misc/npm-index.html | 4 | ||||
| -rw-r--r-- | deps/npm/html/doc/misc/npm-registry.html | 17 | ||||
| -rw-r--r-- | deps/npm/html/doc/misc/npm-scope.html | 2 | ||||
| -rw-r--r-- | deps/npm/html/doc/misc/npm-scripts.html | 7 | ||||
| -rw-r--r-- | deps/npm/html/doc/misc/removing-npm.html | 2 | ||||
| -rw-r--r-- | deps/npm/html/doc/misc/semver.html | 186 |
12 files changed, 200 insertions, 529 deletions
diff --git a/deps/npm/html/doc/misc/index.html b/deps/npm/html/doc/misc/index.html deleted file mode 100644 index 4db393c7c4..0000000000 --- a/deps/npm/html/doc/misc/index.html +++ /dev/null @@ -1,438 +0,0 @@ -<!doctype html> -<html> - <title>index</title> - <meta http-equiv="content-type" value="text/html;utf-8"> - <link rel="stylesheet" type="text/css" href="../../static/style.css"> - - <body> - <div id="wrapper"> -<h1><a href="../misc/npm-index.html">npm-index</a></h1> <p>Index of all npm documentation</p> - -<h2 id="README-1"><a href="../../doc/README.html">README</a></h2> - -<p>node package manager</p> - -<h1>Command Line Documentation</h1> - -<h2 id="npm-1"><a href="../cli/npm.html">npm(1)</a></h2> - -<p>node package manager</p> - -<h2 id="npm-adduser-1"><a href="../cli/npm-adduser.html">npm-adduser(1)</a></h2> - -<p>Add a registry user account</p> - -<h2 id="npm-bin-1"><a href="../cli/npm-bin.html">npm-bin(1)</a></h2> - -<p>Display npm bin folder</p> - -<h2 id="npm-bugs-1"><a href="../cli/npm-bugs.html">npm-bugs(1)</a></h2> - -<p>Bugs for a package in a web browser maybe</p> - -<h2 id="npm-build-1"><a href="../cli/npm-build.html">npm-build(1)</a></h2> - -<p>Build a package</p> - -<h2 id="npm-bundle-1"><a href="../cli/npm-bundle.html">npm-bundle(1)</a></h2> - -<p>REMOVED</p> - -<h2 id="npm-cache-1"><a href="../cli/npm-cache.html">npm-cache(1)</a></h2> - -<p>Manipulates packages cache</p> - -<h2 id="npm-completion-1"><a href="../cli/npm-completion.html">npm-completion(1)</a></h2> - -<p>Tab Completion for npm</p> - -<h2 id="npm-config-1"><a href="../cli/npm-config.html">npm-config(1)</a></h2> - -<p>Manage the npm configuration files</p> - -<h2 id="npm-dedupe-1"><a href="../cli/npm-dedupe.html">npm-dedupe(1)</a></h2> - -<p>Reduce duplication</p> - -<h2 id="npm-deprecate-1"><a href="../cli/npm-deprecate.html">npm-deprecate(1)</a></h2> - -<p>Deprecate a version of a package</p> - -<h2 id="npm-docs-1"><a href="../cli/npm-docs.html">npm-docs(1)</a></h2> - -<p>Docs for a package in a web browser maybe</p> - -<h2 id="npm-edit-1"><a href="../cli/npm-edit.html">npm-edit(1)</a></h2> - -<p>Edit an installed package</p> - -<h2 id="npm-explore-1"><a href="../cli/npm-explore.html">npm-explore(1)</a></h2> - -<p>Browse an installed package</p> - -<h2 id="npm-help-search-1"><a href="../cli/npm-help-search.html">npm-help-search(1)</a></h2> - -<p>Search npm help documentation</p> - -<h2 id="npm-help-1"><a href="../cli/npm-help.html">npm-help(1)</a></h2> - -<p>Get help on npm</p> - -<h2 id="npm-init-1"><a href="../cli/npm-init.html">npm-init(1)</a></h2> - -<p>Interactively create a package.json file</p> - -<h2 id="npm-install-1"><a href="../cli/npm-install.html">npm-install(1)</a></h2> - -<p>Install a package</p> - -<h2 id="npm-link-1"><a href="../cli/npm-link.html">npm-link(1)</a></h2> - -<p>Symlink a package folder</p> - -<h2 id="npm-ls-1"><a href="../cli/npm-ls.html">npm-ls(1)</a></h2> - -<p>List installed packages</p> - -<h2 id="npm-outdated-1"><a href="../cli/npm-outdated.html">npm-outdated(1)</a></h2> - -<p>Check for outdated packages</p> - -<h2 id="npm-owner-1"><a href="../cli/npm-owner.html">npm-owner(1)</a></h2> - -<p>Manage package owners</p> - -<h2 id="npm-pack-1"><a href="../cli/npm-pack.html">npm-pack(1)</a></h2> - -<p>Create a tarball from a package</p> - -<h2 id="npm-prefix-1"><a href="../cli/npm-prefix.html">npm-prefix(1)</a></h2> - -<p>Display prefix</p> - -<h2 id="npm-prune-1"><a href="../cli/npm-prune.html">npm-prune(1)</a></h2> - -<p>Remove extraneous packages</p> - -<h2 id="npm-publish-1"><a href="../cli/npm-publish.html">npm-publish(1)</a></h2> - -<p>Publish a package</p> - -<h2 id="npm-rebuild-1"><a href="../cli/npm-rebuild.html">npm-rebuild(1)</a></h2> - -<p>Rebuild a package</p> - -<h2 id="npm-restart-1"><a href="../cli/npm-restart.html">npm-restart(1)</a></h2> - -<p>Start a package</p> - -<h2 id="npm-rm-1"><a href="../cli/npm-rm.html">npm-rm(1)</a></h2> - -<p>Remove a package</p> - -<h2 id="npm-root-1"><a href="../cli/npm-root.html">npm-root(1)</a></h2> - -<p>Display npm root</p> - -<h2 id="npm-run-script-1"><a href="../cli/npm-run-script.html">npm-run-script(1)</a></h2> - -<p>Run arbitrary package scripts</p> - -<h2 id="npm-search-1"><a href="../cli/npm-search.html">npm-search(1)</a></h2> - -<p>Search for packages</p> - -<h2 id="npm-shrinkwrap-1"><a href="../cli/npm-shrinkwrap.html">npm-shrinkwrap(1)</a></h2> - -<p>Lock down dependency versions</p> - -<h2 id="npm-star-1"><a href="../cli/npm-star.html">npm-star(1)</a></h2> - -<p>Mark your favorite packages</p> - -<h2 id="npm-stars-1"><a href="../cli/npm-stars.html">npm-stars(1)</a></h2> - -<p>View packages marked as favorites</p> - -<h2 id="npm-start-1"><a href="../cli/npm-start.html">npm-start(1)</a></h2> - -<p>Start a package</p> - -<h2 id="npm-stop-1"><a href="../cli/npm-stop.html">npm-stop(1)</a></h2> - -<p>Stop a package</p> - -<h2 id="npm-submodule-1"><a href="../cli/npm-submodule.html">npm-submodule(1)</a></h2> - -<p>Add a package as a git submodule</p> - -<h2 id="npm-tag-1"><a href="../cli/npm-tag.html">npm-tag(1)</a></h2> - -<p>Tag a published version</p> - -<h2 id="npm-test-1"><a href="../cli/npm-test.html">npm-test(1)</a></h2> - -<p>Test a package</p> - -<h2 id="npm-uninstall-1"><a href="../cli/npm-uninstall.html">npm-uninstall(1)</a></h2> - -<p>Remove a package</p> - -<h2 id="npm-unpublish-1"><a href="../cli/npm-unpublish.html">npm-unpublish(1)</a></h2> - -<p>Remove a package from the registry</p> - -<h2 id="npm-update-1"><a href="../cli/npm-update.html">npm-update(1)</a></h2> - -<p>Update a package</p> - -<h2 id="npm-version-1"><a href="../cli/npm-version.html">npm-version(1)</a></h2> - -<p>Bump a package version</p> - -<h2 id="npm-view-1"><a href="../cli/npm-view.html">npm-view(1)</a></h2> - -<p>View registry info</p> - -<h2 id="npm-whoami-1"><a href="../cli/npm-whoami.html">npm-whoami(1)</a></h2> - -<p>Display npm username</p> - -<h1>API Documentation</h1> - -<h2 id="npm-3"><a href="../api/npm.html">npm(3)</a></h2> - -<p>node package manager</p> - -<h2 id="npm-bin-3"><a href="../api/npm-bin.html">npm-bin(3)</a></h2> - -<p>Display npm bin folder</p> - -<h2 id="npm-bugs-3"><a href="../api/npm-bugs.html">npm-bugs(3)</a></h2> - -<p>Bugs for a package in a web browser maybe</p> - -<h2 id="npm-commands-3"><a href="../api/npm-commands.html">npm-commands(3)</a></h2> - -<p>npm commands</p> - -<h2 id="npm-config-3"><a href="../api/npm-config.html">npm-config(3)</a></h2> - -<p>Manage the npm configuration files</p> - -<h2 id="npm-deprecate-3"><a href="../api/npm-deprecate.html">npm-deprecate(3)</a></h2> - -<p>Deprecate a version of a package</p> - -<h2 id="npm-docs-3"><a href="../api/npm-docs.html">npm-docs(3)</a></h2> - -<p>Docs for a package in a web browser maybe</p> - -<h2 id="npm-edit-3"><a href="../api/npm-edit.html">npm-edit(3)</a></h2> - -<p>Edit an installed package</p> - -<h2 id="npm-explore-3"><a href="../api/npm-explore.html">npm-explore(3)</a></h2> - -<p>Browse an installed package</p> - -<h2 id="npm-help-search-3"><a href="../api/npm-help-search.html">npm-help-search(3)</a></h2> - -<p>Search the help pages</p> - -<h2 id="npm-init-3"><a href="../api/npm-init.html">npm-init(3)</a></h2> - -<p>Interactively create a package.json file</p> - -<h2 id="npm-install-3"><a href="../api/npm-install.html">npm-install(3)</a></h2> - -<p>install a package programmatically</p> - -<h2 id="npm-link-3"><a href="../api/npm-link.html">npm-link(3)</a></h2> - -<p>Symlink a package folder</p> - -<h2 id="npm-load-3"><a href="../api/npm-load.html">npm-load(3)</a></h2> - -<p>Load config settings</p> - -<h2 id="npm-ls-3"><a href="../api/npm-ls.html">npm-ls(3)</a></h2> - -<p>List installed packages</p> - -<h2 id="npm-outdated-3"><a href="../api/npm-outdated.html">npm-outdated(3)</a></h2> - -<p>Check for outdated packages</p> - -<h2 id="npm-owner-3"><a href="../api/npm-owner.html">npm-owner(3)</a></h2> - -<p>Manage package owners</p> - -<h2 id="npm-pack-3"><a href="../api/npm-pack.html">npm-pack(3)</a></h2> - -<p>Create a tarball from a package</p> - -<h2 id="npm-prefix-3"><a href="../api/npm-prefix.html">npm-prefix(3)</a></h2> - -<p>Display prefix</p> - -<h2 id="npm-prune-3"><a href="../api/npm-prune.html">npm-prune(3)</a></h2> - -<p>Remove extraneous packages</p> - -<h2 id="npm-publish-3"><a href="../api/npm-publish.html">npm-publish(3)</a></h2> - -<p>Publish a package</p> - -<h2 id="npm-rebuild-3"><a href="../api/npm-rebuild.html">npm-rebuild(3)</a></h2> - -<p>Rebuild a package</p> - -<h2 id="npm-restart-3"><a href="../api/npm-restart.html">npm-restart(3)</a></h2> - -<p>Start a package</p> - -<h2 id="npm-root-3"><a href="../api/npm-root.html">npm-root(3)</a></h2> - -<p>Display npm root</p> - -<h2 id="npm-run-script-3"><a href="../api/npm-run-script.html">npm-run-script(3)</a></h2> - -<p>Run arbitrary package scripts</p> - -<h2 id="npm-search-3"><a href="../api/npm-search.html">npm-search(3)</a></h2> - -<p>Search for packages</p> - -<h2 id="npm-shrinkwrap-3"><a href="../api/npm-shrinkwrap.html">npm-shrinkwrap(3)</a></h2> - -<p>programmatically generate package shrinkwrap file</p> - -<h2 id="npm-start-3"><a href="../api/npm-start.html">npm-start(3)</a></h2> - -<p>Start a package</p> - -<h2 id="npm-stop-3"><a href="../api/npm-stop.html">npm-stop(3)</a></h2> - -<p>Stop a package</p> - -<h2 id="npm-submodule-3"><a href="../api/npm-submodule.html">npm-submodule(3)</a></h2> - -<p>Add a package as a git submodule</p> - -<h2 id="npm-tag-3"><a href="../api/npm-tag.html">npm-tag(3)</a></h2> - -<p>Tag a published version</p> - -<h2 id="npm-test-3"><a href="../api/npm-test.html">npm-test(3)</a></h2> - -<p>Test a package</p> - -<h2 id="npm-uninstall-3"><a href="../api/npm-uninstall.html">npm-uninstall(3)</a></h2> - -<p>uninstall a package programmatically</p> - -<h2 id="npm-unpublish-3"><a href="../api/npm-unpublish.html">npm-unpublish(3)</a></h2> - -<p>Remove a package from the registry</p> - -<h2 id="npm-update-3"><a href="../api/npm-update.html">npm-update(3)</a></h2> - -<p>Update a package</p> - -<h2 id="npm-version-3"><a href="../api/npm-version.html">npm-version(3)</a></h2> - -<p>Bump a package version</p> - -<h2 id="npm-view-3"><a href="../api/npm-view.html">npm-view(3)</a></h2> - -<p>View registry info</p> - -<h2 id="npm-whoami-3"><a href="../api/npm-whoami.html">npm-whoami(3)</a></h2> - -<p>Display npm username</p> - -<h1>Files</h1> - -<h2 id="npm-folders-5"><a href="../files/npm-folders.html">npm-folders(5)</a></h2> - -<p>Folder Structures Used by npm</p> - -<h2 id="npmrc-5"><a href="../files/npmrc.html">npmrc(5)</a></h2> - -<p>The npm config files</p> - -<h2 id="package-json-5"><a href="../files/package.json.html">package.json(5)</a></h2> - -<p>Specifics of npm's package.json handling</p> - -<h1>Misc</h1> - -<h2 id="npm-coding-style-7"><a href="../misc/npm-coding-style.html">npm-coding-style(7)</a></h2> - -<p>npm's "funny" coding style</p> - -<h2 id="npm-config-7"><a href="../misc/npm-config.html">npm-config(7)</a></h2> - -<p>More than you probably want to know about npm configuration</p> - -<h2 id="npm-developers-7"><a href="../misc/npm-developers.html">npm-developers(7)</a></h2> - -<p>Developer Guide</p> - -<h2 id="npm-disputes-7"><a href="../misc/npm-disputes.html">npm-disputes(7)</a></h2> - -<p>Handling Module Name Disputes</p> - -<h2 id="npm-faq-7"><a href="../misc/npm-faq.html">npm-faq(7)</a></h2> - -<p>Frequently Asked Questions</p> - -<h2 id="npm-registry-7"><a href="../misc/npm-registry.html">npm-registry(7)</a></h2> - -<p>The JavaScript Package Registry</p> - -<h2 id="npm-scripts-7"><a href="../misc/npm-scripts.html">npm-scripts(7)</a></h2> - -<p>How npm handles the "scripts" field</p> - -<h2 id="removing-npm-7"><a href="../misc/removing-npm.html">removing-npm(7)</a></h2> - -<p>Cleaning the Slate</p> - -<h2 id="semver-7"><a href="../misc/semver.html">semver(7)</a></h2> - -<p>The semantic versioner for npm</p> -</div> -<p id="footer">index — npm@1.3.2</p> -<script> -;(function () { -var wrapper = document.getElementById("wrapper") -var els = Array.prototype.slice.call(wrapper.getElementsByTagName("*"), 0) - .filter(function (el) { - return el.parentNode === wrapper - && el.tagName.match(/H[1-6]/) - && el.id - }) -var l = 2 - , toc = document.createElement("ul") -toc.innerHTML = els.map(function (el) { - var i = el.tagName.charAt(1) - , out = "" - while (i > l) { - out += "<ul>" - l ++ - } - while (i < l) { - out += "</ul>" - l -- - } - out += "<li><a href='#" + el.id + "'>" + - ( el.innerText || el.text || el.innerHTML) - + "</a>" - return out -}).join("\n") -toc.id = "toc" -document.body.appendChild(toc) -})() -</script> diff --git a/deps/npm/html/doc/misc/npm-coding-style.html b/deps/npm/html/doc/misc/npm-coding-style.html index cd523ac910..5d94f84bf0 100644 --- a/deps/npm/html/doc/misc/npm-coding-style.html +++ b/deps/npm/html/doc/misc/npm-coding-style.html @@ -147,5 +147,5 @@ set to anything."</p> <tr><td style="width:60px;height:10px;background:rgb(237,127,127)" colspan=6> </td><td colspan=10 style="width:10px;height:10px;background:rgb(237,127,127)"> </td></tr> <tr><td colspan=5 style="width:50px;height:10px;background:#fff"> </td><td style="width:40px;height:10px;background:rgb(237,127,127)" colspan=4> </td><td style="width:90px;height:10px;background:#fff" colspan=9> </td></tr> </table> -<p id="footer">npm-coding-style — npm@1.4.28</p> +<p id="footer">npm-coding-style — npm@2.0.0</p> diff --git a/deps/npm/html/doc/misc/npm-config.html b/deps/npm/html/doc/misc/npm-config.html index aa4c300bfa..e7696f491e 100644 --- a/deps/npm/html/doc/misc/npm-config.html +++ b/deps/npm/html/doc/misc/npm-config.html @@ -48,6 +48,7 @@ defaults if nothing else is specified.</p> <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> @@ -215,9 +216,6 @@ 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="email">email</h3> -<p>The email of the logged-in user.</p> -<p>Set by the <code>npm adduser</code> command. Should not be set explicitly.</p> <h3 id="engine-strict">engine-strict</h3> <ul> <li>Default: false</li> @@ -359,6 +357,13 @@ for more information, or <a href="../cli/npm-init.html">npm-init(1)</a>.</p> <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: "0.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> @@ -400,7 +405,7 @@ to the npm registry. Must be IPv4 in versions of Node prior to 0.12.</p> <ul> <li>Default: "http"</li> <li>Type: String</li> -<li>Values: "silent", "win", "error", "warn", "http", "info", "verbose", "silly"</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> @@ -568,11 +573,22 @@ devDependencies hash.</p> <li>Default: '^'</li> <li>Type: String</li> </ul> -<p>Configure how versions of packages installed to a package.json file via +<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 it's version is -set to <code>^1.2.3</code> which allows minor upgrades for that package, but after<br><code>npm config set save-prefix='~'</code> it would be set to <code>~1.2.3</code> which only allows +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> @@ -678,12 +694,6 @@ instead of complete help when doing <code><a href="../cli/npm-help.html">npm-hel <li>Type: String or Number</li> </ul> <p>The UID to set to when running package scripts as root.</p> -<h3 id="username">username</h3> -<ul> -<li>Default: null</li> -<li>Type: String</li> -</ul> -<p>The username on the npm registry. Set with <code>npm adduser</code></p> <h3 id="userconfig">userconfig</h3> <ul> <li>Default: ~/.npmrc</li> @@ -749,5 +759,5 @@ hash, and exit successfully.</p> <tr><td style="width:60px;height:10px;background:rgb(237,127,127)" colspan=6> </td><td colspan=10 style="width:10px;height:10px;background:rgb(237,127,127)"> </td></tr> <tr><td colspan=5 style="width:50px;height:10px;background:#fff"> </td><td style="width:40px;height:10px;background:rgb(237,127,127)" colspan=4> </td><td style="width:90px;height:10px;background:#fff" colspan=9> </td></tr> </table> -<p id="footer">npm-config — npm@1.4.28</p> +<p id="footer">npm-config — npm@2.0.0</p> diff --git a/deps/npm/html/doc/misc/npm-developers.html b/deps/npm/html/doc/misc/npm-developers.html index 3cc1b0466c..1734785f4b 100644 --- a/deps/npm/html/doc/misc/npm-developers.html +++ b/deps/npm/html/doc/misc/npm-developers.html @@ -181,5 +181,5 @@ from a fresh checkout.</p> <tr><td style="width:60px;height:10px;background:rgb(237,127,127)" colspan=6> </td><td colspan=10 style="width:10px;height:10px;background:rgb(237,127,127)"> </td></tr> <tr><td colspan=5 style="width:50px;height:10px;background:#fff"> </td><td style="width:40px;height:10px;background:rgb(237,127,127)" colspan=4> </td><td style="width:90px;height:10px;background:#fff" colspan=9> </td></tr> </table> -<p id="footer">npm-developers — npm@1.4.28</p> +<p id="footer">npm-developers — npm@2.0.0</p> diff --git a/deps/npm/html/doc/misc/npm-disputes.html b/deps/npm/html/doc/misc/npm-disputes.html index 7a45340936..e6bc9a6180 100644 --- a/deps/npm/html/doc/misc/npm-disputes.html +++ b/deps/npm/html/doc/misc/npm-disputes.html @@ -13,7 +13,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> @@ -51,12 +51,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> @@ -112,5 +112,5 @@ things into it.</li> <tr><td style="width:60px;height:10px;background:rgb(237,127,127)" colspan=6> </td><td colspan=10 style="width:10px;height:10px;background:rgb(237,127,127)"> </td></tr> <tr><td colspan=5 style="width:50px;height:10px;background:#fff"> </td><td style="width:40px;height:10px;background:rgb(237,127,127)" colspan=4> </td><td style="width:90px;height:10px;background:#fff" colspan=9> </td></tr> </table> -<p id="footer">npm-disputes — npm@1.4.28</p> +<p id="footer">npm-disputes — npm@2.0.0</p> diff --git a/deps/npm/html/doc/misc/npm-faq.html b/deps/npm/html/doc/misc/npm-faq.html index cdde512eee..85536d6f12 100644 --- a/deps/npm/html/doc/misc/npm-faq.html +++ b/deps/npm/html/doc/misc/npm-faq.html @@ -59,17 +59,16 @@ program that uses it.</p> in a shell script if you really wanted to.</p> <p>npm will not help you do something that is known to be a bad idea.</p> <h2 id="should-i-check-my-node_modules-folder-into-git-">Should I check my <code>node_modules</code> folder into git?</h2> -<p>Mikeal Rogers answered this question very well:</p> -<p><a href="http://www.futurealoof.com/posts/nodemodules-in-git.html">http://www.futurealoof.com/posts/nodemodules-in-git.html</a></p> -<p>tl;dr</p> -<ul> -<li>Check <code>node_modules</code> into git for things you <strong>deploy</strong>, such as -websites and apps.</li> -<li>Do not check <code>node_modules</code> into git for libraries and modules -intended to be reused.</li> -<li>Use npm to manage dependencies in your dev environment, but not in -your deployment scripts.</li> -</ul> +<p>Usually, no. Allow npm to resolve dependencies for your packages.</p> +<p>For packages you <strong>deploy</strong>, such as websites and apps, +you should use npm shrinkwrap to lock down your full dependency tree:</p> +<p><a href="https://www.npmjs.org/doc/cli/npm-shrinkwrap.html">https://www.npmjs.org/doc/cli/npm-shrinkwrap.html</a></p> +<p>If you are paranoid about depending on the npm ecosystem, +you should run a private npm mirror or a private cache.</p> +<p>If you want 100% confidence in being able to reproduce the specific bytes +included in a deployment, you should use an additional mechanism that can +verify contents rather than versions. For example, +Amazon machine images, DigitalOcean snapshots, Heroku slugs, or simple tarballs.</p> <h2 id="is-it-npm-or-npm-or-npm-">Is it 'npm' or 'NPM' or 'Npm'?</h2> <p>npm should never be capitalized unless it is being displayed in a location that is customarily all-caps (such as the title of man pages.)</p> @@ -237,7 +236,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> @@ -285,5 +284,5 @@ good folks at <a href="http://www.npmjs.com">npm, Inc.</a></p> <tr><td style="width:60px;height:10px;background:rgb(237,127,127)" colspan=6> </td><td colspan=10 style="width:10px;height:10px;background:rgb(237,127,127)"> </td></tr> <tr><td colspan=5 style="width:50px;height:10px;background:#fff"> </td><td style="width:40px;height:10px;background:rgb(237,127,127)" colspan=4> </td><td style="width:90px;height:10px;background:#fff" colspan=9> </td></tr> </table> -<p id="footer">npm-faq — npm@1.4.28</p> +<p id="footer">npm-faq — npm@2.0.0</p> diff --git a/deps/npm/html/doc/misc/npm-index.html b/deps/npm/html/doc/misc/npm-index.html index 3346d1ce98..6de20ca442 100644 --- a/deps/npm/html/doc/misc/npm-index.html +++ b/deps/npm/html/doc/misc/npm-index.html @@ -214,6 +214,8 @@ <p>Index of all npm documentation</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> @@ -232,5 +234,5 @@ <tr><td style="width:60px;height:10px;background:rgb(237,127,127)" colspan=6> </td><td colspan=10 style="width:10px;height:10px;background:rgb(237,127,127)"> </td></tr> <tr><td colspan=5 style="width:50px;height:10px;background:#fff"> </td><td style="width:40px;height:10px;background:rgb(237,127,127)" colspan=4> </td><td style="width:90px;height:10px;background:#fff" colspan=9> </td></tr> </table> -<p id="footer">npm-index — npm@1.4.28</p> +<p id="footer">npm-index — npm@2.0.0</p> diff --git a/deps/npm/html/doc/misc/npm-registry.html b/deps/npm/html/doc/misc/npm-registry.html index d08e8f877d..530e350d71 100644 --- a/deps/npm/html/doc/misc/npm-registry.html +++ b/deps/npm/html/doc/misc/npm-registry.html @@ -18,14 +18,13 @@ package info.</p> write APIs as well, to allow for publishing packages and managing user account information.</p> <p>The official public npm registry is at <a href="http://registry.npmjs.org/">http://registry.npmjs.org/</a>. It -is powered by a CouchDB database at -<a href="http://isaacs.iriscouch.com/registry">http://isaacs.iriscouch.com/registry</a>. The code for the couchapp is -available at <a href="http://github.com/npm/npmjs.org">http://github.com/npm/npmjs.org</a>. npm user accounts -are CouchDB users, stored in the <a href="http://isaacs.iriscouch.com/_users">http://isaacs.iriscouch.com/_users</a> -database.</p> -<p>The registry URL is supplied by the <code>registry</code> config parameter. See -<code><a href="../cli/npm-config.html">npm-config(1)</a></code>, <code><a href="../files/npmrc.html">npmrc(5)</a></code>, and <code><a href="../misc/npm-config.html">npm-config(7)</a></code> for more on managing -npm's configuration.</p> +is powered by a CouchDB database, of which there is a public mirror at +<a href="http://skimdb.npmjs.com/registry">http://skimdb.npmjs.com/registry</a>. The code for the couchapp is +available at <a href="http://github.com/npm/npm-registry-couchapp">http://github.com/npm/npm-registry-couchapp</a>.</p> +<p>The registry URL used is determined by the scope of the package (see +<code><a href="../misc/npm-scope.html">npm-scope(7)</a></code>). If no scope is specified, the default registry is used, which is +supplied by the <code>registry</code> config parameter. See <code><a href="../cli/npm-config.html">npm-config(1)</a></code>, +<code><a href="../files/npmrc.html">npmrc(5)</a></code>, and <code><a href="../misc/npm-config.html">npm-config(7)</a></code> for more on managing npm's configuration.</p> <h2 id="can-i-run-my-own-private-registry-">Can I run my own private registry?</h2> <p>Yes!</p> <p>The easiest way is to replicate the couch database, and use the same (or @@ -71,5 +70,5 @@ effectively implement the entire CouchDB API anyway.</p> <tr><td style="width:60px;height:10px;background:rgb(237,127,127)" colspan=6> </td><td colspan=10 style="width:10px;height:10px;background:rgb(237,127,127)"> </td></tr> <tr><td colspan=5 style="width:50px;height:10px;background:#fff"> </td><td style="width:40px;height:10px;background:rgb(237,127,127)" colspan=4> </td><td style="width:90px;height:10px;background:#fff" colspan=9> </td></tr> </table> -<p id="footer">npm-registry — npm@1.4.28</p> +<p id="footer">npm-registry — npm@2.0.0</p> diff --git a/deps/npm/html/doc/misc/npm-scope.html b/deps/npm/html/doc/misc/npm-scope.html index ae8dfa6037..91ac0ae8e1 100644 --- a/deps/npm/html/doc/misc/npm-scope.html +++ b/deps/npm/html/doc/misc/npm-scope.html @@ -78,5 +78,5 @@ that registry instead.</p> <tr><td style="width:60px;height:10px;background:rgb(237,127,127)" colspan=6> </td><td colspan=10 style="width:10px;height:10px;background:rgb(237,127,127)"> </td></tr> <tr><td colspan=5 style="width:50px;height:10px;background:#fff"> </td><td style="width:40px;height:10px;background:rgb(237,127,127)" colspan=4> </td><td style="width:90px;height:10px;background:#fff" colspan=9> </td></tr> </table> -<p id="footer">npm-scope — npm@2.0.0-beta.3</p> +<p id="footer">npm-scope — npm@2.0.0</p> diff --git a/deps/npm/html/doc/misc/npm-scripts.html b/deps/npm/html/doc/misc/npm-scripts.html index 0c2c697a50..8b65e871cd 100644 --- a/deps/npm/html/doc/misc/npm-scripts.html +++ b/deps/npm/html/doc/misc/npm-scripts.html @@ -41,8 +41,9 @@ Run by the <code>npm start</code> command.</li> Run by the <code>npm restart</code> command. Note: <code>npm restart</code> will run the stop and start scripts if no <code>restart</code> script is provided.</li> </ul> -<p>Additionally, arbitrary scripts can be run by doing -<code>npm run-script <pkg> <stage></code>.</p> +<p>Additionally, arbitrary scripts can be executed by running `npm run-script</p> +<p><pkg> <stage><code>. *Pre* and *post* commands with matching names will be run for +those as well (e.g.</code>premyscript<code>,</code>myscript<code>,</code>postmyscript`).</p> <h2 id="note-install-scripts-are-an-antipattern">NOTE: INSTALL SCRIPTS ARE AN ANTIPATTERN</h2> <p><strong>tl;dr</strong> Don't use <code>install</code>. Use a <code>.gyp</code> file for compilation, and <code>prepublish</code> for anything else.</p> @@ -218,5 +219,5 @@ the user will sudo the npm command in question.</li> <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-scripts — npm@1.4.28</p> +<p id="footer">npm-scripts — npm@2.0.0</p> diff --git a/deps/npm/html/doc/misc/removing-npm.html b/deps/npm/html/doc/misc/removing-npm.html index afd747c956..576c734347 100644 --- a/deps/npm/html/doc/misc/removing-npm.html +++ b/deps/npm/html/doc/misc/removing-npm.html @@ -57,5 +57,5 @@ modules. To track those down, you can do the following:</p> <tr><td style="width:60px;height:10px;background:rgb(237,127,127)" colspan=6> </td><td colspan=10 style="width:10px;height:10px;background:rgb(237,127,127)"> </td></tr> <tr><td colspan=5 style="width:50px;height:10px;background:#fff"> </td><td style="width:40px;height:10px;background:rgb(237,127,127)" colspan=4> </td><td style="width:90px;height:10px;background:#fff" colspan=9> </td></tr> </table> -<p id="footer">removing-npm — npm@1.4.28</p> +<p id="footer">removing-npm — npm@2.0.0</p> diff --git a/deps/npm/html/doc/misc/semver.html b/deps/npm/html/doc/misc/semver.html index 5ab35fa819..2a360ea08f 100644 --- a/deps/npm/html/doc/misc/semver.html +++ b/deps/npm/html/doc/misc/semver.html @@ -42,52 +42,150 @@ multiple versions to the utility will just sort them. <a href="http://semver.org/">http://semver.org/</a>.</p> <p>A leading <code>"="</code> or <code>"v"</code> character is stripped off and ignored.</p> <h2 id="ranges">Ranges</h2> -<p>The following range styles are supported:</p> +<p>A <code>version range</code> is a set of <code>comparators</code> which specify versions +that satisfy the range.</p> +<p>A <code>comparator</code> is composed of an <code>operator</code> and a <code>version</code>. The set +of primitive <code>operators</code> is:</p> +<ul> +<li><code><</code> Less than</li> +<li><code><=</code> Less than or equal to</li> +<li><code>></code> Greater than</li> +<li><code>>=</code> Greater than or equal to</li> +<li><code>=</code> Equal. If no operator is specified, then equality is assumed, +so this operator is optional, but MAY be included.</li> +</ul> +<p>For example, the comparator <code>>=1.2.7</code> would match the versions +<code>1.2.7</code>, <code>1.2.8</code>, <code>2.5.3</code>, and <code>1.3.9</code>, but not the versions <code>1.2.6</code> +or <code>1.1.0</code>.</p> +<p>Comparators can be joined by whitespace to form a <code>comparator set</code>, +which is satisfied by the <strong>intersection</strong> of all of the comparators +it includes.</p> +<p>A range is composed of one or more comparator sets, joined by <code>||</code>. A +version matches a range if and only if every comparator in at least +one of the <code>||</code>-separated comparator sets is satisfied by the version.</p> +<p>For example, the range <code>>=1.2.7 <1.3.0</code> would match the versions +<code>1.2.7</code>, <code>1.2.8</code>, and <code>1.2.99</code>, but not the versions <code>1.2.6</code>, <code>1.3.0</code>, +or <code>1.1.0</code>.</p> +<p>The range <code>1.2.7 || >=1.2.9 <2.0.0</code> would match the versions <code>1.2.7</code>, +<code>1.2.9</code>, and <code>1.4.6</code>, but not the versions <code>1.2.8</code> or <code>2.0.0</code>.</p> +<h3 id="prerelease-tags">Prerelease Tags</h3> +<p>If a version has a prerelease tag (for example, <code>1.2.3-alpha.3</code>) then +it will only be allowed to satisfy comparator sets if at least one +comparator with the same <code>[major, minor, patch]</code> tuple also has a +prerelease tag.</p> +<p>For example, the range <code>>1.2.3-alpha.3</code> would be allowed to match the +version <code>1.2.3-alpha.7</code>, but it would <em>not</em> be satisfied by +<code>3.4.5-alpha.9</code>, even though <code>3.4.5-alpha.9</code> is technically "greater +than" <code>1.2.3-alpha.3</code> according to the SemVer sort rules. The version +range only accepts prerelease tags on the <code>1.2.3</code> version. The +version <code>3.4.5</code> <em>would</em> satisfy the range, because it does not have a +prerelease flag, and <code>3.4.5</code> is greater than <code>1.2.3-alpha.7</code>.</p> +<p>The purpose for this behavior is twofold. First, prerelease versions +frequently are updated very quickly, and contain many breaking changes +that are (by the author's design) not yet fit for public consumption. +Therefore, by default, they are excluded from range matching +semantics.</p> +<p>Second, a user who has opted into using a prerelease version has +clearly indicated the intent to use <em>that specific</em> set of +alpha/beta/rc versions. By including a prerelease tag in the range, +the user is indicating that they are aware of the risk. However, it +is still not appropriate to assume that they have opted into taking a +similar risk on the <em>next</em> set of prerelease versions.</p> +<h3 id="advanced-range-syntax">Advanced Range Syntax</h3> +<p>Advanced range syntax desugars to primitive comparators in +deterministic ways.</p> +<p>Advanced ranges may be combined in the same way as primitive +comparators using white space or <code>||</code>.</p> +<h4 id="hyphen-ranges-x-y-z-a-b-c-">Hyphen Ranges <code>X.Y.Z - A.B.C</code></h4> +<p>Specifies an inclusive set.</p> <ul> -<li><code>1.2.3</code> A specific version. When nothing else will do. Must be a full -version number, with major, minor, and patch versions specified. -Note that build metadata is still ignored, so <code>1.2.3+build2012</code> will -satisfy this range.</li> -<li><code>>1.2.3</code> Greater than a specific version.</li> -<li><code><1.2.3</code> Less than a specific version. If there is no prerelease -tag on the version range, then no prerelease version will be allowed -either, even though these are technically "less than".</li> -<li><code>>=1.2.3</code> Greater than or equal to. Note that prerelease versions -are NOT equal to their "normal" equivalents, so <code>1.2.3-beta</code> will -not satisfy this range, but <code>2.3.0-beta</code> will.</li> -<li><code><=1.2.3</code> Less than or equal to. In this case, prerelease versions -ARE allowed, so <code>1.2.3-beta</code> would satisfy.</li> <li><code>1.2.3 - 2.3.4</code> := <code>>=1.2.3 <=2.3.4</code></li> -<li><code>~1.2.3</code> := <code>>=1.2.3-0 <1.3.0-0</code> "Reasonably close to <code>1.2.3</code>". When -using tilde operators, prerelease versions are supported as well, -but a prerelease of the next significant digit will NOT be -satisfactory, so <code>1.3.0-beta</code> will not satisfy <code>~1.2.3</code>.</li> -<li><code>^1.2.3</code> := <code>>=1.2.3-0 <2.0.0-0</code> "Compatible with <code>1.2.3</code>". When -using caret operators, anything from the specified version (including -prerelease) will be supported up to, but not including, the next -major version (or its prereleases). <code>1.5.1</code> will satisfy <code>^1.2.3</code>, -while <code>1.2.2</code> and <code>2.0.0-beta</code> will not.</li> -<li><code>^0.1.3</code> := <code>>=0.1.3-0 <0.2.0-0</code> "Compatible with <code>0.1.3</code>". <code>0.x.x</code> versions are -special: the first non-zero component indicates potentially breaking changes, -meaning the caret operator matches any version with the same first non-zero -component starting at the specified version.</li> -<li><code>^0.0.2</code> := <code>=0.0.2</code> "Only the version <code>0.0.2</code> is considered compatible"</li> -<li><code>~1.2</code> := <code>>=1.2.0-0 <1.3.0-0</code> "Any version starting with <code>1.2</code>"</li> -<li><code>^1.2</code> := <code>>=1.2.0-0 <2.0.0-0</code> "Any version compatible with <code>1.2</code>"</li> -<li><code>1.2.x</code> := <code>>=1.2.0-0 <1.3.0-0</code> "Any version starting with <code>1.2</code>"</li> -<li><code>1.2.*</code> Same as <code>1.2.x</code>.</li> -<li><code>1.2</code> Same as <code>1.2.x</code>.</li> -<li><code>~1</code> := <code>>=1.0.0-0 <2.0.0-0</code> "Any version starting with <code>1</code>"</li> -<li><code>^1</code> := <code>>=1.0.0-0 <2.0.0-0</code> "Any version compatible with <code>1</code>"</li> -<li><code>1.x</code> := <code>>=1.0.0-0 <2.0.0-0</code> "Any version starting with <code>1</code>"</li> -<li><code>1.*</code> Same as <code>1.x</code>.</li> -<li><code>1</code> Same as <code>1.x</code>.</li> -<li><code>*</code> Any version whatsoever.</li> -<li><code>x</code> Same as <code>*</code>.</li> -<li><code>""</code> (just an empty string) Same as <code>*</code>.</li> </ul> -<p>Ranges can be joined with either a space (which implies "and") or a -<code>||</code> (which implies "or").</p> +<p>If a partial version is provided as the first version in the inclusive +range, then the missing pieces are replaced with zeroes.</p> +<ul> +<li><code>1.2 - 2.3.4</code> := <code>>=1.2.0 <=2.3.4</code></li> +</ul> +<p>If a partial version is provided as the second version in the +inclusive range, then all versions that start with the supplied parts +of the tuple are accepted, but nothing that would be greater than the +provided tuple parts.</p> +<ul> +<li><code>1.2.3 - 2.3</code> := <code>>=1.2.3 <2.4.0</code></li> +<li><code>1.2.3 - 2</code> := <code>>=1.2.3 <3.0.0</code></li> +</ul> +<h4 id="x-ranges-1-2-x-1-x-1-2-">X-Ranges <code>1.2.x</code> <code>1.X</code> <code>1.2.*</code> <code>*</code></h4> +<p>Any of <code>X</code>, <code>x</code>, or <code>*</code> may be used to "stand in" for one of the +numeric values in the <code>[major, minor, patch]</code> tuple.</p> +<ul> +<li><code>*</code> := <code>>=0.0.0</code> (Any version satisfies)</li> +<li><code>1.x</code> := <code>>=1.0.0 <2.0.0</code> (Matching major version)</li> +<li><code>1.2.x</code> := <code>>=1.2.0 <1.3.0</code> (Matching major and minor versions)</li> +</ul> +<p>A partial version range is treated as an X-Range, so the special +character is in fact optional.</p> +<ul> +<li><code>` (empty string) :=</code>*<code>:=</code>>=0.0.0`</li> +<li><code>1</code> := <code>1.x.x</code> := <code>>=1.0.0 <2.0.0</code></li> +<li><code>1.2</code> := <code>1.2.x</code> := <code>>=1.2.0 <1.3.0</code></li> +</ul> +<h4 id="tilde-ranges-1-2-3-1-2-1-">Tilde Ranges <code>~1.2.3</code> <code>~1.2</code> <code>~1</code></h4> +<p>Allows patch-level changes if a minor version is specified on the +comparator. Allows minor-level changes if not.</p> +<ul> +<li><code>~1.2.3</code> := <code>>=1.2.3 <1.(2+1).0</code> := <code>>=1.2.3 <1.3.0</code></li> +<li><code>~1.2</code> := <code>>=1.2.0 <1.(2+1).0</code> := <code>>=1.2.0 <1.3.0</code> (Same as <code>1.2.x</code>)</li> +<li><code>~1</code> := <code>>=1.0.0 <(1+1).0.0</code> := <code>>=1.0.0 <2.0.0</code> (Same as <code>1.x</code>)</li> +<li><code>~0.2.3</code> := <code>>=0.2.3 <0.(2+1).0</code> := <code>>=0.2.3 <0.3.0</code></li> +<li><code>~0.2</code> := <code>>=0.2.0 <0.(2+1).0</code> := <code>>=0.2.0 <0.3.0</code> (Same as <code>0.2.x</code>)</li> +<li><code>~0</code> := <code>>=0.0.0 <(0+1).0.0</code> := <code>>=0.0.0 <1.0.0</code> (Same as <code>0.x</code>)</li> +<li><code>~1.2.3-beta.2</code> := <code>>=1.2.3-beta.2 <1.3.0</code> Note that prereleases in +the <code>1.2.3</code> version will be allowed, if they are greater than or +equal to <code>beta.2</code>. So, <code>1.2.3-beta.4</code> would be allowed, but +<code>1.2.4-beta.2</code> would not, because it is a prerelease of a +different <code>[major, minor, patch]</code> tuple.</li> +</ul> +<p>Note: this is the same as the <code>~></code> operator in rubygems.</p> +<h4 id="caret-ranges-1-2-3-0-2-5-0-0-4-">Caret Ranges <code>^1.2.3</code> <code>^0.2.5</code> <code>^0.0.4</code></h4> +<p>Allows changes that do not modify the left-most non-zero digit in the +<code>[major, minor, patch]</code> tuple. In other words, this allows patch and +minor updates for versions <code>1.0.0</code> and above, patch updates for +versions <code>0.X >=0.1.0</code>, and <em>no</em> updates for versions <code>0.0.X</code>.</p> +<p>Many authors treat a <code>0.x</code> version as if the <code>x</code> were the major +"breaking-change" indicator.</p> +<p>Caret ranges are ideal when an author may make breaking changes +between <code>0.2.4</code> and <code>0.3.0</code> releases, which is a common practice. +However, it presumes that there will <em>not</em> be breaking changes between +<code>0.2.4</code> and <code>0.2.5</code>. It allows for changes that are presumed to be +additive (but non-breaking), according to commonly observed practices.</p> +<ul> +<li><code>^1.2.3</code> := <code>>=1.2.3 <2.0.0</code></li> +<li><code>^0.2.3</code> := <code>>=0.2.3 <0.3.0</code></li> +<li><code>^0.0.3</code> := <code>>=0.0.3 <0.0.4</code></li> +<li><code>^1.2.3-beta.2</code> := <code>>=1.2.3-beta.2 <2.0.0</code> Note that prereleases in +the <code>1.2.3</code> version will be allowed, if they are greater than or +equal to <code>beta.2</code>. So, <code>1.2.3-beta.4</code> would be allowed, but +<code>1.2.4-beta.2</code> would not, because it is a prerelease of a +different <code>[major, minor, patch]</code> tuple.</li> +<li><code>^0.0.3-beta</code> := <code>>=0.0.3-beta <0.0.4</code> Note that prereleases in the +<code>0.0.3</code> version <em>only</em> will be allowed, if they are greater than or +equal to <code>beta</code>. So, <code>0.0.3-pr.2</code> would be allowed.</li> +</ul> +<p>When parsing caret ranges, a missing <code>patch</code> value desugars to the +number <code>0</code>, but will allow flexibility within that value, even if the +major and minor versions are both <code>0</code>.</p> +<ul> +<li><code>^1.2.x</code> := <code>>=1.2.0 <2.0.0</code></li> +<li><code>^0.0.x</code> := <code>>=0.0.0 <0.1.0</code></li> +<li><code>^0.0</code> := <code>>=0.0.0 <0.1.0</code></li> +</ul> +<p>A missing <code>minor</code> and <code>patch</code> values will desugar to zero, but also +allow flexibility within those values, even if the major version is +zero.</p> +<ul> +<li><code>^1.x</code> := <code>>=1.0.0 <2.0.0</code></li> +<li><code>^0.x</code> := <code>>=0.0.0 <1.0.0</code></li> +</ul> <h2 id="functions">Functions</h2> <p>All methods and classes take a final <code>loose</code> boolean argument that, if true, will be more forgiving about not-quite-valid semver strings. @@ -165,5 +263,5 @@ range, use the <code>satisfies(version, range)</code> function.</p> <tr><td style="width:60px;height:10px;background:rgb(237,127,127)" colspan=6> </td><td colspan=10 style="width:10px;height:10px;background:rgb(237,127,127)"> </td></tr> <tr><td colspan=5 style="width:50px;height:10px;background:#fff"> </td><td style="width:40px;height:10px;background:rgb(237,127,127)" colspan=4> </td><td style="width:90px;height:10px;background:#fff" colspan=9> </td></tr> </table> -<p id="footer">semver — npm@1.4.28</p> +<p id="footer">semver — npm@2.0.0</p> |