@cryptotaxi247 / documentation-1 / commits / 3a15e02

CLI documentation update from CI

npm CLI robot committed Apr 3, 2024 at 14:50 UTC 3a15e020c10f293c65a734ea3a60eb55453dc37a
7 files changed +74 -13
content/cli/v10/commands/npm-audit.mdx
+3 -1
@@ -65,6 +65,8 @@ Registry signatures can be verified using the following `audit` command:
65 $ npm audit signatures
66 ```
67
68 +The `audit signatures` command will also verify the provenance attestations of downloaded packages. Because provenance attestations are such a new feature, security features may be added to (or changed in) the attestation format over time. To ensure that you're always able to verify attestation signatures check that you're running the latest version of the npm CLI. Please note this often means updating npm beyond the version that ships with Node.js.
69 +
70 The npm CLI supports registry signatures and signing keys provided by any registry if the following conventions are followed:
71
72 1. Signatures are provided in the package's `packument` in each published version within the `dist` object:
@@ -105,7 +107,7 @@ Keys response:
107 - `scheme`: only `ecdsa-sha2-nistp256` is currently supported by the npm CLI
108 - `key`: base64 encoded public key
109
108 -See this [example key's response from the public npm registry](https://registry.npmjs.org/-/npm/v1/keys").
110 +See this [example key's response from the public npm registry](https://registry.npmjs.org/-/npm/v1/keys).
111
112 ### Audit Endpoints
113
content/cli/v10/commands/npm-ls.mdx
+1 -1
@@ -52,7 +52,7 @@ Note: to get a "bottoms up" view of why a given package is included in the tree
52 Positional arguments are `name@version-range` identifiers, which will limit the results to only the paths to the packages named. Note that nested packages will _also_ show the paths to the specified packages. For example, running `npm ls promzard` in npm's source tree will show:
53
54 ```bash
55 -npm@10.5.0 /path/to/npm
55 +npm@10.5.1 /path/to/npm
56 └─┬ init-package-json@0.0.4
57 └── promzard@0.1.5
58 ```
content/cli/v10/commands/npm-search.mdx
+7
@@ -96,6 +96,13 @@ Output parseable results from commands that write to standard output. For `npm s
96
97 Show the description in `npm search`
98
99 +#### `searchlimit`
100 +
101 +- Default: 20
102 +- Type: Number
103 +
104 +Number of items to limit search results to. Will not apply at all to legacy searches.
105 +
106 #### `searchopts`
107
108 - Default: ""
content/cli/v10/commands/npm.mdx
+1 -1
@@ -31,7 +31,7 @@ Note: This command is unaware of workspaces.
31
32 ### Version
33
34 -10.5.0
34 +10.5.1
35
36 ### Description
37
content/cli/v10/configuring-npm/package-json.mdx
+9 -9
@@ -49,7 +49,7 @@ Some rules:
49 Some tips:
50
51 - Don't use the same name as a core Node module.
52 -- Don't put "js" or "node" in the name. It's assumed that it's js, since you're writing a package.json file, and you can specify the engine using the "engines" field. (See below.)
52 +- Don't put "js" or "node" in the name. It's assumed that it's js, since you're writing a package.json file, and you can specify the engine using the "[engines](#engines)" field. (See below.)
53 - The name will probably be passed as an argument to require(), so it should be something short, but also reasonably descriptive.
54 - You may want to check the npm registry to see if there's something by that name already, before you get too attached to it. [https://www.npmjs.com/](https://www.npmjs.com/)
55
@@ -71,7 +71,7 @@ Put keywords in it. It's an array of strings. This helps people discover your pa
71
72 ### homepage
73
74 -The url to the project homepage.
74 +The URL to the project homepage.
75
76 Example:
77
@@ -81,7 +81,7 @@ Example:
81
82 ### bugs
83
84 -The url to your project's issue tracker and / or the email address to which issues should be reported. These are helpful for people who encounter issues with your package.
84 +The URL to your project's issue tracker and / or the email address to which issues should be reported. These are helpful for people who encounter issues with your package.
85
86 It should look like this:
87
@@ -94,9 +94,9 @@ It should look like this:
94 }
95 ```
96
97 -You can specify either one or both values. If you want to provide only a url, you can specify the value for "bugs" as a simple string instead of an object.
97 +You can specify either one or both values. If you want to provide only a URL, you can specify the value for "bugs" as a simple string instead of an object.
98
99 -If a url is provided, it will be used by the `npm bugs` command.
99 +If a URL is provided, it will be used by the `npm bugs` command.
100
101 ### license
102
@@ -424,7 +424,7 @@ Do it like this:
424 }
425 ```
426
427 -The URL should be a publicly available (perhaps read-only) url that can be handed directly to a VCS program without any modification. It should not be a url to an html project page that you put in your browser. It's for computers.
427 +The URL should be a publicly available (perhaps read-only) URL that can be handed directly to a VCS program without any modification. It should not be a URL to an html project page that you put in your browser. It's for computers.
428
429 For GitHub, GitHub gist, Bitbucket, or GitLab repositories you can use the same shortcut syntax you use for `npm install`:
430
@@ -530,7 +530,7 @@ This tarball will be downloaded and installed locally to your package at install
530
531 #### Git URLs as Dependencies
532
533 -Git urls are of the form:
533 +Git URLs are of the form:
534
535 ```bash
536 <protocol>://[<user>[:<password>]@]<hostname>[:<port>][:][/]<path>[#<commit-ish> | #semver:<semver>]
@@ -564,7 +564,7 @@ If your git repository includes pre-built artifacts, you will likely want to mak
564
565 #### GitHub URLs
566
567 -As of version 1.1.65, you can refer to GitHub urls as just "foo": "user/foo-project". Just as with git URLs, a `commit-ish` suffix can be included. For example:
567 +As of version 1.1.65, you can refer to GitHub URLs as just "foo": "user/foo-project". Just as with git URLs, a `commit-ish` suffix can be included. For example:
568
569 ```json
570 {
@@ -712,7 +712,7 @@ Alternatively, `"bundleDependencies"` can be defined as a boolean value. A value
712
713 ### optionalDependencies
714
715 -If a dependency can be used, but you would like npm to proceed if it cannot be found or fails to install, then you may put it in the `optionalDependencies` object. This is a map of package name to version or url, just like the `dependencies` object. The difference is that build failures do not cause installation to fail. Running `npm install --omit=optional` will prevent these dependencies from being installed.
715 +If a dependency can be used, but you would like npm to proceed if it cannot be found or fails to install, then you may put it in the `optionalDependencies` object. This is a map of package name to version or URL, just like the `dependencies` object. The difference is that build failures do not cause installation to fail. Running `npm install --omit=optional` will prevent these dependencies from being installed.
716
717 It is still your program's responsibility to handle the lack of the dependency. For example, something like this:
718
content/cli/v10/using-npm/changelog.mdx
+52
@@ -15,6 +15,58 @@ redirect_from:
15 - /using-npm/changelog
16 ---
17
18 +## [10.5.1](https://github.com/npm/cli/compare/v10.5.0...v10.5.1) (2024-04-03)
19 +
20 +### Bug Fixes
21 +
22 +- [`17d97d2`](https://github.com/npm/cli/commit/17d97d266807f69cfc2a7a3982e8db126f90c48a) [#7334](https://github.com/npm/cli/pull/7334) use @npmcli/redact for log redactions (@lukekarrys)
23 +- [`8cab136`](https://github.com/npm/cli/commit/8cab136f731c69be079be08d79e3514e01bbd563) [#7324](https://github.com/npm/cli/pull/7324) ensure maxSockets is respected (#7324) (@lukekarrys)
24 +- [`9bffa13`](https://github.com/npm/cli/commit/9bffa13e0b96efe1039d9075fdcb11d5946b2f90) [#7320](https://github.com/npm/cli/pull/7320) query: properly return :missing nodes (#7320) (@wraithgar)
25 +- [`9d4e85f`](https://github.com/npm/cli/commit/9d4e85f2379eded50b54f4e0b6f307031037f1ec) [#7297](https://github.com/npm/cli/pull/7297) search: include searchlimit option in help output (#7297) (@10xLaCroixDrinker)
26 +- [`bdb3c28`](https://github.com/npm/cli/commit/bdb3c28167f757060474ef2b82c92f3a1f210972) [#7274](https://github.com/npm/cli/pull/7274) added check for dry-run (#7274) (@cod1r)
27 +- [`7f1ab88`](https://github.com/npm/cli/commit/7f1ab8822a8d50403338595ab9f218e4d63f37fa) [#7271](https://github.com/npm/cli/pull/7271) more lightweight npm bin discovery in windows (#7271) (@wraithgar)
28 +
29 +### Documentation
30 +
31 +- [`1da5cf0`](https://github.com/npm/cli/commit/1da5cf0ace30d89edf05833b91ce80467c7864bd) [#7198](https://github.com/npm/cli/pull/7198) add link to engines section (#7198) (@uiolee)
32 +- [`1114a12`](https://github.com/npm/cli/commit/1114a12f2b4691d403d0863d4dca44f25580f57d) [#7307](https://github.com/npm/cli/pull/7307) fix incorrect npm audit key response link (#7307) (@davidlj95)
33 +- [`9807caf`](https://github.com/npm/cli/commit/9807cafbaf274eca2a0abbd04a9b2b55e850de9d) [#7304](https://github.com/npm/cli/pull/7304) update audit docs with provenance info (#7304) (@bdehamer)
34 +- [`e1ecfa7`](https://github.com/npm/cli/commit/e1ecfa7829be91282373862669b92ef42b9e48df) [#7285](https://github.com/npm/cli/pull/7285) Correct capitalization for URL (#7285) (@coliff)
35 +
36 +### Dependencies
37 +
38 +- [`87a61fc`](https://github.com/npm/cli/commit/87a61fc8bb65c950cda389ab3d14ae250ab2345d) [#7334](https://github.com/npm/cli/pull/7334) `npm-registry-fetch@16.2.0`
39 +- [`5469614`](https://github.com/npm/cli/commit/54696148f25986bcdf39e1acb5aca4bf09e7d1a0) [#7327](https://github.com/npm/cli/pull/7327) `init-package-json@6.0.2`
40 +- [`5469614`](https://github.com/npm/cli/commit/54696148f25986bcdf39e1acb5aca4bf09e7d1a0) [#7327](https://github.com/npm/cli/pull/7327) `promzard@1.0.1`
41 +- [`5469614`](https://github.com/npm/cli/commit/54696148f25986bcdf39e1acb5aca4bf09e7d1a0) [#7327](https://github.com/npm/cli/pull/7327) `read@3.0.1` (#7327)
42 +- [`9ccff72`](https://github.com/npm/cli/commit/9ccff72c332e6062e6ebcf8123c7888d8d617091) [#7329](https://github.com/npm/cli/pull/7329) `tar@6.2.1`
43 +- [`7201a00`](https://github.com/npm/cli/commit/7201a00632f5cedf50101e8411a4b3c514439efb) [#7329](https://github.com/npm/cli/pull/7329) `node-gyp@10.1.0`
44 +- [`6fd94f2`](https://github.com/npm/cli/commit/6fd94f249f43080ae183da36b971981e8ad00882) [#7329](https://github.com/npm/cli/pull/7329) `minimatch@9.0.4`
45 +- [`b048592`](https://github.com/npm/cli/commit/b048592a9583dca6f75a9c837edee57ab4e12ab0) [#7329](https://github.com/npm/cli/pull/7329) `ini@4.1.2`
46 +- [`c54a84a`](https://github.com/npm/cli/commit/c54a84ab5fdd7513913518734c0ece5f3d3e39c9) [#7329](https://github.com/npm/cli/pull/7329) `glob@10.3.12`
47 +- [`6853531`](https://github.com/npm/cli/commit/6853531da30bc8fecb776c823144766915b5e421) [#7329](https://github.com/npm/cli/pull/7329) `cli-table3@0.6.4`
48 +- [`c9315cb`](https://github.com/npm/cli/commit/c9315cb240be02babbbd99585f7ef23679e1d963) [#7329](https://github.com/npm/cli/pull/7329) `binary-extensions@2.3.0`
49 +- [`5bb0031`](https://github.com/npm/cli/commit/5bb003147423a644969c04222e2ba1b6cf407e6f) [#7329](https://github.com/npm/cli/pull/7329) `@sigstore/tuf@2.3.2`
50 +- [`8cab136`](https://github.com/npm/cli/commit/8cab136f731c69be079be08d79e3514e01bbd563) [#7324](https://github.com/npm/cli/pull/7324) `agent-base@7.1.1` (@lukekarrys)
51 +- [workspace](https://github.com/npm/cli/releases/tag/arborist-v7.4.1): `@npmcli/arborist@7.4.1`
52 +- [workspace](https://github.com/npm/cli/releases/tag/config-v8.2.1): `@npmcli/config@8.2.1`
53 +- [workspace](https://github.com/npm/cli/releases/tag/libnpmaccess-v8.0.3): `libnpmaccess@8.0.3`
54 +- [workspace](https://github.com/npm/cli/releases/tag/libnpmdiff-v6.0.8): `libnpmdiff@6.0.8`
55 +- [workspace](https://github.com/npm/cli/releases/tag/libnpmexec-v7.0.9): `libnpmexec@7.0.9`
56 +- [workspace](https://github.com/npm/cli/releases/tag/libnpmfund-v5.0.6): `libnpmfund@5.0.6`
57 +- [workspace](https://github.com/npm/cli/releases/tag/libnpmhook-v10.0.2): `libnpmhook@10.0.2`
58 +- [workspace](https://github.com/npm/cli/releases/tag/libnpmorg-v6.0.3): `libnpmorg@6.0.3`
59 +- [workspace](https://github.com/npm/cli/releases/tag/libnpmpack-v6.0.8): `libnpmpack@6.0.8`
60 +- [workspace](https://github.com/npm/cli/releases/tag/libnpmpublish-v9.0.5): `libnpmpublish@9.0.5`
61 +- [workspace](https://github.com/npm/cli/releases/tag/libnpmsearch-v7.0.2): `libnpmsearch@7.0.2`
62 +- [workspace](https://github.com/npm/cli/releases/tag/libnpmteam-v6.0.2): `libnpmteam@6.0.2`
63 +
64 +### Chores
65 +
66 +- [`8cab136`](https://github.com/npm/cli/commit/8cab136f731c69be079be08d79e3514e01bbd563) [#7324](https://github.com/npm/cli/pull/7324) add smoke-test for large prod installs (@lukekarrys)
67 +- [`0dab381`](https://github.com/npm/cli/commit/0dab3810e6b84e1b4afcc2a315c878fffccb328b) [#7258](https://github.com/npm/cli/pull/7258) `jsdom@24.0.0` (#7258) (@wraithgar)
68 +- [`af3c48e`](https://github.com/npm/cli/commit/af3c48e074d03caebaa8ed24d39405329f545497) [#7262](https://github.com/npm/cli/pull/7262) test refactor (#7262) (@wraithgar)
69 +
70 ## [10.5.0](https://github.com/npm/cli/compare/v10.4.0...v10.5.0) (2024-02-28)
71
72 ### Features
content/nav.yml
+1 -1
@@ -1324,7 +1324,7 @@
1324 - title: Changelog
1325 url: /cli/v9/using-npm/changelog
1326 description: Changelog notes for each version
1327 - - title: Version 10.5.0
1327 + - title: Version 10.5.1
1328 shortName: v10
1329 url: /cli/v10
1330 default: true