summaryrefslogtreecommitdiff
path: root/deps/npm/docs/content/commands/npm-install-test.md
diff options
context:
space:
mode:
Diffstat (limited to 'deps/npm/docs/content/commands/npm-install-test.md')
-rw-r--r--deps/npm/docs/content/commands/npm-install-test.md37
1 files changed, 26 insertions, 11 deletions
diff --git a/deps/npm/docs/content/commands/npm-install-test.md b/deps/npm/docs/content/commands/npm-install-test.md
index c464e5bd0b..ed39c6705a 100644
--- a/deps/npm/docs/content/commands/npm-install-test.md
+++ b/deps/npm/docs/content/commands/npm-install-test.md
@@ -6,20 +6,30 @@ description: Install package(s) and run tests
### Synopsis
+<!-- AUTOGENERATED USAGE DESCRIPTIONS START -->
+<!-- automatically generated, do not edit manually -->
+<!-- see lib/commands/install-test.js -->
+
```bash
-npm install-test (with no args, in package dir)
-npm install-test [<@scope>/]<name>
-npm install-test [<@scope>/]<name>@<tag>
-npm install-test [<@scope>/]<name>@<version>
-npm install-test [<@scope>/]<name>@<version range>
+npm install-test [<@scope>/]<pkg>
+npm install-test [<@scope>/]<pkg>@<tag>
+npm install-test [<@scope>/]<pkg>@<version>
+npm install-test [<@scope>/]<pkg>@<version range>
+npm install-test <alias>@npm:<name>
+npm install-test <folder>
npm install-test <tarball file>
npm install-test <tarball url>
-npm install-test <folder>
+npm install-test <git:// url>
+npm install-test <github username>/<github project>
-alias: npm it
-common options: [--save|--save-dev|--save-optional] [--save-exact] [--dry-run]
+alias: it
```
+<!-- automatically generated, do not edit manually -->
+<!-- see lib/commands/install-test.js -->
+
+<!-- AUTOGENERATED USAGE DESCRIPTIONS END -->
+
### Description
This command runs an `npm install` followed immediately by an `npm test`. It
@@ -32,13 +42,16 @@ takes exactly the same arguments as `npm install`.
<!-- see lib/utils/config/definitions.js -->
#### `save`
-* Default: true
+* Default: `true` unless when using `npm update` or `npm dedupe` where it
+ defaults to `false`
* Type: Boolean
-Save installed packages to a package.json file as dependencies.
+Save installed packages to a `package.json` file as dependencies.
When used with the `npm rm` command, removes the dependency from
-package.json.
+`package.json`.
+
+Will also prevent writing to `package-lock.json` if set to `false`.
<!-- automatically generated, do not edit manually -->
<!-- see lib/utils/config/definitions.js -->
@@ -133,6 +146,8 @@ When package package-locks are disabled, automatic pruning of extraneous
modules will also be disabled. To remove extraneous modules with
package-locks disabled use `npm prune`.
+This configuration does not affect `npm ci`.
+
<!-- automatically generated, do not edit manually -->
<!-- see lib/utils/config/definitions.js -->