lint: Switch to golangci-lint #210
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
|
Thanks! |
adrianchiris
requested changes
Jul 12, 2022
|
@adrianchiris , @eoghanlawless I added a minimal configuration, containing the linter list. Do you think it worths adding a full configuration like sriov-network-operator/.golangci.yml ? |
Makefile
Outdated
| $(GOBIN)/golint: | $(BASE) ; $(info Installing golint...) | ||
| $Q go install golang.org/x/lint/golint | ||
| GOLANGCILINT = $(GOBIN)/golangci-lint | ||
| $(GOBIN)/golangci-lint: | $(BASE) ; $(info Installing golangci-lint...) |
There was a problem hiding this comment.
Suggested change
| $(GOBIN)/golangci-lint: | $(BASE) ; $(info Installing golangci-lint...) | |
| $(GOLANGCILINT): | $(BASE) ; $(info Installing golangci-lint...) |
| @@ -0,0 +1,6 @@ | |||
| linters: | |||
| enable: | |||
There was a problem hiding this comment.
Suggested change
| enable: | |
| disable-all: true | |
| enable: |
Do we need this here, it's in the network operator's .golangci.yml?
There was a problem hiding this comment.
Not sure what is the best for this. Default enabled linters are the following:
golangci-lint help linters
Enabled by default linters:
deadcode: Finds unused code [fast: false, auto-fix: false]
errcheck: Errcheck is a program for checking for unchecked errors in go programs. These unchecked errors can be critical bugs in some cases [fast: false, auto-fix: false]
gosimple (megacheck): Linter for Go source code that specializes in simplifying a code [fast: false, auto-fix: false]
govet (vet, vetshadow): Vet examines Go source code and reports suspicious constructs, such as Printf calls whose arguments do not align with the format string [fast: false, auto-fix: false]
ineffassign: Detects when assignments to existing variables are not used [fast: true, auto-fix: false]
staticcheck (megacheck): Staticcheck is a go vet on steroids, applying a ton of static analysis checks [fast: false, auto-fix: false]
structcheck: Finds unused struct fields [fast: false, auto-fix: false]
typecheck: Like the front-end of a Go compiler, parses and type-checks Go code [fast: false, auto-fix: false]
unused (megacheck): Checks Go code for unused constants, variables, functions and types [fast: false, auto-fix: false]
varcheck: Finds unused global variables and constants [fast: false, auto-fix: false]
...
As long as we use a specific version of golangci-lint, the default linter list should not change. And I think it's good to get this list updated when updating the tool.
golint tool has been deprecated and its repository is archived. Use golangci-lint in makefile, as it's what is currently used in CI lanes. Switch golint sublinter to revive, as suggested by golangci-lint itself. Move the linter list to `.golangci.yml` file to avoid misalignments between CI configuration and Makefile `lint` rule. Signed-off-by: Andrea Panattoni <apanatto@redhat.com>
adrianchiris
approved these changes
Jul 17, 2022
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 PR comes from this thread on #205
golinthas been deprecated and this PR replaces it withgolangci-lint, in order to have the same lint output as CI.Also, it replace
golintsublinter withrevive, as suggested by golangci-lint in its output