-
Notifications
You must be signed in to change notification settings - Fork 291
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
ci: Use golangci-lint #1150
ci: Use golangci-lint #1150
Conversation
Instead of home-rolled linting workflows, use golangci-lint to manage linting. See also uber-go/zap#1323
Fixes the following lint issues in code: ``` annotated.go:120:15: var-declaration: should omit type reflect.Type from declaration of var _typeOfError; it will be inferred from the right-hand side (revive) annotated.go:645:19: var-declaration: should omit type reflect.Type from declaration of var _typeOfLifecycle; it will be inferred from the right-hand side (revive) annotated.go:646:19: var-declaration: should omit type reflect.Type from declaration of var _typeOfContext; it will be inferred from the right-hand side (revive) internal/lifecycle/lifecycle.go:198:18: var-declaration: should omit type appState from declaration of var returnState; it will be inferred from the right-hand side (revive) ```
``` app.go:550:14: type assertion on error will fail on wrapped errors. Use errors.As to check for specific errors (errorlint) decorate.go:219:81: non-wrapping format verb for fmt.Errorf. Use `%w` to format errors (errorlint) ```
Adds package comments missing from a couple public packages per revive.
golangci-lint wants lint ignore directives in the form: //nolint:$name //nolint:$name // reason ``` internal/lifecycle/lifecycle_test.go:324:18: SA1012: do not pass a nil Context, even if a function permits it; pass context.TODO if you are unsure about which Context to use (staticcheck) internal/lifecycle/lifecycle_test.go:329:16: SA1012: do not pass a nil Context, even if a function permits it; pass context.TODO if you are unsure about which Context to use (staticcheck) ```
``` module_test.go:237:5: increment-decrement: should replace p.age += 1 with p.age++ (revive) module_test.go:242:6: increment-decrement: should replace p.age += 1 with p.age++ (revive) ```
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This seems much cleaner! The exclusions you configured make sense. LGTM.
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #1150 +/- ##
==========================================
- Coverage 98.80% 98.74% -0.07%
==========================================
Files 36 30 -6
Lines 3106 2950 -156
==========================================
- Hits 3069 2913 -156
Misses 30 30
Partials 7 7 ☔ View full report in Codecov by Sentry. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for your contribution!
This PR switches to using golangci-lint to run linters. staticcheck is included and enabled by default. We add revive and a few others. All issues reported by the linters have been fixed. This also allows the linter to run in parallel with the tests. License header check has also been moved to golangci-lint, similarly to uber-go/fx#1157. Refs uber-go/fx#1150 Refs uber-go/zap#1323
This PR switches to using golangci-lint to run linters. staticcheck is included and enabled by default. We add revive and a few others. All issues reported by the linters have been fixed. This also allows the linter to run in parallel with the tests. License header check has also been moved to golangci-lint, similarly to uber-go/fx#1157. Refs uber-go/fx#1150 Refs uber-go/zap#1323
Commits are individually reviewable
We've been using a hand-rolled lint setup for a while.
It's limiting, and so we've neglected to keep our lints up to date.
This PR switches to using golangci-lint to run linters.
staticcheck is included and enabled by default.
We add revive and a few others.
This also allows the linter to run in parallel with the tests.
See also uber-go/zap#1323 for a similar change to Zap.
Commits after the first one are fixes to the lints found by golangci-lint.
Some of these are:
Files should be gofumpt-ed.
Shouldn't add type in
var x T = y
when type ofy
isT
.Should use
errors.As
and%w
when wrapping and unwrapping errors.All public packages should have doc comments.
x += 1
should bex++
.