@cryptotaxi247 / documentation-1 / commits / 40f567f

CLI documentation update from CI

CI User committed Mar 18, 2022 at 02:37 UTC 40f567ff62b4f37d518773ae8b44df17b8ec7b0e
15 files changed +235 -71
cli/v8
+1 -1
@@ -1 +1 @@
1 -Subproject commit f95396a033b75e2a3e9aa83f0b06c527641027a4
1 +Subproject commit 362831c4eba2554b44feec60fdff197d92eac0c1
content/cli/v8/commands/npm-audit.md
+31
@@ -256,6 +256,7 @@ mistakes, unnecessary performance degradation, and malicious input.
256 * Allow conflicting peerDependencies to be installed in the root project.
257 * Implicitly set `--yes` during `npm init`.
258 * Allow clobbering existing values in `npm pkg`
259 +* Allow unpublishing of entire packages (not just a single version).
260
261 If you don't have a clear idea of what you want to do, it is strongly
262 recommended that you do not use this option!
@@ -316,6 +317,36 @@ variable will be set to `'production'` for all lifecycle scripts.
317 <!-- automatically generated, do not edit manually -->
318 <!-- see lib/utils/config/definitions.js -->
319
320 +#### `foreground-scripts`
321 +
322 +* Default: false
323 +* Type: Boolean
324 +
325 +Run all build scripts (ie, `preinstall`, `install`, and `postinstall`)
326 +scripts for installed packages in the foreground process, sharing standard
327 +input, output, and error with the main npm process.
328 +
329 +Note that this will generally make installs run slower, and be much noisier,
330 +but can be useful for debugging.
331 +
332 +<!-- automatically generated, do not edit manually -->
333 +<!-- see lib/utils/config/definitions.js -->
334 +
335 +#### `ignore-scripts`
336 +
337 +* Default: false
338 +* Type: Boolean
339 +
340 +If true, npm does not run scripts specified in package.json files.
341 +
342 +Note that commands explicitly intended to run a particular script, such as
343 +`npm start`, `npm stop`, `npm restart`, `npm test`, and `npm run-script`
344 +will still run their intended script if `ignore-scripts` is set, but they
345 +will *not* run any pre- or post-scripts.
346 +
347 +<!-- automatically generated, do not edit manually -->
348 +<!-- see lib/utils/config/definitions.js -->
349 +
350 #### `workspace`
351
352 * Default:
content/cli/v8/commands/npm-ci.md
+15
@@ -104,6 +104,21 @@ submitted.
104 <!-- automatically generated, do not edit manually -->
105 <!-- see lib/utils/config/definitions.js -->
106
107 +#### `foreground-scripts`
108 +
109 +* Default: false
110 +* Type: Boolean
111 +
112 +Run all build scripts (ie, `preinstall`, `install`, and `postinstall`)
113 +scripts for installed packages in the foreground process, sharing standard
114 +input, output, and error with the main npm process.
115 +
116 +Note that this will generally make installs run slower, and be much noisier,
117 +but can be useful for debugging.
118 +
119 +<!-- automatically generated, do not edit manually -->
120 +<!-- see lib/utils/config/definitions.js -->
121 +
122 #### `ignore-scripts`
123
124 * Default: false
content/cli/v8/commands/npm-init.md
+1
@@ -209,6 +209,7 @@ mistakes, unnecessary performance degradation, and malicious input.
209 * Allow conflicting peerDependencies to be installed in the root project.
210 * Implicitly set `--yes` during `npm init`.
211 * Allow clobbering existing values in `npm pkg`
212 +* Allow unpublishing of entire packages (not just a single version).
213
214 If you don't have a clear idea of what you want to do, it is strongly
215 recommended that you do not use this option!
content/cli/v8/commands/npm-install-ci-test.md
+15
@@ -53,6 +53,21 @@ submitted.
53 <!-- automatically generated, do not edit manually -->
54 <!-- see lib/utils/config/definitions.js -->
55
56 +#### `foreground-scripts`
57 +
58 +* Default: false
59 +* Type: Boolean
60 +
61 +Run all build scripts (ie, `preinstall`, `install`, and `postinstall`)
62 +scripts for installed packages in the foreground process, sharing standard
63 +input, output, and error with the main npm process.
64 +
65 +Note that this will generally make installs run slower, and be much noisier,
66 +but can be useful for debugging.
67 +
68 +<!-- automatically generated, do not edit manually -->
69 +<!-- see lib/utils/config/definitions.js -->
70 +
71 #### `ignore-scripts`
72
73 * Default: false
content/cli/v8/commands/npm-install-test.md
+29 -14
@@ -122,6 +122,27 @@ will be preferred.
122 <!-- automatically generated, do not edit manually -->
123 <!-- see lib/utils/config/definitions.js -->
124
125 +#### `omit`
126 +
127 +* Default: 'dev' if the `NODE_ENV` environment variable is set to
128 + 'production', otherwise empty.
129 +* Type: "dev", "optional", or "peer" (can be set multiple times)
130 +
131 +Dependency types to omit from the installation tree on disk.
132 +
133 +Note that these dependencies _are_ still resolved and added to the
134 +`package-lock.json` or `npm-shrinkwrap.json` file. They are just not
135 +physically installed on disk.
136 +
137 +If a package type appears in both the `--include` and `--omit` lists, then
138 +it will be included.
139 +
140 +If the resulting omit list includes `'dev'`, then the `NODE_ENV` environment
141 +variable will be set to `'production'` for all lifecycle scripts.
142 +
143 +<!-- automatically generated, do not edit manually -->
144 +<!-- see lib/utils/config/definitions.js -->
145 +
146 #### `strict-peer-deps`
147
148 * Default: false
@@ -161,23 +182,17 @@ This configuration does not affect `npm ci`.
182 <!-- automatically generated, do not edit manually -->
183 <!-- see lib/utils/config/definitions.js -->
184
164 -#### `omit`
165 -
166 -* Default: 'dev' if the `NODE_ENV` environment variable is set to
167 - 'production', otherwise empty.
168 -* Type: "dev", "optional", or "peer" (can be set multiple times)
169 -
170 -Dependency types to omit from the installation tree on disk.
185 +#### `foreground-scripts`
186
172 -Note that these dependencies _are_ still resolved and added to the
173 -`package-lock.json` or `npm-shrinkwrap.json` file. They are just not
174 -physically installed on disk.
187 +* Default: false
188 +* Type: Boolean
189
176 -If a package type appears in both the `--include` and `--omit` lists, then
177 -it will be included.
190 +Run all build scripts (ie, `preinstall`, `install`, and `postinstall`)
191 +scripts for installed packages in the foreground process, sharing standard
192 +input, output, and error with the main npm process.
193
179 -If the resulting omit list includes `'dev'`, then the `NODE_ENV` environment
180 -variable will be set to `'production'` for all lifecycle scripts.
194 +Note that this will generally make installs run slower, and be much noisier,
195 +but can be useful for debugging.
196
197 <!-- automatically generated, do not edit manually -->
198 <!-- see lib/utils/config/definitions.js -->
content/cli/v8/commands/npm-install.md
+30 -15
@@ -33,7 +33,7 @@ npm install <tarball url>
33 npm install <git:// url>
34 npm install <github username>/<github project>
35
36 -aliases: i, in, ins, inst, insta, instal, isnt, isnta, isntal, add
36 +aliases: i, in, ins, inst, insta, instal, isnt, isnta, isntal, isntall, add
37 ```
38
39 <!-- automatically generated, do not edit manually -->
@@ -513,6 +513,27 @@ will be preferred.
513 <!-- automatically generated, do not edit manually -->
514 <!-- see lib/utils/config/definitions.js -->
515
516 +#### `omit`
517 +
518 +* Default: 'dev' if the `NODE_ENV` environment variable is set to
519 + 'production', otherwise empty.
520 +* Type: "dev", "optional", or "peer" (can be set multiple times)
521 +
522 +Dependency types to omit from the installation tree on disk.
523 +
524 +Note that these dependencies _are_ still resolved and added to the
525 +`package-lock.json` or `npm-shrinkwrap.json` file. They are just not
526 +physically installed on disk.
527 +
528 +If a package type appears in both the `--include` and `--omit` lists, then
529 +it will be included.
530 +
531 +If the resulting omit list includes `'dev'`, then the `NODE_ENV` environment
532 +variable will be set to `'production'` for all lifecycle scripts.
533 +
534 +<!-- automatically generated, do not edit manually -->
535 +<!-- see lib/utils/config/definitions.js -->
536 +
537 #### `strict-peer-deps`
538
539 * Default: false
@@ -552,23 +573,17 @@ This configuration does not affect `npm ci`.
573 <!-- automatically generated, do not edit manually -->
574 <!-- see lib/utils/config/definitions.js -->
575
555 -#### `omit`
556 -
557 -* Default: 'dev' if the `NODE_ENV` environment variable is set to
558 - 'production', otherwise empty.
559 -* Type: "dev", "optional", or "peer" (can be set multiple times)
560 -
561 -Dependency types to omit from the installation tree on disk.
576 +#### `foreground-scripts`
577
563 -Note that these dependencies _are_ still resolved and added to the
564 -`package-lock.json` or `npm-shrinkwrap.json` file. They are just not
565 -physically installed on disk.
578 +* Default: false
579 +* Type: Boolean
580
567 -If a package type appears in both the `--include` and `--omit` lists, then
568 -it will be included.
581 +Run all build scripts (ie, `preinstall`, `install`, and `postinstall`)
582 +scripts for installed packages in the foreground process, sharing standard
583 +input, output, and error with the main npm process.
584
570 -If the resulting omit list includes `'dev'`, then the `NODE_ENV` environment
571 -variable will be set to `'production'` for all lifecycle scripts.
585 +Note that this will generally make installs run slower, and be much noisier,
586 +but can be useful for debugging.
587
588 <!-- automatically generated, do not edit manually -->
589 <!-- see lib/utils/config/definitions.js -->
content/cli/v8/commands/npm-pkg.md
+3
@@ -24,6 +24,8 @@ github_path: docs/content/commands/npm-pkg.md
24 npm pkg set <key>=<value> [<key>=<value> ...]
25 npm pkg get [<key> [<key> ...]]
26 npm pkg delete <key> [<key> ...]
27 +npm pkg set [<array>[<index>].<key>=<value> ...]
28 +npm pkg set [<array>[].<key>=<value> ...]
29 ```
30
31 <!-- automatically generated, do not edit manually -->
@@ -207,6 +209,7 @@ mistakes, unnecessary performance degradation, and malicious input.
209 * Allow conflicting peerDependencies to be installed in the root project.
210 * Implicitly set `--yes` during `npm init`.
211 * Allow clobbering existing values in `npm pkg`
212 +* Allow unpublishing of entire packages (not just a single version).
213
214 If you don't have a clear idea of what you want to do, it is strongly
215 recommended that you do not use this option!
content/cli/v8/commands/npm-prune.md
+30
@@ -109,6 +109,36 @@ Not supported by all npm commands.
109 <!-- automatically generated, do not edit manually -->
110 <!-- see lib/utils/config/definitions.js -->
111
112 +#### `foreground-scripts`
113 +
114 +* Default: false
115 +* Type: Boolean
116 +
117 +Run all build scripts (ie, `preinstall`, `install`, and `postinstall`)
118 +scripts for installed packages in the foreground process, sharing standard
119 +input, output, and error with the main npm process.
120 +
121 +Note that this will generally make installs run slower, and be much noisier,
122 +but can be useful for debugging.
123 +
124 +<!-- automatically generated, do not edit manually -->
125 +<!-- see lib/utils/config/definitions.js -->
126 +
127 +#### `ignore-scripts`
128 +
129 +* Default: false
130 +* Type: Boolean
131 +
132 +If true, npm does not run scripts specified in package.json files.
133 +
134 +Note that commands explicitly intended to run a particular script, such as
135 +`npm start`, `npm stop`, `npm restart`, `npm test`, and `npm run-script`
136 +will still run their intended script if `ignore-scripts` is set, but they
137 +will *not* run any pre- or post-scripts.
138 +
139 +<!-- automatically generated, do not edit manually -->
140 +<!-- see lib/utils/config/definitions.js -->
141 +
142 #### `workspace`
143
144 * Default:
content/cli/v8/commands/npm-rebuild.md
+15
@@ -80,6 +80,21 @@ systems.
80 <!-- automatically generated, do not edit manually -->
81 <!-- see lib/utils/config/definitions.js -->
82
83 +#### `foreground-scripts`
84 +
85 +* Default: false
86 +* Type: Boolean
87 +
88 +Run all build scripts (ie, `preinstall`, `install`, and `postinstall`)
89 +scripts for installed packages in the foreground process, sharing standard
90 +input, output, and error with the main npm process.
91 +
92 +Note that this will generally make installs run slower, and be much noisier,
93 +but can be useful for debugging.
94 +
95 +<!-- automatically generated, do not edit manually -->
96 +<!-- see lib/utils/config/definitions.js -->
97 +
98 #### `ignore-scripts`
99
100 * Default: false
content/cli/v8/commands/npm-unpublish.md
+12 -10
@@ -16,21 +16,22 @@ github_path: docs/content/commands/npm-unpublish.md
16
17 ### Synopsis
18
19 -To learn more about how the npm registry treats unpublish, see our <a
20 -href="https://docs.npmjs.com/policies/unpublish" target="_blank"
21 -rel="noopener noreferrer"> unpublish policies</a>
22 -
23 -#### Unpublishing a single version of a package
19 +<!-- AUTOGENERATED USAGE DESCRIPTIONS START -->
20 +<!-- automatically generated, do not edit manually -->
21 +<!-- see lib/commands/unpublish.js -->
22
23 ```bash
26 -npm unpublish [<@scope>/]<pkg>@<version>
24 +npm unpublish [<@scope>/]<pkg>[@<version>]
25 ```
26
29 -#### Unpublishing an entire package
27 +<!-- automatically generated, do not edit manually -->
28 +<!-- see lib/commands/unpublish.js -->
29 +
30 +<!-- AUTOGENERATED USAGE DESCRIPTIONS END -->
31
31 -```bash
32 -npm unpublish [<@scope>/]<pkg> --force
33 -```
32 +To learn more about how the npm registry treats unpublish, see our <a
33 +href="https://docs.npmjs.com/policies/unpublish" target="_blank"
34 +rel="noopener noreferrer"> unpublish policies</a>
35
36 ### Warning
37
@@ -97,6 +98,7 @@ mistakes, unnecessary performance degradation, and malicious input.
98 * Allow conflicting peerDependencies to be installed in the root project.
99 * Implicitly set `--yes` during `npm init`.
100 * Allow clobbering existing values in `npm pkg`
101 +* Allow unpublishing of entire packages (not just a single version).
102
103 If you don't have a clear idea of what you want to do, it is strongly
104 recommended that you do not use this option!
content/cli/v8/commands/npm-update.md
+44 -29
@@ -179,6 +179,22 @@ be _downgraded_.
179 <!-- AUTOGENERATED CONFIG DESCRIPTIONS START -->
180 <!-- automatically generated, do not edit manually -->
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`
186 +* Type: Boolean
187 +
188 +Save installed packages to a `package.json` file as dependencies.
189 +
190 +When used with the `npm rm` command, removes the dependency from
191 +`package.json`.
192 +
193 +Will also prevent writing to `package-lock.json` if set to `false`.
194 +
195 +<!-- automatically generated, do not edit manually -->
196 +<!-- see lib/utils/config/definitions.js -->
197 +
198 #### `global`
199
200 * Default: false
@@ -224,6 +240,27 @@ will be preferred.
240 <!-- automatically generated, do not edit manually -->
241 <!-- see lib/utils/config/definitions.js -->
242
243 +#### `omit`
244 +
245 +* Default: 'dev' if the `NODE_ENV` environment variable is set to
246 + 'production', otherwise empty.
247 +* Type: "dev", "optional", or "peer" (can be set multiple times)
248 +
249 +Dependency types to omit from the installation tree on disk.
250 +
251 +Note that these dependencies _are_ still resolved and added to the
252 +`package-lock.json` or `npm-shrinkwrap.json` file. They are just not
253 +physically installed on disk.
254 +
255 +If a package type appears in both the `--include` and `--omit` lists, then
256 +it will be included.
257 +
258 +If the resulting omit list includes `'dev'`, then the `NODE_ENV` environment
259 +variable will be set to `'production'` for all lifecycle scripts.
260 +
261 +<!-- automatically generated, do not edit manually -->
262 +<!-- see lib/utils/config/definitions.js -->
263 +
264 #### `strict-peer-deps`
265
266 * Default: false
@@ -263,39 +300,17 @@ This configuration does not affect `npm ci`.
300 <!-- automatically generated, do not edit manually -->
301 <!-- see lib/utils/config/definitions.js -->
302
266 -#### `save`
303 +#### `foreground-scripts`
304
268 -* Default: `true` unless when using `npm update` or `npm dedupe` where it
269 - defaults to `false`
305 +* Default: false
306 * Type: Boolean
307
272 -Save installed packages to a `package.json` file as dependencies.
308 +Run all build scripts (ie, `preinstall`, `install`, and `postinstall`)
309 +scripts for installed packages in the foreground process, sharing standard
310 +input, output, and error with the main npm process.
311
274 -When used with the `npm rm` command, removes the dependency from
275 -`package.json`.
276 -
277 -Will also prevent writing to `package-lock.json` if set to `false`.
278 -
279 -<!-- automatically generated, do not edit manually -->
280 -<!-- see lib/utils/config/definitions.js -->
281 -
282 -#### `omit`
283 -
284 -* Default: 'dev' if the `NODE_ENV` environment variable is set to
285 - 'production', otherwise empty.
286 -* Type: "dev", "optional", or "peer" (can be set multiple times)
287 -
288 -Dependency types to omit from the installation tree on disk.
289 -
290 -Note that these dependencies _are_ still resolved and added to the
291 -`package-lock.json` or `npm-shrinkwrap.json` file. They are just not
292 -physically installed on disk.
293 -
294 -If a package type appears in both the `--include` and `--omit` lists, then
295 -it will be included.
296 -
297 -If the resulting omit list includes `'dev'`, then the `NODE_ENV` environment
298 -variable will be set to `'production'` for all lifecycle scripts.
312 +Note that this will generally make installs run slower, and be much noisier,
313 +but can be useful for debugging.
314
315 <!-- automatically generated, do not edit manually -->
316 <!-- see lib/utils/config/definitions.js -->
content/cli/v8/commands/npm-version.md
+2 -1
@@ -62,7 +62,8 @@ Run git commit hooks when using the `npm version` command.
62 * Default: true
63 * Type: Boolean
64
65 -Tag the commit when using the `npm version` command.
65 +Tag the commit when using the `npm version` command. Setting this to false
66 +results in no commit being made at all.
67
68 <!-- automatically generated, do not edit manually -->
69 <!-- see lib/utils/config/definitions.js -->
content/cli/v8/configuring-npm/package-json.md
+4
@@ -700,6 +700,10 @@ This feature is helpful for local offline development and creating tests
700 that require npm installing where you don't want to hit an external server,
701 but should not be used when publishing packages to the public registry.
702
703 +*note*: Packages linked by local path will not have their own
704 +dependencies installed when `npm install` is ran in this case. You must
705 +run `npm install` from inside the local path itself.
706 +
707 ### devDependencies
708
709 If someone is planning on downloading and using your module in their
content/cli/v8/using-npm/config.md
+3 -1
@@ -624,6 +624,7 @@ mistakes, unnecessary performance degradation, and malicious input.
624 * Allow conflicting peerDependencies to be installed in the root project.
625 * Implicitly set `--yes` during `npm init`.
626 * Allow clobbering existing values in `npm pkg`
627 +* Allow unpublishing of entire packages (not just a single version).
628
629 If you don't have a clear idea of what you want to do, it is strongly
630 recommended that you do not use this option!
@@ -685,7 +686,8 @@ but is not in the `PATH`, then set this to the full path to the git binary.
686 * Default: true
687 * Type: Boolean
688
688 -Tag the commit when using the `npm version` command.
689 +Tag the commit when using the `npm version` command. Setting this to false
690 +results in no commit being made at all.
691
692 <!-- automatically generated, do not edit manually -->
693 <!-- see lib/utils/config/definitions.js -->