Ignore comments and empty lines in excludes files #181
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
|
Another feature that would be helpful is if |
|
Looks good at initial glance. I will have a more thorough look soon The unmatched pattern reporting is a good idea too, I would probably want to put that behind a flag that can be used to audit the pattern file. |
echlebek
reviewed
Jul 6, 2020
main_test.go
Outdated
| func TestReadExcludesFailure(t *testing.T) { | ||
| _, err := readExcludes("testdata/notafile") | ||
| if err == nil { | ||
| t.Fatal("expected nil err, got:", err) |
There was a problem hiding this comment.
I think the test actually expects non-nil error?
This change gives uses a way to organize and document exclude entries. This is helpful for large codebases where it isn't obvious why a certain pattern isn't excluded.
|
I pushed a new commit that a) fixed the buggy test and b) eliminates an errcheck error I accidentally introduced. |
|
@kisielk did you want hold off on merging this until you have a look? |
|
Looks good to me. |
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 held off integrating errcheck into some projects for a while, because I really didn't want to add more false positives to my linters. The
-excludeflag gives me a clean way to runerrcheckand have everyone on the team easily use the same ignore settings.However, if we just add patterns to a file, over time it becomes very difficult to maintain. It isn't always obvious why we want to exclude a certain pattern. Comments and whitespace make it easier to organize the file in large projects.
Comments are also handy when debugging something, because you can temporarily comment something out and see if anything changes.
Note
I wrote this to ignore lines prefixed with
//. I'm not certain that's better than#because maybe it could conflict with future pattern recognition features you might add. But, I chose//anyway since that's what Go uses. I think it would make sense to change it, if someone thinks it might be a problem.