@cryptotaxi247 / documentation / commits / 3e36997

CLI documentation update from CI

CI User committed Oct 15, 2021 at 02:27 UTC 3e3699750dd8fa967c85dead06d27dd16249ed5b
31 files changed +707 -138
cli/v7
+1 -1
@@ -1 +1 @@
1 -Subproject commit c3b2738de5ba34442f56d8fa4aad1e3063ae35a2
1 +Subproject commit 69bff9cc1108e7d131fe5873cff0fb0e9a71c52f
content/cli/v7/commands/npm-audit.md
+27 -5
@@ -323,8 +323,8 @@ Valid values for the `workspace` config are either:
323
324 * Workspace names
325 * Path to a workspace directory
326 -* Path to a parent workspace directory (will result to selecting all of the
327 - nested workspaces)
326 +* Path to a parent workspace directory (will result in selecting all
327 + workspaces within that folder)
328
329 When set for the `npm init` command, this may be set to the folder of a
330 workspace which does not yet exist, to create the folder and set it up as a
@@ -337,17 +337,39 @@ This value is not exported to the environment for child processes.
337
338 #### `workspaces`
339
340 -* Default: false
341 -* Type: Boolean
340 +* Default: null
341 +* Type: null or Boolean
342
343 -Enable running a command in the context of **all** the configured
343 +Set to true to run the command in the context of **all** configured
344 workspaces.
345
346 +Explicitly setting this to false will cause commands like `install` to
347 +ignore workspaces altogether. When not set explicitly:
348 +
349 +- Commands that operate on the `node_modules` tree (install, update, etc.)
350 +will link workspaces into the `node_modules` folder. - Commands that do
351 +other things (test, exec, publish, etc.) will operate on the root project,
352 +_unless_ one or more workspaces are specified in the `workspace` config.
353 +
354 This value is not exported to the environment for child processes.
355
356 <!-- automatically generated, do not edit manually -->
357 <!-- see lib/utils/config/definitions.js -->
358
359 +#### `include-workspace-root`
360 +
361 +* Default: false
362 +* Type: Boolean
363 +
364 +Include the workspace root when workspaces are enabled for a command.
365 +
366 +When false, specifying individual workspaces via the `workspace` config, or
367 +all workspaces via the `workspaces` flag, will cause npm to operate only on
368 +the specified workspaces, and not on the root project.
369 +
370 +<!-- automatically generated, do not edit manually -->
371 +<!-- see lib/utils/config/definitions.js -->
372 +
373 <!-- AUTOGENERATED CONFIG DESCRIPTIONS END -->
374
375 ### See Also
content/cli/v7/commands/npm-dedupe.md
+27 -5
@@ -257,8 +257,8 @@ Valid values for the `workspace` config are either:
257
258 * Workspace names
259 * Path to a workspace directory
260 -* Path to a parent workspace directory (will result to selecting all of the
261 - nested workspaces)
260 +* Path to a parent workspace directory (will result in selecting all
261 + workspaces within that folder)
262
263 When set for the `npm init` command, this may be set to the folder of a
264 workspace which does not yet exist, to create the folder and set it up as a
@@ -271,17 +271,39 @@ This value is not exported to the environment for child processes.
271
272 #### `workspaces`
273
274 -* Default: false
275 -* Type: Boolean
274 +* Default: null
275 +* Type: null or Boolean
276
277 -Enable running a command in the context of **all** the configured
277 +Set to true to run the command in the context of **all** configured
278 workspaces.
279
280 +Explicitly setting this to false will cause commands like `install` to
281 +ignore workspaces altogether. When not set explicitly:
282 +
283 +- Commands that operate on the `node_modules` tree (install, update, etc.)
284 +will link workspaces into the `node_modules` folder. - Commands that do
285 +other things (test, exec, publish, etc.) will operate on the root project,
286 +_unless_ one or more workspaces are specified in the `workspace` config.
287 +
288 This value is not exported to the environment for child processes.
289
290 <!-- automatically generated, do not edit manually -->
291 <!-- see lib/utils/config/definitions.js -->
292
293 +#### `include-workspace-root`
294 +
295 +* Default: false
296 +* Type: Boolean
297 +
298 +Include the workspace root when workspaces are enabled for a command.
299 +
300 +When false, specifying individual workspaces via the `workspace` config, or
301 +all workspaces via the `workspaces` flag, will cause npm to operate only on
302 +the specified workspaces, and not on the root project.
303 +
304 +<!-- automatically generated, do not edit manually -->
305 +<!-- see lib/utils/config/definitions.js -->
306 +
307 <!-- AUTOGENERATED CONFIG DESCRIPTIONS END -->
308
309 ### See Also
content/cli/v7/commands/npm-diff.md
+27 -5
@@ -296,8 +296,8 @@ Valid values for the `workspace` config are either:
296
297 * Workspace names
298 * Path to a workspace directory
299 -* Path to a parent workspace directory (will result to selecting all of the
300 - nested workspaces)
299 +* Path to a parent workspace directory (will result in selecting all
300 + workspaces within that folder)
301
302 When set for the `npm init` command, this may be set to the folder of a
303 workspace which does not yet exist, to create the folder and set it up as a
@@ -310,17 +310,39 @@ This value is not exported to the environment for child processes.
310
311 #### `workspaces`
312
313 -* Default: false
314 -* Type: Boolean
313 +* Default: null
314 +* Type: null or Boolean
315
316 -Enable running a command in the context of **all** the configured
316 +Set to true to run the command in the context of **all** configured
317 workspaces.
318
319 +Explicitly setting this to false will cause commands like `install` to
320 +ignore workspaces altogether. When not set explicitly:
321 +
322 +- Commands that operate on the `node_modules` tree (install, update, etc.)
323 +will link workspaces into the `node_modules` folder. - Commands that do
324 +other things (test, exec, publish, etc.) will operate on the root project,
325 +_unless_ one or more workspaces are specified in the `workspace` config.
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
332 +#### `include-workspace-root`
333 +
334 +* Default: false
335 +* Type: Boolean
336 +
337 +Include the workspace root when workspaces are enabled for a command.
338 +
339 +When false, specifying individual workspaces via the `workspace` config, or
340 +all workspaces via the `workspaces` flag, will cause npm to operate only on
341 +the specified workspaces, and not on the root project.
342 +
343 +<!-- automatically generated, do not edit manually -->
344 +<!-- see lib/utils/config/definitions.js -->
345 +
346 <!-- AUTOGENERATED CONFIG DESCRIPTIONS END -->
347 ## See Also
348
content/cli/v7/commands/npm-dist-tag.md
+27 -5
@@ -116,8 +116,8 @@ Valid values for the `workspace` config are either:
116
117 * Workspace names
118 * Path to a workspace directory
119 -* Path to a parent workspace directory (will result to selecting all of the
120 - nested workspaces)
119 +* Path to a parent workspace directory (will result in selecting all
120 + workspaces within that folder)
121
122 When set for the `npm init` command, this may be set to the folder of a
123 workspace which does not yet exist, to create the folder and set it up as a
@@ -130,17 +130,39 @@ This value is not exported to the environment for child processes.
130
131 #### `workspaces`
132
133 -* Default: false
134 -* Type: Boolean
133 +* Default: null
134 +* Type: null or Boolean
135
136 -Enable running a command in the context of **all** the configured
136 +Set to true to run the command in the context of **all** configured
137 workspaces.
138
139 +Explicitly setting this to false will cause commands like `install` to
140 +ignore workspaces altogether. When not set explicitly:
141 +
142 +- Commands that operate on the `node_modules` tree (install, update, etc.)
143 +will link workspaces into the `node_modules` folder. - Commands that do
144 +other things (test, exec, publish, etc.) will operate on the root project,
145 +_unless_ one or more workspaces are specified in the `workspace` config.
146 +
147 This value is not exported to the environment for child processes.
148
149 <!-- automatically generated, do not edit manually -->
150 <!-- see lib/utils/config/definitions.js -->
151
152 +#### `include-workspace-root`
153 +
154 +* Default: false
155 +* Type: Boolean
156 +
157 +Include the workspace root when workspaces are enabled for a command.
158 +
159 +When false, specifying individual workspaces via the `workspace` config, or
160 +all workspaces via the `workspaces` flag, will cause npm to operate only on
161 +the specified workspaces, and not on the root project.
162 +
163 +<!-- automatically generated, do not edit manually -->
164 +<!-- see lib/utils/config/definitions.js -->
165 +
166 <!-- AUTOGENERATED CONFIG DESCRIPTIONS END -->
167
168 ### See Also
content/cli/v7/commands/npm-docs.md
+27 -5
@@ -73,8 +73,8 @@ Valid values for the `workspace` config are either:
73
74 * Workspace names
75 * Path to a workspace directory
76 -* Path to a parent workspace directory (will result to selecting all of the
77 - nested workspaces)
76 +* Path to a parent workspace directory (will result in selecting all
77 + workspaces within that folder)
78
79 When set for the `npm init` command, this may be set to the folder of a
80 workspace which does not yet exist, to create the folder and set it up as a
@@ -87,17 +87,39 @@ This value is not exported to the environment for child processes.
87
88 #### `workspaces`
89
90 -* Default: false
91 -* Type: Boolean
90 +* Default: null
91 +* Type: null or Boolean
92
93 -Enable running a command in the context of **all** the configured
93 +Set to true to run the command in the context of **all** configured
94 workspaces.
95
96 +Explicitly setting this to false will cause commands like `install` to
97 +ignore workspaces altogether. When not set explicitly:
98 +
99 +- Commands that operate on the `node_modules` tree (install, update, etc.)
100 +will link workspaces into the `node_modules` folder. - Commands that do
101 +other things (test, exec, publish, etc.) will operate on the root project,
102 +_unless_ one or more workspaces are specified in the `workspace` config.
103 +
104 This value is not exported to the environment for child processes.
105
106 <!-- automatically generated, do not edit manually -->
107 <!-- see lib/utils/config/definitions.js -->
108
109 +#### `include-workspace-root`
110 +
111 +* Default: false
112 +* Type: Boolean
113 +
114 +Include the workspace root when workspaces are enabled for a command.
115 +
116 +When false, specifying individual workspaces via the `workspace` config, or
117 +all workspaces via the `workspaces` flag, will cause npm to operate only on
118 +the specified workspaces, and not on the root project.
119 +
120 +<!-- automatically generated, do not edit manually -->
121 +<!-- see lib/utils/config/definitions.js -->
122 +
123 <!-- AUTOGENERATED CONFIG DESCRIPTIONS END -->
124
125 ### See Also
content/cli/v7/commands/npm-exec.md
+27 -5
@@ -174,8 +174,8 @@ Valid values for the `workspace` config are either:
174
175 * Workspace names
176 * Path to a workspace directory
177 -* Path to a parent workspace directory (will result to selecting all of the
178 - nested workspaces)
177 +* Path to a parent workspace directory (will result in selecting all
178 + workspaces within that folder)
179
180 When set for the `npm init` command, this may be set to the folder of a
181 workspace which does not yet exist, to create the folder and set it up as a
@@ -188,17 +188,39 @@ This value is not exported to the environment for child processes.
188
189 #### `workspaces`
190
191 -* Default: false
192 -* Type: Boolean
191 +* Default: null
192 +* Type: null or Boolean
193
194 -Enable running a command in the context of **all** the configured
194 +Set to true to run the command in the context of **all** configured
195 workspaces.
196
197 +Explicitly setting this to false will cause commands like `install` to
198 +ignore workspaces altogether. When not set explicitly:
199 +
200 +- Commands that operate on the `node_modules` tree (install, update, etc.)
201 +will link workspaces into the `node_modules` folder. - Commands that do
202 +other things (test, exec, publish, etc.) will operate on the root project,
203 +_unless_ one or more workspaces are specified in the `workspace` config.
204 +
205 This value is not exported to the environment for child processes.
206
207 <!-- automatically generated, do not edit manually -->
208 <!-- see lib/utils/config/definitions.js -->
209
210 +#### `include-workspace-root`
211 +
212 +* Default: false
213 +* Type: Boolean
214 +
215 +Include the workspace root when workspaces are enabled for a command.
216 +
217 +When false, specifying individual workspaces via the `workspace` config, or
218 +all workspaces via the `workspaces` flag, will cause npm to operate only on
219 +the specified workspaces, and not on the root project.
220 +
221 +<!-- automatically generated, do not edit manually -->
222 +<!-- see lib/utils/config/definitions.js -->
223 +
224 <!-- AUTOGENERATED CONFIG DESCRIPTIONS END -->
225
226 ### Examples
content/cli/v7/commands/npm-explain.md
+2 -2
@@ -95,8 +95,8 @@ Valid values for the `workspace` config are either:
95
96 * Workspace names
97 * Path to a workspace directory
98 -* Path to a parent workspace directory (will result to selecting all of the
99 - nested workspaces)
98 +* Path to a parent workspace directory (will result in selecting all
99 + workspaces within that folder)
100
101 When set for the `npm init` command, this may be set to the folder of a
102 workspace which does not yet exist, to create the folder and set it up as a
content/cli/v7/commands/npm-find-dupes.md
+27 -5
@@ -184,8 +184,8 @@ Valid values for the `workspace` config are either:
184
185 * Workspace names
186 * Path to a workspace directory
187 -* Path to a parent workspace directory (will result to selecting all of the
188 - nested workspaces)
187 +* Path to a parent workspace directory (will result in selecting all
188 + workspaces within that folder)
189
190 When set for the `npm init` command, this may be set to the folder of a
191 workspace which does not yet exist, to create the folder and set it up as a
@@ -198,17 +198,39 @@ This value is not exported to the environment for child processes.
198
199 #### `workspaces`
200
201 -* Default: false
202 -* Type: Boolean
201 +* Default: null
202 +* Type: null or Boolean
203
204 -Enable running a command in the context of **all** the configured
204 +Set to true to run the command in the context of **all** configured
205 workspaces.
206
207 +Explicitly setting this to false will cause commands like `install` to
208 +ignore workspaces altogether. When not set explicitly:
209 +
210 +- Commands that operate on the `node_modules` tree (install, update, etc.)
211 +will link workspaces into the `node_modules` folder. - Commands that do
212 +other things (test, exec, publish, etc.) will operate on the root project,
213 +_unless_ one or more workspaces are specified in the `workspace` config.
214 +
215 This value is not exported to the environment for child processes.
216
217 <!-- automatically generated, do not edit manually -->
218 <!-- see lib/utils/config/definitions.js -->
219
220 +#### `include-workspace-root`
221 +
222 +* Default: false
223 +* Type: Boolean
224 +
225 +Include the workspace root when workspaces are enabled for a command.
226 +
227 +When false, specifying individual workspaces via the `workspace` config, or
228 +all workspaces via the `workspaces` flag, will cause npm to operate only on
229 +the specified workspaces, and not on the root project.
230 +
231 +<!-- automatically generated, do not edit manually -->
232 +<!-- see lib/utils/config/definitions.js -->
233 +
234 <!-- AUTOGENERATED CONFIG DESCRIPTIONS END -->
235
236 ### See Also
content/cli/v7/commands/npm-fund.md
+2 -2
@@ -132,8 +132,8 @@ Valid values for the `workspace` config are either:
132
133 * Workspace names
134 * Path to a workspace directory
135 -* Path to a parent workspace directory (will result to selecting all of the
136 - nested workspaces)
135 +* Path to a parent workspace directory (will result in selecting all
136 + workspaces within that folder)
137
138 When set for the `npm init` command, this may be set to the folder of a
139 workspace which does not yet exist, to create the folder and set it up as a
content/cli/v7/commands/npm-init.md
+27 -5
@@ -210,8 +210,8 @@ Valid values for the `workspace` config are either:
210
211 * Workspace names
212 * Path to a workspace directory
213 -* Path to a parent workspace directory (will result to selecting all of the
214 - nested workspaces)
213 +* Path to a parent workspace directory (will result in selecting all
214 + workspaces within that folder)
215
216 When set for the `npm init` command, this may be set to the folder of a
217 workspace which does not yet exist, to create the folder and set it up as a
@@ -224,17 +224,39 @@ This value is not exported to the environment for child processes.
224
225 #### `workspaces`
226
227 -* Default: false
228 -* Type: Boolean
227 +* Default: null
228 +* Type: null or Boolean
229
230 -Enable running a command in the context of **all** the configured
230 +Set to true to run the command in the context of **all** configured
231 workspaces.
232
233 +Explicitly setting this to false will cause commands like `install` to
234 +ignore workspaces altogether. When not set explicitly:
235 +
236 +- Commands that operate on the `node_modules` tree (install, update, etc.)
237 +will link workspaces into the `node_modules` folder. - Commands that do
238 +other things (test, exec, publish, etc.) will operate on the root project,
239 +_unless_ one or more workspaces are specified in the `workspace` config.
240 +
241 This value is not exported to the environment for child processes.
242
243 <!-- automatically generated, do not edit manually -->
244 <!-- see lib/utils/config/definitions.js -->
245
246 +#### `include-workspace-root`
247 +
248 +* Default: false
249 +* Type: Boolean
250 +
251 +Include the workspace root when workspaces are enabled for a command.
252 +
253 +When false, specifying individual workspaces via the `workspace` config, or
254 +all workspaces via the `workspaces` flag, will cause npm to operate only on
255 +the specified workspaces, and not on the root project.
256 +
257 +<!-- automatically generated, do not edit manually -->
258 +<!-- see lib/utils/config/definitions.js -->
259 +
260 <!-- AUTOGENERATED CONFIG DESCRIPTIONS END -->
261
262 ### See Also
content/cli/v7/commands/npm-install-test.md
+27 -5
@@ -251,8 +251,8 @@ Valid values for the `workspace` config are either:
251
252 * Workspace names
253 * Path to a workspace directory
254 -* Path to a parent workspace directory (will result to selecting all of the
255 - nested workspaces)
254 +* Path to a parent workspace directory (will result in selecting all
255 + workspaces within that folder)
256
257 When set for the `npm init` command, this may be set to the folder of a
258 workspace which does not yet exist, to create the folder and set it up as a
@@ -265,17 +265,39 @@ This value is not exported to the environment for child processes.
265
266 #### `workspaces`
267
268 -* Default: false
269 -* Type: Boolean
268 +* Default: null
269 +* Type: null or Boolean
270
271 -Enable running a command in the context of **all** the configured
271 +Set to true to run the command in the context of **all** configured
272 workspaces.
273
274 +Explicitly setting this to false will cause commands like `install` to
275 +ignore workspaces altogether. When not set explicitly:
276 +
277 +- Commands that operate on the `node_modules` tree (install, update, etc.)
278 +will link workspaces into the `node_modules` folder. - Commands that do
279 +other things (test, exec, publish, etc.) will operate on the root project,
280 +_unless_ one or more workspaces are specified in the `workspace` config.
281 +
282 This value is not exported to the environment for child processes.
283
284 <!-- automatically generated, do not edit manually -->
285 <!-- see lib/utils/config/definitions.js -->
286
287 +#### `include-workspace-root`
288 +
289 +* Default: false
290 +* Type: Boolean
291 +
292 +Include the workspace root when workspaces are enabled for a command.
293 +
294 +When false, specifying individual workspaces via the `workspace` config, or
295 +all workspaces via the `workspaces` flag, will cause npm to operate only on
296 +the specified workspaces, and not on the root project.
297 +
298 +<!-- automatically generated, do not edit manually -->
299 +<!-- see lib/utils/config/definitions.js -->
300 +
301 <!-- AUTOGENERATED CONFIG DESCRIPTIONS END -->
302
303 ### See Also
content/cli/v7/commands/npm-install.md
+27 -5
@@ -636,8 +636,8 @@ Valid values for the `workspace` config are either:
636
637 * Workspace names
638 * Path to a workspace directory
639 -* Path to a parent workspace directory (will result to selecting all of the
640 - nested workspaces)
639 +* Path to a parent workspace directory (will result in selecting all
640 + workspaces within that folder)
641
642 When set for the `npm init` command, this may be set to the folder of a
643 workspace which does not yet exist, to create the folder and set it up as a
@@ -650,17 +650,39 @@ This value is not exported to the environment for child processes.
650
651 #### `workspaces`
652
653 -* Default: false
654 -* Type: Boolean
653 +* Default: null
654 +* Type: null or Boolean
655
656 -Enable running a command in the context of **all** the configured
656 +Set to true to run the command in the context of **all** configured
657 workspaces.
658
659 +Explicitly setting this to false will cause commands like `install` to
660 +ignore workspaces altogether. When not set explicitly:
661 +
662 +- Commands that operate on the `node_modules` tree (install, update, etc.)
663 +will link workspaces into the `node_modules` folder. - Commands that do
664 +other things (test, exec, publish, etc.) will operate on the root project,
665 +_unless_ one or more workspaces are specified in the `workspace` config.
666 +
667 This value is not exported to the environment for child processes.
668
669 <!-- automatically generated, do not edit manually -->
670 <!-- see lib/utils/config/definitions.js -->
671
672 +#### `include-workspace-root`
673 +
674 +* Default: false
675 +* Type: Boolean
676 +
677 +Include the workspace root when workspaces are enabled for a command.
678 +
679 +When false, specifying individual workspaces via the `workspace` config, or
680 +all workspaces via the `workspaces` flag, will cause npm to operate only on
681 +the specified workspaces, and not on the root project.
682 +
683 +<!-- automatically generated, do not edit manually -->
684 +<!-- see lib/utils/config/definitions.js -->
685 +
686 <!-- AUTOGENERATED CONFIG DESCRIPTIONS END -->
687
688 ### Algorithm
content/cli/v7/commands/npm-link.md
+27 -5
@@ -335,8 +335,8 @@ Valid values for the `workspace` config are either:
335
336 * Workspace names
337 * Path to a workspace directory
338 -* Path to a parent workspace directory (will result to selecting all of the
339 - nested workspaces)
338 +* Path to a parent workspace directory (will result in selecting all
339 + workspaces within that folder)
340
341 When set for the `npm init` command, this may be set to the folder of a
342 workspace which does not yet exist, to create the folder and set it up as a
@@ -349,17 +349,39 @@ This value is not exported to the environment for child processes.
349
350 #### `workspaces`
351
352 -* Default: false
353 -* Type: Boolean
352 +* Default: null
353 +* Type: null or Boolean
354
355 -Enable running a command in the context of **all** the configured
355 +Set to true to run the command in the context of **all** configured
356 workspaces.
357
358 +Explicitly setting this to false will cause commands like `install` to
359 +ignore workspaces altogether. When not set explicitly:
360 +
361 +- Commands that operate on the `node_modules` tree (install, update, etc.)
362 +will link workspaces into the `node_modules` folder. - Commands that do
363 +other things (test, exec, publish, etc.) will operate on the root project,
364 +_unless_ one or more workspaces are specified in the `workspace` config.
365 +
366 This value is not exported to the environment for child processes.
367
368 <!-- automatically generated, do not edit manually -->
369 <!-- see lib/utils/config/definitions.js -->
370
371 +#### `include-workspace-root`
372 +
373 +* Default: false
374 +* Type: Boolean
375 +
376 +Include the workspace root when workspaces are enabled for a command.
377 +
378 +When false, specifying individual workspaces via the `workspace` config, or
379 +all workspaces via the `workspaces` flag, will cause npm to operate only on
380 +the specified workspaces, and not on the root project.
381 +
382 +<!-- automatically generated, do not edit manually -->
383 +<!-- see lib/utils/config/definitions.js -->
384 +
385 <!-- AUTOGENERATED CONFIG DESCRIPTIONS END -->
386
387 ### See Also
content/cli/v7/commands/npm-ls.md
+27 -5
@@ -237,8 +237,8 @@ Valid values for the `workspace` config are either:
237
238 * Workspace names
239 * Path to a workspace directory
240 -* Path to a parent workspace directory (will result to selecting all of the
241 - nested workspaces)
240 +* Path to a parent workspace directory (will result in selecting all
241 + workspaces within that folder)
242
243 When set for the `npm init` command, this may be set to the folder of a
244 workspace which does not yet exist, to create the folder and set it up as a
@@ -251,17 +251,39 @@ This value is not exported to the environment for child processes.
251
252 #### `workspaces`
253
254 -* Default: false
255 -* Type: Boolean
254 +* Default: null
255 +* Type: null or Boolean
256
257 -Enable running a command in the context of **all** the configured
257 +Set to true to run the command in the context of **all** configured
258 workspaces.
259
260 +Explicitly setting this to false will cause commands like `install` to
261 +ignore workspaces altogether. When not set explicitly:
262 +
263 +- Commands that operate on the `node_modules` tree (install, update, etc.)
264 +will link workspaces into the `node_modules` folder. - Commands that do
265 +other things (test, exec, publish, etc.) will operate on the root project,
266 +_unless_ one or more workspaces are specified in the `workspace` config.
267 +
268 This value is not exported to the environment for child processes.
269
270 <!-- automatically generated, do not edit manually -->
271 <!-- see lib/utils/config/definitions.js -->
272
273 +#### `include-workspace-root`
274 +
275 +* Default: false
276 +* Type: Boolean
277 +
278 +Include the workspace root when workspaces are enabled for a command.
279 +
280 +When false, specifying individual workspaces via the `workspace` config, or
281 +all workspaces via the `workspaces` flag, will cause npm to operate only on
282 +the specified workspaces, and not on the root project.
283 +
284 +<!-- automatically generated, do not edit manually -->
285 +<!-- see lib/utils/config/definitions.js -->
286 +
287 <!-- AUTOGENERATED CONFIG DESCRIPTIONS END -->
288
289 ### See Also
content/cli/v7/commands/npm-outdated.md
+2 -2
@@ -177,8 +177,8 @@ Valid values for the `workspace` config are either:
177
178 * Workspace names
179 * Path to a workspace directory
180 -* Path to a parent workspace directory (will result to selecting all of the
181 - nested workspaces)
180 +* Path to a parent workspace directory (will result in selecting all
181 + workspaces within that folder)
182
183 When set for the `npm init` command, this may be set to the folder of a
184 workspace which does not yet exist, to create the folder and set it up as a
content/cli/v7/commands/npm-pack.md
+27 -5
@@ -79,8 +79,8 @@ Valid values for the `workspace` config are either:
79
80 * Workspace names
81 * Path to a workspace directory
82 -* Path to a parent workspace directory (will result to selecting all of the
83 - nested workspaces)
82 +* Path to a parent workspace directory (will result in selecting all
83 + workspaces within that folder)
84
85 When set for the `npm init` command, this may be set to the folder of a
86 workspace which does not yet exist, to create the folder and set it up as a
@@ -93,17 +93,39 @@ This value is not exported to the environment for child processes.
93
94 #### `workspaces`
95
96 -* Default: false
97 -* Type: Boolean
96 +* Default: null
97 +* Type: null or Boolean
98
99 -Enable running a command in the context of **all** the configured
99 +Set to true to run the command in the context of **all** configured
100 workspaces.
101
102 +Explicitly setting this to false will cause commands like `install` to
103 +ignore workspaces altogether. When not set explicitly:
104 +
105 +- Commands that operate on the `node_modules` tree (install, update, etc.)
106 +will link workspaces into the `node_modules` folder. - Commands that do
107 +other things (test, exec, publish, etc.) will operate on the root project,
108 +_unless_ one or more workspaces are specified in the `workspace` config.
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
115 +#### `include-workspace-root`
116 +
117 +* Default: false
118 +* Type: Boolean
119 +
120 +Include the workspace root when workspaces are enabled for a command.
121 +
122 +When false, specifying individual workspaces via the `workspace` config, or
123 +all workspaces via the `workspaces` flag, will cause npm to operate only on
124 +the specified workspaces, and not on the root project.
125 +
126 +<!-- automatically generated, do not edit manually -->
127 +<!-- see lib/utils/config/definitions.js -->
128 +
129 <!-- AUTOGENERATED CONFIG DESCRIPTIONS END -->
130
131 ### Description
content/cli/v7/commands/npm-pkg.md
+13 -5
@@ -233,8 +233,8 @@ Valid values for the `workspace` config are either:
233
234 * Workspace names
235 * Path to a workspace directory
236 -* Path to a parent workspace directory (will result to selecting all of the
237 - nested workspaces)
236 +* Path to a parent workspace directory (will result in selecting all
237 + workspaces within that folder)
238
239 When set for the `npm init` command, this may be set to the folder of a
240 workspace which does not yet exist, to create the folder and set it up as a
@@ -247,12 +247,20 @@ This value is not exported to the environment for child processes.
247
248 #### `workspaces`
249
250 -* Default: false
251 -* Type: Boolean
250 +* Default: null
251 +* Type: null or Boolean
252
253 -Enable running a command in the context of **all** the configured
253 +Set to true to run the command in the context of **all** configured
254 workspaces.
255
256 +Explicitly setting this to false will cause commands like `install` to
257 +ignore workspaces altogether. When not set explicitly:
258 +
259 +- Commands that operate on the `node_modules` tree (install, update, etc.)
260 +will link workspaces into the `node_modules` folder. - Commands that do
261 +other things (test, exec, publish, etc.) will operate on the root project,
262 +_unless_ one or more workspaces are specified in the `workspace` config.
263 +
264 This value is not exported to the environment for child processes.
265
266 <!-- automatically generated, do not edit manually -->
content/cli/v7/commands/npm-prune.md
+27 -5
@@ -113,8 +113,8 @@ Valid values for the `workspace` config are either:
113
114 * Workspace names
115 * Path to a workspace directory
116 -* Path to a parent workspace directory (will result to selecting all of the
117 - nested workspaces)
116 +* Path to a parent workspace directory (will result in selecting all
117 + workspaces within that folder)
118
119 When set for the `npm init` command, this may be set to the folder of a
120 workspace which does not yet exist, to create the folder and set it up as a
@@ -127,17 +127,39 @@ This value is not exported to the environment for child processes.
127
128 #### `workspaces`
129
130 -* Default: false
131 -* Type: Boolean
130 +* Default: null
131 +* Type: null or Boolean
132
133 -Enable running a command in the context of **all** the configured
133 +Set to true to run the command in the context of **all** configured
134 workspaces.
135
136 +Explicitly setting this to false will cause commands like `install` to
137 +ignore workspaces altogether. When not set explicitly:
138 +
139 +- Commands that operate on the `node_modules` tree (install, update, etc.)
140 +will link workspaces into the `node_modules` folder. - Commands that do
141 +other things (test, exec, publish, etc.) will operate on the root project,
142 +_unless_ one or more workspaces are specified in the `workspace` config.
143 +
144 This value is not exported to the environment for child processes.
145
146 <!-- automatically generated, do not edit manually -->
147 <!-- see lib/utils/config/definitions.js -->
148
149 +#### `include-workspace-root`
150 +
151 +* Default: false
152 +* Type: Boolean
153 +
154 +Include the workspace root when workspaces are enabled for a command.
155 +
156 +When false, specifying individual workspaces via the `workspace` config, or
157 +all workspaces via the `workspaces` flag, will cause npm to operate only on
158 +the specified workspaces, and not on the root project.
159 +
160 +<!-- automatically generated, do not edit manually -->
161 +<!-- see lib/utils/config/definitions.js -->
162 +
163 <!-- AUTOGENERATED CONFIG DESCRIPTIONS END -->
164
165 ### See Also
content/cli/v7/commands/npm-publish.md
+27 -5
@@ -198,8 +198,8 @@ Valid values for the `workspace` config are either:
198
199 * Workspace names
200 * Path to a workspace directory
201 -* Path to a parent workspace directory (will result to selecting all of the
202 - nested workspaces)
201 +* Path to a parent workspace directory (will result in selecting all
202 + workspaces within that folder)
203
204 When set for the `npm init` command, this may be set to the folder of a
205 workspace which does not yet exist, to create the folder and set it up as a
@@ -212,17 +212,39 @@ This value is not exported to the environment for child processes.
212
213 #### `workspaces`
214
215 -* Default: false
216 -* Type: Boolean
215 +* Default: null
216 +* Type: null or Boolean
217
218 -Enable running a command in the context of **all** the configured
218 +Set to true to run the command in the context of **all** configured
219 workspaces.
220
221 +Explicitly setting this to false will cause commands like `install` to
222 +ignore workspaces altogether. When not set explicitly:
223 +
224 +- Commands that operate on the `node_modules` tree (install, update, etc.)
225 +will link workspaces into the `node_modules` folder. - Commands that do
226 +other things (test, exec, publish, etc.) will operate on the root project,
227 +_unless_ one or more workspaces are specified in the `workspace` config.
228 +
229 This value is not exported to the environment for child processes.
230
231 <!-- automatically generated, do not edit manually -->
232 <!-- see lib/utils/config/definitions.js -->
233
234 +#### `include-workspace-root`
235 +
236 +* Default: false
237 +* Type: Boolean
238 +
239 +Include the workspace root when workspaces are enabled for a command.
240 +
241 +When false, specifying individual workspaces via the `workspace` config, or
242 +all workspaces via the `workspaces` flag, will cause npm to operate only on
243 +the specified workspaces, and not on the root project.
244 +
245 +<!-- automatically generated, do not edit manually -->
246 +<!-- see lib/utils/config/definitions.js -->
247 +
248 <!-- AUTOGENERATED CONFIG DESCRIPTIONS END -->
249
250 ### See Also
content/cli/v7/commands/npm-rebuild.md
+27 -5
@@ -99,8 +99,8 @@ Valid values for the `workspace` config are either:
99
100 * Workspace names
101 * Path to a workspace directory
102 -* Path to a parent workspace directory (will result to selecting all of the
103 - nested workspaces)
102 +* Path to a parent workspace directory (will result in selecting all
103 + workspaces within that folder)
104
105 When set for the `npm init` command, this may be set to the folder of a
106 workspace which does not yet exist, to create the folder and set it up as a
@@ -113,17 +113,39 @@ This value is not exported to the environment for child processes.
113
114 #### `workspaces`
115
116 -* Default: false
117 -* Type: Boolean
116 +* Default: null
117 +* Type: null or Boolean
118
119 -Enable running a command in the context of **all** the configured
119 +Set to true to run the command in the context of **all** configured
120 workspaces.
121
122 +Explicitly setting this to false will cause commands like `install` to
123 +ignore workspaces altogether. When not set explicitly:
124 +
125 +- Commands that operate on the `node_modules` tree (install, update, etc.)
126 +will link workspaces into the `node_modules` folder. - Commands that do
127 +other things (test, exec, publish, etc.) will operate on the root project,
128 +_unless_ one or more workspaces are specified in the `workspace` config.
129 +
130 This value is not exported to the environment for child processes.
131
132 <!-- automatically generated, do not edit manually -->
133 <!-- see lib/utils/config/definitions.js -->
134
135 +#### `include-workspace-root`
136 +
137 +* Default: false
138 +* Type: Boolean
139 +
140 +Include the workspace root when workspaces are enabled for a command.
141 +
142 +When false, specifying individual workspaces via the `workspace` config, or
143 +all workspaces via the `workspaces` flag, will cause npm to operate only on
144 +the specified workspaces, and not on the root project.
145 +
146 +<!-- automatically generated, do not edit manually -->
147 +<!-- see lib/utils/config/definitions.js -->
148 +
149 <!-- AUTOGENERATED CONFIG DESCRIPTIONS END -->
150
151 ### See Also
content/cli/v7/commands/npm-repo.md
+27 -5
@@ -60,8 +60,8 @@ Valid values for the `workspace` config are either:
60
61 * Workspace names
62 * Path to a workspace directory
63 -* Path to a parent workspace directory (will result to selecting all of the
64 - nested workspaces)
63 +* Path to a parent workspace directory (will result in selecting all
64 + workspaces within that folder)
65
66 When set for the `npm init` command, this may be set to the folder of a
67 workspace which does not yet exist, to create the folder and set it up as a
@@ -74,17 +74,39 @@ This value is not exported to the environment for child processes.
74
75 #### `workspaces`
76
77 -* Default: false
78 -* Type: Boolean
77 +* Default: null
78 +* Type: null or Boolean
79
80 -Enable running a command in the context of **all** the configured
80 +Set to true to run the command in the context of **all** configured
81 workspaces.
82
83 +Explicitly setting this to false will cause commands like `install` to
84 +ignore workspaces altogether. When not set explicitly:
85 +
86 +- Commands that operate on the `node_modules` tree (install, update, etc.)
87 +will link workspaces into the `node_modules` folder. - Commands that do
88 +other things (test, exec, publish, etc.) will operate on the root project,
89 +_unless_ one or more workspaces are specified in the `workspace` config.
90 +
91 This value is not exported to the environment for child processes.
92
93 <!-- automatically generated, do not edit manually -->
94 <!-- see lib/utils/config/definitions.js -->
95
96 +#### `include-workspace-root`
97 +
98 +* Default: false
99 +* Type: Boolean
100 +
101 +Include the workspace root when workspaces are enabled for a command.
102 +
103 +When false, specifying individual workspaces via the `workspace` config, or
104 +all workspaces via the `workspaces` flag, will cause npm to operate only on
105 +the specified workspaces, and not on the root project.
106 +
107 +<!-- automatically generated, do not edit manually -->
108 +<!-- see lib/utils/config/definitions.js -->
109 +
110 <!-- AUTOGENERATED CONFIG DESCRIPTIONS END -->
111
112 ### See Also
content/cli/v7/commands/npm-run-script.md
+27 -5
@@ -162,8 +162,8 @@ Valid values for the `workspace` config are either:
162
163 * Workspace names
164 * Path to a workspace directory
165 -* Path to a parent workspace directory (will result to selecting all of the
166 - nested workspaces)
165 +* Path to a parent workspace directory (will result in selecting all
166 + workspaces within that folder)
167
168 When set for the `npm init` command, this may be set to the folder of a
169 workspace which does not yet exist, to create the folder and set it up as a
@@ -176,17 +176,39 @@ This value is not exported to the environment for child processes.
176
177 #### `workspaces`
178
179 -* Default: false
180 -* Type: Boolean
179 +* Default: null
180 +* Type: null or Boolean
181
182 -Enable running a command in the context of **all** the configured
182 +Set to true to run the command in the context of **all** configured
183 workspaces.
184
185 +Explicitly setting this to false will cause commands like `install` to
186 +ignore workspaces altogether. When not set explicitly:
187 +
188 +- Commands that operate on the `node_modules` tree (install, update, etc.)
189 +will link workspaces into the `node_modules` folder. - Commands that do
190 +other things (test, exec, publish, etc.) will operate on the root project,
191 +_unless_ one or more workspaces are specified in the `workspace` config.
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
198 +#### `include-workspace-root`
199 +
200 +* Default: false
201 +* Type: Boolean
202 +
203 +Include the workspace root when workspaces are enabled for a command.
204 +
205 +When false, specifying individual workspaces via the `workspace` config, or
206 +all workspaces via the `workspaces` flag, will cause npm to operate only on
207 +the specified workspaces, and not on the root project.
208 +
209 +<!-- automatically generated, do not edit manually -->
210 +<!-- see lib/utils/config/definitions.js -->
211 +
212 #### `if-present`
213
214 * Default: false
content/cli/v7/commands/npm-set-script.md
+27 -5
@@ -54,8 +54,8 @@ Valid values for the `workspace` config are either:
54
55 * Workspace names
56 * Path to a workspace directory
57 -* Path to a parent workspace directory (will result to selecting all of the
58 - nested workspaces)
57 +* Path to a parent workspace directory (will result in selecting all
58 + workspaces within that folder)
59
60 When set for the `npm init` command, this may be set to the folder of a
61 workspace which does not yet exist, to create the folder and set it up as a
@@ -68,17 +68,39 @@ This value is not exported to the environment for child processes.
68
69 #### `workspaces`
70
71 -* Default: false
72 -* Type: Boolean
71 +* Default: null
72 +* Type: null or Boolean
73
74 -Enable running a command in the context of **all** the configured
74 +Set to true to run the command in the context of **all** configured
75 workspaces.
76
77 +Explicitly setting this to false will cause commands like `install` to
78 +ignore workspaces altogether. When not set explicitly:
79 +
80 +- Commands that operate on the `node_modules` tree (install, update, etc.)
81 +will link workspaces into the `node_modules` folder. - Commands that do
82 +other things (test, exec, publish, etc.) will operate on the root project,
83 +_unless_ one or more workspaces are specified in the `workspace` config.
84 +
85 This value is not exported to the environment for child processes.
86
87 <!-- automatically generated, do not edit manually -->
88 <!-- see lib/utils/config/definitions.js -->
89
90 +#### `include-workspace-root`
91 +
92 +* Default: false
93 +* Type: Boolean
94 +
95 +Include the workspace root when workspaces are enabled for a command.
96 +
97 +When false, specifying individual workspaces via the `workspace` config, or
98 +all workspaces via the `workspaces` flag, will cause npm to operate only on
99 +the specified workspaces, and not on the root project.
100 +
101 +<!-- automatically generated, do not edit manually -->
102 +<!-- see lib/utils/config/definitions.js -->
103 +
104 <!-- AUTOGENERATED CONFIG DESCRIPTIONS END -->
105
106 ### See Also
content/cli/v7/commands/npm-uninstall.md
+27 -5
@@ -95,8 +95,8 @@ Valid values for the `workspace` config are either:
95
96 * Workspace names
97 * Path to a workspace directory
98 -* Path to a parent workspace directory (will result to selecting all of the
99 - nested workspaces)
98 +* Path to a parent workspace directory (will result in selecting all
99 + workspaces within that folder)
100
101 When set for the `npm init` command, this may be set to the folder of a
102 workspace which does not yet exist, to create the folder and set it up as a
@@ -109,17 +109,39 @@ This value is not exported to the environment for child processes.
109
110 #### `workspaces`
111
112 -* Default: false
113 -* Type: Boolean
112 +* Default: null
113 +* Type: null or Boolean
114
115 -Enable running a command in the context of **all** the configured
115 +Set to true to run the command in the context of **all** configured
116 workspaces.
117
118 +Explicitly setting this to false will cause commands like `install` to
119 +ignore workspaces altogether. When not set explicitly:
120 +
121 +- Commands that operate on the `node_modules` tree (install, update, etc.)
122 +will link workspaces into the `node_modules` folder. - Commands that do
123 +other things (test, exec, publish, etc.) will operate on the root project,
124 +_unless_ one or more workspaces are specified in the `workspace` config.
125 +
126 This value is not exported to the environment for child processes.
127
128 <!-- automatically generated, do not edit manually -->
129 <!-- see lib/utils/config/definitions.js -->
130
131 +#### `include-workspace-root`
132 +
133 +* Default: false
134 +* Type: Boolean
135 +
136 +Include the workspace root when workspaces are enabled for a command.
137 +
138 +When false, specifying individual workspaces via the `workspace` config, or
139 +all workspaces via the `workspaces` flag, will cause npm to operate only on
140 +the specified workspaces, and not on the root project.
141 +
142 +<!-- automatically generated, do not edit manually -->
143 +<!-- see lib/utils/config/definitions.js -->
144 +
145 <!-- AUTOGENERATED CONFIG DESCRIPTIONS END -->
146
147 ### See Also
content/cli/v7/commands/npm-unpublish.md
+13 -5
@@ -117,8 +117,8 @@ Valid values for the `workspace` config are either:
117
118 * Workspace names
119 * Path to a workspace directory
120 -* Path to a parent workspace directory (will result to selecting all of the
121 - nested workspaces)
120 +* Path to a parent workspace directory (will result in selecting all
121 + workspaces within that folder)
122
123 When set for the `npm init` command, this may be set to the folder of a
124 workspace which does not yet exist, to create the folder and set it up as a
@@ -131,12 +131,20 @@ This value is not exported to the environment for child processes.
131
132 #### `workspaces`
133
134 -* Default: false
135 -* Type: Boolean
134 +* Default: null
135 +* Type: null or Boolean
136
137 -Enable running a command in the context of **all** the configured
137 +Set to true to run the command in the context of **all** configured
138 workspaces.
139
140 +Explicitly setting this to false will cause commands like `install` to
141 +ignore workspaces altogether. When not set explicitly:
142 +
143 +- Commands that operate on the `node_modules` tree (install, update, etc.)
144 +will link workspaces into the `node_modules` folder. - Commands that do
145 +other things (test, exec, publish, etc.) will operate on the root project,
146 +_unless_ one or more workspaces are specified in the `workspace` config.
147 +
148 This value is not exported to the environment for child processes.
149
150 <!-- automatically generated, do not edit manually -->
content/cli/v7/commands/npm-update.md
+27 -5
@@ -351,8 +351,8 @@ Valid values for the `workspace` config are either:
351
352 * Workspace names
353 * Path to a workspace directory
354 -* Path to a parent workspace directory (will result to selecting all of the
355 - nested workspaces)
354 +* Path to a parent workspace directory (will result in selecting all
355 + workspaces within that folder)
356
357 When set for the `npm init` command, this may be set to the folder of a
358 workspace which does not yet exist, to create the folder and set it up as a
@@ -365,17 +365,39 @@ This value is not exported to the environment for child processes.
365
366 #### `workspaces`
367
368 -* Default: false
369 -* Type: Boolean
368 +* Default: null
369 +* Type: null or Boolean
370
371 -Enable running a command in the context of **all** the configured
371 +Set to true to run the command in the context of **all** configured
372 workspaces.
373
374 +Explicitly setting this to false will cause commands like `install` to
375 +ignore workspaces altogether. When not set explicitly:
376 +
377 +- Commands that operate on the `node_modules` tree (install, update, etc.)
378 +will link workspaces into the `node_modules` folder. - Commands that do
379 +other things (test, exec, publish, etc.) will operate on the root project,
380 +_unless_ one or more workspaces are specified in the `workspace` config.
381 +
382 This value is not exported to the environment for child processes.
383
384 <!-- automatically generated, do not edit manually -->
385 <!-- see lib/utils/config/definitions.js -->
386
387 +#### `include-workspace-root`
388 +
389 +* Default: false
390 +* Type: Boolean
391 +
392 +Include the workspace root when workspaces are enabled for a command.
393 +
394 +When false, specifying individual workspaces via the `workspace` config, or
395 +all workspaces via the `workspaces` flag, will cause npm to operate only on
396 +the specified workspaces, and not on the root project.
397 +
398 +<!-- automatically generated, do not edit manually -->
399 +<!-- see lib/utils/config/definitions.js -->
400 +
401 <!-- AUTOGENERATED CONFIG DESCRIPTIONS END -->
402
403 ### See Also
content/cli/v7/commands/npm-version.md
+27 -5
@@ -113,8 +113,8 @@ Valid values for the `workspace` config are either:
113
114 * Workspace names
115 * Path to a workspace directory
116 -* Path to a parent workspace directory (will result to selecting all of the
117 - nested workspaces)
116 +* Path to a parent workspace directory (will result in selecting all
117 + workspaces within that folder)
118
119 When set for the `npm init` command, this may be set to the folder of a
120 workspace which does not yet exist, to create the folder and set it up as a
@@ -127,17 +127,39 @@ This value is not exported to the environment for child processes.
127
128 #### `workspaces`
129
130 -* Default: false
131 -* Type: Boolean
130 +* Default: null
131 +* Type: null or Boolean
132
133 -Enable running a command in the context of **all** the configured
133 +Set to true to run the command in the context of **all** configured
134 workspaces.
135
136 +Explicitly setting this to false will cause commands like `install` to
137 +ignore workspaces altogether. When not set explicitly:
138 +
139 +- Commands that operate on the `node_modules` tree (install, update, etc.)
140 +will link workspaces into the `node_modules` folder. - Commands that do
141 +other things (test, exec, publish, etc.) will operate on the root project,
142 +_unless_ one or more workspaces are specified in the `workspace` config.
143 +
144 This value is not exported to the environment for child processes.
145
146 <!-- automatically generated, do not edit manually -->
147 <!-- see lib/utils/config/definitions.js -->
148
149 +#### `include-workspace-root`
150 +
151 +* Default: false
152 +* Type: Boolean
153 +
154 +Include the workspace root when workspaces are enabled for a command.
155 +
156 +When false, specifying individual workspaces via the `workspace` config, or
157 +all workspaces via the `workspaces` flag, will cause npm to operate only on
158 +the specified workspaces, and not on the root project.
159 +
160 +<!-- automatically generated, do not edit manually -->
161 +<!-- see lib/utils/config/definitions.js -->
162 +
163 <!-- AUTOGENERATED CONFIG DESCRIPTIONS END -->
164
165 ### Description
content/cli/v7/commands/npm-view.md
+27 -5
@@ -137,8 +137,8 @@ Valid values for the `workspace` config are either:
137
138 * Workspace names
139 * Path to a workspace directory
140 -* Path to a parent workspace directory (will result to selecting all of the
141 - nested workspaces)
140 +* Path to a parent workspace directory (will result in selecting all
141 + workspaces within that folder)
142
143 When set for the `npm init` command, this may be set to the folder of a
144 workspace which does not yet exist, to create the folder and set it up as a
@@ -151,17 +151,39 @@ This value is not exported to the environment for child processes.
151
152 #### `workspaces`
153
154 -* Default: false
155 -* Type: Boolean
154 +* Default: null
155 +* Type: null or Boolean
156
157 -Enable running a command in the context of **all** the configured
157 +Set to true to run the command in the context of **all** configured
158 workspaces.
159
160 +Explicitly setting this to false will cause commands like `install` to
161 +ignore workspaces altogether. When not set explicitly:
162 +
163 +- Commands that operate on the `node_modules` tree (install, update, etc.)
164 +will link workspaces into the `node_modules` folder. - Commands that do
165 +other things (test, exec, publish, etc.) will operate on the root project,
166 +_unless_ one or more workspaces are specified in the `workspace` config.
167 +
168 This value is not exported to the environment for child processes.
169
170 <!-- automatically generated, do not edit manually -->
171 <!-- see lib/utils/config/definitions.js -->
172
173 +#### `include-workspace-root`
174 +
175 +* Default: false
176 +* Type: Boolean
177 +
178 +Include the workspace root when workspaces are enabled for a command.
179 +
180 +When false, specifying individual workspaces via the `workspace` config, or
181 +all workspaces via the `workspaces` flag, will cause npm to operate only on
182 +the specified workspaces, and not on the root project.
183 +
184 +<!-- automatically generated, do not edit manually -->
185 +<!-- see lib/utils/config/definitions.js -->
186 +
187 <!-- AUTOGENERATED CONFIG DESCRIPTIONS END -->
188
189 ### Output
content/cli/v7/using-npm/config.md
+52 -5
@@ -814,6 +814,20 @@ This is experimental, and not implemented by the npm public registry.
814 <!-- automatically generated, do not edit manually -->
815 <!-- see lib/utils/config/definitions.js -->
816
817 +#### `include-workspace-root`
818 +
819 +* Default: false
820 +* Type: Boolean
821 +
822 +Include the workspace root when workspaces are enabled for a command.
823 +
824 +When false, specifying individual workspaces via the `workspace` config, or
825 +all workspaces via the `workspaces` flag, will cause npm to operate only on
826 +the specified workspaces, and not on the root project.
827 +
828 +<!-- automatically generated, do not edit manually -->
829 +<!-- see lib/utils/config/definitions.js -->
830 +
831 #### `init-author-email`
832
833 * Default: ""
@@ -977,6 +991,31 @@ When passed to `npm config` this refers to which config file to use.
991 <!-- automatically generated, do not edit manually -->
992 <!-- see lib/utils/config/definitions.js -->
993
994 +#### `lockfile-version`
995 +
996 +* Default: Version 2 if no lockfile or current lockfile version less than or
997 + equal to 2, otherwise maintain current lockfile version
998 +* Type: null, 1, 2, or 3
999 +
1000 +Set the lockfile format version to be used in package-lock.json and
1001 +npm-shrinkwrap-json files. Possible options are:
1002 +
1003 +1: The lockfile version used by npm versions 5 and 6. Lacks some data that
1004 +is used during the install, resulting in slower and possibly less
1005 +deterministic installs. Prevents lockfile churn when interoperating with
1006 +older npm versions.
1007 +
1008 +2: The default lockfile version used by npm version 7. Includes both the
1009 +version 1 lockfile data and version 3 lockfile data, for maximum determinism
1010 +and interoperability, at the expense of more bytes on disk.
1011 +
1012 +3: Only the new lockfile information introduced in npm version 7. Smaller on
1013 +disk than lockfile version 2, but not interoperable with older npm versions.
1014 +Ideal if all users are on npm version 7 and higher.
1015 +
1016 +<!-- automatically generated, do not edit manually -->
1017 +<!-- see lib/utils/config/definitions.js -->
1018 +
1019 #### `loglevel`
1020
1021 * Default: "notice"
@@ -1752,8 +1791,8 @@ Valid values for the `workspace` config are either:
1791
1792 * Workspace names
1793 * Path to a workspace directory
1755 -* Path to a parent workspace directory (will result to selecting all of the
1756 - nested workspaces)
1794 +* Path to a parent workspace directory (will result in selecting all
1795 + workspaces within that folder)
1796
1797 When set for the `npm init` command, this may be set to the folder of a
1798 workspace which does not yet exist, to create the folder and set it up as a
@@ -1766,12 +1805,20 @@ This value is not exported to the environment for child processes.
1805
1806 #### `workspaces`
1807
1769 -* Default: false
1770 -* Type: Boolean
1808 +* Default: null
1809 +* Type: null or Boolean
1810
1772 -Enable running a command in the context of **all** the configured
1811 +Set to true to run the command in the context of **all** configured
1812 workspaces.
1813
1814 +Explicitly setting this to false will cause commands like `install` to
1815 +ignore workspaces altogether. When not set explicitly:
1816 +
1817 +- Commands that operate on the `node_modules` tree (install, update, etc.)
1818 +will link workspaces into the `node_modules` folder. - Commands that do
1819 +other things (test, exec, publish, etc.) will operate on the root project,
1820 +_unless_ one or more workspaces are specified in the `workspace` config.
1821 +
1822 This value is not exported to the environment for child processes.
1823
1824 <!-- automatically generated, do not edit manually -->
content/cli/v7/using-npm/workspaces.md
+1 -1
@@ -117,7 +117,7 @@ respect the provided `workspace` configuration.
117 ### Using workspaces
118
119 Given the [specifities of how Node.js handles module resolution](https://nodejs.org/dist/latest-v14.x/docs/api/modules.html#modules_all_together) it's possible to consume any defined workspace
120 -by it's declared `package.json` `name`. Continuing from the example defined
120 +by its declared `package.json` `name`. Continuing from the example defined
121 above, let's also create a Node.js script that will require the `workspace-a`
122 example module, e.g:
123