CLI documentation update from CI
npm CLI robot committed
Oct 18, 2023 at 20:32 UTC
9b8e8835d7ff95e5a06b87223b9658b46f060dac
6 files changed
+56
-13
content/cli/v10/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@10.2.0 /path/to/npm
61
+npm@10.2.1 /path/to/npm
62
└─┬ init-package-json@0.0.4
63
└── promzard@0.1.5
64
```
content/cli/v10/commands/npm-rebuild.md
+23
-8
@@ -45,14 +45,29 @@ alias: rb
45
46
### Description
47
48
-This command runs the `npm build` command on the matched folders. This is
49
-useful when you install a new version of node, and must recompile all your
50
-C++ addons with the new binary. It is also useful when installing with
51
-`--ignore-scripts` and `--no-bin-links`, to explicitly choose which
52
-packages to build and/or link bins.
53
-
54
-If one or more package specs are provided, then only packages with a
55
-name and version matching one of the specifiers will be rebuilt.
48
+This command does the following:
49
+
50
+1. Execute lifecycle scripts (`preinstall`, `install`, `postinstall`, `prepare`)
51
+2. Links bins depending on whether bin links are enabled
52
+
53
+This command is particularly useful in scenarios including but not limited to:
54
+
55
+1. Installing a new version of **node.js**, where you need to recompile all your C++ add-ons with the updated binary.
56
+2. Installing with `--ignore-scripts` and `--no-bin-links`, to explicitly choose which packages to build and/or link bins.
57
+
58
+If one or more package specs are provided, then only packages with a name and version matching one of the specifiers will be rebuilt.
59
+
60
+Usually, you should not need to run `npm rebuild` as it is already done for you as part of npm install (unless you suppressed these steps with `--ignore-scripts` or `--no-bin-links`).
61
+
62
+If there is a `binding.gyp` file in the root of your package, then npm will use a default install hook:
63
+
64
+```
65
+"scripts": {
66
+ "install": "node-gyp rebuild"
67
+}
68
+```
69
+
70
+This default behavior is suppressed if the `package.json` has its own `install` or `preinstall` scripts. It is also suppressed if the package specifies `"gypfile": false`
71
72
### Configuration
73
content/cli/v10/commands/npm.md
+1
-1
@@ -31,7 +31,7 @@ Note: This command is unaware of workspaces.
31
32
### Version
33
34
-10.2.0
34
+10.2.1
35
36
### Description
37
content/cli/v10/using-npm/changelog.md
+30
@@ -17,6 +17,36 @@ redirect_from:
17
18
# Changelog
19
20
+## [10.2.1](https://github.com/npm/cli/compare/v10.2.0...v10.2.1) (2023-10-18)
21
+
22
+### Bug Fixes
23
+
24
+* [`35c92fe`](https://github.com/npm/cli/commit/35c92fec3d053d303cc8057faa0ff4fe6e7cdc8a) [#6902](https://github.com/npm/cli/pull/6902) Add check to pkg command to deal with empty values (#6902) (@NeonArray)
25
+* [`5b6172f`](https://github.com/npm/cli/commit/5b6172f01c88b73e83a75a508bbdcad92231ead5) [#6895](https://github.com/npm/cli/pull/6895) logout from custom registry (@wraithgar)
26
+* [`8423d4f`](https://github.com/npm/cli/commit/8423d4f133a40c8ceb0e1a75d23aa95fbf4f5b65) [#6895](https://github.com/npm/cli/pull/6895) delete auth from proper location on logout (@wraithgar)
27
+* [`0cfe9de`](https://github.com/npm/cli/commit/0cfe9de1c74b20d3e04ecc26ccf594196d101afe) [#6873](https://github.com/npm/cli/pull/6873) audit: spelling error in message (#6873) (@Fdawgs)
28
+
29
+### Documentation
30
+
31
+* [`5142735`](https://github.com/npm/cli/commit/5142735c462e285a7a7d9bcbd562885c6ef96c96) [#6894](https://github.com/npm/cli/pull/6894) update npm build description (#6894) (@siemhesda)
32
+* [`2e4b4ad`](https://github.com/npm/cli/commit/2e4b4ad8bef158def1b2302846ab294fe7a83de4) [#6861](https://github.com/npm/cli/pull/6861) npm publish content modification (#6861) (@jpg619)
33
+
34
+### Dependencies
35
+
36
+* [`96e1637`](https://github.com/npm/cli/commit/96e1637117b6614b5ad861d86d828746d5db356c) [#6915](https://github.com/npm/cli/pull/6915) `cmd-shim@6.0.2` (#6915)
37
+* [`b405da1`](https://github.com/npm/cli/commit/b405da1672e05d55bd22e476091891c443bcbeab) [#6899](https://github.com/npm/cli/pull/6899) `bin-links@4.0.3`
38
+* [`ef69d36`](https://github.com/npm/cli/commit/ef69d362fa81640ac3ca60a6e01921c17f7a76cb) [#6895](https://github.com/npm/cli/pull/6895) `npm-registry-fetch@16.1.0`
39
+* [`337c903`](https://github.com/npm/cli/commit/337c9038605b97431e06d2f470229f4370703b13) [#6882](https://github.com/npm/cli/pull/6882) `spdx-license-ids@3.0.16`
40
+* [`e6b0be7`](https://github.com/npm/cli/commit/e6b0be7d3b3cd7f66612f9adb6c4de829335b607) [#6882](https://github.com/npm/cli/pull/6882) `socks-proxy-agent@8.0.2`
41
+* [`ee6892e`](https://github.com/npm/cli/commit/ee6892e69079b07c0a8747d873018819a97e3877) [#6882](https://github.com/npm/cli/pull/6882) `readable-stream@4.4.2`
42
+* [`61c3ee9`](https://github.com/npm/cli/commit/61c3ee9a073528b30676ec66fdd29788ea7be09d) [#6882](https://github.com/npm/cli/pull/6882) `minipass@7.0.4`
43
+* [`14d31fd`](https://github.com/npm/cli/commit/14d31fdcc747f420158d254d0ac258a848bc888c) [#6882](https://github.com/npm/cli/pull/6882) `is-core-module@2.13.0`
44
+* [`03f3d2e`](https://github.com/npm/cli/commit/03f3d2e1d13cd12f23a946cfb9065b8e8fbe129b) [#6882](https://github.com/npm/cli/pull/6882) `https-proxy-agent@7.0.2`
45
+* [`e0163c6`](https://github.com/npm/cli/commit/e0163c6787f3877c3ad6c84d8af44378f7eed23b) [#6882](https://github.com/npm/cli/pull/6882) `are-we-there-yet@4.0.1`
46
+* [`fca804a`](https://github.com/npm/cli/commit/fca804adec57e176bb2a2e60bf84df44e661478f) [#6882](https://github.com/npm/cli/pull/6882) `ci-info@3.9.0`
47
+* [`6af582f`](https://github.com/npm/cli/commit/6af582f23bf046a224d5679e917977f0bb3f95e3) [#6882](https://github.com/npm/cli/pull/6882) `npm-install-checks@6.3.0`
48
+* [Workspace](https://github.com/npm/cli/releases/tag/config-v8.0.1): `@npmcli/config@8.0.1`
49
+
50
## [10.2.0](https://github.com/npm/cli/compare/v10.1.0...v10.2.0) (2023-10-02)
51
52
### Features
content/cli/v10/using-npm/scripts.md
-2
@@ -172,8 +172,6 @@ These are run from the scripts of `<pkg-name>`
172
* `publish`
173
* `postpublish`
174
175
-`prepare` will not run during `--dry-run`
176
-
175
#### [`npm rebuild`](/cli/v10/commands/npm-rebuild)
176
177
* `preinstall`
src/theme/nav.yml
+1
-1
@@ -1320,7 +1320,7 @@
1320
- title: Changelog
1321
url: /cli/v9/using-npm/changelog
1322
description: Changelog notes for each version
1323
- - title: Version 10.2.0 (Latest Release)
1323
+ - title: Version 10.2.1 (Latest Release)
1324
shortName: v10
1325
url: /cli/v10
1326
default: true