chore: setup golangci-lint with a basic configuration
#262
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
This was referenced Nov 5, 2024
erikvarga
reviewed
Nov 6, 2024
.golangci.yaml
Outdated
| @@ -0,0 +1,92 @@ | |||
| # todo: this should match the configuration of osv-scanner for the most part | |||
There was a problem hiding this comment.
Create an issue for TODOs and link to the issue in the comment.
There was a problem hiding this comment.
Thanks! Can you change the todos in this doc to the format # TODO(#274): in that case?
There was a problem hiding this comment.
done! and I've made a note to check if there's a lint for that 😄
erikvarga
approved these changes
Nov 11, 2024
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 is a first step towards having a robust linting configuration based off what we have in
osv-scanner; currently, I've had to disable everything and then manually re-enable specific rules due to the linter throwing many type errors about something - I'm guessing it probably relates to the protobuffer stuff, even though I have been able to get that compiled locally.Regardless this should serve as a good starting point by having linting running and enforcing some lints, along with a commented out list of all the linters that we want to look at getting enabled to match the
osv-scannerconfiguration. I created this list by runninggo run github.com/golangci/golangci-lint/cmd/[email protected] linters, then manually commenting out each linter that has violations until everything was happy.The idea is eventually when all the kinks are worked out we should be able to completely replace this configuration with the one from
osv-scanner, meaning we shouldn't need to worry about e.g.enablevspresets.I will follow this PR up with more that tackle the individual rules, acknowledging there will be some that we probably want to discuss so I'll first try to weed out the ones that should be no-brainers to get enabled.
Relates to #158