Merged
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) ```
JacobOaks
approved these changes
Feb 6, 2024
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. |
r-hang
approved these changes
Feb 7, 2024
abhinav
added a commit
to abhinav/dig
that referenced
this pull request
Feb 11, 2024
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
JacobOaks
pushed a commit
to uber-go/dig
that referenced
this pull request
Feb 13, 2024
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 file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
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 = ywhen type ofyisT.Should use
errors.Asand%wwhen wrapping and unwrapping errors.All public packages should have doc comments.
x += 1should bex++.