Created
September 14, 2024 15:23
-
-
Save jac18281828/0e06b9c84b10db05f76f198e19ee0cab to your computer and use it in GitHub Desktop.
go lang lint example
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
run: | |
timeout: 5m | |
linters: | |
disable-all: true | |
enable: | |
- errcheck # checking for unchecked errors, these unchecked errors can be critical bugs in some cases | |
- 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+) | |
- 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 | |
- errorlint # finds code that will cause problems with the error wrapping scheme introduced in Go 1.13 | |
- fatcontext # detects nested contexts in loops | |
- gocheckcompilerdirectives # validates go compiler directive comments (//go:) | |
- gochecknoglobals # checks that no global variables exist | |
- gochecknoinits # checks that no init functions are present in Go code | |
- gochecksumtype # checks exhaustiveness on Go "sum types" | |
- gocognit # computes and checks the cognitive complexity of functions | |
- goconst # finds repeated strings that could be replaced by a constant | |
- gocritic # provides diagnostics that check for bugs, performance and style issues | |
- gocyclo # computes and checks the cyclomatic complexity of functions | |
- godot # checks if comments end in a period | |
- 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 | |
- intrange # finds places where for loops could make use of an integer range | |
- 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 | |
- mnd # detects magic numbers | |
- musttag # enforces field tags in (un)marshaled structs | |
- nakedret # finds naked returns in functions greater than a specified function length | |
- 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 | |
- nonamedreturns # reports all named returns | |
- nosprintfhostport # checks for misuse of Sprintf to construct a host with port in a URL | |
- perfsprint # checks that fmt.Sprintf can be replaced with a faster alternative | |
- 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: | |
exclude-rules: | |
- source: "(noinspection|TODO)" | |
linters: [ godot ] | |
- source: "//noinspection" | |
linters: [ gocritic ] | |
exclude-files: | |
- ".*_test\\.go" | |
linters-settings: | |
gocognit: | |
# Minimal code complexity to report. | |
# Default: 30 (but we recommend 10-20) | |
min-complexity: 20 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment