move to golangci-lint and address linting issues #242
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
Previously, two separate checks "errcheck" and "staticcheck" were used. These are also part of "golangci-lint" [1] metalinter. In addition, "golangci-lint" has a nolint directive [2], which at least "errcheck" did not seem to have. At this point in time, "golangci-lint" bundles 72 linters [3] (of which this project uses two) - so additional check can easily be added. A configuration file was required to suppress false positives regarding determinism stemming from "print" and "fmt" functions. As this project use "go 1.16" some safe linting suggestions have been applied (e.g. related to deprecation of https://pkg.go.dev/io/ioutil). [1] https://golangci-lint.run/ [2] https://golangci-lint.run/usage/false-positives/#nolint-directive [3] https://golangci-lint.run/usage/linters/
|
|
cretz
reviewed
Jan 3, 2023
There was a problem hiding this comment.
Thanks! I think we should do the same to https://github.com/temporalio/sdk-go then too. It's a bit off to do it one way in our samples but another in the canonical Go SDK project. (some in-progress PRs are already changing from using ioutil, so we may have to wait until after those)
| body, err := ioutil.ReadAll(resp.Body) | ||
| _ = resp.Body.Close() | ||
| defer resp.Body.Close() // nolint:errcheck | ||
| body, err := io.ReadAll(resp.Body) |
There was a problem hiding this comment.
I think we should leave this how it was and just change ioutil to os. We want to explicitly show we ignore errors and there is no benefit to changing this to a defer here.
|
|
||
| workflowcheck: | ||
| @printf $(COLOR) "Run workflow check..." | ||
| @go install go.temporal.io/sdk/contrib/tools/workflowcheck | ||
| @workflowcheck -show-pos ./... | ||
| @workflowcheck -config workflowcheck.config.yaml -show-pos ./... |
There was a problem hiding this comment.
Why add this config? Is something triggering it?
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.
What was changed
Previously, two separate checks "errcheck" and "staticcheck" were used. These are also part of "golangci-lint" [1] metalinter.
In addition, "golangci-lint" has a nolint directive [2], which at least "errcheck" did not seem to have.
At this point in time, "golangci-lint" bundles 72 linters [3] (of which this project uses two) - so additional check can easily be added. A configuration file was required to suppress false positives regarding determinism stemming from "print" and "fmt" functions.
As this project use "go 1.16" some safe linting suggestions have been applied (e.g. related to deprecation of https://pkg.go.dev/io/ioutil).
Why?
I wanted to use the nolint directive of golangci-lint to selectively ignore checks, e.g. to ignore an error in
deferwhen closing an HTTP response body.At the same time, it seemed to simplify the
Makefileto use a single "metalinter" instead of two separate linters.Checklist
Tested locally, via:
Not required.