CLI documentation update from CI
npm CLI robot committed
Jun 2, 2022 at 03:02 UTC
a94019868ab5cd08574ecc5fdb73ddfca09a6f44
6 files changed
+57
-4
cli/v8
+1
-1
@@ -1 +1 @@
1
-Subproject commit d60cfbcb43745705fd418fc2a7b8b427c6611911
1
+Subproject commit 4ee12d0f64c3bc1b168f795deddb5145e5c86444
content/cli/v8/commands/npm-adduser.md
+14
@@ -97,6 +97,20 @@ npm init --scope=@foo --yes
97
```
98
99
100
+<!-- automatically generated, do not edit manually -->
101
+<!-- see lib/utils/config/definitions.js -->
102
+
103
+#### `auth-type`
104
+
105
+* Default: "legacy"
106
+* Type: "legacy", "webauthn", "sso", "saml", or "oauth"
107
+* DEPRECATED: The SSO/SAML/OAuth methods are deprecated and will be removed in
108
+ a future version of npm in favor of web-based login.
109
+
110
+What authentication strategy to use with `adduser`/`login`.
111
+
112
+Pass `webauthn` to use a web-based login.
113
+
114
<!-- automatically generated, do not edit manually -->
115
<!-- see lib/utils/config/definitions.js -->
116
content/cli/v8/commands/npm-init.md
+11
@@ -263,6 +263,17 @@ This value is not exported to the environment for child processes.
263
<!-- automatically generated, do not edit manually -->
264
<!-- see lib/utils/config/definitions.js -->
265
266
+#### `workspaces-update`
267
+
268
+* Default: true
269
+* Type: Boolean
270
+
271
+If set to true, the npm cli will run an update after operations that may
272
+possibly change the workspaces installed to the `node_modules` folder.
273
+
274
+<!-- automatically generated, do not edit manually -->
275
+<!-- see lib/utils/config/definitions.js -->
276
+
277
#### `include-workspace-root`
278
279
* Default: false
content/cli/v8/configuring-npm/package-json.md
+20
@@ -653,6 +653,26 @@ git+https://isaacs@github.com/npm/cli.git
653
git://github.com/npm/cli.git#v1.0.27
654
```
655
656
+When installing from a `git` repository, the presence of certain fields in the
657
+`package.json` will cause npm to believe it needs to perform a build. To do so
658
+your repository will be cloned into a temporary directory, all of its deps
659
+installed, relevant scripts run, and the resulting directory packed and
660
+installed.
661
+
662
+This flow will occur if your git dependency uses `workspaces`, or if any of the
663
+following scripts are present:
664
+
665
+* `build`
666
+* `prepare`
667
+* `prepack`
668
+* `preinstall`
669
+* `install`
670
+* `postinstall`
671
+
672
+If your git repository includes pre-built artifacts, you will likely want to
673
+make sure that none of the above scripts are defined, or your dependency
674
+will be rebuilt for every installation.
675
+
676
#### GitHub URLs
677
678
As of version 1.1.65, you can refer to GitHub urls as just "foo":
content/cli/v8/using-npm/config.md
+5
-3
@@ -1899,12 +1899,14 @@ When set to `dev` or `development`, this is an alias for `--include=dev`.
1899
#### `auth-type`
1900
1901
* Default: "legacy"
1902
-* Type: "legacy", "sso", "saml", or "oauth"
1903
-* DEPRECATED: This method of SSO/SAML/OAuth is deprecated and will be removed
1904
- in a future version of npm in favor of web-based login.
1902
+* Type: "legacy", "webauthn", "sso", "saml", or "oauth"
1903
+* DEPRECATED: The SSO/SAML/OAuth methods are deprecated and will be removed in
1904
+ a future version of npm in favor of web-based login.
1905
1906
What authentication strategy to use with `adduser`/`login`.
1907
1908
+Pass `webauthn` to use a web-based login.
1909
+
1910
<!-- automatically generated, do not edit manually -->
1911
<!-- see lib/utils/config/definitions.js -->
1912
content/cli/v8/using-npm/scripts.md
+6
@@ -211,6 +211,12 @@ will default the `start` command to `node server.js`. `prestart` and
211
* `test`
212
* `posttest`
213
214
+#### [`npm version`](/cli/v8/commands/npm-version)
215
+
216
+* `preversion`
217
+* `version`
218
+* `postversion`
219
+
220
#### A Note on a lack of [`npm uninstall`](/cli/v8/commands/npm-uninstall) scripts
221
222
While npm v6 had `uninstall` lifecycle scripts, npm v7 does not. Removal of a package can happen for a wide variety of reasons, and there's no clear way to currently give the script enough context to be useful.