@cryptotaxi247 / documentation-1 / commits / 8c9313d

CLI documentation update from CI

npm CLI robot committed Oct 3, 2023 at 16:00 UTC 8c9313d9161a0db06466681163d2fa6a3bf49858
19 files changed +664 -4
content/cli/v10/commands/npm-audit.md
+31
@@ -63,6 +63,13 @@ vulnerability is found. It may be useful in CI environments to include the
63 will cause the command to fail. This option does not filter the report
64 output, it simply changes the command's failure threshold.
65
66 +### Package lock
67 +
68 +By default npm requires a package-lock or shrinkwrap in order to run the
69 +audit. You can bypass the package lock with `--no-package-lock` but be
70 +aware the results may be different with every run, since npm will
71 +re-build the dependency tree each time.
72 +
73 ### Audit Signatures
74
75 To ensure the integrity of packages you download from the public npm registry, or any registry that supports signatures, you can verify the registry signatures of downloaded packages using the npm CLI.
@@ -352,6 +359,16 @@ For `list` this means the output will be based on the tree described by the
359
360
361
362 +#### `package-lock`
363 +
364 +* Default: true
365 +* Type: Boolean
366 +
367 +If set to false, then ignore `package-lock.json` files when installing. This
368 +will also prevent _writing_ `package-lock.json` if `save` is true.
369 +
370 +
371 +
372 #### `omit`
373
374 * Default: 'dev' if the `NODE_ENV` environment variable is set to
@@ -372,6 +389,20 @@ variable will be set to `'production'` for all lifecycle scripts.
389
390
391
392 +#### `include`
393 +
394 +* Default:
395 +* Type: "prod", "dev", "optional", or "peer" (can be set multiple times)
396 +
397 +Option that allows for defining which types of dependencies to install.
398 +
399 +This is the inverse of `--omit=<type>`.
400 +
401 +Dependency types specified in `--include` will not be omitted, regardless of
402 +the order in which omit/include are specified on the command-line.
403 +
404 +
405 +
406 #### `foreground-scripts`
407
408 * Default: false
content/cli/v10/commands/npm-ci.md
+14
@@ -163,6 +163,20 @@ variable will be set to `'production'` for all lifecycle scripts.
163
164
165
166 +#### `include`
167 +
168 +* Default:
169 +* Type: "prod", "dev", "optional", or "peer" (can be set multiple times)
170 +
171 +Option that allows for defining which types of dependencies to install.
172 +
173 +This is the inverse of `--omit=<type>`.
174 +
175 +Dependency types specified in `--include` will not be omitted, regardless of
176 +the order in which omit/include are specified on the command-line.
177 +
178 +
179 +
180 #### `strict-peer-deps`
181
182 * Default: false
content/cli/v10/commands/npm-dedupe.md
+14
@@ -199,6 +199,20 @@ variable will be set to `'production'` for all lifecycle scripts.
199
200
201
202 +#### `include`
203 +
204 +* Default:
205 +* Type: "prod", "dev", "optional", or "peer" (can be set multiple times)
206 +
207 +Option that allows for defining which types of dependencies to install.
208 +
209 +This is the inverse of `--omit=<type>`.
210 +
211 +Dependency types specified in `--include` will not be omitted, regardless of
212 +the order in which omit/include are specified on the command-line.
213 +
214 +
215 +
216 #### `ignore-scripts`
217
218 * Default: false
content/cli/v10/commands/npm-doctor.md
+1 -1
@@ -1,7 +1,7 @@
1 ---
2 title: npm-doctor
3 section: 1
4 -description: Check your npm environment
4 +description: Check the health of your npm environment
5 github_repo: npm/cli
6 github_branch: latest
7 github_path: docs/lib/content/commands/npm-doctor.md
content/cli/v10/commands/npm-find-dupes.md
+14
@@ -139,6 +139,20 @@ variable will be set to `'production'` for all lifecycle scripts.
139
140
141
142 +#### `include`
143 +
144 +* Default:
145 +* Type: "prod", "dev", "optional", or "peer" (can be set multiple times)
146 +
147 +Option that allows for defining which types of dependencies to install.
148 +
149 +This is the inverse of `--omit=<type>`.
150 +
151 +Dependency types specified in `--include` will not be omitted, regardless of
152 +the order in which omit/include are specified on the command-line.
153 +
154 +
155 +
156 #### `ignore-scripts`
157
158 * Default: false
content/cli/v10/commands/npm-init.md
+50
@@ -187,6 +187,56 @@ dot to represent the current directory in that context, e.g: `react-app .`:
187
188 ### Configuration
189
190 +#### `init-author-name`
191 +
192 +* Default: ""
193 +* Type: String
194 +
195 +The value `npm init` should use by default for the package author's name.
196 +
197 +
198 +
199 +#### `init-author-url`
200 +
201 +* Default: ""
202 +* Type: "" or URL
203 +
204 +The value `npm init` should use by default for the package author's
205 +homepage.
206 +
207 +
208 +
209 +#### `init-license`
210 +
211 +* Default: "ISC"
212 +* Type: String
213 +
214 +The value `npm init` should use by default for the package license.
215 +
216 +
217 +
218 +#### `init-module`
219 +
220 +* Default: "~/.npm-init.js"
221 +* Type: Path
222 +
223 +A module that will be loaded by the `npm init` command. See the
224 +documentation for the
225 +[init-package-json](https://github.com/npm/init-package-json) module for
226 +more information, or [npm init](/cli/v10/commands/npm-init).
227 +
228 +
229 +
230 +#### `init-version`
231 +
232 +* Default: "1.0.0"
233 +* Type: SemVer string
234 +
235 +The value that `npm init` should use by default for the package version
236 +number, if not already set in package.json.
237 +
238 +
239 +
240 #### `yes`
241
242 * Default: null
content/cli/v10/commands/npm-install-ci-test.md
+14
@@ -109,6 +109,20 @@ variable will be set to `'production'` for all lifecycle scripts.
109
110
111
112 +#### `include`
113 +
114 +* Default:
115 +* Type: "prod", "dev", "optional", or "peer" (can be set multiple times)
116 +
117 +Option that allows for defining which types of dependencies to install.
118 +
119 +This is the inverse of `--omit=<type>`.
120 +
121 +Dependency types specified in `--include` will not be omitted, regardless of
122 +the order in which omit/include are specified on the command-line.
123 +
124 +
125 +
126 #### `strict-peer-deps`
127
128 * Default: false
content/cli/v10/commands/npm-install-test.md
+14
@@ -150,6 +150,20 @@ variable will be set to `'production'` for all lifecycle scripts.
150
151
152
153 +#### `include`
154 +
155 +* Default:
156 +* Type: "prod", "dev", "optional", or "peer" (can be set multiple times)
157 +
158 +Option that allows for defining which types of dependencies to install.
159 +
160 +This is the inverse of `--omit=<type>`.
161 +
162 +Dependency types specified in `--include` will not be omitted, regardless of
163 +the order in which omit/include are specified on the command-line.
164 +
165 +
166 +
167 #### `strict-peer-deps`
168
169 * Default: false
content/cli/v10/commands/npm-install.md
+14
@@ -540,6 +540,20 @@ variable will be set to `'production'` for all lifecycle scripts.
540
541
542
543 +#### `include`
544 +
545 +* Default:
546 +* Type: "prod", "dev", "optional", or "peer" (can be set multiple times)
547 +
548 +Option that allows for defining which types of dependencies to install.
549 +
550 +This is the inverse of `--omit=<type>`.
551 +
552 +Dependency types specified in `--include` will not be omitted, regardless of
553 +the order in which omit/include are specified on the command-line.
554 +
555 +
556 +
557 #### `strict-peer-deps`
558
559 * Default: false
content/cli/v10/commands/npm-link.md
+14
@@ -272,6 +272,20 @@ variable will be set to `'production'` for all lifecycle scripts.
272
273
274
275 +#### `include`
276 +
277 +* Default:
278 +* Type: "prod", "dev", "optional", or "peer" (can be set multiple times)
279 +
280 +Option that allows for defining which types of dependencies to install.
281 +
282 +This is the inverse of `--omit=<type>`.
283 +
284 +Dependency types specified in `--include` will not be omitted, regardless of
285 +the order in which omit/include are specified on the command-line.
286 +
287 +
288 +
289 #### `ignore-scripts`
290
291 * Default: false
content/cli/v10/commands/npm-ls.md
+15 -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.1.0 /path/to/npm
61 +npm@10.2.0 /path/to/npm
62 └─┬ init-package-json@0.0.4
63 └── promzard@0.1.5
64 ```
@@ -196,6 +196,20 @@ variable will be set to `'production'` for all lifecycle scripts.
196
197
198
199 +#### `include`
200 +
201 +* Default:
202 +* Type: "prod", "dev", "optional", or "peer" (can be set multiple times)
203 +
204 +Option that allows for defining which types of dependencies to install.
205 +
206 +This is the inverse of `--omit=<type>`.
207 +
208 +Dependency types specified in `--include` will not be omitted, regardless of
209 +the order in which omit/include are specified on the command-line.
210 +
211 +
212 +
213 #### `link`
214
215 * Default: false
content/cli/v10/commands/npm-prune.md
+14
@@ -86,6 +86,20 @@ variable will be set to `'production'` for all lifecycle scripts.
86
87
88
89 +#### `include`
90 +
91 +* Default:
92 +* Type: "prod", "dev", "optional", or "peer" (can be set multiple times)
93 +
94 +Option that allows for defining which types of dependencies to install.
95 +
96 +This is the inverse of `--omit=<type>`.
97 +
98 +Dependency types specified in `--include` will not be omitted, regardless of
99 +the order in which omit/include are specified on the command-line.
100 +
101 +
102 +
103 #### `dry-run`
104
105 * Default: false
content/cli/v10/commands/npm-query.md
+29
@@ -166,6 +166,19 @@ npm query ":type(git)" | jq 'map(.name)' | xargs -I {} npm why {}
166 },
167 ...
168 ```
169 +### Package lock only mode
170 +
171 +If package-lock-only is enabled, only the information in the package
172 +lock (or shrinkwrap) is loaded. This means that information from the
173 +package.json files of your dependencies will not be included in the
174 +result set (e.g. description, homepage, engines).
175 +
176 +### Package lock only mode
177 +
178 +If package-lock-only is enabled, only the information in the package
179 +lock (or shrinkwrap) is loaded. This means that information from the
180 +package.json files of your dependencies will not be included in the
181 +result set (e.g. description, homepage, engines).
182
183 ### Configuration
184
@@ -237,6 +250,22 @@ all workspaces via the `workspaces` flag, will cause npm to operate only on
250 the specified workspaces, and not on the root project.
251
252 This value is not exported to the environment for child processes.
253 +
254 +#### `package-lock-only`
255 +
256 +* Default: false
257 +* Type: Boolean
258 +
259 +If set to true, the current operation will only use the `package-lock.json`,
260 +ignoring `node_modules`.
261 +
262 +For `update` this means only the `package-lock.json` will be updated,
263 +instead of checking `node_modules` and downloading dependencies.
264 +
265 +For `list` this means the output will be based on the tree described by the
266 +`package-lock.json`, rather than the contents of `node_modules`.
267 +
268 +
269 ## See Also
270
271 * [dependency selectors](/cli/v10/using-npm/dependency-selectors)
content/cli/v10/commands/npm-sbom.md new
+350
@@ -0,0 +1,350 @@
1 +---
2 +title: npm-sbom
3 +section: 1
4 +description: Generate a Software Bill of Materials (SBOM)
5 +github_repo: npm/cli
6 +github_branch: latest
7 +github_path: docs/lib/content/commands/npm-sbom.md
8 +redirect_from:
9 + - /cli-commands/npm-sbom
10 + - /cli-commands/sbom
11 + - /cli-documentation/cli-commands/npm-sbom
12 + - /cli-documentation/cli-commands/sbom
13 + - /cli-documentation/commands/npm-sbom
14 + - /cli-documentation/commands/sbom
15 + - /cli-documentation/npm-sbom
16 + - /cli-documentation/sbom
17 + - /cli-documentation/v10/cli-commands/npm-sbom
18 + - /cli-documentation/v10/cli-commands/sbom
19 + - /cli-documentation/v10/commands/npm-sbom
20 + - /cli-documentation/v10/commands/sbom
21 + - /cli-documentation/v10/npm-sbom
22 + - /cli-documentation/v10/sbom
23 + - /cli/cli-commands/npm-sbom
24 + - /cli/cli-commands/sbom
25 + - /cli/commands/npm-sbom
26 + - /cli/commands/sbom
27 + - /cli/npm-sbom
28 + - /cli/sbom
29 + - /cli/v10/cli-commands/npm-sbom
30 + - /cli/v10/cli-commands/sbom
31 + - /cli/v10/commands/sbom
32 + - /cli/v10/npm-sbom
33 + - /cli/v10/sbom
34 + - /commands/npm-sbom
35 + - /commands/sbom
36 +---
37 +
38 +### Synopsis
39 +
40 +```bash
41 +npm sbom
42 +```
43 +
44 +### Description
45 +
46 +The `npm sbom` command generates a Software Bill of Materials (SBOM) listing the
47 +dependencies for the current project. SBOMs can be generated in either
48 +[SPDX](https://spdx.dev/) or [CycloneDX](https://cyclonedx.org/) format.
49 +
50 +### Example CycloneDX SBOM
51 +
52 +```json
53 +{
54 + "$schema": "http://cyclonedx.org/schema/bom-1.5.schema.json",
55 + "bomFormat": "CycloneDX",
56 + "specVersion": "1.5",
57 + "serialNumber": "urn:uuid:09f55116-97e1-49cf-b3b8-44d0207e7730",
58 + "version": 1,
59 + "metadata": {
60 + "timestamp": "2023-09-01T00:00:00.001Z",
61 + "lifecycles": [
62 + {
63 + "phase": "build"
64 + }
65 + ],
66 + "tools": [
67 + {
68 + "vendor": "npm",
69 + "name": "cli",
70 + "version": "10.1.0"
71 + }
72 + ],
73 + "component": {
74 + "bom-ref": "simple@1.0.0",
75 + "type": "library",
76 + "name": "simple",
77 + "version": "1.0.0",
78 + "scope": "required",
79 + "author": "John Doe",
80 + "description": "simple react app",
81 + "purl": "pkg:npm/simple@1.0.0",
82 + "properties": [
83 + {
84 + "name": "cdx:npm:package:path",
85 + "value": ""
86 + }
87 + ],
88 + "externalReferences": [],
89 + "licenses": [
90 + {
91 + "license": {
92 + "id": "MIT"
93 + }
94 + }
95 + ]
96 + }
97 + },
98 + "components": [
99 + {
100 + "bom-ref": "lodash@4.17.21",
101 + "type": "library",
102 + "name": "lodash",
103 + "version": "4.17.21",
104 + "scope": "required",
105 + "author": "John-David Dalton",
106 + "description": "Lodash modular utilities.",
107 + "purl": "pkg:npm/lodash@4.17.21",
108 + "properties": [
109 + {
110 + "name": "cdx:npm:package:path",
111 + "value": "node_modules/lodash"
112 + }
113 + ],
114 + "externalReferences": [
115 + {
116 + "type": "distribution",
117 + "url": "https://registry.npmjs.org/lodash/-/lodash-4.17.21.tgz"
118 + },
119 + {
120 + "type": "vcs",
121 + "url": "git+https://github.com/lodash/lodash.git"
122 + },
123 + {
124 + "type": "website",
125 + "url": "https://lodash.com/"
126 + },
127 + {
128 + "type": "issue-tracker",
129 + "url": "https://github.com/lodash/lodash/issues"
130 + }
131 + ],
132 + "hashes": [
133 + {
134 + "alg": "SHA-512",
135 + "content": "bf690311ee7b95e713ba568322e3533f2dd1cb880b189e99d4edef13592b81764daec43e2c54c61d5c558dc5cfb35ecb85b65519e74026ff17675b6f8f916f4a"
136 + }
137 + ],
138 + "licenses": [
139 + {
140 + "license": {
141 + "id": "MIT"
142 + }
143 + }
144 + ]
145 + }
146 + ],
147 + "dependencies": [
148 + {
149 + "ref": "simple@1.0.0",
150 + "dependsOn": [
151 + "lodash@4.17.21"
152 + ]
153 + },
154 + {
155 + "ref": "lodash@4.17.21",
156 + "dependsOn": []
157 + }
158 + ]
159 +}
160 +```
161 +
162 +### Example SPDX SBOM
163 +
164 +```json
165 +{
166 + "spdxVersion": "SPDX-2.3",
167 + "dataLicense": "CC0-1.0",
168 + "SPDXID": "SPDXRef-DOCUMENT",
169 + "name": "simple@1.0.0",
170 + "documentNamespace": "http://spdx.org/spdxdocs/simple-1.0.0-bf81090e-8bbc-459d-bec9-abeb794e096a",
171 + "creationInfo": {
172 + "created": "2023-09-01T00:00:00.001Z",
173 + "creators": [
174 + "Tool: npm/cli-10.1.0"
175 + ]
176 + },
177 + "documentDescribes": [
178 + "SPDXRef-Package-simple-1.0.0"
179 + ],
180 + "packages": [
181 + {
182 + "name": "simple",
183 + "SPDXID": "SPDXRef-Package-simple-1.0.0",
184 + "versionInfo": "1.0.0",
185 + "packageFileName": "",
186 + "description": "simple react app",
187 + "primaryPackagePurpose": "LIBRARY",
188 + "downloadLocation": "NOASSERTION",
189 + "filesAnalyzed": false,
190 + "homepage": "NOASSERTION",
191 + "licenseDeclared": "MIT",
192 + "externalRefs": [
193 + {
194 + "referenceCategory": "PACKAGE-MANAGER",
195 + "referenceType": "purl",
196 + "referenceLocator": "pkg:npm/simple@1.0.0"
197 + }
198 + ]
199 + },
200 + {
201 + "name": "lodash",
202 + "SPDXID": "SPDXRef-Package-lodash-4.17.21",
203 + "versionInfo": "4.17.21",
204 + "packageFileName": "node_modules/lodash",
205 + "description": "Lodash modular utilities.",
206 + "downloadLocation": "https://registry.npmjs.org/lodash/-/lodash-4.17.21.tgz",
207 + "filesAnalyzed": false,
208 + "homepage": "https://lodash.com/",
209 + "licenseDeclared": "MIT",
210 + "externalRefs": [
211 + {
212 + "referenceCategory": "PACKAGE-MANAGER",
213 + "referenceType": "purl",
214 + "referenceLocator": "pkg:npm/lodash@4.17.21"
215 + }
216 + ],
217 + "checksums": [
218 + {
219 + "algorithm": "SHA512",
220 + "checksumValue": "bf690311ee7b95e713ba568322e3533f2dd1cb880b189e99d4edef13592b81764daec43e2c54c61d5c558dc5cfb35ecb85b65519e74026ff17675b6f8f916f4a"
221 + }
222 + ]
223 + }
224 + ],
225 + "relationships": [
226 + {
227 + "spdxElementId": "SPDXRef-DOCUMENT",
228 + "relatedSpdxElement": "SPDXRef-Package-simple-1.0.0",
229 + "relationshipType": "DESCRIBES"
230 + },
231 + {
232 + "spdxElementId": "SPDXRef-Package-simple-1.0.0",
233 + "relatedSpdxElement": "SPDXRef-Package-lodash-4.17.21",
234 + "relationshipType": "DEPENDS_ON"
235 + }
236 + ]
237 +}
238 +```
239 +
240 +### Package lock only mode
241 +
242 +If package-lock-only is enabled, only the information in the package
243 +lock (or shrinkwrap) is loaded. This means that information from the
244 +package.json files of your dependencies will not be included in the
245 +result set (e.g. description, homepage, engines).
246 +
247 +### Configuration
248 +
249 +#### `omit`
250 +
251 +* Default: 'dev' if the `NODE_ENV` environment variable is set to
252 + 'production', otherwise empty.
253 +* Type: "dev", "optional", or "peer" (can be set multiple times)
254 +
255 +Dependency types to omit from the installation tree on disk.
256 +
257 +Note that these dependencies _are_ still resolved and added to the
258 +`package-lock.json` or `npm-shrinkwrap.json` file. They are just not
259 +physically installed on disk.
260 +
261 +If a package type appears in both the `--include` and `--omit` lists, then
262 +it will be included.
263 +
264 +If the resulting omit list includes `'dev'`, then the `NODE_ENV` environment
265 +variable will be set to `'production'` for all lifecycle scripts.
266 +
267 +
268 +
269 +#### `package-lock-only`
270 +
271 +* Default: false
272 +* Type: Boolean
273 +
274 +If set to true, the current operation will only use the `package-lock.json`,
275 +ignoring `node_modules`.
276 +
277 +For `update` this means only the `package-lock.json` will be updated,
278 +instead of checking `node_modules` and downloading dependencies.
279 +
280 +For `list` this means the output will be based on the tree described by the
281 +`package-lock.json`, rather than the contents of `node_modules`.
282 +
283 +
284 +
285 +#### `sbom-format`
286 +
287 +* Default: null
288 +* Type: "cyclonedx" or "spdx"
289 +
290 +SBOM format to use when generating SBOMs.
291 +
292 +
293 +
294 +#### `sbom-type`
295 +
296 +* Default: "library"
297 +* Type: "library", "application", or "framework"
298 +
299 +The type of package described by the generated SBOM. For SPDX, this is the
300 +value for the `primaryPackagePurpose` fieled. For CycloneDX, this is the
301 +value for the `type` field.
302 +
303 +
304 +
305 +#### `workspace`
306 +
307 +* Default:
308 +* Type: String (can be set multiple times)
309 +
310 +Enable running a command in the context of the configured workspaces of the
311 +current project while filtering by running only the workspaces defined by
312 +this configuration option.
313 +
314 +Valid values for the `workspace` config are either:
315 +
316 +* Workspace names
317 +* Path to a workspace directory
318 +* Path to a parent workspace directory (will result in selecting all
319 + workspaces within that folder)
320 +
321 +When set for the `npm init` command, this may be set to the folder of a
322 +workspace which does not yet exist, to create the folder and set it up as a
323 +brand new workspace within the project.
324 +
325 +This value is not exported to the environment for child processes.
326 +
327 +#### `workspaces`
328 +
329 +* Default: null
330 +* Type: null or Boolean
331 +
332 +Set to true to run the command in the context of **all** configured
333 +workspaces.
334 +
335 +Explicitly setting this to false will cause commands like `install` to
336 +ignore workspaces altogether. When not set explicitly:
337 +
338 +- Commands that operate on the `node_modules` tree (install, update, etc.)
339 +will link workspaces into the `node_modules` folder. - Commands that do
340 +other things (test, exec, publish, etc.) will operate on the root project,
341 +_unless_ one or more workspaces are specified in the `workspace` config.
342 +
343 +This value is not exported to the environment for child processes.
344 +## See Also
345 +
346 +* [package spec](/cli/v10/using-npm/package-spec)
347 +* [dependency selectors](/cli/v10/using-npm/dependency-selectors)
348 +* [package.json](/cli/v10/configuring-npm/package-json)
349 +* [workspaces](/cli/v10/using-npm/workspaces)
350 +
content/cli/v10/commands/npm-update.md
+14
@@ -278,6 +278,20 @@ variable will be set to `'production'` for all lifecycle scripts.
278
279
280
281 +#### `include`
282 +
283 +* Default:
284 +* Type: "prod", "dev", "optional", or "peer" (can be set multiple times)
285 +
286 +Option that allows for defining which types of dependencies to install.
287 +
288 +This is the inverse of `--omit=<type>`.
289 +
290 +Dependency types specified in `--include` will not be omitted, regardless of
291 +the order in which omit/include are specified on the command-line.
292 +
293 +
294 +
295 #### `strict-peer-deps`
296
297 * Default: false
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.1.0
34 +10.2.0
35
36 ### Description
37
content/cli/v10/using-npm/changelog.md
+40
@@ -17,6 +17,46 @@ redirect_from:
17
18 # Changelog
19
20 +## [10.2.0](https://github.com/npm/cli/compare/v10.1.0...v10.2.0) (2023-10-02)
21 +
22 +### Features
23 +
24 +* [`7c459d2`](https://github.com/npm/cli/commit/7c459d28ca987264028d4d2ca21b0825493c1537) [#6801](https://github.com/npm/cli/pull/6801) add npm sbom command (#6801) (@bdehamer)
25 +* [`81a460f`](https://github.com/npm/cli/commit/81a460f6e6317aca2288d16cda591aa6541540c6) [#6732](https://github.com/npm/cli/pull/6732) add package-lock-only mode to npm query (@wraithgar)
26 +* [`0d29855`](https://github.com/npm/cli/commit/0d2985535c9cc3dfc3e1f355580570c9cce37d61) [#6732](https://github.com/npm/cli/pull/6732) add no-package-lock mode to npm audit (@wraithgar)
27 +
28 +### Bug Fixes
29 +
30 +* [`2207628`](https://github.com/npm/cli/commit/22076286a46499e3d0b3f8564b7ba07008317be4) [#6823](https://github.com/npm/cli/pull/6823) use strip-ansi module instead of internal regex (#6823) (@wraithgar)
31 +* [`d46d052`](https://github.com/npm/cli/commit/d46d0526be12eae2cd458fd08dd5c0a0320cc8bd) [#6798](https://github.com/npm/cli/pull/6798) tolerate null bugs URLs (#6798) (@vladh)
32 +* [`fb1b674`](https://github.com/npm/cli/commit/fb1b6741bd52d865b8f8a93ad3fd6c8afa758b6a) [#6758](https://github.com/npm/cli/pull/6758) deprecate: ignore implicit workspace mode (#6758) (@wraithgar)
33 +
34 +### Documentation
35 +
36 +* [`68031f2`](https://github.com/npm/cli/commit/68031f2ae1cd5d49b0fb263da1a7eae62712ff97) [#6844](https://github.com/npm/cli/pull/6844) update `CONTRIBUTING.md` to prevent errors (#6844) (@darcyclarke)
37 +* [`3ac703c`](https://github.com/npm/cli/commit/3ac703c95e7bb851d0f6145f1d612749ed479fef) [#6831](https://github.com/npm/cli/pull/6831) add `include `param to commands that have `omit` param (#6831) (@siemhesda)
38 +* [`03912db`](https://github.com/npm/cli/commit/03912dbaeb92559270ab3f7df75b507b2f35a119) [#6819](https://github.com/npm/cli/pull/6819) add init-specific params to init docs/help (#6819) (@wraithgar)
39 +* [`8088325`](https://github.com/npm/cli/commit/8088325281bc976e8a8aea4d7527b54f4e25fb5f) [#6800](https://github.com/npm/cli/pull/6800) Update npm-doctor.md (#6800) (@siemhesda)
40 +
41 +### Dependencies
42 +
43 +* [`aa6728b`](https://github.com/npm/cli/commit/aa6728b1d003f0fc620b074ba0396a3e07f2db6a) [#6859](https://github.com/npm/cli/pull/6859) `tar@6.2.0`
44 +* [`ce9089f`](https://github.com/npm/cli/commit/ce9089f604a01297d3d2dd544283696a6297dce5) [#6859](https://github.com/npm/cli/pull/6859) `npm-package-arg@11.0.1`
45 +* [`39d7f04`](https://github.com/npm/cli/commit/39d7f046f1c39017b398cb242ad07e874484e86c) [#6859](https://github.com/npm/cli/pull/6859) `minipass@7.0.4`
46 +* [`0a47af5`](https://github.com/npm/cli/commit/0a47af509d66071908c7e0bf065dcf2f4c877669) [#6859](https://github.com/npm/cli/pull/6859) `hosted-git-info@7.0.1`
47 +* [`af93130`](https://github.com/npm/cli/commit/af93130fe949f07df23891286c634c77ecf38c53) [#6859](https://github.com/npm/cli/pull/6859) `glob@10.3.10`
48 +* [`3ebc474`](https://github.com/npm/cli/commit/3ebc4744433d906e5c491d183fc077ffe79958cf) [#6859](https://github.com/npm/cli/pull/6859) `@npmcli/query@3.0.1`
49 +* [`284cbfd`](https://github.com/npm/cli/commit/284cbfd168879b9277c9999e8a28dad8f72ecc02) [#6858](https://github.com/npm/cli/pull/6858) `@npmcli/agent@2.2.0`
50 +* [Workspace](https://github.com/npm/cli/releases/tag/arborist-v7.2.0): `@npmcli/arborist@7.2.0`
51 +* [Workspace](https://github.com/npm/cli/releases/tag/config-v8.0.0): `@npmcli/config@8.0.0`
52 +* [Workspace](https://github.com/npm/cli/releases/tag/libnpmaccess-v8.0.1): `libnpmaccess@8.0.1`
53 +* [Workspace](https://github.com/npm/cli/releases/tag/libnpmdiff-v6.0.2): `libnpmdiff@6.0.2`
54 +* [Workspace](https://github.com/npm/cli/releases/tag/libnpmexec-v7.0.2): `libnpmexec@7.0.2`
55 +* [Workspace](https://github.com/npm/cli/releases/tag/libnpmfund-v5.0.0): `libnpmfund@5.0.0`
56 +* [Workspace](https://github.com/npm/cli/releases/tag/libnpmorg-v6.0.1): `libnpmorg@6.0.1`
57 +* [Workspace](https://github.com/npm/cli/releases/tag/libnpmpack-v6.0.2): `libnpmpack@6.0.2`
58 +* [Workspace](https://github.com/npm/cli/releases/tag/libnpmpublish-v9.0.1): `libnpmpublish@9.0.1`
59 +
60 ## [10.1.0](https://github.com/npm/cli/compare/v10.0.0...v10.1.0) (2023-09-08)
61
62 ### Features
content/cli/v10/using-npm/config.md
+20
@@ -1371,6 +1371,26 @@ or `--save-optional` are true.
1371
1372
1373
1374 +#### `sbom-format`
1375 +
1376 +* Default: null
1377 +* Type: "cyclonedx" or "spdx"
1378 +
1379 +SBOM format to use when generating SBOMs.
1380 +
1381 +
1382 +
1383 +#### `sbom-type`
1384 +
1385 +* Default: "library"
1386 +* Type: "library", "application", or "framework"
1387 +
1388 +The type of package described by the generated SBOM. For SPDX, this is the
1389 +value for the `primaryPackagePurpose` fieled. For CycloneDX, this is the
1390 +value for the `type` field.
1391 +
1392 +
1393 +
1394 #### `scope`
1395
1396 * Default: the scope of the current project, if any, or ""
src/theme/nav.yml
+1 -1
@@ -1317,7 +1317,7 @@
1317 - title: Changelog
1318 url: /cli/v9/using-npm/changelog
1319 description: Changelog notes for each version
1320 - - title: Version 10.1.0 (Latest Release)
1320 + - title: Version 10.2.0 (Latest Release)
1321 shortName: v10
1322 url: /cli/v10
1323 default: true