CLI documentation update from CI

CI User committed Apr 5, 2022 at 02:43 UTC fca31e6b7aa22a601dd0be483265ee6d9afc6053
25 files changed +59 -35
cli/v8
+1 -1
@@ -1 +1 @@
1 -Subproject commit 79827ec7e7303db34894b9b6114696c5fedb8894
1 +Subproject commit f37f7d23f6e9e33cbd6600670020b9c2f4754b05
content/cli/v8/commands/npm-audit.md
+2
@@ -404,6 +404,8 @@ When false, specifying individual workspaces via the `workspace` config, or
404 all workspaces via the `workspaces` flag, will cause npm to operate only on
405 the specified workspaces, and not on the root project.
406
407 +This value is not exported to the environment for child processes.
408 +
409 <!-- automatically generated, do not edit manually -->
410 <!-- see lib/utils/config/definitions.js -->
411
content/cli/v8/commands/npm-dedupe.md
+5 -21
@@ -90,11 +90,9 @@ result in new modules being installed.
90
91 Using `npm find-dupes` will run the command in `--dry-run` mode.
92
93 -Note that by default `npm dedupe` will not update the semver values of direct
94 -dependencies in your project `package.json`, if you want to also update
95 -values in `package.json` you can run: `npm dedupe --save` (or add the
96 -`save=true` option to a [configuration file](/cli/v8/configuring-npm/npmrc)
97 -to make that the default behavior).
93 +Note: `npm dedupe` will never update the semver values of direct
94 +dependencies in your project `package.json`, if you want to update
95 +values in `package.json` you can run: `npm update --save` instead.
96
97 ### Configuration
98
@@ -168,22 +166,6 @@ This configuration does not affect `npm ci`.
166 <!-- automatically generated, do not edit manually -->
167 <!-- see lib/utils/config/definitions.js -->
168
171 -#### `save`
172 -
173 -* Default: `true` unless when using `npm update` or `npm dedupe` where it
174 - defaults to `false`
175 -* Type: Boolean
176 -
177 -Save installed packages to a `package.json` file as dependencies.
178 -
179 -When used with the `npm rm` command, removes the dependency from
180 -`package.json`.
181 -
182 -Will also prevent writing to `package-lock.json` if set to `false`.
183 -
184 -<!-- automatically generated, do not edit manually -->
185 -<!-- see lib/utils/config/definitions.js -->
186 -
169 #### `omit`
170
171 * Default: 'dev' if the `NODE_ENV` environment variable is set to
@@ -333,6 +315,8 @@ When false, specifying individual workspaces via the `workspace` config, or
315 all workspaces via the `workspaces` flag, will cause npm to operate only on
316 the specified workspaces, and not on the root project.
317
318 +This value is not exported to the environment for child processes.
319 +
320 <!-- automatically generated, do not edit manually -->
321 <!-- see lib/utils/config/definitions.js -->
322
content/cli/v8/commands/npm-diff.md
+2
@@ -345,6 +345,8 @@ When false, specifying individual workspaces via the `workspace` config, or
345 all workspaces via the `workspaces` flag, will cause npm to operate only on
346 the specified workspaces, and not on the root project.
347
348 +This value is not exported to the environment for child processes.
349 +
350 <!-- automatically generated, do not edit manually -->
351 <!-- see lib/utils/config/definitions.js -->
352
content/cli/v8/commands/npm-dist-tag.md
+2
@@ -169,6 +169,8 @@ When false, specifying individual workspaces via the `workspace` config, or
169 all workspaces via the `workspaces` flag, will cause npm to operate only on
170 the specified workspaces, and not on the root project.
171
172 +This value is not exported to the environment for child processes.
173 +
174 <!-- automatically generated, do not edit manually -->
175 <!-- see lib/utils/config/definitions.js -->
176
content/cli/v8/commands/npm-docs.md
+2
@@ -126,6 +126,8 @@ When false, specifying individual workspaces via the `workspace` config, or
126 all workspaces via the `workspaces` flag, will cause npm to operate only on
127 the specified workspaces, and not on the root project.
128
129 +This value is not exported to the environment for child processes.
130 +
131 <!-- automatically generated, do not edit manually -->
132 <!-- see lib/utils/config/definitions.js -->
133
content/cli/v8/commands/npm-exec.md
+2
@@ -215,6 +215,8 @@ When false, specifying individual workspaces via the `workspace` config, or
215 all workspaces via the `workspaces` flag, will cause npm to operate only on
216 the specified workspaces, and not on the root project.
217
218 +This value is not exported to the environment for child processes.
219 +
220 <!-- automatically generated, do not edit manually -->
221 <!-- see lib/utils/config/definitions.js -->
222
content/cli/v8/commands/npm-find-dupes.md
+2
@@ -239,6 +239,8 @@ When false, specifying individual workspaces via the `workspace` config, or
239 all workspaces via the `workspaces` flag, will cause npm to operate only on
240 the specified workspaces, and not on the root project.
241
242 +This value is not exported to the environment for child processes.
243 +
244 <!-- automatically generated, do not edit manually -->
245 <!-- see lib/utils/config/definitions.js -->
246
content/cli/v8/commands/npm-init.md
+2
@@ -274,6 +274,8 @@ When false, specifying individual workspaces via the `workspace` config, or
274 all workspaces via the `workspaces` flag, will cause npm to operate only on
275 the specified workspaces, and not on the root project.
276
277 +This value is not exported to the environment for child processes.
278 +
279 <!-- automatically generated, do not edit manually -->
280 <!-- see lib/utils/config/definitions.js -->
281
content/cli/v8/commands/npm-install-test.md
+3 -2
@@ -52,8 +52,7 @@ takes exactly the same arguments as `npm install`.
52 <!-- see lib/utils/config/definitions.js -->
53 #### `save`
54
55 -* Default: `true` unless when using `npm update` or `npm dedupe` where it
56 - defaults to `false`
55 +* Default: `true` unless when using `npm update` where it defaults to `false`
56 * Type: Boolean
57
58 Save installed packages to a `package.json` file as dependencies.
@@ -325,6 +324,8 @@ When false, specifying individual workspaces via the `workspace` config, or
324 all workspaces via the `workspaces` flag, will cause npm to operate only on
325 the specified workspaces, and not on the root project.
326
327 +This value is not exported to the environment for child processes.
328 +
329 <!-- automatically generated, do not edit manually -->
330 <!-- see lib/utils/config/definitions.js -->
331
content/cli/v8/commands/npm-install.md
+3 -2
@@ -443,8 +443,7 @@ These are some of the most common options related to installation.
443 <!-- see lib/utils/config/definitions.js -->
444 #### `save`
445
446 -* Default: `true` unless when using `npm update` or `npm dedupe` where it
447 - defaults to `false`
446 +* Default: `true` unless when using `npm update` where it defaults to `false`
447 * Type: Boolean
448
449 Save installed packages to a `package.json` file as dependencies.
@@ -716,6 +715,8 @@ When false, specifying individual workspaces via the `workspace` config, or
715 all workspaces via the `workspaces` flag, will cause npm to operate only on
716 the specified workspaces, and not on the root project.
717
718 +This value is not exported to the environment for child processes.
719 +
720 <!-- automatically generated, do not edit manually -->
721 <!-- see lib/utils/config/definitions.js -->
722
content/cli/v8/commands/npm-link.md
+3 -2
@@ -135,8 +135,7 @@ workspace(s).
135 <!-- see lib/utils/config/definitions.js -->
136 #### `save`
137
138 -* Default: `true` unless when using `npm update` or `npm dedupe` where it
139 - defaults to `false`
138 +* Default: `true` unless when using `npm update` where it defaults to `false`
139 * Type: Boolean
140
141 Save installed packages to a `package.json` file as dependencies.
@@ -393,6 +392,8 @@ When false, specifying individual workspaces via the `workspace` config, or
392 all workspaces via the `workspaces` flag, will cause npm to operate only on
393 the specified workspaces, and not on the root project.
394
395 +This value is not exported to the environment for child processes.
396 +
397 <!-- automatically generated, do not edit manually -->
398 <!-- see lib/utils/config/definitions.js -->
399
content/cli/v8/commands/npm-ls.md
+2
@@ -290,6 +290,8 @@ When false, specifying individual workspaces via the `workspace` config, or
290 all workspaces via the `workspaces` flag, will cause npm to operate only on
291 the specified workspaces, and not on the root project.
292
293 +This value is not exported to the environment for child processes.
294 +
295 <!-- automatically generated, do not edit manually -->
296 <!-- see lib/utils/config/definitions.js -->
297
content/cli/v8/commands/npm-pack.md
+2
@@ -132,6 +132,8 @@ When false, specifying individual workspaces via the `workspace` config, or
132 all workspaces via the `workspaces` flag, will cause npm to operate only on
133 the specified workspaces, and not on the root project.
134
135 +This value is not exported to the environment for child processes.
136 +
137 <!-- automatically generated, do not edit manually -->
138 <!-- see lib/utils/config/definitions.js -->
139
content/cli/v8/commands/npm-prune.md
+2
@@ -196,6 +196,8 @@ When false, specifying individual workspaces via the `workspace` config, or
196 all workspaces via the `workspaces` flag, will cause npm to operate only on
197 the specified workspaces, and not on the root project.
198
199 +This value is not exported to the environment for child processes.
200 +
201 <!-- automatically generated, do not edit manually -->
202 <!-- see lib/utils/config/definitions.js -->
203
content/cli/v8/commands/npm-publish.md
+2
@@ -248,6 +248,8 @@ When false, specifying individual workspaces via the `workspace` config, or
248 all workspaces via the `workspaces` flag, will cause npm to operate only on
249 the specified workspaces, and not on the root project.
250
251 +This value is not exported to the environment for child processes.
252 +
253 <!-- automatically generated, do not edit manually -->
254 <!-- see lib/utils/config/definitions.js -->
255
content/cli/v8/commands/npm-rebuild.md
+2
@@ -167,6 +167,8 @@ When false, specifying individual workspaces via the `workspace` config, or
167 all workspaces via the `workspaces` flag, will cause npm to operate only on
168 the specified workspaces, and not on the root project.
169
170 +This value is not exported to the environment for child processes.
171 +
172 <!-- automatically generated, do not edit manually -->
173 <!-- see lib/utils/config/definitions.js -->
174
content/cli/v8/commands/npm-repo.md
+2
@@ -113,6 +113,8 @@ When false, specifying individual workspaces via the `workspace` config, or
113 all workspaces via the `workspaces` flag, will cause npm to operate only on
114 the specified workspaces, and not on the root project.
115
116 +This value is not exported to the environment for child processes.
117 +
118 <!-- automatically generated, do not edit manually -->
119 <!-- see lib/utils/config/definitions.js -->
120
content/cli/v8/commands/npm-run-script.md
+2
@@ -213,6 +213,8 @@ When false, specifying individual workspaces via the `workspace` config, or
213 all workspaces via the `workspaces` flag, will cause npm to operate only on
214 the specified workspaces, and not on the root project.
215
216 +This value is not exported to the environment for child processes.
217 +
218 <!-- automatically generated, do not edit manually -->
219 <!-- see lib/utils/config/definitions.js -->
220
content/cli/v8/commands/npm-set-script.md
+2
@@ -107,6 +107,8 @@ When false, specifying individual workspaces via the `workspace` config, or
107 all workspaces via the `workspaces` flag, will cause npm to operate only on
108 the specified workspaces, and not on the root project.
109
110 +This value is not exported to the environment for child processes.
111 +
112 <!-- automatically generated, do not edit manually -->
113 <!-- see lib/utils/config/definitions.js -->
114
content/cli/v8/commands/npm-uninstall.md
+4 -3
@@ -40,7 +40,7 @@ It also removes the package from the `dependencies`, `devDependencies`,
40 `optionalDependencies`, and `peerDependencies` objects in your
41 `package.json`.
42
43 -Futher, if you have an `npm-shrinkwrap.json` or `package-lock.json`, npm
43 +Further, if you have an `npm-shrinkwrap.json` or `package-lock.json`, npm
44 will update those files as well.
45
46 `--no-save` will tell npm not to remove the package from your
@@ -80,8 +80,7 @@ npm uninstall lodash --no-save
80 <!-- see lib/utils/config/definitions.js -->
81 #### `save`
82
83 -* Default: `true` unless when using `npm update` or `npm dedupe` where it
84 - defaults to `false`
83 +* Default: `true` unless when using `npm update` where it defaults to `false`
84 * Type: Boolean
85
86 Save installed packages to a `package.json` file as dependencies.
@@ -151,6 +150,8 @@ When false, specifying individual workspaces via the `workspace` config, or
150 all workspaces via the `workspaces` flag, will cause npm to operate only on
151 the specified workspaces, and not on the root project.
152
153 +This value is not exported to the environment for child processes.
154 +
155 <!-- automatically generated, do not edit manually -->
156 <!-- see lib/utils/config/definitions.js -->
157
content/cli/v8/commands/npm-update.md
+3 -2
@@ -181,8 +181,7 @@ be _downgraded_.
181 <!-- see lib/utils/config/definitions.js -->
182 #### `save`
183
184 -* Default: `true` unless when using `npm update` or `npm dedupe` where it
185 - defaults to `false`
184 +* Default: `true` unless when using `npm update` where it defaults to `false`
185 * Type: Boolean
186
187 Save installed packages to a `package.json` file as dependencies.
@@ -443,6 +442,8 @@ When false, specifying individual workspaces via the `workspace` config, or
442 all workspaces via the `workspaces` flag, will cause npm to operate only on
443 the specified workspaces, and not on the root project.
444
445 +This value is not exported to the environment for child processes.
446 +
447 <!-- automatically generated, do not edit manually -->
448 <!-- see lib/utils/config/definitions.js -->
449
content/cli/v8/commands/npm-version.md
+2
@@ -176,6 +176,8 @@ When false, specifying individual workspaces via the `workspace` config, or
176 all workspaces via the `workspaces` flag, will cause npm to operate only on
177 the specified workspaces, and not on the root project.
178
179 +This value is not exported to the environment for child processes.
180 +
181 <!-- automatically generated, do not edit manually -->
182 <!-- see lib/utils/config/definitions.js -->
183
content/cli/v8/commands/npm-view.md
+2
@@ -190,6 +190,8 @@ When false, specifying individual workspaces via the `workspace` config, or
190 all workspaces via the `workspaces` flag, will cause npm to operate only on
191 the specified workspaces, and not on the root project.
192
193 +This value is not exported to the environment for child processes.
194 +
195 <!-- automatically generated, do not edit manually -->
196 <!-- see lib/utils/config/definitions.js -->
197
content/cli/v8/using-npm/config.md
+3 -2
@@ -827,6 +827,8 @@ When false, specifying individual workspaces via the `workspace` config, or
827 all workspaces via the `workspaces` flag, will cause npm to operate only on
828 the specified workspaces, and not on the root project.
829
830 +This value is not exported to the environment for child processes.
831 +
832 <!-- automatically generated, do not edit manually -->
833 <!-- see lib/utils/config/definitions.js -->
834
@@ -1351,8 +1353,7 @@ The base URL of the npm registry.
1353
1354 #### `save`
1355
1354 -* Default: `true` unless when using `npm update` or `npm dedupe` where it
1355 - defaults to `false`
1356 +* Default: `true` unless when using `npm update` where it defaults to `false`
1357 * Type: Boolean
1358
1359 Save installed packages to a `package.json` file as dependencies.