Skip to content

Commit f69adf9

Browse files
author
CI User
committed
CLI documentation update from CI
1 parent 2fb45e4 commit f69adf9

File tree

10 files changed

+55
-29
lines changed

10 files changed

+55
-29
lines changed

‎cli/v8

Submodule v8 updated 42 files

‎content/cli/v8/commands/npm-dedupe.md

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -157,10 +157,6 @@ this warning is treated as a failure.
157157
If set to false, then ignore `package-lock.json` files when installing. This
158158
will also prevent _writing_ `package-lock.json` if `save` is true.
159159
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-
164160
This configuration does not affect `npm ci`.
165161
166162
<!-- automatically generated, do not edit manually -->

‎content/cli/v8/commands/npm-find-dupes.md

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -97,10 +97,6 @@ this warning is treated as a failure.
9797
If set to false, then ignore `package-lock.json` files when installing. This
9898
will also prevent _writing_ `package-lock.json` if `save` is true.
9999

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-
104100
This configuration does not affect `npm ci`.
105101

106102
<!-- automatically generated, do not edit manually -->

‎content/cli/v8/commands/npm-install-test.md

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -172,10 +172,6 @@ this warning is treated as a failure.
172172
If set to false, then ignore `package-lock.json` files when installing. This
173173
will also prevent _writing_ `package-lock.json` if `save` is true.
174174

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-
179175
This configuration does not affect `npm ci`.
180176

181177
<!-- automatically generated, do not edit manually -->

‎content/cli/v8/commands/npm-install.md

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -563,10 +563,6 @@ this warning is treated as a failure.
563563
If set to false, then ignore `package-lock.json` files when installing. This
564564
will also prevent _writing_ `package-lock.json` if `save` is true.
565565
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-
570566
This configuration does not affect `npm ci`.
571567
572568
<!-- automatically generated, do not edit manually -->

‎content/cli/v8/commands/npm-link.md

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -234,10 +234,6 @@ this warning is treated as a failure.
234234
If set to false, then ignore `package-lock.json` files when installing. This
235235
will also prevent _writing_ `package-lock.json` if `save` is true.
236236

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-
241237
This configuration does not affect `npm ci`.
242238

243239
<!-- automatically generated, do not edit manually -->

‎content/cli/v8/commands/npm-owner.md

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -83,6 +83,52 @@ password, npm will prompt on the command line for one.
8383
<!-- automatically generated, do not edit manually -->
8484
<!-- see lib/utils/config/definitions.js -->
8585

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+
86132
<!-- AUTOGENERATED CONFIG DESCRIPTIONS END -->
87133

88134
### See Also

‎content/cli/v8/commands/npm-pkg.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -86,6 +86,14 @@ Returned values are always in **json** format.
8686
npm pkg get contributors[0].email
8787
```
8888
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+
8997
* `npm pkg set <field>=<value>`
9098
9199
Sets a `value` in your `package.json` based on the `field` value. When

‎content/cli/v8/commands/npm-update.md

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -290,10 +290,6 @@ this warning is treated as a failure.
290290
If set to false, then ignore `package-lock.json` files when installing. This
291291
will also prevent _writing_ `package-lock.json` if `save` is true.
292292

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-
297293
This configuration does not affect `npm ci`.
298294

299295
<!-- automatically generated, do not edit manually -->

‎content/cli/v8/using-npm/config.md

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1227,10 +1227,6 @@ The package to install for [`npm exec`](/cli/v8/commands/npm-exec)
12271227
If set to false, then ignore `package-lock.json` files when installing. This
12281228
will also prevent _writing_ `package-lock.json` if `save` is true.
12291229

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-
12341230
This configuration does not affect `npm ci`.
12351231

12361232
<!-- automatically generated, do not edit manually -->

0 commit comments

Comments
 (0)