Implement --list-checks feature, to list the names of all available checks from the cli. #804
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
rodjek
force-pushed
the
feature/list_checks
branch
from
ed93573 to
b6b0d80
Compare
rodjek
force-pushed
the
feature/list_checks
branch
from
b6b0d80 to
1a2339c
Compare
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.
I was attempting to set a control comment to ignore a particular lint check the other day and was having a difficult time figuring out what exactly the check name should be in the
# lint:ignore:<check_name>comment. I ended up having to dig through the source code for the check in question to find the correct check name string to add to the comment, and thought it would be nice if there was an easier way to list these.They're sort of listed on the Puppet Lint - Checks page, but one has to infer the name of the check by looking at the pattern of the cli options strings, i.e. the actual name of the check is
--no-CHECK_NAME-check.This provides a simple flag to list out the checks with some basic documentation at the cli. Also includes an update to the README mentioning the feature, and an rspec test to make sure all checks are listed. All tests passing.