fix(usage): better audit/boolean flag usage output #3497
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
wraithgar
force-pushed
the
gar/ci-audit-param
branch
from
a82b5a7
to
35d4eac
Compare
|
Added a hard-coded usage for |
darcyclarke
added
Release 7.x
nlf
approved these changes
Jul 12, 2021
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
wraithgar
force-pushed
the
gar/ci-audit-param
branch
from
35d4eac
to
89483e8
Compare
Merged
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This adds the
auditconfig item to the usage output ofnpm ci, andalso tweaks how usage flags are shown for boolean options that do not
default to false. Their usage is shown as the
--no-xform of the flagto better communicate that the flag is needed to turn that normally true
option OFF.
The description of
auditwas also updated to reflect that it runs onmany 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-testnot try to redefine its ownusage, but to inherit from
ciwas also included.References
Closes #2703