Skip to content

Commit dba7b58

Browse files
wraithgarwraithgar
committed
docs: add --save-bundle to --save usage output
1 parent 0cc9d4c commit dba7b58

File tree

6 files changed

+17
-17
lines changed

6 files changed

+17
-17
lines changed

‎docs/content/using-npm/config.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1351,7 +1351,7 @@ If a package would be saved at install time by the use of `--save`,
13511351
`--save-dev`, or `--save-optional`, then also put it in the
13521352
`bundleDependencies` list.
13531353

1354-
Ignore if `--save-peer` is set, since peerDependencies cannot be bundled.
1354+
Ignored if `--save-peer` is set, since peerDependencies cannot be bundled.
13551355

13561356
<!-- automatically generated, do not edit manually -->
13571357
<!-- see lib/utils/config/definitions.js -->

‎lib/utils/config/definitions.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1587,7 +1587,7 @@ define('save', {
15871587
default: true,
15881588
defaultDescription: `\`true\` unless when using \`npm update\` or
15891589
\`npm dedupe\` where it defaults to \`false\``,
1590-
usage: '-S|--save|--no-save|--save-prod|--save-dev|--save-optional|--save-peer',
1590+
usage: '-S|--save|--no-save|--save-prod|--save-dev|--save-optional|--save-peer|--save-bundle',
15911591
type: Boolean,
15921592
short: 'S',
15931593
description: `
@@ -1610,7 +1610,7 @@ define('save-bundle', {
16101610
\`--save-dev\`, or \`--save-optional\`, then also put it in the
16111611
\`bundleDependencies\` list.
16121612
1613-
Ignore if \`--save-peer\` is set, since peerDependencies cannot be bundled.
1613+
Ignored if \`--save-peer\` is set, since peerDependencies cannot be bundled.
16141614
`,
16151615
flatten (key, obj, flatOptions) {
16161616
// XXX update arborist to just ignore it if resulting saveType is peer

‎tap-snapshots/test/lib/load-all-commands.js.test.cjs

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -170,7 +170,7 @@ npm dedupe
170170
171171
Options:
172172
[--global-style] [--legacy-bundling] [--strict-peer-deps] [--no-package-lock]
173-
[-S|--save|--no-save|--save-prod|--save-dev|--save-optional|--save-peer]
173+
[-S|--save|--no-save|--save-prod|--save-dev|--save-optional|--save-peer|--save-bundle]
174174
[--omit <dev|optional|peer> [--omit <dev|optional|peer> ...]] [--ignore-scripts]
175175
[--no-audit] [--no-bin-links] [--no-fund] [--dry-run]
176176
[-w|--workspace <workspace-name> [-w|--workspace <workspace-name> ...]]
@@ -447,7 +447,7 @@ npm install <git:// url>
447447
npm install <github username>/<github project>
448448
449449
Options:
450-
[-S|--save|--no-save|--save-prod|--save-dev|--save-optional|--save-peer]
450+
[-S|--save|--no-save|--save-prod|--save-dev|--save-optional|--save-peer|--save-bundle]
451451
[-E|--save-exact] [-g|--global] [--global-style] [--legacy-bundling]
452452
[--strict-peer-deps] [--no-package-lock]
453453
[--omit <dev|optional|peer> [--omit <dev|optional|peer> ...]] [--ignore-scripts]
@@ -494,7 +494,7 @@ npm install-test <git:// url>
494494
npm install-test <github username>/<github project>
495495
496496
Options:
497-
[-S|--save|--no-save|--save-prod|--save-dev|--save-optional|--save-peer]
497+
[-S|--save|--no-save|--save-prod|--save-dev|--save-optional|--save-peer|--save-bundle]
498498
[-E|--save-exact] [-g|--global] [--global-style] [--legacy-bundling]
499499
[--strict-peer-deps] [--no-package-lock]
500500
[--omit <dev|optional|peer> [--omit <dev|optional|peer> ...]] [--ignore-scripts]
@@ -517,7 +517,7 @@ npm link (in package dir)
517517
npm link [<@scope>/]<pkg>[@<version>]
518518
519519
Options:
520-
[-S|--save|--no-save|--save-prod|--save-dev|--save-optional|--save-peer]
520+
[-S|--save|--no-save|--save-prod|--save-dev|--save-optional|--save-peer|--save-bundle]
521521
[-E|--save-exact] [-g|--global] [--global-style] [--legacy-bundling]
522522
[--strict-peer-deps] [--no-package-lock]
523523
[--omit <dev|optional|peer> [--omit <dev|optional|peer> ...]] [--ignore-scripts]
@@ -1013,7 +1013,7 @@ Usage:
10131013
npm uninstall [<@scope>/]<pkg>...
10141014
10151015
Options:
1016-
[-S|--save|--no-save|--save-prod|--save-dev|--save-optional|--save-peer]
1016+
[-S|--save|--no-save|--save-prod|--save-dev|--save-optional|--save-peer|--save-bundle]
10171017
[-w|--workspace <workspace-name> [-w|--workspace <workspace-name> ...]]
10181018
[-ws|--workspaces] [--include-workspace-root]
10191019
@@ -1063,7 +1063,7 @@ npm update [<pkg>...]
10631063
Options:
10641064
[-g|--global] [--global-style] [--legacy-bundling] [--strict-peer-deps]
10651065
[--no-package-lock]
1066-
[-S|--save|--no-save|--save-prod|--save-dev|--save-optional|--save-peer]
1066+
[-S|--save|--no-save|--save-prod|--save-dev|--save-optional|--save-peer|--save-bundle]
10671067
[--omit <dev|optional|peer> [--omit <dev|optional|peer> ...]] [--ignore-scripts]
10681068
[--no-audit] [--no-bin-links] [--no-fund] [--dry-run]
10691069
[-w|--workspace <workspace-name> [-w|--workspace <workspace-name> ...]]

‎tap-snapshots/test/lib/utils/config/definitions.js.test.cjs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1430,7 +1430,7 @@ If a package would be saved at install time by the use of \`--save\`,
14301430
\`--save-dev\`, or \`--save-optional\`, then also put it in the
14311431
\`bundleDependencies\` list.
14321432
1433-
Ignore if \`--save-peer\` is set, since peerDependencies cannot be bundled.
1433+
Ignored if \`--save-peer\` is set, since peerDependencies cannot be bundled.
14341434
`
14351435

14361436
exports[`test/lib/utils/config/definitions.js TAP > config description for save-dev 1`] = `

‎tap-snapshots/test/lib/utils/config/describe-all.js.test.cjs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1225,7 +1225,7 @@ If a package would be saved at install time by the use of \`--save\`,
12251225
\`--save-dev\`, or \`--save-optional\`, then also put it in the
12261226
\`bundleDependencies\` list.
12271227
1228-
Ignore if \`--save-peer\` is set, since peerDependencies cannot be bundled.
1228+
Ignored if \`--save-peer\` is set, since peerDependencies cannot be bundled.
12291229
12301230
<!-- automatically generated, do not edit manually -->
12311231
<!-- see lib/utils/config/definitions.js -->

‎tap-snapshots/test/lib/utils/npm-usage.js.test.cjs

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -311,7 +311,7 @@ All commands:
311311
312312
Options:
313313
[--global-style] [--legacy-bundling] [--strict-peer-deps] [--no-package-lock]
314-
[-S|--save|--no-save|--save-prod|--save-dev|--save-optional|--save-peer]
314+
[-S|--save|--no-save|--save-prod|--save-dev|--save-optional|--save-peer|--save-bundle]
315315
[--omit <dev|optional|peer> [--omit <dev|optional|peer> ...]] [--ignore-scripts]
316316
[--no-audit] [--no-bin-links] [--no-fund] [--dry-run]
317317
[-w|--workspace <workspace-name> [-w|--workspace <workspace-name> ...]]
@@ -556,7 +556,7 @@ All commands:
556556
npm install <github username>/<github project>
557557
558558
Options:
559-
[-S|--save|--no-save|--save-prod|--save-dev|--save-optional|--save-peer]
559+
[-S|--save|--no-save|--save-prod|--save-dev|--save-optional|--save-peer|--save-bundle]
560560
[-E|--save-exact] [-g|--global] [--global-style] [--legacy-bundling]
561561
[--strict-peer-deps] [--no-package-lock]
562562
[--omit <dev|optional|peer> [--omit <dev|optional|peer> ...]] [--ignore-scripts]
@@ -599,7 +599,7 @@ All commands:
599599
npm install-test <github username>/<github project>
600600
601601
Options:
602-
[-S|--save|--no-save|--save-prod|--save-dev|--save-optional|--save-peer]
602+
[-S|--save|--no-save|--save-prod|--save-dev|--save-optional|--save-peer|--save-bundle]
603603
[-E|--save-exact] [-g|--global] [--global-style] [--legacy-bundling]
604604
[--strict-peer-deps] [--no-package-lock]
605605
[--omit <dev|optional|peer> [--omit <dev|optional|peer> ...]] [--ignore-scripts]
@@ -620,7 +620,7 @@ All commands:
620620
npm link [<@scope>/]<pkg>[@<version>]
621621
622622
Options:
623-
[-S|--save|--no-save|--save-prod|--save-dev|--save-optional|--save-peer]
623+
[-S|--save|--no-save|--save-prod|--save-dev|--save-optional|--save-peer|--save-bundle]
624624
[-E|--save-exact] [-g|--global] [--global-style] [--legacy-bundling]
625625
[--strict-peer-deps] [--no-package-lock]
626626
[--omit <dev|optional|peer> [--omit <dev|optional|peer> ...]] [--ignore-scripts]
@@ -1054,7 +1054,7 @@ All commands:
10541054
npm uninstall [<@scope>/]<pkg>...
10551055
10561056
Options:
1057-
[-S|--save|--no-save|--save-prod|--save-dev|--save-optional|--save-peer]
1057+
[-S|--save|--no-save|--save-prod|--save-dev|--save-optional|--save-peer|--save-bundle]
10581058
[-w|--workspace <workspace-name> [-w|--workspace <workspace-name> ...]]
10591059
[-ws|--workspaces] [--include-workspace-root]
10601060
@@ -1098,7 +1098,7 @@ All commands:
10981098
Options:
10991099
[-g|--global] [--global-style] [--legacy-bundling] [--strict-peer-deps]
11001100
[--no-package-lock]
1101-
[-S|--save|--no-save|--save-prod|--save-dev|--save-optional|--save-peer]
1101+
[-S|--save|--no-save|--save-prod|--save-dev|--save-optional|--save-peer|--save-bundle]
11021102
[--omit <dev|optional|peer> [--omit <dev|optional|peer> ...]] [--ignore-scripts]
11031103
[--no-audit] [--no-bin-links] [--no-fund] [--dry-run]
11041104
[-w|--workspace <workspace-name> [-w|--workspace <workspace-name> ...]]

0 commit comments

Comments
 (0)