382 lines
17 KiB
YAML
382 lines
17 KiB
YAML
# https://github.com/golangci/golangci-lint/blob/master/.golangci.reference.yml
|
||
|
||
linters-settings:
|
||
cyclop:
|
||
# lower this after refactoring
|
||
max-complexity: 53
|
||
|
||
gci:
|
||
sections:
|
||
- standard
|
||
- default
|
||
- prefix(github.com/crowdsecurity)
|
||
- prefix(github.com/crowdsecurity/crowdsec)
|
||
|
||
gomoddirectives:
|
||
replace-allow-list:
|
||
- golang.org/x/time/rate
|
||
|
||
gocognit:
|
||
# lower this after refactoring
|
||
min-complexity: 145
|
||
|
||
gocyclo:
|
||
# lower this after refactoring
|
||
min-complexity: 49
|
||
|
||
funlen:
|
||
# Checks the number of lines in a function.
|
||
# If lower than 0, disable the check.
|
||
# Default: 60
|
||
# lower this after refactoring
|
||
lines: 437
|
||
# Checks the number of statements in a function.
|
||
# If lower than 0, disable the check.
|
||
# Default: 40
|
||
# lower this after refactoring
|
||
statements: 122
|
||
|
||
govet:
|
||
enable-all: true
|
||
disable:
|
||
- reflectvaluecompare
|
||
- fieldalignment
|
||
|
||
lll:
|
||
# lower this after refactoring
|
||
line-length: 2607
|
||
|
||
maintidx:
|
||
# raise this after refactoring
|
||
under: 11
|
||
|
||
misspell:
|
||
locale: US
|
||
|
||
nestif:
|
||
# lower this after refactoring
|
||
min-complexity: 28
|
||
|
||
nlreturn:
|
||
block-size: 5
|
||
|
||
nolintlint:
|
||
allow-unused: false # report any unused nolint directives
|
||
require-explanation: false # don't require an explanation for nolint directives
|
||
require-specific: false # don't require nolint directives to be specific about which linter is being skipped
|
||
|
||
interfacebloat:
|
||
max: 12
|
||
|
||
depguard:
|
||
rules:
|
||
wrap:
|
||
deny:
|
||
- pkg: "github.com/pkg/errors"
|
||
desc: "errors.Wrap() is deprecated in favor of fmt.Errorf()"
|
||
files:
|
||
- "!**/pkg/database/*.go"
|
||
- "!**/pkg/exprhelpers/*.go"
|
||
- "!**/pkg/acquisition/modules/appsec/appsec.go"
|
||
- "!**/pkg/acquisition/modules/loki/internal/lokiclient/loki_client.go"
|
||
- "!**/pkg/apiserver/controllers/v1/errors.go"
|
||
yaml:
|
||
files:
|
||
- "!**/cmd/notification-dummy/main.go"
|
||
- "!**/cmd/notification-email/main.go"
|
||
- "!**/cmd/notification-http/main.go"
|
||
- "!**/cmd/notification-slack/main.go"
|
||
- "!**/cmd/notification-splunk/main.go"
|
||
- "!**/pkg/acquisition/acquisition.go"
|
||
- "!**/pkg/acquisition/acquisition_test.go"
|
||
- "!**/pkg/acquisition/modules/appsec/appsec.go"
|
||
- "!**/pkg/acquisition/modules/cloudwatch/cloudwatch.go"
|
||
- "!**/pkg/acquisition/modules/docker/docker.go"
|
||
- "!**/pkg/acquisition/modules/file/file.go"
|
||
- "!**/pkg/acquisition/modules/journalctl/journalctl.go"
|
||
- "!**/pkg/acquisition/modules/kafka/kafka.go"
|
||
- "!**/pkg/acquisition/modules/kinesis/kinesis.go"
|
||
- "!**/pkg/acquisition/modules/kubernetesaudit/k8s_audit.go"
|
||
- "!**/pkg/acquisition/modules/loki/loki.go"
|
||
- "!**/pkg/acquisition/modules/loki/timestamp_test.go"
|
||
- "!**/pkg/acquisition/modules/s3/s3.go"
|
||
- "!**/pkg/acquisition/modules/syslog/syslog.go"
|
||
- "!**/pkg/acquisition/modules/wineventlog/wineventlog_windows.go"
|
||
- "!**/pkg/appsec/appsec.go"
|
||
- "!**/pkg/appsec/loader.go"
|
||
- "!**/pkg/csplugin/broker.go"
|
||
- "!**/pkg/csplugin/broker_test.go"
|
||
- "!**/pkg/dumps/bucket_dump.go"
|
||
- "!**/pkg/dumps/parser_dump.go"
|
||
- "!**/pkg/hubtest/coverage.go"
|
||
- "!**/pkg/hubtest/hubtest_item.go"
|
||
- "!**/pkg/hubtest/parser_assert.go"
|
||
- "!**/pkg/hubtest/scenario_assert.go"
|
||
- "!**/pkg/leakybucket/buckets_test.go"
|
||
- "!**/pkg/leakybucket/manager_load.go"
|
||
- "!**/pkg/metabase/metabase.go"
|
||
- "!**/pkg/parser/node.go"
|
||
- "!**/pkg/parser/node_test.go"
|
||
- "!**/pkg/parser/parsing_test.go"
|
||
- "!**/pkg/parser/stage.go"
|
||
deny:
|
||
- pkg: "gopkg.in/yaml.v2"
|
||
desc: "yaml.v2 is deprecated for new code in favor of yaml.v3"
|
||
|
||
wsl:
|
||
# Allow blocks to end with comments
|
||
allow-trailing-comment: true
|
||
|
||
linters:
|
||
enable-all: true
|
||
disable:
|
||
#
|
||
# DEPRECATED by golangi-lint
|
||
#
|
||
- deadcode
|
||
- exhaustivestruct
|
||
- golint
|
||
- ifshort
|
||
- interfacer
|
||
- maligned
|
||
- nosnakecase
|
||
- scopelint
|
||
- structcheck
|
||
- varcheck
|
||
|
||
#
|
||
# Enabled
|
||
#
|
||
|
||
# - asasalint # check for pass []any as any in variadic func(...any)
|
||
# - asciicheck # checks that all code identifiers does not have non-ASCII symbols in the name
|
||
# - bidichk # Checks for dangerous unicode character sequences
|
||
# - bodyclose # checks whether HTTP response body is closed successfully
|
||
# - copyloopvar # copyloopvar is a linter detects places where loop variables are copied
|
||
# - cyclop # checks function and package cyclomatic complexity
|
||
# - decorder # check declaration order and count of types, constants, variables and functions
|
||
# - depguard # Go linter that checks if package imports are in a list of acceptable packages
|
||
# - dupword # checks for duplicate words in the source code
|
||
# - durationcheck # check for two durations multiplied together
|
||
# - errcheck # errcheck is a program for checking for unchecked errors in Go code. These unchecked errors can be critical bugs in some cases
|
||
# - errorlint # errorlint is a linter for that can be used to find code that will cause problems with the error wrapping scheme introduced in Go 1.13.
|
||
# - execinquery # execinquery is a linter about query string checker in Query function which reads your Go src files and warning it finds
|
||
# - exportloopref # checks for pointers to enclosing loop variables
|
||
# - funlen # Tool for detection of long functions
|
||
# - ginkgolinter # enforces standards of using ginkgo and gomega
|
||
# - gocheckcompilerdirectives # Checks that go compiler directive comments (//go:) are valid.
|
||
# - gochecknoinits # Checks that no init functions are present in Go code
|
||
# - gochecksumtype # Run exhaustiveness checks on Go "sum types"
|
||
# - gocognit # Computes and checks the cognitive complexity of functions
|
||
# - gocritic # Provides diagnostics that check for bugs, performance and style issues.
|
||
# - gocyclo # Computes and checks the cyclomatic complexity of functions
|
||
# - goheader # Checks is file header matches to pattern
|
||
# - gomoddirectives # Manage the use of 'replace', 'retract', and 'excludes' directives in go.mod.
|
||
# - gomodguard # Allow and block list 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
|
||
# - gosimple # (megacheck): Linter for Go source code that specializes in simplifying code
|
||
# - gosmopolitan # Report certain i18n/l10n anti-patterns in your Go codebase
|
||
# - govet # (vet, vetshadow): Vet examines Go source code and reports suspicious constructs. It is roughly the same as 'go vet' and uses its passes.
|
||
# - grouper # Analyze expression groups.
|
||
# - importas # Enforces consistent import aliases
|
||
# - ineffassign # Detects when assignments to existing variables are not used
|
||
# - interfacebloat # A linter that checks the number of methods inside an interface.
|
||
# - intrange # intrange is a linter to find places where for loops could make use of an integer range.
|
||
# - lll # Reports long lines
|
||
# - loggercheck # (logrlint): Checks key value pairs for common logger libraries (kitlog,klog,logr,zap).
|
||
# - logrlint # Check logr arguments.
|
||
# - maintidx # maintidx measures the maintainability index of each function.
|
||
# - makezero # Finds slice declarations with non-zero initial length
|
||
# - mirror # reports wrong mirror patterns of bytes/strings usage
|
||
# - misspell # Finds commonly misspelled English words
|
||
# - nakedret # Checks that functions with naked returns are not longer than a maximum size (can be zero).
|
||
# - nestif # Reports deeply nested if statements
|
||
# - nilerr # Finds the code that returns nil even if it checks that the error is not nil.
|
||
# - 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 # find code that shadows one of Go's predeclared identifiers
|
||
# - reassign # Checks that package variables are not reassigned
|
||
# - rowserrcheck # checks whether Rows.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, sql.Stmt, sqlx.NamedStmt, pgx.Query are closed.
|
||
# - staticcheck # (megacheck): It's a set of rules from staticcheck. It's not the same thing as the staticcheck binary. The author of staticcheck doesn't support or approve the use of staticcheck as a library inside golangci-lint.
|
||
# - tenv # tenv is analyzer that detects using os.Setenv instead of t.Setenv since Go1.17
|
||
# - testableexamples # linter checks if examples are testable (have an expected output)
|
||
# - testifylint # Checks usage of github.com/stretchr/testify.
|
||
# - tparallel # tparallel detects inappropriate usage of t.Parallel() method in your Go test codes
|
||
# - unconvert # Remove unnecessary type conversions
|
||
# - unused # (megacheck): Checks Go code for unused constants, variables, functions and types
|
||
# - usestdlibvars # A linter that detect the possibility to use variables/constants from the Go standard library.
|
||
# - wastedassign # Finds wasted assignment statements
|
||
# - zerologlint # Detects the wrong usage of `zerolog` that a user forgets to dispatch with `Send` or `Msg`
|
||
|
||
#
|
||
# Recommended? (easy)
|
||
#
|
||
|
||
- dogsled # Checks assignments with too many blank identifiers (e.g. x, _, _, _, := f())
|
||
- errchkjson # Checks types passed to the json encoding functions. Reports unsupported types and reports occations, where the check for the returned error can be omitted.
|
||
- exhaustive # check exhaustiveness of enum switch statements
|
||
- gci # Gci control golang package import order and make it always deterministic.
|
||
- godot # Check if comments end in a period
|
||
- gofmt # Gofmt checks whether code was gofmt-ed. By default this tool runs with -s option to check for code simplification
|
||
- goimports # Check import statements are formatted according to the 'goimport' command. Reformat imports in autofix mode.
|
||
- gosec # (gas): Inspects source code for security problems
|
||
- inamedparam # reports interfaces with unnamed method parameters
|
||
- musttag # enforce field tags in (un)marshaled structs
|
||
- promlinter # Check Prometheus metrics naming via promlint
|
||
- protogetter # Reports direct reads from proto message fields when getters should be used
|
||
- revive # Fast, configurable, extensible, flexible, and beautiful linter for Go. Drop-in replacement of golint.
|
||
- tagalign # check that struct tags are well aligned
|
||
- thelper # thelper detects tests helpers which is not start with t.Helper() method.
|
||
- wrapcheck # Checks that errors returned from external packages are wrapped
|
||
|
||
#
|
||
# Recommended? (requires some work)
|
||
#
|
||
|
||
- containedctx # containedctx is a linter that detects struct contained context.Context field
|
||
- contextcheck # check whether the function uses a non-inherited context
|
||
- errname # Checks that sentinel errors are prefixed with the `Err` and error types are suffixed with the `Error`.
|
||
- gomnd # An analyzer to detect magic numbers.
|
||
- ireturn # Accept Interfaces, Return Concrete Types
|
||
- nilnil # Checks that there is no simultaneous return of `nil` error and an invalid value.
|
||
- noctx # Finds sending http request without context.Context
|
||
- unparam # Reports unused function parameters
|
||
|
||
#
|
||
# Formatting only, useful in IDE but should not be forced on CI?
|
||
#
|
||
|
||
- gofumpt # Gofumpt checks whether code was gofumpt-ed.
|
||
- nlreturn # nlreturn checks for a new line before return and branch statements to increase code clarity
|
||
- whitespace # Whitespace is a linter that checks for unnecessary newlines at the start and end of functions, if, for, etc.
|
||
- wsl # add or remove empty lines
|
||
|
||
#
|
||
# Well intended, but not ready for this
|
||
#
|
||
- dupl # Tool for code clone detection
|
||
- forcetypeassert # finds forced type assertions
|
||
- godox # Tool for detection of FIXME, TODO and other comment keywords
|
||
- goerr113 # Go linter to check the errors handling expressions
|
||
- paralleltest # Detects missing usage of t.Parallel() method in your Go test
|
||
- testpackage # linter that makes you use a separate _test package
|
||
|
||
#
|
||
# Too strict / too many false positives (for now?)
|
||
#
|
||
- exhaustruct # Checks if all structure fields are initialized
|
||
- forbidigo # Forbids identifiers
|
||
- gochecknoglobals # Check that no global variables exist.
|
||
- goconst # Finds repeated strings that could be replaced by a constant
|
||
- stylecheck # Stylecheck is a replacement for golint
|
||
- tagliatelle # Checks the struct tags.
|
||
- varnamelen # checks that the length of a variable's name matches its scope
|
||
|
||
#
|
||
# Under evaluation
|
||
#
|
||
|
||
- prealloc # Finds slice declarations that could potentially be preallocated
|
||
|
||
|
||
issues:
|
||
# “Look, that’s why there’s rules, understand? So that you think before you
|
||
# break ‘em.” ― Terry Pratchett
|
||
|
||
exclude-dirs:
|
||
- pkg/time/rate
|
||
|
||
exclude-files:
|
||
- pkg/yamlpatch/merge.go
|
||
- pkg/yamlpatch/merge_test.go
|
||
|
||
exclude-generated-strict: true
|
||
|
||
max-issues-per-linter: 0
|
||
max-same-issues: 0
|
||
exclude-rules:
|
||
|
||
# Won't fix:
|
||
|
||
# `err` is often shadowed, we may continue to do it
|
||
- linters:
|
||
- govet
|
||
text: "shadow: declaration of \"err\" shadows declaration"
|
||
|
||
- linters:
|
||
- errcheck
|
||
text: "Error return value of `.*` is not checked"
|
||
|
||
- linters:
|
||
- gocritic
|
||
text: "ifElseChain: rewrite if-else to switch statement"
|
||
|
||
- linters:
|
||
- gocritic
|
||
text: "captLocal: `.*' should not be capitalized"
|
||
|
||
- linters:
|
||
- gocritic
|
||
text: "appendAssign: append result not assigned to the same slice"
|
||
|
||
- linters:
|
||
- gocritic
|
||
text: "commentFormatting: put a space between `//` and comment text"
|
||
|
||
# Will fix, trivial - just beware of merge conflicts
|
||
|
||
- linters:
|
||
- perfsprint
|
||
text: "fmt.Sprintf can be replaced .*"
|
||
|
||
- linters:
|
||
- perfsprint
|
||
text: "fmt.Errorf can be replaced with errors.New"
|
||
|
||
#
|
||
# Will fix, easy but some neurons required
|
||
#
|
||
|
||
- linters:
|
||
- errorlint
|
||
text: "non-wrapping format verb for fmt.Errorf. Use `%w` to format errors"
|
||
|
||
- linters:
|
||
- errorlint
|
||
text: "type assertion on error will fail on wrapped errors. Use errors.As to check for specific errors"
|
||
|
||
- linters:
|
||
- errorlint
|
||
text: "type switch on error will fail on wrapped errors. Use errors.As to check for specific errors"
|
||
|
||
- linters:
|
||
- errorlint
|
||
text: "type assertion on error will fail on wrapped errors. Use errors.Is to check for specific errors"
|
||
|
||
- linters:
|
||
- errorlint
|
||
text: "comparing with .* will fail on wrapped errors. Use errors.Is to check for a specific error"
|
||
|
||
- linters:
|
||
- errorlint
|
||
text: "switch on an error will fail on wrapped errors. Use errors.Is to check for specific errors"
|
||
|
||
- linters:
|
||
- nosprintfhostport
|
||
text: "host:port in url should be constructed with net.JoinHostPort and not directly with fmt.Sprintf"
|
||
|
||
# https://github.com/timakin/bodyclose
|
||
- linters:
|
||
- bodyclose
|
||
text: "response body must be closed"
|
||
|
||
# named/naked returns are evil, with a single exception
|
||
# https://go.dev/wiki/CodeReviewComments#named-result-parameters
|
||
- linters:
|
||
- nonamedreturns
|
||
text: "named return .* with type .* found"
|