Skip to content

Commit 6efac6e

Browse files
JamieMageeMichael Smith
authored andcommitted
fix(config): clarify --all help so it's accurate for approve-scripts and deny-scripts
1 parent b97edc0 commit 6efac6e

2 files changed

Lines changed: 16 additions & 14 deletions

File tree

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

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -210,9 +210,10 @@ The value \`private\` is an alias for \`restricted\`.
210210
* Default: false
211211
* Type: Boolean
212212
213-
When running \`npm outdated\` and \`npm ls\`, setting \`--all\` will show all
214-
outdated or installed packages, rather than only those directly depended
215-
upon by the current project.
213+
Show or act on all packages, not just the ones your project directly depends
214+
on. For \`npm outdated\` and \`npm ls\` this lists every outdated or installed
215+
package. For \`npm approve-scripts\` and \`npm deny-scripts\` it selects every
216+
package with pending install scripts.
216217
217218
218219
@@ -3019,7 +3020,7 @@ Options:
30193020
[-a|--all] [--allow-scripts-pending] [--no-allow-scripts-pin] [--json]
30203021
30213022
-a|--all
3022-
When running \`npm outdated\` and \`npm ls\`, setting \`--all\` will show
3023+
Show or act on all packages, not just the ones your project directly
30233024
30243025
--allow-scripts-pending
30253026
List packages with install scripts that are not yet covered by the
@@ -3532,7 +3533,7 @@ Options:
35323533
[-a|--all] [--allow-scripts-pending] [--no-allow-scripts-pin] [--json]
35333534
35343535
-a|--all
3535-
When running \`npm outdated\` and \`npm ls\`, setting \`--all\` will show
3536+
Show or act on all packages, not just the ones your project directly
35363537
35373538
--allow-scripts-pending
35383539
List packages with install scripts that are not yet covered by the
@@ -4807,7 +4808,7 @@ Options:
48074808
[--workspaces] [--include-workspace-root] [--install-links]
48084809
48094810
-a|--all
4810-
When running \`npm outdated\` and \`npm ls\`, setting \`--all\` will show
4811+
Show or act on all packages, not just the ones your project directly
48114812
48124813
--json
48134814
Whether or not to output JSON data, rather than the normal output.
@@ -4954,7 +4955,7 @@ Options:
49544955
[--workspaces] [--include-workspace-root] [--install-links]
49554956
49564957
-a|--all
4957-
When running \`npm outdated\` and \`npm ls\`, setting \`--all\` will show
4958+
Show or act on all packages, not just the ones your project directly
49584959
49594960
--json
49604961
Whether or not to output JSON data, rather than the normal output.
@@ -5103,7 +5104,7 @@ Options:
51035104
[--before <date>] [--min-release-age <days>]
51045105
51055106
-a|--all
5106-
When running \`npm outdated\` and \`npm ls\`, setting \`--all\` will show
5107+
Show or act on all packages, not just the ones your project directly
51075108
51085109
--json
51095110
Whether or not to output JSON data, rather than the normal output.

workspaces/config/lib/definitions/definitions.js

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -178,9 +178,10 @@ const definitions = {
178178
type: Boolean,
179179
short: 'a',
180180
description: `
181-
When running \`npm outdated\` and \`npm ls\`, setting \`--all\` will show
182-
all outdated or installed packages, rather than only those directly
183-
depended upon by the current project.
181+
Show or act on all packages, not just the ones your project directly
182+
depends on. For \`npm outdated\` and \`npm ls\` this lists every outdated
183+
or installed package. For \`npm approve-scripts\` and \`npm deny-scripts\`
184+
it selects every package with pending install scripts.
184185
`,
185186
flatten,
186187
}),
@@ -2347,13 +2348,13 @@ const definitions = {
23472348
If you ask npm to install a package and don't tell it a specific version,
23482349
then it will install the specified tag.
23492350
2350-
It is the tag added to the package@version specified in the
2351+
It is the tag added to the package@version specified in the
23512352
\`npm dist-tag add\` command, if no explicit tag is given.
23522353
23532354
When used by the \`npm diff\` command, this is the tag used to fetch the
23542355
tarball that will be compared with the local files by default.
2355-
2356-
If used in the \`npm publish\` command, this is the tag that will be
2356+
2357+
If used in the \`npm publish\` command, this is the tag that will be
23572358
added to the package submitted to the registry.
23582359
`,
23592360
flatten (key, obj, flatOptions) {

0 commit comments

Comments
 (0)