diff options
| author | Kat Marchán <kzm@sykosomatic.org> | 2017-07-14 10:52:48 -0700 |
|---|---|---|
| committer | James M Snell <jasnell@gmail.com> | 2017-07-17 08:49:02 -0700 |
| commit | 24f43903b4a2f5aa73a99e6f3d4cc62d559cf94b (patch) | |
| tree | 9c32bd08c43de8721e54cd846d816fbe6cdf056e /deps/npm/doc/files/package.json.md | |
| parent | fa73087fcf4bd14db7791120e688a0a508885b64 (diff) | |
| download | android-node-v8-24f43903b4a2f5aa73a99e6f3d4cc62d559cf94b.tar.gz android-node-v8-24f43903b4a2f5aa73a99e6f3d4cc62d559cf94b.tar.bz2 android-node-v8-24f43903b4a2f5aa73a99e6f3d4cc62d559cf94b.zip | |
deps: upgrade npm to 5.3.0
PR-URL: https://github.com/nodejs/node/pull/14235
Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com>
Reviewed-By: Refael Ackermann <refack@gmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Yuta Hiroto <hello@about-hiroppy.com>
Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com>
Reviewed-By: Tobias Nießen <tniessen@tnie.de>
Reviewed-By: James M Snell <jasnell@gmail.com>
Diffstat (limited to 'deps/npm/doc/files/package.json.md')
| -rw-r--r-- | deps/npm/doc/files/package.json.md | 39 |
1 files changed, 24 insertions, 15 deletions
diff --git a/deps/npm/doc/files/package.json.md b/deps/npm/doc/files/package.json.md index 1a06ff794b..1b2b04fe2f 100644 --- a/deps/npm/doc/files/package.json.md +++ b/deps/npm/doc/files/package.json.md @@ -451,18 +451,28 @@ install time. ### Git URLs as Dependencies -Git urls can be of the form: +Git urls are of the form: - 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 + <protocol>://[<user>[:<password>]@]<hostname>[:<port>][:][/]<path>[#<commit-ish> | #semver:<semver>] -The `commit-ish` can be any tag, sha, or branch which can be supplied as -an argument to `git checkout`. The default is `master`. +`<protocol>` is one of `git`, `git+ssh`, `git+http`, `git+https`, or +`git+file`. -## GitHub URLs +If `#<commit-ish>` is provided, it will be used to clone exactly that +commit. If the commit-ish has the format `#semver:<semver>`, `<semver>` 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 `#<commit-ish>` or `#semver:<semver>` is +specified, then `master` is used. + +Examples: + + 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 + +### GitHub URLs As of version 1.1.65, you can refer to GitHub urls as just "foo": "user/foo-project". Just as with git URLs, a `commit-ish` suffix can be @@ -478,7 +488,7 @@ included. For example: } } -## Local Paths +### Local Paths 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 `npm install -S` or @@ -700,12 +710,11 @@ The host architecture is determined by `process.arch` ## preferGlobal -If your package is primarily a command-line application that should be -installed globally, then set this value to `true` to provide a warning -if it is installed locally. +**DEPRECATED** -It doesn't actually prevent users from installing it locally, but it -does help prevent some confusion if it doesn't work as expected. +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. ## private |