-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
t This is a combination of 3 commits.
docs: add golangci-lint.yml & fix workflow
- Loading branch information
Showing
10 changed files
with
155 additions
and
115 deletions.
There are no files selected for viewing
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
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
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
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
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
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,128 @@ | ||
# Options for analysis running | ||
run: | ||
# Timeout for analysis, e.g. 30s, 5m, default is 1m | ||
timeout: 5m | ||
|
||
# Include test files or not, default is true | ||
tests: false | ||
|
||
# Output configuration options | ||
output: | ||
# print lines of code with issue, default is true | ||
print-issued-lines: true | ||
|
||
# print linter name in the end of issue text, default is true | ||
print-linter-name: true | ||
|
||
# All available settings of specific linters | ||
linters-settings: | ||
errcheck: | ||
# report about not checking of errors in type assertions: `a := b.(MyStruct)`; | ||
# default is false: such cases aren't reported by default. | ||
check-type-assertions: true | ||
|
||
govet: | ||
# Enable the 'shadow' check instead of 'check-shadowing' | ||
enable: | ||
- shadow | ||
|
||
gocyclo: | ||
# minimal code complexity to report, 30 by default | ||
min-complexity: 30 | ||
|
||
dupl: | ||
# tokens count to trigger issue, 150 by default | ||
threshold: 150 | ||
|
||
goconst: | ||
# minimal length of string constant, 3 by default | ||
min-len: 3 | ||
# minimal occurrences count to trigger, 3 by default | ||
min-occurrences: 3 | ||
|
||
lll: | ||
# max line length, lines longer will be reported. Default is 120. | ||
line-length: 120 | ||
|
||
# Linters to run | ||
linters: | ||
enable: | ||
## enabled by default | ||
- errcheck # checking for unchecked errors, these unchecked errors can be critical bugs in some cases | ||
- gosimple # specializes in simplifying a code | ||
- govet # reports suspicious constructs, such as Printf calls whose arguments do not align with the format string | ||
- ineffassign # detects when assignments to existing variables are not used | ||
- staticcheck # is a go vet on steroids, applying a ton of static analysis checks | ||
- typecheck # like the front-end of a Go compiler, parses and type-checks Go code | ||
- unused # checks for unused constants, variables, functions and types | ||
## disabled by default | ||
- asasalint # checks for pass []any as any in variadic func(...any) | ||
- asciicheck # checks that your code does not contain non-ASCII identifiers | ||
- bidichk # checks for dangerous unicode character sequences | ||
- bodyclose # checks whether HTTP response body is closed successfully | ||
- canonicalheader # checks whether net/http.Header uses canonical header | ||
- copyloopvar # detects places where loop variables are copied (Go 1.22+) | ||
- cyclop # checks function and package cyclomatic complexity | ||
- dupl # tool for code clone detection | ||
- durationcheck # checks for two durations multiplied together | ||
- errname # checks that sentinel errors are prefixed with the Err and error types are suffixed with the Error | ||
- exhaustive # checks exhaustiveness of enum switch statements | ||
- fatcontext # detects nested contexts in loops | ||
- funlen # tool for detection of long functions | ||
- gocheckcompilerdirectives # validates go compiler directive comments (//go:) | ||
- gochecksumtype # checks exhaustiveness on Go "sum types" | ||
- gocyclo # computes and checks the cyclomatic complexity of functions | ||
- goimports # in addition to fixing imports, goimports also formats your code in the same style as gofmt | ||
- gomoddirectives # manages the use of 'replace', 'retract', and 'excludes' directives in go.mod | ||
- gomodguard # allow and block lists linter for direct Go module dependencies. This is different from depguard where there are different block types for example version constraints and module recommendations | ||
- goprintffuncname # checks that printf-like functions are named with f at the end | ||
- gosec # inspects source code for security problems | ||
- lll # reports long lines | ||
- loggercheck # checks key value pairs for common logger libraries (kitlog,klog,logr,zap) | ||
- makezero # finds slice declarations with non-zero initial length | ||
- mirror # reports wrong mirror patterns of bytes/strings usage | ||
- musttag # enforces field tags in (un)marshaled structs | ||
- nakedret # finds naked returns in functions greater than a specified function length | ||
- nestif # reports deeply nested if statements | ||
- nilerr # finds the code that returns nil even if it checks that the error is not nil | ||
- nilnil # checks that there is no simultaneous return of nil error and an invalid value | ||
- noctx # finds sending http request without context.Context | ||
- nolintlint # reports ill-formed or insufficient nolint directives | ||
- nosprintfhostport # checks for misuse of Sprintf to construct a host with port in a URL | ||
- predeclared # finds code that shadows one of Go's predeclared identifiers | ||
- promlinter # checks Prometheus metrics naming via promlint | ||
- protogetter # reports direct reads from proto message fields when getters should be used | ||
- reassign # checks that package variables are not reassigned | ||
- revive # fast, configurable, extensible, flexible, and beautiful linter for Go, drop-in replacement of golint | ||
- rowserrcheck # checks whether Err of rows is checked successfully | ||
- sloglint # ensure consistent code style when using log/slog | ||
- spancheck # checks for mistakes with OpenTelemetry/Census spans | ||
- sqlclosecheck # checks that sql.Rows and sql.Stmt are closed | ||
- stylecheck # is a replacement for golint | ||
- tenv # detects using os.Setenv instead of t.Setenv since Go1.17 | ||
- testableexamples # checks if examples are testable (have an expected output) | ||
- testifylint # checks usage of github.com/stretchr/testify | ||
- tparallel # detects inappropriate usage of t.Parallel() method in your Go test codes | ||
- unconvert # removes unnecessary type conversions | ||
- unparam # reports unused function parameters | ||
- usestdlibvars # detects the possibility to use variables/constants from the Go standard library | ||
- wastedassign # finds wasted assignment statements | ||
- whitespace # detects leading and trailing whitespace | ||
|
||
# Issues configuration | ||
issues: | ||
# List of regexps of issue texts to exclude, empty list by default. | ||
exclude-rules: | ||
- path: _test\.go | ||
linters: | ||
- dupl | ||
- gosec | ||
|
||
exclude-dirs: | ||
- vendor | ||
|
||
# Maximum issues count per one linter. Set to 0 to disable. Default is 50. | ||
max-issues-per-linter: 0 | ||
|
||
# Maximum count of issues with the same text. Set to 0 to disable. Default is 3. | ||
max-same-issues: 0 |
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
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
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