summaryrefslogtreecommitdiff
path: root/deps/npm/doc
diff options
context:
space:
mode:
authorForrest L Norvell <forrest@npmjs.com>2015-07-09 20:48:26 -0700
committerJeremiah Senkpiel <fishrock123@rocketmail.com>2015-07-16 12:26:54 -0700
commit938cc757bb996244df6301cd91187789f4f8a909 (patch)
treee701fd52797d3babf9f1ab3355c96d2d8457c0eb /deps/npm/doc
parent6c3aabf455f5ed9c65bd6ae1ea208c752317216b (diff)
downloadandroid-node-v8-938cc757bb996244df6301cd91187789f4f8a909.tar.gz
android-node-v8-938cc757bb996244df6301cd91187789f4f8a909.tar.bz2
android-node-v8-938cc757bb996244df6301cd91187789f4f8a909.zip
deps: upgrade to npm 2.13.0
PR-URL: https://github.com/nodejs/io.js/pull/2152 Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com>
Diffstat (limited to 'deps/npm/doc')
-rw-r--r--deps/npm/doc/api/npm-ping.md14
-rw-r--r--deps/npm/doc/cli/npm-ping.md16
-rw-r--r--deps/npm/doc/cli/npm-version.md39
-rw-r--r--deps/npm/doc/files/package.json.md9
-rw-r--r--deps/npm/doc/misc/npm-faq.md1
-rw-r--r--deps/npm/doc/misc/npm-index.md8
6 files changed, 76 insertions, 11 deletions
diff --git a/deps/npm/doc/api/npm-ping.md b/deps/npm/doc/api/npm-ping.md
new file mode 100644
index 0000000000..4357fe2ba9
--- /dev/null
+++ b/deps/npm/doc/api/npm-ping.md
@@ -0,0 +1,14 @@
+npm-ping(3) -- Ping npm registry
+================================
+
+## SYNOPSIS
+
+ npm.registry.ping(registry, options, function (er, pong))
+
+## DESCRIPTION
+
+Attempts to connect to the given registry, returning a `pong`
+object with various metadata if it succeeds.
+
+This function is primarily useful for debugging connection issues
+to npm registries.
diff --git a/deps/npm/doc/cli/npm-ping.md b/deps/npm/doc/cli/npm-ping.md
new file mode 100644
index 0000000000..f0e628915e
--- /dev/null
+++ b/deps/npm/doc/cli/npm-ping.md
@@ -0,0 +1,16 @@
+npm-ping(1) -- Ping npm registry
+================================
+
+## SYNOPSIS
+
+ npm ping [--registry <registry>]
+
+## DESCRIPTION
+
+Ping the configured or given npm registry and verify authentication.
+
+## SEE ALSO
+
+* npm-config(1)
+* npm-config(7)
+* npmrc(5)
diff --git a/deps/npm/doc/cli/npm-version.md b/deps/npm/doc/cli/npm-version.md
index abcd25b3a5..0a00e78cd7 100644
--- a/deps/npm/doc/cli/npm-version.md
+++ b/deps/npm/doc/cli/npm-version.md
@@ -15,10 +15,11 @@ valid second argument to semver.inc (one of `patch`, `minor`, `major`,
`prepatch`, `preminor`, `premajor`, `prerelease`). In the second case,
the existing version will be incremented by 1 in the specified field.
-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 `git-tag-version` (see
-below), and can be disabled on the command line by running `npm
---no-git-tag-version version`
+If run in a git repo, it will also create a version commit and tag.
+This behavior is controlled by `git-tag-version` (see below), and can
+be disabled on the command line by running `npm --no-git-tag-version version`.
+It will fail if the working directory is not clean, unless the `--force`
+flag is set.
If supplied with `--message` (shorthand: `-m`) config option, npm will
use it as a commit message when creating a version commit. If the
@@ -42,11 +43,33 @@ in your git config for this to work properly. For example:
If `preversion`, `version`, or `postversion` are in the `scripts` property of
the package.json, they will be executed as part of running `npm version`.
-`preversion` and `version` are executed before bumping the package version, and
-`postversion` is executed afterwards. For example, to run `npm version` only if
-all tests pass:
- "scripts": { "preversion": "npm test" }
+The exact order of execution is as follows:
+ 1. 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 `--force` flag is set.
+ 2. Run the `preversion` script. These scripts have access to the old `version` 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 `git add`.
+ 3. Bump `version` in `package.json` as requested (`patch`, `minor`, `major`, etc).
+ 4. Run the `version` script. These scripts have access to the new `version` 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 `git add`.
+ 5. Commit and tag.
+ 6. Run the `postversion` script. Use it to clean up the file system or automatically push
+ the commit and/or tag.
+
+Take the following example:
+
+ "scripts": {
+ "preversion": "npm test",
+ "version": "npm run build && git add -A dist",
+ "postversion": "git push && git push --tags && rm -rf build/temp"
+ }
+
+This runs all your tests, and proceeds only if they pass. Then runs your `build` script, and
+adds everything in the `dist` directory to the commit. After the commit, it pushes the new commit
+and tag up to the server, and deletes the `build/temp` directory.
## CONFIGURATION
diff --git a/deps/npm/doc/files/package.json.md b/deps/npm/doc/files/package.json.md
index f402e2ebcc..a63b75842d 100644
--- a/deps/npm/doc/files/package.json.md
+++ b/deps/npm/doc/files/package.json.md
@@ -283,10 +283,13 @@ with the lib folder in any way, but it's useful meta info.
### directories.bin
-If you specify a `bin` directory, then all the files in that folder will
-be added as children of the `bin` path.
+If you specify a `bin` directory in `directories.bin`, all the files in
+that folder will be added.
-If you have a `bin` path already, then this has no effect.
+Because of the way the `bin` directive works, specifying both a
+`bin` path and setting `directories.bin` is an error. If you want to
+specify individual files, use `bin`, and for all the files in an
+existing `bin` directory, use `directories.bin`.
### directories.man
diff --git a/deps/npm/doc/misc/npm-faq.md b/deps/npm/doc/misc/npm-faq.md
index b9e837f76d..557ec1a9c6 100644
--- a/deps/npm/doc/misc/npm-faq.md
+++ b/deps/npm/doc/misc/npm-faq.md
@@ -279,6 +279,7 @@ Unix:
Windows:
* <http://github.com/marcelklehr/nodist>
+* <https://github.com/coreybutler/nvm-windows>
* <https://github.com/hakobera/nvmw>
* <https://github.com/nanjingboy/nvmw>
diff --git a/deps/npm/doc/misc/npm-index.md b/deps/npm/doc/misc/npm-index.md
index 8b9b69a48b..837ef26ba0 100644
--- a/deps/npm/doc/misc/npm-index.md
+++ b/deps/npm/doc/misc/npm-index.md
@@ -113,6 +113,10 @@ Manage package owners
Create a tarball from a package
+### npm-ping(1)
+
+Ping npm registry
+
### npm-prefix(1)
Display prefix
@@ -285,6 +289,10 @@ Manage package owners
Create a tarball from a package
+### npm-ping(3)
+
+Ping npm registry
+
### npm-prefix(3)
Display prefix