CLI documentation update from CI
npm CLI robot committed
Jan 12, 2023 at 20:36 UTC
2d3e7c635b761084b033f4b69c14f254e28dc4ce
24 files changed
+82
-39
content/cli/v9/commands/npm-access.md
+2
@@ -47,6 +47,8 @@ npm access grant <read-only|read-write> <scope:team> [<package>]
47
npm access revoke <scope:team> [<package>]
48
```
49
50
+Note: This command is unaware of workspaces.
51
+
52
### Description
53
54
Used to set access controls on private packages.
content/cli/v9/commands/npm-adduser.md
+2
-1
@@ -98,7 +98,8 @@ npm init --scope=@foo --yes
98
* Default: "web"
99
* Type: "legacy" or "web"
100
101
-What authentication strategy to use with `login`.
101
+What authentication strategy to use with `login`. Note that if an `otp`
102
+config is given, this value will always be set to `legacy`.
103
104
### See Also
105
content/cli/v9/commands/npm-ci.md
+2
-2
@@ -169,7 +169,7 @@ de-duplicating. Sets `--install-strategy=nested`.
169
`--install-strategy=shallow`
170
171
Only install direct dependencies in the top level `node_modules`, but hoist
172
-on deeper dependendencies. Sets `--install-strategy=shallow`.
172
+on deeper dependencies. Sets `--install-strategy=shallow`.
173
174
#### `omit`
175
@@ -204,7 +204,7 @@ be resolved using the nearest non-peer dependency specification, even if
204
doing so will result in some packages receiving a peer dependency outside
205
the range set in their package's `peerDependencies` object.
206
207
-When such and override is performed, a warning is printed, explaining the
207
+When such an override is performed, a warning is printed, explaining the
208
conflict and the packages involved. If `--strict-peer-deps` is set, then
209
this warning is treated as a failure.
210
content/cli/v9/commands/npm-dedupe.md
+2
-2
@@ -140,7 +140,7 @@ de-duplicating. Sets `--install-strategy=nested`.
140
`--install-strategy=shallow`
141
142
Only install direct dependencies in the top level `node_modules`, but hoist
143
-on deeper dependendencies. Sets `--install-strategy=shallow`.
143
+on deeper dependencies. Sets `--install-strategy=shallow`.
144
145
#### `strict-peer-deps`
146
@@ -157,7 +157,7 @@ be resolved using the nearest non-peer dependency specification, even if
157
doing so will result in some packages receiving a peer dependency outside
158
the range set in their package's `peerDependencies` object.
159
160
-When such and override is performed, a warning is printed, explaining the
160
+When such an override is performed, a warning is printed, explaining the
161
conflict and the packages involved. If `--strict-peer-deps` is set, then
162
this warning is treated as a failure.
163
content/cli/v9/commands/npm-find-dupes.md
+2
-2
@@ -80,7 +80,7 @@ de-duplicating. Sets `--install-strategy=nested`.
80
`--install-strategy=shallow`
81
82
Only install direct dependencies in the top level `node_modules`, but hoist
83
-on deeper dependendencies. Sets `--install-strategy=shallow`.
83
+on deeper dependencies. Sets `--install-strategy=shallow`.
84
85
#### `strict-peer-deps`
86
@@ -97,7 +97,7 @@ be resolved using the nearest non-peer dependency specification, even if
97
doing so will result in some packages receiving a peer dependency outside
98
the range set in their package's `peerDependencies` object.
99
100
-When such and override is performed, a warning is printed, explaining the
100
+When such an override is performed, a warning is printed, explaining the
101
conflict and the packages involved. If `--strict-peer-deps` is set, then
102
this warning is treated as a failure.
103
content/cli/v9/commands/npm-init.md
+1
-1
@@ -38,7 +38,7 @@ redirect_from:
38
### Synopsis
39
40
```bash
41
-npm init <package-spec> (same as `npx <package-spec>)
41
+npm init <package-spec> (same as `npx <package-spec>`)
42
npm init <@scope> (same as `npx <@scope>/create`)
43
44
aliases: create, innit
content/cli/v9/commands/npm-install-ci-test.md
+2
-2
@@ -115,7 +115,7 @@ de-duplicating. Sets `--install-strategy=nested`.
115
`--install-strategy=shallow`
116
117
Only install direct dependencies in the top level `node_modules`, but hoist
118
-on deeper dependendencies. Sets `--install-strategy=shallow`.
118
+on deeper dependencies. Sets `--install-strategy=shallow`.
119
120
#### `omit`
121
@@ -150,7 +150,7 @@ be resolved using the nearest non-peer dependency specification, even if
150
doing so will result in some packages receiving a peer dependency outside
151
the range set in their package's `peerDependencies` object.
152
153
-When such and override is performed, a warning is printed, explaining the
153
+When such an override is performed, a warning is printed, explaining the
154
conflict and the packages involved. If `--strict-peer-deps` is set, then
155
this warning is treated as a failure.
156
content/cli/v9/commands/npm-install-test.md
+2
-2
@@ -116,7 +116,7 @@ de-duplicating. Sets `--install-strategy=nested`.
116
`--install-strategy=shallow`
117
118
Only install direct dependencies in the top level `node_modules`, but hoist
119
-on deeper dependendencies. Sets `--install-strategy=shallow`.
119
+on deeper dependencies. Sets `--install-strategy=shallow`.
120
121
#### `omit`
122
@@ -151,7 +151,7 @@ be resolved using the nearest non-peer dependency specification, even if
151
doing so will result in some packages receiving a peer dependency outside
152
the range set in their package's `peerDependencies` object.
153
154
-When such and override is performed, a warning is printed, explaining the
154
+When such an override is performed, a warning is printed, explaining the
155
conflict and the packages involved. If `--strict-peer-deps` is set, then
156
this warning is treated as a failure.
157
content/cli/v9/commands/npm-install.md
+2
-2
@@ -506,7 +506,7 @@ de-duplicating. Sets `--install-strategy=nested`.
506
`--install-strategy=shallow`
507
508
Only install direct dependencies in the top level `node_modules`, but hoist
509
-on deeper dependendencies. Sets `--install-strategy=shallow`.
509
+on deeper dependencies. Sets `--install-strategy=shallow`.
510
511
#### `omit`
512
@@ -541,7 +541,7 @@ be resolved using the nearest non-peer dependency specification, even if
541
doing so will result in some packages receiving a peer dependency outside
542
the range set in their package's `peerDependencies` object.
543
544
-When such and override is performed, a warning is printed, explaining the
544
+When such an override is performed, a warning is printed, explaining the
545
conflict and the packages involved. If `--strict-peer-deps` is set, then
546
this warning is treated as a failure.
547
content/cli/v9/commands/npm-link.md
+2
-2
@@ -207,7 +207,7 @@ de-duplicating. Sets `--install-strategy=nested`.
207
`--install-strategy=shallow`
208
209
Only install direct dependencies in the top level `node_modules`, but hoist
210
-on deeper dependendencies. Sets `--install-strategy=shallow`.
210
+on deeper dependencies. Sets `--install-strategy=shallow`.
211
212
#### `strict-peer-deps`
213
@@ -224,7 +224,7 @@ be resolved using the nearest non-peer dependency specification, even if
224
doing so will result in some packages receiving a peer dependency outside
225
the range set in their package's `peerDependencies` object.
226
227
-When such and override is performed, a warning is printed, explaining the
227
+When such an override is performed, a warning is printed, explaining the
228
conflict and the packages involved. If `--strict-peer-deps` is set, then
229
this warning is treated as a failure.
230
content/cli/v9/commands/npm-login.md
+2
-1
@@ -105,7 +105,8 @@ npm init --scope=@foo --yes
105
* Default: "web"
106
* Type: "legacy" or "web"
107
108
-What authentication strategy to use with `login`.
108
+What authentication strategy to use with `login`. Note that if an `otp`
109
+config is given, this value will always be set to `legacy`.
110
111
### See Also
112
content/cli/v9/commands/npm-ls.md
+1
-1
@@ -58,7 +58,7 @@ packages will *also* show the paths to the specified packages. For
58
example, running `npm ls promzard` in npm's source tree will show:
59
60
```bash
61
-npm@9.2.0 /path/to/npm
61
+npm@9.3.0 /path/to/npm
62
└─┬ init-package-json@0.0.4
63
└── promzard@0.1.5
64
```
content/cli/v9/commands/npm-owner.md
-2
@@ -45,8 +45,6 @@ npm owner ls <package-spec>
45
alias: author
46
```
47
48
-Note: This command is unaware of workspaces.
49
-
48
### Description
49
50
Manage ownership of published packages.
content/cli/v9/commands/npm-publish.md
+2
-2
@@ -138,8 +138,8 @@ tarball that will be compared with the local files by default.
138
current level
139
* Type: null, "restricted", or "public"
140
141
-If do not want your scoped package to be publicly viewable (and installable)
142
-set `--access=restricted`.
141
+If you do not want your scoped package to be publicly viewable (and
142
+installable) set `--access=restricted`.
143
144
Unscoped packages can not be set to `restricted`.
145
content/cli/v9/commands/npm-root.md
+2
@@ -41,6 +41,8 @@ redirect_from:
41
npm root
42
```
43
44
+Note: This command is unaware of workspaces.
45
+
46
### Description
47
48
Print the effective `node_modules` folder to standard out.
content/cli/v9/commands/npm-update.md
+2
-2
@@ -246,7 +246,7 @@ de-duplicating. Sets `--install-strategy=nested`.
246
`--install-strategy=shallow`
247
248
Only install direct dependencies in the top level `node_modules`, but hoist
249
-on deeper dependendencies. Sets `--install-strategy=shallow`.
249
+on deeper dependencies. Sets `--install-strategy=shallow`.
250
251
#### `omit`
252
@@ -281,7 +281,7 @@ be resolved using the nearest non-peer dependency specification, even if
281
doing so will result in some packages receiving a peer dependency outside
282
the range set in their package's `peerDependencies` object.
283
284
-When such and override is performed, a warning is printed, explaining the
284
+When such an override is performed, a warning is printed, explaining the
285
conflict and the packages involved. If `--strict-peer-deps` is set, then
286
this warning is treated as a failure.
287
content/cli/v9/commands/npm.md
+4
-2
@@ -27,9 +27,11 @@ redirect_from:
27
npm
28
```
29
30
+Note: This command is unaware of workspaces.
31
+
32
### Version
33
32
-9.2.0
34
+9.3.0
35
36
### Description
37
@@ -149,7 +151,7 @@ npm is extremely configurable. It reads its configuration options from
151
in the cli, env, or user config, then that file is parsed instead.
152
* Defaults:
153
npm's default configuration options are defined in
152
- lib/utils/config-defs.js. These must not be changed.
154
+ `lib/utils/config/definitions.js`. These must not be changed.
155
156
See [`config`](/cli/v9/using-npm/config) for much much more information.
157
content/cli/v9/configuring-npm/install.md
+3
-3
@@ -30,11 +30,11 @@ run npm packages globally.
30
### Overview
31
32
- [Checking your version of npm and
33
- Node.js](#checking-your-version-of-npm-and-node-js)
33
+ Node.js](#checking-your-version-of-npm-and-nodejs)
34
- [Using a Node version manager to install Node.js and
35
- npm](#using-a-node-version-manager-to-install-node-js-and-npm)
35
+ npm](#using-a-node-version-manager-to-install-nodejs-and-npm)
36
- [Using a Node installer to install Node.js and
37
- npm](#using-a-node-installer-to-install-node-js-and-npm)
37
+ npm](#using-a-node-installer-to-install-nodejs-and-npm)
38
39
### Checking your version of npm and Node.js
40
content/cli/v9/using-npm/changelog.md
+36
@@ -17,6 +17,42 @@ redirect_from:
17
18
# Changelog
19
20
+## [9.3.0](https://github.com/npm/cli/compare/v9.2.0...v9.3.0) (2023-01-12)
21
+
22
+### Features
23
+
24
+* [`753b98e`](https://github.com/npm/cli/commit/753b98ef49e0410642cbfb1adbe06e7417e22d82) [#5261](https://github.com/npm/cli/pull/5261) rootless workspace init provides suggestion (@fritzy)
25
+
26
+### Bug Fixes
27
+
28
+* [`cf175fb`](https://github.com/npm/cli/commit/cf175fb2a7faffa6664874a9e8bea52dbbb1b0e2) [#6044](https://github.com/npm/cli/pull/6044) default auth-type to legacy if otp is configured (#6044) (@wraithgar)
29
+* [`2383deb`](https://github.com/npm/cli/commit/2383deb9723593365cf748238f3b2388e7aaf6f5) [#6037](https://github.com/npm/cli/pull/6037) clean urls from arborist, owner, and ping commands (#6037) (@lukekarrys)
30
+* [`69f5ff8`](https://github.com/npm/cli/commit/69f5ff863fccf91935b1f62b514fd2621b761903) view: convert command to use output instead of console (@lukekarrys)
31
+* [`dc52222`](https://github.com/npm/cli/commit/dc52222123245d3faf2afa444d0223deb25e35b6) init: write package.json workspaces paths with / separators (@lukekarrys)
32
+* [`31af1aa`](https://github.com/npm/cli/commit/31af1aaa9f6427bd61d752d54801d873c6242af8) refactor `help` to use `@npmcli/promise-spawn` (@lukekarrys)
33
+* [`669ef94`](https://github.com/npm/cli/commit/669ef9476cac4679322bec69e7a55ff5992cf827) fund: correctly parse and use `which` config (@lukekarrys)
34
+* [`72e6d6f`](https://github.com/npm/cli/commit/72e6d6f638db03dbe3c965be79ce05cb6fda12fc) generate workspace support for docs pages (@lukekarrys)
35
+* [`450e50f`](https://github.com/npm/cli/commit/450e50fa555bfef869735b0195fe0a451e94eb3d) evaluate configs in command class (@lukekarrys)
36
+* [`28ec922`](https://github.com/npm/cli/commit/28ec922e18c7178e840fd28cbbf78f56f0a7a653) [#5946](https://github.com/npm/cli/pull/5946) replace rimraf with fs.rm (@lukekarrys)
37
+
38
+### Documentation
39
+
40
+* [`f0038e5`](https://github.com/npm/cli/commit/f0038e5b7492a899da26fafd5f781291961ef427) [#6048](https://github.com/npm/cli/pull/6048) missing backtick in synopsis of npm init (#5837) (#6048) (@Peallyz)
41
+* [`ca8ff00`](https://github.com/npm/cli/commit/ca8ff007d7abba1f3ae6646668ee840afa1191b6) [#6045](https://github.com/npm/cli/pull/6045) update outdated file path to definitions.js (@ericmutta)
42
+* [`fe9debd`](https://github.com/npm/cli/commit/fe9debd7925c8e6d05d53f49f516fec8aede8890) [#6038](https://github.com/npm/cli/pull/6038) fix typos in definitions.js (#6038) (@lukekarrys, @ericmutta)
43
+* [`fa27aca`](https://github.com/npm/cli/commit/fa27acaa72002c5cc80f59401dbd0ba817cda404) [#6018](https://github.com/npm/cli/pull/6018) fix typo in removal.md (@ericmutta)
44
+* [`82f69d9`](https://github.com/npm/cli/commit/82f69d90d58da8cc2a53570bfe2a1a9cc2574f0d) [#6026](https://github.com/npm/cli/pull/6026) fix typo in registry.md (@ericmutta)
45
+
46
+### Dependencies
47
+
48
+* [`ec09474`](https://github.com/npm/cli/commit/ec09474b371b0706d0d55a4968cf6ae545423568) [#5945](https://github.com/npm/cli/pull/5945) `minipass-fetch@3.0.1`
49
+* [Workspace](https://github.com/npm/cli/releases/tag/arborist-v6.1.6): `@npmcli/arborist@6.1.6`
50
+* [Workspace](https://github.com/npm/cli/releases/tag/config-v6.1.1): `@npmcli/config@6.1.1`
51
+* [Workspace](https://github.com/npm/cli/releases/tag/libnpmdiff-v5.0.7): `libnpmdiff@5.0.7`
52
+* [Workspace](https://github.com/npm/cli/releases/tag/libnpmexec-v5.0.7): `libnpmexec@5.0.7`
53
+* [Workspace](https://github.com/npm/cli/releases/tag/libnpmfund-v4.0.7): `libnpmfund@4.0.7`
54
+* [Workspace](https://github.com/npm/cli/releases/tag/libnpmpack-v5.0.7): `libnpmpack@5.0.7`
55
+
56
## [9.2.0](https://github.com/npm/cli/compare/v9.1.3...v9.2.0) (2022-12-07)
57
58
### Features
content/cli/v9/using-npm/config.md
+6
-5
@@ -155,8 +155,8 @@ safer to use a registry-provided authentication bearer token stored in the
155
current level
156
* Type: null, "restricted", or "public"
157
158
-If do not want your scoped package to be publicly viewable (and installable)
159
-set `--access=restricted`.
158
+If you do not want your scoped package to be publicly viewable (and
159
+installable) set `--access=restricted`.
160
161
Unscoped packages can not be set to `restricted`.
162
@@ -205,7 +205,8 @@ exit code.
205
* Default: "web"
206
* Type: "legacy" or "web"
207
208
-What authentication strategy to use with `login`.
208
+What authentication strategy to use with `login`. Note that if an `otp`
209
+config is given, this value will always be set to `legacy`.
210
211
#### `before`
212
@@ -1253,7 +1254,7 @@ be resolved using the nearest non-peer dependency specification, even if
1254
doing so will result in some packages receiving a peer dependency outside
1255
the range set in their package's `peerDependencies` object.
1256
1256
-When such and override is performed, a warning is printed, explaining the
1257
+When such an override is performed, a warning is printed, explaining the
1258
conflict and the packages involved. If `--strict-peer-deps` is set, then
1259
this warning is treated as a failure.
1260
@@ -1534,7 +1535,7 @@ Alias for `--include=dev`.
1535
`--install-strategy=shallow`
1536
1537
Only install direct dependencies in the top level `node_modules`, but hoist
1537
-on deeper dependendencies. Sets `--install-strategy=shallow`.
1538
+on deeper dependencies. Sets `--install-strategy=shallow`.
1539
1540
#### `init.author.email`
1541
content/cli/v9/using-npm/registry.md
+1
-1
@@ -48,7 +48,7 @@ Authentication configuration such as auth tokens and certificates are configured
48
specifically scoped to an individual registry. See
49
[Auth Related Configuration](/cli/v9/configuring-npm/npmrc#auth-related-configuration)
50
51
-When the default registry is used in a package-lock or shrinkwrap is has the
51
+When the default registry is used in a package-lock or shrinkwrap it has the
52
special meaning of "the currently configured registry". If you create a lock
53
file while using the default registry you can switch to another registry and
54
npm will install packages from the new registry, but if you create a lock
content/cli/v9/using-npm/removal.md
+2
-2
@@ -51,8 +51,8 @@ continue reading.
51
52
Note that this is only necessary for globally-installed packages. Local
53
installs are completely contained within a project's `node_modules`
54
-folder. Delete that folder, and everything is gone less a package's
55
-install script is particularly ill-behaved).
54
+folder. Delete that folder, and everything is gone unless a package's
55
+install script is particularly ill-behaved.
56
57
This assumes that you installed node and npm in the default place. If
58
you configured node with a different `--prefix`, or installed npm with a
content/cli/v9/using-npm/scripts.md
+1
-1
@@ -76,7 +76,7 @@ situations. These scripts happen in addition to the `pre<event>`, `post<event>`,
76
* Runs BEFORE the package is prepared and packed, ONLY on `npm publish`.
77
78
**prepack**
79
-* Runs BEFORE a tarball is packed (on "`npm pack`", "`npm publish`", and when installing a git dependencies).
79
+* Runs BEFORE a tarball is packed (on "`npm pack`", "`npm publish`", and when installing a git dependency).
80
* NOTE: "`npm run pack`" is NOT the same as "`npm pack`". "`npm run pack`" is an arbitrary user defined script name, where as, "`npm pack`" is a CLI defined command.
81
82
**postpack**
src/theme/nav.yml
+1
-1
@@ -1053,7 +1053,7 @@
1053
- title: Changelog
1054
url: /cli/v8/using-npm/changelog
1055
description: Changelog notes for each version
1056
- - title: Version 9.2.0 (Latest Release)
1056
+ - title: Version 9.3.0 (Latest Release)
1057
shortName: v9
1058
url: /cli/v9
1059
default: true