Skip to content

Commit 89483e8

Browse files
wraithgarwraithgar
committed
fix(usage): better audit/boolean flag usage output
This adds the `audit` config item to the usage output of `npm ci`, and also tweaks how usage flags are shown for boolean options that do not default to false. Their usage is shown as the `--no-x` form of the flag to better communicate that the flag is needed to turn that normally true option OFF. The description of `audit` was also updated to reflect that it runs on many different npm commands, not just install. Because this flag is included in the usage of those commands it's best to let the assocation happen there instead of trying to be comprehensive in the description itself. A small fix to make `install-ci-test` not try to redefine its own usage, but to inherit from `ci` was also included. PR-URL: #3497 Credit: @wraithgar Close: #3497 Reviewed-by: @nlf
1 parent c3bd10e commit 89483e8

18 files changed

Lines changed: 135 additions & 87 deletions

‎docs/content/commands/npm-ci.md‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -69,6 +69,16 @@ cache:
6969

7070
<!-- AUTOGENERATED CONFIG DESCRIPTIONS START -->
7171
<!-- automatically generated, do not edit manually -->
72+
#### `audit`
73+
74+
* Default: true
75+
* Type: Boolean
76+
77+
When "true" submit audit reports alongside the current npm command to the
78+
default registry and all registries configured for scopes. See the
79+
documentation for [`npm audit`](/commands/npm-audit) for details on what is
80+
submitted.
81+
7282
#### `ignore-scripts`
7383

7484
* Default: false

‎docs/content/commands/npm-dedupe.md‎

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -164,9 +164,10 @@ will *not* run any pre- or post-scripts.
164164
* Default: true
165165
* Type: Boolean
166166
167-
When "true" submit audit reports alongside `npm install` runs to the default
168-
registry and all registries configured for scopes. See the documentation for
169-
[`npm audit`](/commands/npm-audit) for details on what is submitted.
167+
When "true" submit audit reports alongside the current npm command to the
168+
default registry and all registries configured for scopes. See the
169+
documentation for [`npm audit`](/commands/npm-audit) for details on what is
170+
submitted.
170171
171172
#### `bin-links`
172173

‎docs/content/commands/npm-find-dupes.md‎

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -107,9 +107,10 @@ will *not* run any pre- or post-scripts.
107107
* Default: true
108108
* Type: Boolean
109109

110-
When "true" submit audit reports alongside `npm install` runs to the default
111-
registry and all registries configured for scopes. See the documentation for
112-
[`npm audit`](/commands/npm-audit) for details on what is submitted.
110+
When "true" submit audit reports alongside the current npm command to the
111+
default registry and all registries configured for scopes. See the
112+
documentation for [`npm audit`](/commands/npm-audit) for details on what is
113+
submitted.
113114

114115
#### `bin-links`
115116

‎docs/content/commands/npm-install-ci-test.md‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,16 @@ This command runs `npm ci` followed immediately by `npm test`.
2020

2121
<!-- AUTOGENERATED CONFIG DESCRIPTIONS START -->
2222
<!-- automatically generated, do not edit manually -->
23+
#### `audit`
24+
25+
* Default: true
26+
* Type: Boolean
27+
28+
When "true" submit audit reports alongside the current npm command to the
29+
default registry and all registries configured for scopes. See the
30+
documentation for [`npm audit`](/commands/npm-audit) for details on what is
31+
submitted.
32+
2333
#### `ignore-scripts`
2434

2535
* Default: false

‎docs/content/commands/npm-install-test.md‎

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -149,9 +149,10 @@ will *not* run any pre- or post-scripts.
149149
* Default: true
150150
* Type: Boolean
151151

152-
When "true" submit audit reports alongside `npm install` runs to the default
153-
registry and all registries configured for scopes. See the documentation for
154-
[`npm audit`](/commands/npm-audit) for details on what is submitted.
152+
When "true" submit audit reports alongside the current npm command to the
153+
default registry and all registries configured for scopes. See the
154+
documentation for [`npm audit`](/commands/npm-audit) for details on what is
155+
submitted.
155156

156157
#### `bin-links`
157158

‎docs/content/commands/npm-install.md‎

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -533,9 +533,10 @@ will *not* run any pre- or post-scripts.
533533
* Default: true
534534
* Type: Boolean
535535
536-
When "true" submit audit reports alongside `npm install` runs to the default
537-
registry and all registries configured for scopes. See the documentation for
538-
[`npm audit`](/commands/npm-audit) for details on what is submitted.
536+
When "true" submit audit reports alongside the current npm command to the
537+
default registry and all registries configured for scopes. See the
538+
documentation for [`npm audit`](/commands/npm-audit) for details on what is
539+
submitted.
539540
540541
#### `bin-links`
541542

‎docs/content/commands/npm-link.md‎

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -233,9 +233,10 @@ will *not* run any pre- or post-scripts.
233233
* Default: true
234234
* Type: Boolean
235235

236-
When "true" submit audit reports alongside `npm install` runs to the default
237-
registry and all registries configured for scopes. See the documentation for
238-
[`npm audit`](/commands/npm-audit) for details on what is submitted.
236+
When "true" submit audit reports alongside the current npm command to the
237+
default registry and all registries configured for scopes. See the
238+
documentation for [`npm audit`](/commands/npm-audit) for details on what is
239+
submitted.
239240

240241
#### `bin-links`
241242

‎docs/content/commands/npm-update.md‎

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -255,9 +255,10 @@ will *not* run any pre- or post-scripts.
255255
* Default: true
256256
* Type: Boolean
257257

258-
When "true" submit audit reports alongside `npm install` runs to the default
259-
registry and all registries configured for scopes. See the documentation for
260-
[`npm audit`](/commands/npm-audit) for details on what is submitted.
258+
When "true" submit audit reports alongside the current npm command to the
259+
default registry and all registries configured for scopes. See the
260+
documentation for [`npm audit`](/commands/npm-audit) for details on what is
261+
submitted.
261262

262263
#### `bin-links`
263264

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

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -170,9 +170,10 @@ to the same value as the current version.
170170
* Default: true
171171
* Type: Boolean
172172

173-
When "true" submit audit reports alongside `npm install` runs to the default
174-
registry and all registries configured for scopes. See the documentation for
175-
[`npm audit`](/commands/npm-audit) for details on what is submitted.
173+
When "true" submit audit reports alongside the current npm command to the
174+
default registry and all registries configured for scopes. See the
175+
documentation for [`npm audit`](/commands/npm-audit) for details on what is
176+
submitted.
176177

177178
#### `audit-level`
178179

‎lib/ci.js‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,7 @@ class CI extends ArboristWorkspaceCmd {
3333
/* istanbul ignore next - see test/lib/load-all-commands.js */
3434
static get params () {
3535
return [
36+
'audit',
3637
'ignore-scripts',
3738
'script-shell',
3839
]

0 commit comments

Comments
 (0)