diff options
Diffstat (limited to 'deps/npm/doc/cli')
| -rw-r--r-- | deps/npm/doc/cli/npm-ci.md | 58 | ||||
| -rw-r--r-- | deps/npm/doc/cli/npm-install.md | 6 | ||||
| -rw-r--r-- | deps/npm/doc/cli/npm-ls.md | 2 | ||||
| -rw-r--r-- | deps/npm/doc/cli/npm-prune.md | 16 | ||||
| -rw-r--r-- | deps/npm/doc/cli/npm-team.md | 3 | ||||
| -rw-r--r-- | deps/npm/doc/cli/npm-update.md | 28 | ||||
| -rw-r--r-- | deps/npm/doc/cli/npm.md | 2 |
7 files changed, 86 insertions, 29 deletions
diff --git a/deps/npm/doc/cli/npm-ci.md b/deps/npm/doc/cli/npm-ci.md new file mode 100644 index 0000000000..b1406e36a5 --- /dev/null +++ b/deps/npm/doc/cli/npm-ci.md @@ -0,0 +1,58 @@ +npm-ci(1) -- Install a project with a clean slate +=================================== + +## SYNOPSIS + + npm ci + +## EXAMPLE + +Make sure you have a package-lock and an up-to-date install: + +``` +$ cd ./my/npm/project +$ npm install +added 154 packages in 10s +$ ls | grep package-lock +``` + +Run `npm ci` in that project + +``` +$ npm ci +added 154 packages in 5s +``` + +Configure Travis to build using `npm ci` instead of `npm install`: + +``` +# .travis.yml +install: +- npm ci +# keep the npm cache around to speed up installs +cache: + directories: + - "$HOME/.npm" +``` + +## DESCRIPTION + +This command is similar to `npm-install(1)`, except it's meant to be used in +automated environments such as test platforms, continuous integration, and +deployment. It can be significantly faster than a regular npm install by +skipping certain user-oriented features. It is also more strict than a regular +install, which can help catch errors or inconsistencies caused by the +incrementally-installed local environments of most npm users. + +In short, the main differences between using `npm install` and `npm ci` are: + +* The project **must** have an existing `package-lock.json` or `npm-shrinkwrap.json`. +* If dependencies in the package lock do not match those in `package.json`, `npm ci` will exit with an error, instead of updating the package lock. +* `npm ci` can only install entire projects at a time: individual dependencies cannot be added with this command. +* If a `node_modules` is already present, it will be automatically removed before `npm ci` begins its install. +* It will never write to `package.json` or any of the package-locks: installs are essentially frozen. + +## SEE ALSO + +* npm-install(1) +* npm-package-locks(5) diff --git a/deps/npm/doc/cli/npm-install.md b/deps/npm/doc/cli/npm-install.md index 0489ddf94e..370c8f248b 100644 --- a/deps/npm/doc/cli/npm-install.md +++ b/deps/npm/doc/cli/npm-install.md @@ -55,6 +55,9 @@ after packing it up into a tarball (b). is set to `production`), npm will not install modules listed in `devDependencies`. + > NOTE: The `--production` flag has no particular meaning when adding a + dependency to a project. + * `npm install <folder>`: Install the package in the directory as a symlink in the current project. @@ -347,7 +350,8 @@ The `--no-shrinkwrap` argument, which will ignore an available package lock or shrinkwrap file and use the package.json instead. The `--no-package-lock` argument will prevent npm from creating a -`package-lock.json` file. +`package-lock.json` file. When running with package-lock's disabled npm +will not automatically prune your node modules when installing. The `--nodedir=/path/to/node/source` argument will allow npm to find the node source code so that npm can compile native modules. diff --git a/deps/npm/doc/cli/npm-ls.md b/deps/npm/doc/cli/npm-ls.md index e665a735c3..7b10a19d69 100644 --- a/deps/npm/doc/cli/npm-ls.md +++ b/deps/npm/doc/cli/npm-ls.md @@ -76,7 +76,7 @@ Max display depth of the dependency tree. Display only the dependency tree for packages in `dependencies`. -### dev +### dev / development * Type: Boolean * Default: false diff --git a/deps/npm/doc/cli/npm-prune.md b/deps/npm/doc/cli/npm-prune.md index c7f340ca7b..0dde244251 100644 --- a/deps/npm/doc/cli/npm-prune.md +++ b/deps/npm/doc/cli/npm-prune.md @@ -3,7 +3,7 @@ npm-prune(1) -- Remove extraneous packages ## SYNOPSIS - npm prune [[<@scope>/]<pkg>...] [--production] + npm prune [[<@scope>/]<pkg>...] [--production] [--dry-run] [--json] ## DESCRIPTION @@ -16,9 +16,21 @@ package's dependencies list. If the `--production` flag is specified or the `NODE_ENV` environment variable is set to `production`, this command will remove the packages -specified in your `devDependencies`. Setting `--production=false` will +specified in your `devDependencies`. Setting `--no-production` will negate `NODE_ENV` being set to `production`. +If the `--dry-run` flag is used then no changes will actually be made. + +If the `--json` flag is used then the changes `npm prune` made (or would +have made with `--dry-run`) are printed as a JSON object. + +In normal operation with package-locks enabled, extraneous modules are +pruned automatically when modules are installed and you'll only need +this command with the `--production` flag. + +If you've disabled package-locks then extraneous modules will not be removed +and it's up to you to run `npm prune` from time-to-time to remove them. + ## SEE ALSO * npm-uninstall(1) diff --git a/deps/npm/doc/cli/npm-team.md b/deps/npm/doc/cli/npm-team.md index 5a8b4b63e3..9e01a451c7 100644 --- a/deps/npm/doc/cli/npm-team.md +++ b/deps/npm/doc/cli/npm-team.md @@ -34,6 +34,9 @@ when operating on them, separated by a colon (`:`). That is, if you have a under that organization. If performed on a team, it will instead return a list of all users belonging to that particular team. +* edit: + Edit a current team. + ## DETAILS `npm team` always operates directly on the current registry, configurable from diff --git a/deps/npm/doc/cli/npm-update.md b/deps/npm/doc/cli/npm-update.md index d6ec30d2ae..b6cf2af78b 100644 --- a/deps/npm/doc/cli/npm-update.md +++ b/deps/npm/doc/cli/npm-update.md @@ -26,6 +26,10 @@ As of `npm@2.6.1`, the `npm update` will only inspect top-level packages. Prior versions of `npm` would also recursively inspect all dependencies. To get the old behavior, use `npm --depth 9999 update`. +As of `npm@5.0.0`, the `npm update` will change `package.json` to save the +new version as the minimum required dependency. To get the old behavior, +use `npm update --no-save`. + ## EXAMPLES IMPORTANT VERSION NOTE: these examples assume `npm@2.6.1` or later. For @@ -104,30 +108,6 @@ If the dependence were on `^0.4.0`: Then `npm update` will install `dep1@0.4.1`, because that is the highest-sorting version that satisfies `^0.4.0` (`>= 0.4.0 <0.5.0`) -### Recording Updates with `--save` - -When you want to update a package and save the new version as -the minimum required dependency in `package.json`, you can use -`npm update -S` or `npm update --save`. For example if -`package.json` contains: - -``` -"dependencies": { - "dep1": "^1.1.1" -} -``` - -Then `npm update --save` will install `dep1@1.2.2` (i.e., `latest`), -and `package.json` will be modified: - -``` -"dependencies": { - "dep1": "^1.2.2" -} -``` - -Note that `npm` will only write an updated version to `package.json` -if it installs a new package. ### Updating Globally-Installed Packages diff --git a/deps/npm/doc/cli/npm.md b/deps/npm/doc/cli/npm.md index ec867e5f9e..e41e7252e3 100644 --- a/deps/npm/doc/cli/npm.md +++ b/deps/npm/doc/cli/npm.md @@ -93,7 +93,7 @@ npm is extremely configurable. It reads its configuration options from * Command line switches: Set a config with `--key val`. All keys take a value, even if they are booleans (the config parser doesn't know what the options are at - the time of parsing.) If no value is provided, then the option is set + the time of parsing). If no value is provided, then the option is set to boolean `true`. * Environment Variables: Set any config by prefixing the name in an environment variable with |