diff options
Diffstat (limited to 'deps/npm/html/doc/files/package.json.html')
| -rw-r--r-- | deps/npm/html/doc/files/package.json.html | 38 |
1 files changed, 22 insertions, 16 deletions
diff --git a/deps/npm/html/doc/files/package.json.html b/deps/npm/html/doc/files/package.json.html index e0f2df86f2..6374cc5a7d 100644 --- a/deps/npm/html/doc/files/package.json.html +++ b/deps/npm/html/doc/files/package.json.html @@ -342,15 +342,22 @@ tarball or git URL.</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>Git urls are of the form:</p> +<pre><code><protocol>://[<user>[:<password>]@]<hostname>[:<port>][:][/]<path>[#<commit-ish> | #semver:<semver>] +</code></pre><p><code><protocol></code> is one of <code>git</code>, <code>git+ssh</code>, <code>git+http</code>, <code>git+https</code>, or +<code>git+file</code>.</p> +<p>If <code>#<commit-ish></code> is provided, it will be used to clone exactly that +commit. If the commit-ish has the format <code>#semver:<semver></code>, <code><semver></code> can +be any valid semver range or exact version, and npm will look for any tags +or refs matching that range in the remote repository, much as it would for a +registry dependency. If neither <code>#<commit-ish></code> or <code>#semver:<semver></code> is +specified, then <code>master</code> is used.</p> +<p>Examples:</p> +<pre><code>git+ssh://git@github.com:npm/npm.git#v1.0.27 +git+ssh://git@github.com:npm/npm#semver:^5.0 +git+https://isaacs@github.com/npm/npm.git +git://github.com/npm/npm.git#v1.0.27 +</code></pre><h3 id="github-urls">GitHub URLs</h3> <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> @@ -363,7 +370,7 @@ included. For example:</p> "module": "user/repo#feature\/branch" } } -</code></pre><h2 id="local-paths">Local Paths</h2> +</code></pre><h3 id="local-paths">Local Paths</h3> <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 -S</code> or <code>npm install --save</code>, using any of these forms:</p> @@ -523,11 +530,10 @@ you can specify which ones.</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> +<p><strong>DEPRECATED</strong></p> +<p>This option used to trigger an npm warning, but it will no longer warn. It is +purely there for informational purposes. It is now recommended that you install +any binaries as local devDependencies wherever possible.</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> @@ -587,5 +593,5 @@ ignored.</p> <tr><td style="width:60px;height:10px;background:rgb(237,127,127)" colspan=6> </td><td colspan=10 style="width:10px;height:10px;background:rgb(237,127,127)"> </td></tr> <tr><td colspan=5 style="width:50px;height:10px;background:#fff"> </td><td style="width:40px;height:10px;background:rgb(237,127,127)" colspan=4> </td><td style="width:90px;height:10px;background:#fff" colspan=9> </td></tr> </table> -<p id="footer">package.json — npm@5.0.3</p> +<p id="footer">package.json — npm@5.3.0</p> |