CLI documentation update from CI

timscharfenort8 · Jan 12, 2023 · 2d3e7c6 · 2d3e7c6
1 parent 7090dc1
commit 2d3e7c6
Show file tree

Hide file tree

Showing 24 changed files with 82 additions and 39 deletions.
diff --git a/content/cli/v9/commands/npm-access.md b/content/cli/v9/commands/npm-access.md
@@ -47,6 +47,8 @@ npm access grant <read-only|read-write> <scope:team> [<package>]
 npm access revoke <scope:team> [<package>]
 ```
 
+Note: This command is unaware of workspaces.
+
 ### Description
 
 Used to set access controls on private packages.

diff --git a/content/cli/v9/commands/npm-adduser.md b/content/cli/v9/commands/npm-adduser.md
@@ -98,7 +98,8 @@ npm init --scope=@foo --yes
 * Default: "web"
 * Type: "legacy" or "web"
 
-What authentication strategy to use with `login`.
+What authentication strategy to use with `login`. Note that if an `otp`
+config is given, this value will always be set to `legacy`.
 
 ### See Also
 

diff --git a/content/cli/v9/commands/npm-ci.md b/content/cli/v9/commands/npm-ci.md
@@ -169,7 +169,7 @@ de-duplicating. Sets `--install-strategy=nested`.
   `--install-strategy=shallow`
 
 Only install direct dependencies in the top level `node_modules`, but hoist
-on deeper dependendencies. Sets `--install-strategy=shallow`.
+on deeper dependencies. Sets `--install-strategy=shallow`.
 
 #### `omit`
 
@@ -204,7 +204,7 @@ be resolved using the nearest non-peer dependency specification, even if
 doing so will result in some packages receiving a peer dependency outside
 the range set in their package's `peerDependencies` object.
 
-When such and override is performed, a warning is printed, explaining the
+When such an override is performed, a warning is printed, explaining the
 conflict and the packages involved. If `--strict-peer-deps` is set, then
 this warning is treated as a failure.
 

diff --git a/content/cli/v9/commands/npm-dedupe.md b/content/cli/v9/commands/npm-dedupe.md
@@ -140,7 +140,7 @@ de-duplicating. Sets `--install-strategy=nested`.
   `--install-strategy=shallow`
 
 Only install direct dependencies in the top level `node_modules`, but hoist
-on deeper dependendencies. Sets `--install-strategy=shallow`.
+on deeper dependencies. Sets `--install-strategy=shallow`.
 
 #### `strict-peer-deps`
 
@@ -157,7 +157,7 @@ be resolved using the nearest non-peer dependency specification, even if
 doing so will result in some packages receiving a peer dependency outside
 the range set in their package's `peerDependencies` object.
 
-When such and override is performed, a warning is printed, explaining the
+When such an override is performed, a warning is printed, explaining the
 conflict and the packages involved. If `--strict-peer-deps` is set, then
 this warning is treated as a failure.
 

diff --git a/content/cli/v9/commands/npm-find-dupes.md b/content/cli/v9/commands/npm-find-dupes.md
@@ -80,7 +80,7 @@ de-duplicating. Sets `--install-strategy=nested`.
   `--install-strategy=shallow`
 
 Only install direct dependencies in the top level `node_modules`, but hoist
-on deeper dependendencies. Sets `--install-strategy=shallow`.
+on deeper dependencies. Sets `--install-strategy=shallow`.
 
 #### `strict-peer-deps`
 
@@ -97,7 +97,7 @@ be resolved using the nearest non-peer dependency specification, even if
 doing so will result in some packages receiving a peer dependency outside
 the range set in their package's `peerDependencies` object.
 
-When such and override is performed, a warning is printed, explaining the
+When such an override is performed, a warning is printed, explaining the
 conflict and the packages involved. If `--strict-peer-deps` is set, then
 this warning is treated as a failure.
 

diff --git a/content/cli/v9/commands/npm-init.md b/content/cli/v9/commands/npm-init.md
@@ -38,7 +38,7 @@ redirect_from:
 ### Synopsis
 
 ```bash
-npm init <package-spec> (same as `npx <package-spec>)
+npm init <package-spec> (same as `npx <package-spec>`)
 npm init <@scope> (same as `npx <@scope>/create`)
 
 aliases: create, innit

diff --git a/content/cli/v9/commands/npm-install-ci-test.md b/content/cli/v9/commands/npm-install-ci-test.md
@@ -115,7 +115,7 @@ de-duplicating. Sets `--install-strategy=nested`.
   `--install-strategy=shallow`
 
 Only install direct dependencies in the top level `node_modules`, but hoist
-on deeper dependendencies. Sets `--install-strategy=shallow`.
+on deeper dependencies. Sets `--install-strategy=shallow`.
 
 #### `omit`
 
@@ -150,7 +150,7 @@ be resolved using the nearest non-peer dependency specification, even if
 doing so will result in some packages receiving a peer dependency outside
 the range set in their package's `peerDependencies` object.
 
-When such and override is performed, a warning is printed, explaining the
+When such an override is performed, a warning is printed, explaining the
 conflict and the packages involved. If `--strict-peer-deps` is set, then
 this warning is treated as a failure.
 

diff --git a/content/cli/v9/commands/npm-install-test.md b/content/cli/v9/commands/npm-install-test.md
@@ -116,7 +116,7 @@ de-duplicating. Sets `--install-strategy=nested`.
   `--install-strategy=shallow`
 
 Only install direct dependencies in the top level `node_modules`, but hoist
-on deeper dependendencies. Sets `--install-strategy=shallow`.
+on deeper dependencies. Sets `--install-strategy=shallow`.
 
 #### `omit`
 
@@ -151,7 +151,7 @@ be resolved using the nearest non-peer dependency specification, even if
 doing so will result in some packages receiving a peer dependency outside
 the range set in their package's `peerDependencies` object.
 
-When such and override is performed, a warning is printed, explaining the
+When such an override is performed, a warning is printed, explaining the
 conflict and the packages involved. If `--strict-peer-deps` is set, then
 this warning is treated as a failure.
 

diff --git a/content/cli/v9/commands/npm-install.md b/content/cli/v9/commands/npm-install.md
@@ -506,7 +506,7 @@ de-duplicating. Sets `--install-strategy=nested`.
   `--install-strategy=shallow`
 
 Only install direct dependencies in the top level `node_modules`, but hoist
-on deeper dependendencies. Sets `--install-strategy=shallow`.
+on deeper dependencies. Sets `--install-strategy=shallow`.
 
 #### `omit`
 
@@ -541,7 +541,7 @@ be resolved using the nearest non-peer dependency specification, even if
 doing so will result in some packages receiving a peer dependency outside
 the range set in their package's `peerDependencies` object.
 
-When such and override is performed, a warning is printed, explaining the
+When such an override is performed, a warning is printed, explaining the
 conflict and the packages involved. If `--strict-peer-deps` is set, then
 this warning is treated as a failure.
 

diff --git a/content/cli/v9/commands/npm-link.md b/content/cli/v9/commands/npm-link.md
@@ -207,7 +207,7 @@ de-duplicating. Sets `--install-strategy=nested`.
   `--install-strategy=shallow`
 
 Only install direct dependencies in the top level `node_modules`, but hoist
-on deeper dependendencies. Sets `--install-strategy=shallow`.
+on deeper dependencies. Sets `--install-strategy=shallow`.
 
 #### `strict-peer-deps`
 
@@ -224,7 +224,7 @@ be resolved using the nearest non-peer dependency specification, even if
 doing so will result in some packages receiving a peer dependency outside
 the range set in their package's `peerDependencies` object.
 
-When such and override is performed, a warning is printed, explaining the
+When such an override is performed, a warning is printed, explaining the
 conflict and the packages involved. If `--strict-peer-deps` is set, then
 this warning is treated as a failure.
 

diff --git a/content/cli/v9/commands/npm-login.md b/content/cli/v9/commands/npm-login.md
@@ -105,7 +105,8 @@ npm init --scope=@foo --yes
 * Default: "web"
 * Type: "legacy" or "web"
 
-What authentication strategy to use with `login`.
+What authentication strategy to use with `login`. Note that if an `otp`
+config is given, this value will always be set to `legacy`.
 
 ### See Also
 

diff --git a/content/cli/v9/commands/npm-ls.md b/content/cli/v9/commands/npm-ls.md
@@ -58,7 +58,7 @@ packages will *also* show the paths to the specified packages.  For
 example, running `npm ls promzard` in npm's source tree will show:
 
 ```bash
-npm@9.2.0 /path/to/npm
+npm@9.3.0 /path/to/npm
 └─┬ [email protected]
   └── [email protected]
 ```

diff --git a/content/cli/v9/commands/npm-owner.md b/content/cli/v9/commands/npm-owner.md
@@ -45,8 +45,6 @@ npm owner ls <package-spec>
 alias: author
 ```
 
-Note: This command is unaware of workspaces.
-
 ### Description
 
 Manage ownership of published packages.

diff --git a/content/cli/v9/commands/npm-publish.md b/content/cli/v9/commands/npm-publish.md
@@ -138,8 +138,8 @@ tarball that will be compared with the local files by default.
   current level
 * Type: null, "restricted", or "public"
 
-If do not want your scoped package to be publicly viewable (and installable)
-set `--access=restricted`.
+If you do not want your scoped package to be publicly viewable (and
+installable) set `--access=restricted`.
 
 Unscoped packages can not be set to `restricted`.
 

diff --git a/content/cli/v9/commands/npm-root.md b/content/cli/v9/commands/npm-root.md
@@ -41,6 +41,8 @@ redirect_from:
 npm root
 ```
 
+Note: This command is unaware of workspaces.
+
 ### Description
 
 Print the effective `node_modules` folder to standard out.

diff --git a/content/cli/v9/commands/npm-update.md b/content/cli/v9/commands/npm-update.md
@@ -246,7 +246,7 @@ de-duplicating. Sets `--install-strategy=nested`.
   `--install-strategy=shallow`
 
 Only install direct dependencies in the top level `node_modules`, but hoist
-on deeper dependendencies. Sets `--install-strategy=shallow`.
+on deeper dependencies. Sets `--install-strategy=shallow`.
 
 #### `omit`
 
@@ -281,7 +281,7 @@ be resolved using the nearest non-peer dependency specification, even if
 doing so will result in some packages receiving a peer dependency outside
 the range set in their package's `peerDependencies` object.
 
-When such and override is performed, a warning is printed, explaining the
+When such an override is performed, a warning is printed, explaining the
 conflict and the packages involved. If `--strict-peer-deps` is set, then
 this warning is treated as a failure.
 

diff --git a/content/cli/v9/commands/npm.md b/content/cli/v9/commands/npm.md
@@ -27,9 +27,11 @@ redirect_from:
 npm
 ```
 
+Note: This command is unaware of workspaces.
+
 ### Version
 
-9.2.0
+9.3.0
 
 ### Description
 
@@ -149,7 +151,7 @@ npm is extremely configurable.  It reads its configuration options from
   in the cli, env, or user config, then that file is parsed instead.
 * Defaults:
   npm's default configuration options are defined in
-  lib/utils/config-defs.js.  These must not be changed.
+  `lib/utils/config/definitions.js`.  These must not be changed.
 
 See [`config`](/cli/v9/using-npm/config) for much much more information.
 

diff --git a/content/cli/v9/configuring-npm/install.md b/content/cli/v9/configuring-npm/install.md
@@ -30,11 +30,11 @@ run npm packages globally.
 ### Overview
 
 - [Checking your version of npm and
-  Node.js](#checking-your-version-of-npm-and-node-js)
+  Node.js](#checking-your-version-of-npm-and-nodejs)
 - [Using a Node version manager to install Node.js and
-  npm](#using-a-node-version-manager-to-install-node-js-and-npm)
+  npm](#using-a-node-version-manager-to-install-nodejs-and-npm)
 - [Using a Node installer to install Node.js and
-  npm](#using-a-node-installer-to-install-node-js-and-npm)
+  npm](#using-a-node-installer-to-install-nodejs-and-npm)
 
 ### Checking your version of npm and Node.js
 

diff --git a/content/cli/v9/using-npm/changelog.md b/content/cli/v9/using-npm/changelog.md
@@ -17,6 +17,42 @@ redirect_from:
 
 # Changelog
 
+## [9.3.0](https://github.com/npm/cli/compare/v9.2.0...v9.3.0) (2023-01-12)
+
+### Features
+
+* [`753b98e`](https://github.com/npm/cli/commit/753b98ef49e0410642cbfb1adbe06e7417e22d82) [#5261](https://github.com/npm/cli/pull/5261) rootless workspace init provides suggestion (@fritzy)
+
+### Bug Fixes
+
+* [`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)
+* [`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)
+* [`69f5ff8`](https://github.com/npm/cli/commit/69f5ff863fccf91935b1f62b514fd2621b761903) view: convert command to use output instead of console (@lukekarrys)
+* [`dc52222`](https://github.com/npm/cli/commit/dc52222123245d3faf2afa444d0223deb25e35b6) init: write package.json workspaces paths with / separators (@lukekarrys)
+* [`31af1aa`](https://github.com/npm/cli/commit/31af1aaa9f6427bd61d752d54801d873c6242af8) refactor `help` to use `@npmcli/promise-spawn` (@lukekarrys)
+* [`669ef94`](https://github.com/npm/cli/commit/669ef9476cac4679322bec69e7a55ff5992cf827) fund: correctly parse and use `which` config (@lukekarrys)
+* [`72e6d6f`](https://github.com/npm/cli/commit/72e6d6f638db03dbe3c965be79ce05cb6fda12fc) generate workspace support for docs pages (@lukekarrys)
+* [`450e50f`](https://github.com/npm/cli/commit/450e50fa555bfef869735b0195fe0a451e94eb3d) evaluate configs in command class (@lukekarrys)
+* [`28ec922`](https://github.com/npm/cli/commit/28ec922e18c7178e840fd28cbbf78f56f0a7a653) [#5946](https://github.com/npm/cli/pull/5946) replace rimraf with fs.rm (@lukekarrys)
+
+### Documentation
+
+* [`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)
+* [`ca8ff00`](https://github.com/npm/cli/commit/ca8ff007d7abba1f3ae6646668ee840afa1191b6) [#6045](https://github.com/npm/cli/pull/6045) update outdated file path to definitions.js (@ericmutta)
+* [`fe9debd`](https://github.com/npm/cli/commit/fe9debd7925c8e6d05d53f49f516fec8aede8890) [#6038](https://github.com/npm/cli/pull/6038) fix typos in definitions.js (#6038) (@lukekarrys, @ericmutta)
+* [`fa27aca`](https://github.com/npm/cli/commit/fa27acaa72002c5cc80f59401dbd0ba817cda404) [#6018](https://github.com/npm/cli/pull/6018) fix typo in removal.md (@ericmutta)
+* [`82f69d9`](https://github.com/npm/cli/commit/82f69d90d58da8cc2a53570bfe2a1a9cc2574f0d) [#6026](https://github.com/npm/cli/pull/6026) fix typo in registry.md (@ericmutta)
+
+### Dependencies
+
+* [`ec09474`](https://github.com/npm/cli/commit/ec09474b371b0706d0d55a4968cf6ae545423568) [#5945](https://github.com/npm/cli/pull/5945) `[email protected]`
+* [Workspace](https://github.com/npm/cli/releases/tag/arborist-v6.1.6): `@npmcli/[email protected]`
+* [Workspace](https://github.com/npm/cli/releases/tag/config-v6.1.1): `@npmcli/[email protected]`
+* [Workspace](https://github.com/npm/cli/releases/tag/libnpmdiff-v5.0.7): `[email protected]`
+* [Workspace](https://github.com/npm/cli/releases/tag/libnpmexec-v5.0.7): `[email protected]`
+* [Workspace](https://github.com/npm/cli/releases/tag/libnpmfund-v4.0.7): `[email protected]`
+* [Workspace](https://github.com/npm/cli/releases/tag/libnpmpack-v5.0.7): `[email protected]`
+
 ## [9.2.0](https://github.com/npm/cli/compare/v9.1.3...v9.2.0) (2022-12-07)
 
 ### Features

diff --git a/content/cli/v9/using-npm/config.md b/content/cli/v9/using-npm/config.md
@@ -155,8 +155,8 @@ safer to use a registry-provided authentication bearer token stored in the
   current level
 * Type: null, "restricted", or "public"
 
-If do not want your scoped package to be publicly viewable (and installable)
-set `--access=restricted`.
+If you do not want your scoped package to be publicly viewable (and
+installable) set `--access=restricted`.
 
 Unscoped packages can not be set to `restricted`.
 
@@ -205,7 +205,8 @@ exit code.
 * Default: "web"
 * Type: "legacy" or "web"
 
-What authentication strategy to use with `login`.
+What authentication strategy to use with `login`. Note that if an `otp`
+config is given, this value will always be set to `legacy`.
 
 #### `before`
 
@@ -1253,7 +1254,7 @@ be resolved using the nearest non-peer dependency specification, even if
 doing so will result in some packages receiving a peer dependency outside
 the range set in their package's `peerDependencies` object.
 
-When such and override is performed, a warning is printed, explaining the
+When such an override is performed, a warning is printed, explaining the
 conflict and the packages involved. If `--strict-peer-deps` is set, then
 this warning is treated as a failure.
 
@@ -1534,7 +1535,7 @@ Alias for `--include=dev`.
   `--install-strategy=shallow`
 
 Only install direct dependencies in the top level `node_modules`, but hoist
-on deeper dependendencies. Sets `--install-strategy=shallow`.
+on deeper dependencies. Sets `--install-strategy=shallow`.
 
 #### `init.author.email`
 

diff --git a/content/cli/v9/using-npm/registry.md b/content/cli/v9/using-npm/registry.md
@@ -48,7 +48,7 @@ Authentication configuration such as auth tokens and certificates are configured
 specifically scoped to an individual registry. See
 [Auth Related Configuration](/cli/v9/configuring-npm/npmrc#auth-related-configuration)
 
-When the default registry is used in a package-lock or shrinkwrap is has the
+When the default registry is used in a package-lock or shrinkwrap it has the
 special meaning of "the currently configured registry". If you create a lock
 file while using the default registry you can switch to another registry and
 npm will install packages from the new registry, but if you create a lock

diff --git a/content/cli/v9/using-npm/removal.md b/content/cli/v9/using-npm/removal.md
@@ -51,8 +51,8 @@ continue reading.
 
 Note that this is only necessary for globally-installed packages.  Local
 installs are completely contained within a project's `node_modules`
-folder.  Delete that folder, and everything is gone less a package's
-install script is particularly ill-behaved).
+folder.  Delete that folder, and everything is gone unless a package's
+install script is particularly ill-behaved.
 
 This assumes that you installed node and npm in the default place.  If
 you configured node with a different `--prefix`, or installed npm with a

diff --git a/content/cli/v9/using-npm/scripts.md b/content/cli/v9/using-npm/scripts.md
@@ -76,7 +76,7 @@ situations. These scripts happen in addition to the `pre<event>`, `post<event>`,
 * Runs BEFORE the package is prepared and packed, ONLY on `npm publish`.
 
 **prepack**
-* Runs BEFORE a tarball is packed (on "`npm pack`", "`npm publish`", and when installing a git dependencies).
+* Runs BEFORE a tarball is packed (on "`npm pack`", "`npm publish`", and when installing a git dependency).
 * 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.
 
 **postpack**

diff --git a/src/theme/nav.yml b/src/theme/nav.yml
@@ -1053,7 +1053,7 @@
             - title: Changelog
               url: /cli/v8/using-npm/changelog
               description: Changelog notes for each version
-    - title: Version 9.2.0 (Latest Release)
+    - title: Version 9.3.0 (Latest Release)
       shortName: v9
       url: /cli/v9
       default: true