chore(lint): bump golangci lint config to v2, address lint findings #365
There are no files selected for viewing
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -52,3 +52,7 @@ node_modules/ | |
|
|
||
| .cursor | ||
| .envrc | ||
|
|
||
| docker-compose.yaml | ||
| mise.toml | ||
| .jj/ | ||
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,4 +1,4 @@ | ||
| # Copyright 2025 StreamNative | ||
| # | ||
| # Licensed under the Apache License, Version 2.0 (the "License"); | ||
| # you may not use this file except in compliance with the License. | ||
|
|
@@ -12,26 +12,26 @@ | |
| # See the License for the specific language governing permissions and | ||
| # limitations under the License. | ||
|
|
||
| version: "2" | ||
|
|
||
| run: | ||
| go: "1.24" | ||
| build-tags: | ||
| - tools | ||
| - e2e | ||
| allow-parallel-runners: true | ||
|
|
||
| linters: | ||
| default: none | ||
| enable: | ||
| - asciicheck | ||
| - bodyclose | ||
| - copyloopvar | ||
| - dogsled | ||
| - errcheck | ||
| - gocritic | ||
| - goprintffuncname | ||
| - gosec | ||
| - govet | ||
| - importas | ||
| - ineffassign | ||
|
|
@@ -43,166 +43,148 @@ linters: | |
| - predeclared | ||
| - rowserrcheck | ||
| - staticcheck | ||
| - thelper | ||
| - unconvert | ||
| - unparam | ||
| - unused | ||
| settings: | ||
| gocritic: | ||
| disabled-checks: | ||
| - appendAssign | ||
| - dupImport | ||
| - evalOrder | ||
| - ifElseChain | ||
| - octalLiteral | ||
| - regexpSimplify | ||
| - sloppyReassign | ||
| - truncateCmp | ||
| - typeDefFirst | ||
| - unnamedResult | ||
| - unnecessaryDefer | ||
| - whyNoLint | ||
| - wrapperFunc | ||
| enabled-tags: | ||
| - experimental | ||
| godot: | ||
| scope: toplevel | ||
| exclude: | ||
| - ^ \+.* | ||
| - ^ ANCHOR.* | ||
| gosec: | ||
| excludes: | ||
| - G307 | ||
| - G108 | ||
| importas: | ||
| alias: | ||
| - pkg: k8s.io/api/core/v1 | ||
| alias: corev1 | ||
| - pkg: k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1 | ||
| alias: apiextensionsv1 | ||
| - pkg: k8s.io/apimachinery/pkg/apis/meta/v1 | ||
| alias: metav1 | ||
| - pkg: k8s.io/apimachinery/pkg/api/errors | ||
| alias: apierrors | ||
| - pkg: k8s.io/apimachinery/pkg/util/errors | ||
| alias: kerrors | ||
| - pkg: sigs.k8s.io/controller-runtime | ||
| alias: ctrl | ||
| no-unaliased: true | ||
| nolintlint: | ||
| require-specific: true | ||
| allow-unused: false | ||
| exclusions: | ||
| generated: lax | ||
| rules: | ||
| - linters: | ||
| - revive | ||
| text: 'exported: exported method .*\.(Reconcile|SetupWithManager|SetupWebhookWithManager) should have comment or be unexported' | ||
| - linters: | ||
| - errcheck | ||
| text: Error return value of .((os\.)?std(out|err)\..*|.*Close|.*Flush|os\.Remove(All)?|.*print(f|ln)?|os\.(Un)?Setenv). is not checked | ||
| - linters: | ||
| - revive | ||
| text: exported (method|function|type|const) (.+) should have comment or be unexported | ||
| source: (func|type).*Fake.* | ||
| - linters: | ||
| - revive | ||
| path: fake_\.go | ||
| text: exported (method|function|type|const) (.+) should have comment or be unexported | ||
| - linters: | ||
| - revive | ||
| path: cmd/clusterctl/internal/test/providers.*.go | ||
| text: exported (method|function|type|const) (.+) should have comment or be unexported | ||
| - linters: | ||
| - revive | ||
| path: (framework|e2e)/.*.go | ||
| text: exported (method|function|type|const) (.+) should have comment or be unexported | ||
| - linters: | ||
| - unparam | ||
| text: always receives | ||
| - path: _test\.go | ||
| text: should not use dot imports | ||
| - path: (framework|e2e)/.*.go | ||
| text: should not use dot imports | ||
| - path: _test\.go | ||
| text: cyclomatic complexity | ||
| - linters: | ||
| - gocritic | ||
| text: 'appendAssign: append result not assigned to the same slice' | ||
| - linters: | ||
| - ifshort | ||
| path: controllers/mdutil/util.go | ||
| text: variable .* is only used in the if-statement | ||
| - linters: | ||
| - staticcheck | ||
| path: .*(api|types)\/.*\/conversion.*\.go$ | ||
| text: 'SA1019: in.(.+) is deprecated' | ||
| - linters: | ||
| - revive | ||
| path: .*(api|types)\/.*\/conversion.*\.go$ | ||
| text: exported (method|function|type|const) (.+) should have comment or be unexported | ||
| - linters: | ||
| - revive | ||
| path: .*(api|types)\/.*\/conversion.*\.go$ | ||
| text: 'var-naming: don''t use underscores in Go names;' | ||
| - linters: | ||
| - revive | ||
| path: .*(api|types)\/.*\/conversion.*\.go$ | ||
| text: 'receiver-naming: receiver name' | ||
|
Comment on lines
+94
to
+143
There was a problem hiding this comment. Multiple exclusion rules reference the
Author
There was a problem hiding this comment. @maxsxu or @freeznet Enabling the revive linter adds a lot of the following lint failures: and many like Most of the revive lints seem stylistic, I don't really like them but wanted to ask your thoughts? Do you want it enabled or should I leave it disabled and remove the config associated with it? |
||
| - linters: | ||
| - staticcheck | ||
| path: .*(api|types)\/.*\/conversion.*\.go$ | ||
| text: 'ST1003: should not use underscores in Go names;' | ||
| - linters: | ||
| - staticcheck | ||
| path: .*(api|types)\/.*\/conversion.*\.go$ | ||
| text: 'ST1016: methods on the same type should have the same receiver name' | ||
| - linters: | ||
|
mattsre marked this conversation as resolved.
Outdated
|
||
| - ifshort | ||
| path: ^controllers/machine_controller\.go$ | ||
| text: variable 'isDeleteNodeAllowed' is only used in the if-statement.* | ||
|
mattsre marked this conversation as resolved.
Outdated
|
||
| paths: | ||
| - zz_generated.*\.go$ | ||
| - third_party | ||
| - third_party$ | ||
| - builtin$ | ||
| - examples$ | ||
|
|
||
| issues: | ||
| max-issues-per-linter: 0 | ||
| max-same-issues: 0 | ||
|
|
||
| formatters: | ||
| enable: | ||
| - gofmt | ||
| - goimports | ||
| settings: | ||
| gci: | ||
| sections: | ||
| - prefix(github.com/streamnative) | ||
| exclusions: | ||
| generated: lax | ||
| paths: | ||
| - zz_generated.*\.go$ | ||
| - third_party | ||
| - third_party$ | ||
| - builtin$ | ||
| - examples$ | ||
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
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
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
Oops, something went wrong.
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.
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.
The
godotlinter has settings configured but is not enabled in the linters list (line 26). These settings will have no effect. Ifgodotlinting is desired, add it to the enabled linters list. Otherwise, consider removing these unused settings to keep the configuration clean.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.
Removing
godotlinter config -godotis used for adding "." at the end of sentenences however most of the comments/docs in the repo do not follow this pattern so it doesn't seem like this should be enabled