aboutsummaryrefslogtreecommitdiff
path: root/deps/npm/doc/cli
diff options
context:
space:
mode:
authorKat Marchán <kzm@sykosomatic.org>2016-12-18 20:22:09 -0800
committerMyles Borins <myles.borins@gmail.com>2016-12-28 15:30:50 -0500
commit9946519fba73687d34dccd5813808252a1973f3c (patch)
tree74d7194d2a00743bcd905027195e7e8000c5ac5a /deps/npm/doc/cli
parent4d3b487b791606ea965f6280ce0eeea03d79b660 (diff)
downloadandroid-node-v8-9946519fba73687d34dccd5813808252a1973f3c.tar.gz
android-node-v8-9946519fba73687d34dccd5813808252a1973f3c.tar.bz2
android-node-v8-9946519fba73687d34dccd5813808252a1973f3c.zip
deps: upgrade npm to 4.0.5
PR-URL: https://github.com/nodejs/node/pull/10330 Reviewed-By: Myles Borins <myles.borins@gmail.com>
Diffstat (limited to 'deps/npm/doc/cli')
-rw-r--r--deps/npm/doc/cli/npm-adduser.md3
-rw-r--r--deps/npm/doc/cli/npm-dist-tag.md1
-rw-r--r--deps/npm/doc/cli/npm-install.md6
-rw-r--r--deps/npm/doc/cli/npm-logout.md2
-rw-r--r--deps/npm/doc/cli/npm-publish.md2
-rw-r--r--deps/npm/doc/cli/npm-run-script.md7
-rw-r--r--deps/npm/doc/cli/npm-search.md79
-rw-r--r--deps/npm/doc/cli/npm-shrinkwrap.md16
-rw-r--r--deps/npm/doc/cli/npm-tag.md61
-rw-r--r--deps/npm/doc/cli/npm-test.md3
-rw-r--r--deps/npm/doc/cli/npm-version.md9
11 files changed, 103 insertions, 86 deletions
diff --git a/deps/npm/doc/cli/npm-adduser.md b/deps/npm/doc/cli/npm-adduser.md
index 9afece598f..5a53bdd8e2 100644
--- a/deps/npm/doc/cli/npm-adduser.md
+++ b/deps/npm/doc/cli/npm-adduser.md
@@ -33,7 +33,8 @@ your existing record.
Default: https://registry.npmjs.org/
The base URL of the npm package registry. If `scope` is also specified,
-this registry will only be used for packages with that scope. See `npm-scope(7)`.
+this registry will only be used for packages with that scope. `scope` defaults
+to the scope of the project directory you're currently in, if any. See `npm-scope(7)`.
### scope
diff --git a/deps/npm/doc/cli/npm-dist-tag.md b/deps/npm/doc/cli/npm-dist-tag.md
index a88fc35a5e..8b4c170dde 100644
--- a/deps/npm/doc/cli/npm-dist-tag.md
+++ b/deps/npm/doc/cli/npm-dist-tag.md
@@ -77,7 +77,6 @@ begin with a number or the letter `v`.
## SEE ALSO
-* npm-tag(1)
* npm-publish(1)
* npm-install(1)
* npm-dedupe(1)
diff --git a/deps/npm/doc/cli/npm-install.md b/deps/npm/doc/cli/npm-install.md
index 874ce1c287..6a37fcc76b 100644
--- a/deps/npm/doc/cli/npm-install.md
+++ b/deps/npm/doc/cli/npm-install.md
@@ -343,6 +343,10 @@ folder structures that npm creates.
### Limitations of npm's Install Algorithm
+npm will refuse to install any package with an identical name to the
+current package. This can be overridden with the `--force` flag, but in
+most cases can simply be addressed by changing the local package name.
+
There are some very rare and pathological edge-cases where a cycle can
cause npm to try to install a never-ending tree of packages. Here is
the simplest case:
@@ -374,7 +378,7 @@ affects a real use-case, it will be investigated.
* npm-config(7)
* npmrc(5)
* npm-registry(7)
-* npm-tag(1)
+* npm-dist-tag(1)
* npm-uninstall(1)
* npm-shrinkwrap(1)
* package.json(5)
diff --git a/deps/npm/doc/cli/npm-logout.md b/deps/npm/doc/cli/npm-logout.md
index 0841adfbf8..fe6e7b990a 100644
--- a/deps/npm/doc/cli/npm-logout.md
+++ b/deps/npm/doc/cli/npm-logout.md
@@ -29,7 +29,7 @@ it takes precedence.
### scope
-Default: none
+Default: The scope of your current project, if any, otherwise none.
If specified, you will be logged out of the specified scope. See `npm-scope(7)`.
diff --git a/deps/npm/doc/cli/npm-publish.md b/deps/npm/doc/cli/npm-publish.md
index fa512e1a17..caf1fd2430 100644
--- a/deps/npm/doc/cli/npm-publish.md
+++ b/deps/npm/doc/cli/npm-publish.md
@@ -59,5 +59,5 @@ packs them into a tarball to be uploaded to the registry.
* npm-adduser(1)
* npm-owner(1)
* npm-deprecate(1)
-* npm-tag(1)
+* npm-dist-tag(1)
* npm-pack(1)
diff --git a/deps/npm/doc/cli/npm-run-script.md b/deps/npm/doc/cli/npm-run-script.md
index fc6b42a478..f1389c21c6 100644
--- a/deps/npm/doc/cli/npm-run-script.md
+++ b/deps/npm/doc/cli/npm-run-script.md
@@ -41,8 +41,11 @@ you should write:
instead of `"scripts": {"test": "node_modules/.bin/tap test/\*.js"}` to run your tests.
`npm run` sets the `NODE` environment variable to the `node` executable with
-which `npm` is executed. Also, the directory within which it resides is added to the
-`PATH`, if the `node` executable is not in the `PATH`.
+which `npm` is executed. Also, if the `--scripts-prepend-node-path` is passed,
+the directory within which `node` resides is added to the
+`PATH`. If `--scripts-prepend-node-path=auto` is passed (which has been the
+default in `npm` v3), this is only performed when that `node` executable is
+not found in the `PATH`.
If you try to run a script without having a `node_modules` directory and it fails,
you will be given a warning to run `npm install`, just in case you've forgotten.
diff --git a/deps/npm/doc/cli/npm-search.md b/deps/npm/doc/cli/npm-search.md
index 78967f14eb..c1107d79b7 100644
--- a/deps/npm/doc/cli/npm-search.md
+++ b/deps/npm/doc/cli/npm-search.md
@@ -3,20 +3,58 @@ npm-search(1) -- Search for packages
## SYNOPSIS
- npm search [-l|--long] [search terms ...]
+ npm search [-l|--long] [--json] [--parseable] [--no-description] [search terms ...]
aliases: s, se, find
## DESCRIPTION
-Search the registry for packages matching the search terms.
+Search the registry for packages matching the search terms. `npm search`
+performs a linear, incremental, lexically-ordered search through package
+metadata for all files in the registry. If color is enabled, it will further
+highlight the matches in the results.
-If a term starts with `/`, then it's interpreted as a regular expression.
-A trailing `/` will be ignored in this case. (Note that many regular
-expression characters must be escaped or quoted in most shells.)
+Additionally, using the `--searchopts` and `--searchexclude` options paired with
+more search terms will respectively include and exclude further patterns. The
+main difference between `--searchopts` and the standard search terms is that the
+former does not highlight results in the output and can be used for more
+fine-grained filtering. Additionally, both of these can be added to `.npmrc` for
+default search filtering behavior.
+
+Search also allows targeting of maintainers in search results, by prefixing
+their npm username with `=`.
+
+If a term starts with `/`, then it's interpreted as a regular expression and
+supports standard JavaScript RegExp syntax. A trailing `/` will be ignored in
+this case. (Note that many regular expression characters must be escaped or
+quoted in most shells.)
+
+### A Note on caching
## CONFIGURATION
+### description
+
+* Default: true
+* Type: Boolean
+
+Used as `--no-description`, disables search matching in package descriptions and
+suppresses display of that field in results.
+
+### json
+
+* Default: false
+* Type: Boolean
+
+Output search results as a JSON array.
+
+### parseable
+
+* Default: false
+* Type: Boolean
+
+Output search results as lines with tab-separated columns.
+
### long
* Default: false
@@ -27,14 +65,37 @@ lines. When disabled (default) search results are truncated to fit
neatly on a single line. Modules with extremely long names will
fall on multiple lines.
+### searchopts
+
+* Default: ""
+* Type: String
+
+Space-separated options that are always passed to search.
+
+### searchexclude
+
+* Default: ""
+* Type: String
+
+Space-separated options that limit the results from search.
+
+### searchstaleness
+
+* Default: 900 (15 minutes)
+* Type: Number
+
+The age of the cache, in seconds, before another registry request is made.
+
### registry
* Default: https://registry.npmjs.org/
- * Type : url
+ * Type: url
-Search the specified registry for modules. If you have configured npm to point to a different default registry,
-such as your internal private module repository, `npm search` will default to that registry when searching.
-Pass a different registry url such as the default above in order to override this setting.
+Search the specified registry for modules. If you have configured npm to point
+to a different default registry, such as your internal private module
+repository, `npm search` will default to that registry when searching. Pass a
+different registry url such as the default above in order to override this
+setting.
## SEE ALSO
diff --git a/deps/npm/doc/cli/npm-shrinkwrap.md b/deps/npm/doc/cli/npm-shrinkwrap.md
index f89c3b8375..ae04bd02bb 100644
--- a/deps/npm/doc/cli/npm-shrinkwrap.md
+++ b/deps/npm/doc/cli/npm-shrinkwrap.md
@@ -158,12 +158,16 @@ wouldn't actually work. Similarly, the command will fail if there are
extraneous packages (not referenced by `package.json`), since that would
indicate that `package.json` is not correct.
-Since `npm shrinkwrap` is intended to lock down your dependencies for
-production use, `devDependencies` will not be included unless you
-explicitly set the `--dev` flag when you run `npm shrinkwrap`. If
-installed `devDependencies` are excluded, then npm will print a
-warning. If you want them to be installed with your module by
-default, please consider adding them to `dependencies` instead.
+Starting with npm v4.0.1, `devDependencies` are included when you run
+`npm shrinkwrap` and follow the usual rules as to when they're installed.
+As of npm v3.10.8, if you run `npm install --only=production` or
+`npm install --production` with a shrinkwrap including your development
+dependencies they won't be installed. Similarly, if the environment
+variable `NODE_ENV` is `production` then they won't be installed. If you
+need compatibility with versions of npm prior to v3.10.8 or otherwise
+don't want them in your shrinkwrap you can exclude development
+dependencies with:
+`npm shrinkwrap --only=prod` or `npm shrinkwrap --production`.
If shrinkwrapped package A depends on shrinkwrapped package B, B's
shrinkwrap will not be used as part of the installation of A. However,
diff --git a/deps/npm/doc/cli/npm-tag.md b/deps/npm/doc/cli/npm-tag.md
deleted file mode 100644
index 88689d59d3..0000000000
--- a/deps/npm/doc/cli/npm-tag.md
+++ /dev/null
@@ -1,61 +0,0 @@
-npm-tag(1) -- Tag a published version
-=====================================
-
-## SYNOPSIS
-
- [DEPRECATED] npm tag <name>@<version> [<tag>]
- See `dist-tag`
-
-## DESCRIPTION
-
-THIS COMMAND IS DEPRECATED. See npm-dist-tag(1) for details.
-
-Tags the specified version of the package with the specified tag, or the
-`--tag` config if not specified.
-
-A tag can be used when installing packages as a reference to a version instead
-of using a specific version number:
-
- npm install <name>@<tag>
-
-When installing dependencies, a preferred tagged version may be specified:
-
- npm install --tag <tag>
-
-This also applies to `npm dedupe`.
-
-Publishing a package always sets the "latest" tag to the published version.
-
-## PURPOSE
-
-Tags can be used to provide an alias instead of version numbers. For
-example, `npm` currently uses the tag "next" to identify the upcoming
-version, and the tag "latest" to identify the current version.
-
-A project might choose to have multiple streams of development, e.g.,
-"stable", "canary".
-
-## CAVEATS
-
-Tags must share a namespace with version numbers, because they are
-specified in the same slot: `npm install <pkg>@<version>` vs `npm
-install <pkg>@<tag>`.
-
-Tags that can be interpreted as valid semver ranges will be
-rejected. For example, `v1.4` cannot be used as a tag, because it is
-interpreted by semver as `>=1.4.0 <1.5.0`. See
-<https://github.com/npm/npm/issues/6082>.
-
-The simplest way to avoid semver problems with tags is to use tags
-that do not begin with a number or the letter `v`.
-
-## SEE ALSO
-
-* npm-publish(1)
-* npm-install(1)
-* npm-dedupe(1)
-* npm-registry(7)
-* npm-config(1)
-* npm-config(7)
-* npm-dist-tag(1)
-* npmrc(5)
diff --git a/deps/npm/doc/cli/npm-test.md b/deps/npm/doc/cli/npm-test.md
index fe746cc73f..8a379e2efd 100644
--- a/deps/npm/doc/cli/npm-test.md
+++ b/deps/npm/doc/cli/npm-test.md
@@ -11,9 +11,6 @@ npm-test(1) -- Test a package
This runs a package's "test" script, if one was provided.
-To run tests as a condition of installation, set the `npat` config to
-true.
-
## SEE ALSO
* npm-run-script(1)
diff --git a/deps/npm/doc/cli/npm-version.md b/deps/npm/doc/cli/npm-version.md
index 2932516bb6..c00918ddc3 100644
--- a/deps/npm/doc/cli/npm-version.md
+++ b/deps/npm/doc/cli/npm-version.md
@@ -85,6 +85,15 @@ and tag up to the server, and deletes the `build/temp` directory.
Commit and tag the version change.
+### sign-git-tag
+
+* Default: false
+* Type: Boolean
+
+Pass the `-s` flag to git to sign the tag.
+
+Note that you must have a default GPG key set up in your git config for this to work properly.
+
## SEE ALSO
* npm-init(1)