Skip to content

Commit 3ac703c

Browse files
siemhesdasiemhesda
authoredSep 26, 2023
docs: add include param to commands that have omit param (#6831)
·
v11.2.0arborist-v7.2.0
1 parent 6500218 commit 3ac703c

File tree

11 files changed

+46
-12
lines changed

11 files changed

+46
-12
lines changed
 

‎lib/commands/audit.js

+1
Original file line numberDiff line numberDiff line change
@@ -406,6 +406,7 @@ class Audit extends ArboristWorkspaceCmd {
406406
'package-lock-only',
407407
'package-lock',
408408
'omit',
409+
'include',
409410
'foreground-scripts',
410411
'ignore-scripts',
411412
...super.params,

‎lib/commands/ci.js

+1
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ class CI extends ArboristWorkspaceCmd {
1616
'legacy-bundling',
1717
'global-style',
1818
'omit',
19+
'include',
1920
'strict-peer-deps',
2021
'foreground-scripts',
2122
'ignore-scripts',

‎lib/commands/dedupe.js

+1
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ class Dedupe extends ArboristWorkspaceCmd {
1313
'strict-peer-deps',
1414
'package-lock',
1515
'omit',
16+
'include',
1617
'ignore-scripts',
1718
'audit',
1819
'bin-links',

‎lib/commands/find-dupes.js

+1
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ class FindDupes extends ArboristWorkspaceCmd {
1111
'strict-peer-deps',
1212
'package-lock',
1313
'omit',
14+
'include',
1415
'ignore-scripts',
1516
'audit',
1617
'bin-links',

‎lib/commands/install.js

+1
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,7 @@ class Install extends ArboristWorkspaceCmd {
2424
'legacy-bundling',
2525
'global-style',
2626
'omit',
27+
'include',
2728
'strict-peer-deps',
2829
'prefer-dedupe',
2930
'package-lock',

‎lib/commands/link.js

+1
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,7 @@ class Link extends ArboristWorkspaceCmd {
2727
'strict-peer-deps',
2828
'package-lock',
2929
'omit',
30+
'include',
3031
'ignore-scripts',
3132
'audit',
3233
'bin-links',

‎lib/commands/ls.js

+1
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,7 @@ class LS extends ArboristWorkspaceCmd {
3232
'global',
3333
'depth',
3434
'omit',
35+
'include',
3536
'link',
3637
'package-lock-only',
3738
'unicode',

‎lib/commands/prune.js

+1
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ class Prune extends ArboristWorkspaceCmd {
77
static name = 'prune'
88
static params = [
99
'omit',
10+
'include',
1011
'dry-run',
1112
'json',
1213
'foreground-scripts',

‎lib/commands/update.js

+1
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ class Update extends ArboristWorkspaceCmd {
1616
'legacy-bundling',
1717
'global-style',
1818
'omit',
19+
'include',
1920
'strict-peer-deps',
2021
'package-lock',
2122
'foreground-scripts',

‎smoke-tests/tap-snapshots/test/index.js.test.cjs

+1
Original file line numberDiff line numberDiff line change
@@ -57,6 +57,7 @@ npm ERR!
5757
npm ERR! Options:
5858
npm ERR! [--install-strategy <hoisted|nested|shallow|linked>] [--legacy-bundling]
5959
npm ERR! [--global-style] [--omit <dev|optional|peer> [--omit <dev|optional|peer> ...]]
60+
npm ERR! [--include <prod|dev|optional|peer> [--include <prod|dev|optional|peer> ...]]
6061
npm ERR! [--strict-peer-deps] [--foreground-scripts] [--ignore-scripts] [--no-audit]
6162
npm ERR! [--no-bin-links] [--no-fund] [--dry-run]
6263
npm ERR! [-w|--workspace <workspace-name> [-w|--workspace <workspace-name> ...]]

‎tap-snapshots/test/lib/docs.js.test.cjs

+36-12
Original file line numberDiff line numberDiff line change
@@ -2554,6 +2554,7 @@ Options:
25542554
[--audit-level <info|low|moderate|high|critical|none>] [--dry-run] [-f|--force]
25552555
[--json] [--package-lock-only] [--no-package-lock]
25562556
[--omit <dev|optional|peer> [--omit <dev|optional|peer> ...]]
2557+
[--include <prod|dev|optional|peer> [--include <prod|dev|optional|peer> ...]]
25572558
[--foreground-scripts] [--ignore-scripts]
25582559
[-w|--workspace <workspace-name> [-w|--workspace <workspace-name> ...]]
25592560
[-ws|--workspaces] [--include-workspace-root] [--install-links]
@@ -2571,6 +2572,7 @@ npm audit [fix|signatures]
25712572
#### \`package-lock-only\`
25722573
#### \`package-lock\`
25732574
#### \`omit\`
2575+
#### \`include\`
25742576
#### \`foreground-scripts\`
25752577
#### \`ignore-scripts\`
25762578
#### \`workspace\`
@@ -2642,6 +2644,7 @@ npm ci
26422644
Options:
26432645
[--install-strategy <hoisted|nested|shallow|linked>] [--legacy-bundling]
26442646
[--global-style] [--omit <dev|optional|peer> [--omit <dev|optional|peer> ...]]
2647+
[--include <prod|dev|optional|peer> [--include <prod|dev|optional|peer> ...]]
26452648
[--strict-peer-deps] [--foreground-scripts] [--ignore-scripts] [--no-audit]
26462649
[--no-bin-links] [--no-fund] [--dry-run]
26472650
[-w|--workspace <workspace-name> [-w|--workspace <workspace-name> ...]]
@@ -2661,6 +2664,7 @@ aliases: clean-install, ic, install-clean, isntall-clean
26612664
#### \`legacy-bundling\`
26622665
#### \`global-style\`
26632666
#### \`omit\`
2667+
#### \`include\`
26642668
#### \`strict-peer-deps\`
26652669
#### \`foreground-scripts\`
26662670
#### \`ignore-scripts\`
@@ -2739,8 +2743,9 @@ npm dedupe
27392743
Options:
27402744
[--install-strategy <hoisted|nested|shallow|linked>] [--legacy-bundling]
27412745
[--global-style] [--strict-peer-deps] [--no-package-lock]
2742-
[--omit <dev|optional|peer> [--omit <dev|optional|peer> ...]] [--ignore-scripts]
2743-
[--no-audit] [--no-bin-links] [--no-fund] [--dry-run]
2746+
[--omit <dev|optional|peer> [--omit <dev|optional|peer> ...]]
2747+
[--include <prod|dev|optional|peer> [--include <prod|dev|optional|peer> ...]]
2748+
[--ignore-scripts] [--no-audit] [--no-bin-links] [--no-fund] [--dry-run]
27442749
[-w|--workspace <workspace-name> [-w|--workspace <workspace-name> ...]]
27452750
[-ws|--workspaces] [--include-workspace-root] [--install-links]
27462751
@@ -2760,6 +2765,7 @@ alias: ddp
27602765
#### \`strict-peer-deps\`
27612766
#### \`package-lock\`
27622767
#### \`omit\`
2768+
#### \`include\`
27632769
#### \`ignore-scripts\`
27642770
#### \`audit\`
27652771
#### \`bin-links\`
@@ -3010,8 +3016,9 @@ npm find-dupes
30103016
Options:
30113017
[--install-strategy <hoisted|nested|shallow|linked>] [--legacy-bundling]
30123018
[--global-style] [--strict-peer-deps] [--no-package-lock]
3013-
[--omit <dev|optional|peer> [--omit <dev|optional|peer> ...]] [--ignore-scripts]
3014-
[--no-audit] [--no-bin-links] [--no-fund]
3019+
[--omit <dev|optional|peer> [--omit <dev|optional|peer> ...]]
3020+
[--include <prod|dev|optional|peer> [--include <prod|dev|optional|peer> ...]]
3021+
[--ignore-scripts] [--no-audit] [--no-bin-links] [--no-fund]
30153022
[-w|--workspace <workspace-name> [-w|--workspace <workspace-name> ...]]
30163023
[-ws|--workspaces] [--include-workspace-root] [--install-links]
30173024
@@ -3027,6 +3034,7 @@ npm find-dupes
30273034
#### \`strict-peer-deps\`
30283035
#### \`package-lock\`
30293036
#### \`omit\`
3037+
#### \`include\`
30303038
#### \`ignore-scripts\`
30313039
#### \`audit\`
30323040
#### \`bin-links\`
@@ -3202,6 +3210,7 @@ Options:
32023210
[-E|--save-exact] [-g|--global]
32033211
[--install-strategy <hoisted|nested|shallow|linked>] [--legacy-bundling]
32043212
[--global-style] [--omit <dev|optional|peer> [--omit <dev|optional|peer> ...]]
3213+
[--include <prod|dev|optional|peer> [--include <prod|dev|optional|peer> ...]]
32053214
[--strict-peer-deps] [--prefer-dedupe] [--no-package-lock] [--package-lock-only]
32063215
[--foreground-scripts] [--ignore-scripts] [--no-audit] [--no-bin-links]
32073216
[--no-fund] [--dry-run] [--cpu <cpu>] [--os <os>]
@@ -3225,6 +3234,7 @@ aliases: add, i, in, ins, inst, insta, instal, isnt, isnta, isntal, isntall
32253234
#### \`legacy-bundling\`
32263235
#### \`global-style\`
32273236
#### \`omit\`
3237+
#### \`include\`
32283238
#### \`strict-peer-deps\`
32293239
#### \`prefer-dedupe\`
32303240
#### \`package-lock\`
@@ -3252,6 +3262,7 @@ npm install-ci-test
32523262
Options:
32533263
[--install-strategy <hoisted|nested|shallow|linked>] [--legacy-bundling]
32543264
[--global-style] [--omit <dev|optional|peer> [--omit <dev|optional|peer> ...]]
3265+
[--include <prod|dev|optional|peer> [--include <prod|dev|optional|peer> ...]]
32553266
[--strict-peer-deps] [--foreground-scripts] [--ignore-scripts] [--no-audit]
32563267
[--no-bin-links] [--no-fund] [--dry-run]
32573268
[-w|--workspace <workspace-name> [-w|--workspace <workspace-name> ...]]
@@ -3271,6 +3282,7 @@ aliases: cit, clean-install-test, sit
32713282
#### \`legacy-bundling\`
32723283
#### \`global-style\`
32733284
#### \`omit\`
3285+
#### \`include\`
32743286
#### \`strict-peer-deps\`
32753287
#### \`foreground-scripts\`
32763288
#### \`ignore-scripts\`
@@ -3295,6 +3307,7 @@ Options:
32953307
[-E|--save-exact] [-g|--global]
32963308
[--install-strategy <hoisted|nested|shallow|linked>] [--legacy-bundling]
32973309
[--global-style] [--omit <dev|optional|peer> [--omit <dev|optional|peer> ...]]
3310+
[--include <prod|dev|optional|peer> [--include <prod|dev|optional|peer> ...]]
32983311
[--strict-peer-deps] [--prefer-dedupe] [--no-package-lock] [--package-lock-only]
32993312
[--foreground-scripts] [--ignore-scripts] [--no-audit] [--no-bin-links]
33003313
[--no-fund] [--dry-run] [--cpu <cpu>] [--os <os>]
@@ -3318,6 +3331,7 @@ alias: it
33183331
#### \`legacy-bundling\`
33193332
#### \`global-style\`
33203333
#### \`omit\`
3334+
#### \`include\`
33213335
#### \`strict-peer-deps\`
33223336
#### \`prefer-dedupe\`
33233337
#### \`package-lock\`
@@ -3347,8 +3361,9 @@ Options:
33473361
[-E|--save-exact] [-g|--global]
33483362
[--install-strategy <hoisted|nested|shallow|linked>] [--legacy-bundling]
33493363
[--global-style] [--strict-peer-deps] [--no-package-lock]
3350-
[--omit <dev|optional|peer> [--omit <dev|optional|peer> ...]] [--ignore-scripts]
3351-
[--no-audit] [--no-bin-links] [--no-fund] [--dry-run]
3364+
[--omit <dev|optional|peer> [--omit <dev|optional|peer> ...]]
3365+
[--include <prod|dev|optional|peer> [--include <prod|dev|optional|peer> ...]]
3366+
[--ignore-scripts] [--no-audit] [--no-bin-links] [--no-fund] [--dry-run]
33523367
[-w|--workspace <workspace-name> [-w|--workspace <workspace-name> ...]]
33533368
[-ws|--workspaces] [--include-workspace-root] [--install-links]
33543369
@@ -3371,6 +3386,7 @@ alias: ln
33713386
#### \`strict-peer-deps\`
33723387
#### \`package-lock\`
33733388
#### \`omit\`
3389+
#### \`include\`
33743390
#### \`ignore-scripts\`
33753391
#### \`audit\`
33763392
#### \`bin-links\`
@@ -3390,8 +3406,9 @@ npm ll [[<@scope>/]<pkg> ...]
33903406
33913407
Options:
33923408
[-a|--all] [--json] [-l|--long] [-p|--parseable] [-g|--global] [--depth <depth>]
3393-
[--omit <dev|optional|peer> [--omit <dev|optional|peer> ...]] [--link]
3394-
[--package-lock-only] [--unicode]
3409+
[--omit <dev|optional|peer> [--omit <dev|optional|peer> ...]]
3410+
[--include <prod|dev|optional|peer> [--include <prod|dev|optional|peer> ...]]
3411+
[--link] [--package-lock-only] [--unicode]
33953412
[-w|--workspace <workspace-name> [-w|--workspace <workspace-name> ...]]
33963413
[-ws|--workspaces] [--include-workspace-root] [--install-links]
33973414
@@ -3412,6 +3429,7 @@ alias: la
34123429
#### \`global\`
34133430
#### \`depth\`
34143431
#### \`omit\`
3432+
#### \`include\`
34153433
#### \`link\`
34163434
#### \`package-lock-only\`
34173435
#### \`unicode\`
@@ -3472,8 +3490,9 @@ npm ls <package-spec>
34723490
34733491
Options:
34743492
[-a|--all] [--json] [-l|--long] [-p|--parseable] [-g|--global] [--depth <depth>]
3475-
[--omit <dev|optional|peer> [--omit <dev|optional|peer> ...]] [--link]
3476-
[--package-lock-only] [--unicode]
3493+
[--omit <dev|optional|peer> [--omit <dev|optional|peer> ...]]
3494+
[--include <prod|dev|optional|peer> [--include <prod|dev|optional|peer> ...]]
3495+
[--link] [--package-lock-only] [--unicode]
34773496
[-w|--workspace <workspace-name> [-w|--workspace <workspace-name> ...]]
34783497
[-ws|--workspaces] [--include-workspace-root] [--install-links]
34793498
@@ -3494,6 +3513,7 @@ alias: list
34943513
#### \`global\`
34953514
#### \`depth\`
34963515
#### \`omit\`
3516+
#### \`include\`
34973517
#### \`link\`
34983518
#### \`package-lock-only\`
34993519
#### \`unicode\`
@@ -3744,8 +3764,9 @@ Usage:
37443764
npm prune [[<@scope>/]<pkg>...]
37453765
37463766
Options:
3747-
[--omit <dev|optional|peer> [--omit <dev|optional|peer> ...]] [--dry-run]
3748-
[--json] [--foreground-scripts] [--ignore-scripts]
3767+
[--omit <dev|optional|peer> [--omit <dev|optional|peer> ...]]
3768+
[--include <prod|dev|optional|peer> [--include <prod|dev|optional|peer> ...]]
3769+
[--dry-run] [--json] [--foreground-scripts] [--ignore-scripts]
37493770
[-w|--workspace <workspace-name> [-w|--workspace <workspace-name> ...]]
37503771
[-ws|--workspaces] [--include-workspace-root] [--install-links]
37513772
@@ -3756,6 +3777,7 @@ npm prune [[<@scope>/]<pkg>...]
37563777
\`\`\`
37573778
37583779
#### \`omit\`
3780+
#### \`include\`
37593781
#### \`dry-run\`
37603782
#### \`json\`
37613783
#### \`foreground-scripts\`
@@ -4265,6 +4287,7 @@ Options:
42654287
[-g|--global] [--install-strategy <hoisted|nested|shallow|linked>]
42664288
[--legacy-bundling] [--global-style]
42674289
[--omit <dev|optional|peer> [--omit <dev|optional|peer> ...]]
4290+
[--include <prod|dev|optional|peer> [--include <prod|dev|optional|peer> ...]]
42684291
[--strict-peer-deps] [--no-package-lock] [--foreground-scripts]
42694292
[--ignore-scripts] [--no-audit] [--no-bin-links] [--no-fund] [--dry-run]
42704293
[-w|--workspace <workspace-name> [-w|--workspace <workspace-name> ...]]
@@ -4286,6 +4309,7 @@ aliases: up, upgrade, udpate
42864309
#### \`legacy-bundling\`
42874310
#### \`global-style\`
42884311
#### \`omit\`
4312+
#### \`include\`
42894313
#### \`strict-peer-deps\`
42904314
#### \`package-lock\`
42914315
#### \`foreground-scripts\`

0 commit comments

Comments
 (0)
Please sign in to comment.