CLI documentation update from CI
CI User committed
May 4, 2022 at 02:58 UTC
f69adf90e62edfb1a43c805787546e121591506c
10 files changed
+55
-29
cli/v8
+1
-1
@@ -1 +1 @@
1
-Subproject commit 7a858277171813b37d46a032e49db44c8624f78f
1
+Subproject commit 5f59f803d1c6cdc690d4d7016990ca0e20c6706f
content/cli/v8/commands/npm-dedupe.md
-4
@@ -157,10 +157,6 @@ this warning is treated as a failure.
157
If set to false, then ignore `package-lock.json` files when installing. This
158
will also prevent _writing_ `package-lock.json` if `save` is true.
159
160
-When package package-locks are disabled, automatic pruning of extraneous
161
-modules will also be disabled. To remove extraneous modules with
162
-package-locks disabled use `npm prune`.
163
-
160
This configuration does not affect `npm ci`.
161
162
<!-- automatically generated, do not edit manually -->
content/cli/v8/commands/npm-find-dupes.md
-4
@@ -97,10 +97,6 @@ this warning is treated as a failure.
97
If set to false, then ignore `package-lock.json` files when installing. This
98
will also prevent _writing_ `package-lock.json` if `save` is true.
99
100
-When package package-locks are disabled, automatic pruning of extraneous
101
-modules will also be disabled. To remove extraneous modules with
102
-package-locks disabled use `npm prune`.
103
-
100
This configuration does not affect `npm ci`.
101
102
<!-- automatically generated, do not edit manually -->
content/cli/v8/commands/npm-install-test.md
-4
@@ -172,10 +172,6 @@ this warning is treated as a failure.
172
If set to false, then ignore `package-lock.json` files when installing. This
173
will also prevent _writing_ `package-lock.json` if `save` is true.
174
175
-When package package-locks are disabled, automatic pruning of extraneous
176
-modules will also be disabled. To remove extraneous modules with
177
-package-locks disabled use `npm prune`.
178
-
175
This configuration does not affect `npm ci`.
176
177
<!-- automatically generated, do not edit manually -->
content/cli/v8/commands/npm-install.md
-4
@@ -563,10 +563,6 @@ this warning is treated as a failure.
563
If set to false, then ignore `package-lock.json` files when installing. This
564
will also prevent _writing_ `package-lock.json` if `save` is true.
565
566
-When package package-locks are disabled, automatic pruning of extraneous
567
-modules will also be disabled. To remove extraneous modules with
568
-package-locks disabled use `npm prune`.
569
-
566
This configuration does not affect `npm ci`.
567
568
<!-- automatically generated, do not edit manually -->
content/cli/v8/commands/npm-link.md
-4
@@ -234,10 +234,6 @@ this warning is treated as a failure.
234
If set to false, then ignore `package-lock.json` files when installing. This
235
will also prevent _writing_ `package-lock.json` if `save` is true.
236
237
-When package package-locks are disabled, automatic pruning of extraneous
238
-modules will also be disabled. To remove extraneous modules with
239
-package-locks disabled use `npm prune`.
240
-
237
This configuration does not affect `npm ci`.
238
239
<!-- automatically generated, do not edit manually -->
content/cli/v8/commands/npm-owner.md
+46
@@ -83,6 +83,52 @@ password, npm will prompt on the command line for one.
83
<!-- automatically generated, do not edit manually -->
84
<!-- see lib/utils/config/definitions.js -->
85
86
+#### `workspace`
87
+
88
+* Default:
89
+* Type: String (can be set multiple times)
90
+
91
+Enable running a command in the context of the configured workspaces of the
92
+current project while filtering by running only the workspaces defined by
93
+this configuration option.
94
+
95
+Valid values for the `workspace` config are either:
96
+
97
+* Workspace names
98
+* Path to a workspace directory
99
+* Path to a parent workspace directory (will result in selecting all
100
+ workspaces within that folder)
101
+
102
+When set for the `npm init` command, this may be set to the folder of a
103
+workspace which does not yet exist, to create the folder and set it up as a
104
+brand new workspace within the project.
105
+
106
+This value is not exported to the environment for child processes.
107
+
108
+<!-- automatically generated, do not edit manually -->
109
+<!-- see lib/utils/config/definitions.js -->
110
+
111
+#### `workspaces`
112
+
113
+* Default: null
114
+* Type: null or Boolean
115
+
116
+Set to true to run the command in the context of **all** configured
117
+workspaces.
118
+
119
+Explicitly setting this to false will cause commands like `install` to
120
+ignore workspaces altogether. When not set explicitly:
121
+
122
+- Commands that operate on the `node_modules` tree (install, update, etc.)
123
+will link workspaces into the `node_modules` folder. - Commands that do
124
+other things (test, exec, publish, etc.) will operate on the root project,
125
+_unless_ one or more workspaces are specified in the `workspace` config.
126
+
127
+This value is not exported to the environment for child processes.
128
+
129
+<!-- automatically generated, do not edit manually -->
130
+<!-- see lib/utils/config/definitions.js -->
131
+
132
<!-- AUTOGENERATED CONFIG DESCRIPTIONS END -->
133
134
### See Also
content/cli/v8/commands/npm-pkg.md
+8
@@ -86,6 +86,14 @@ Returned values are always in **json** format.
86
npm pkg get contributors[0].email
87
```
88
89
+ For complex fields you can also name a property in square brackets
90
+ to specifically select a child field. This is especially helpful
91
+ with the exports object:
92
+
93
+ ```bash
94
+ npm pkg get "exports[.].require"
95
+ ```
96
+
97
* `npm pkg set <field>=<value>`
98
99
Sets a `value` in your `package.json` based on the `field` value. When
content/cli/v8/commands/npm-update.md
-4
@@ -290,10 +290,6 @@ this warning is treated as a failure.
290
If set to false, then ignore `package-lock.json` files when installing. This
291
will also prevent _writing_ `package-lock.json` if `save` is true.
292
293
-When package package-locks are disabled, automatic pruning of extraneous
294
-modules will also be disabled. To remove extraneous modules with
295
-package-locks disabled use `npm prune`.
296
-
293
This configuration does not affect `npm ci`.
294
295
<!-- automatically generated, do not edit manually -->
content/cli/v8/using-npm/config.md
-4
@@ -1227,10 +1227,6 @@ The package to install for [`npm exec`](/cli/v8/commands/npm-exec)
1227
If set to false, then ignore `package-lock.json` files when installing. This
1228
will also prevent _writing_ `package-lock.json` if `save` is true.
1229
1230
-When package package-locks are disabled, automatic pruning of extraneous
1231
-modules will also be disabled. To remove extraneous modules with
1232
-package-locks disabled use `npm prune`.
1233
-
1230
This configuration does not affect `npm ci`.
1231
1232
<!-- automatically generated, do not edit manually -->