159 lines
7.6 KiB
YAML
159 lines
7.6 KiB
YAML
# note: GolangCI-Lint also searches for config files in all directories from the directory of the first analyzed path up to the root.
|
|
run:
|
|
# Timeout for analysis, e.g. 30s, 5m.
|
|
# gobot is very expensive, on a machine with heavy load it takes some minutes
|
|
# for first run or after empty the cache by 'golangci-lint cache clean'
|
|
# Default: 1m
|
|
timeout: 5m
|
|
|
|
# If set we pass it to "go list -mod={option}". From "go help modules":
|
|
# If invoked with -mod=readonly, the go command is disallowed from the implicit
|
|
# automatic updating of go.mod described above. Instead, it fails when any changes
|
|
# to go.mod are needed. This setting is most useful to check that go.mod does
|
|
# not need updates, such as in a continuous integration and testing system.
|
|
# If invoked with -mod=vendor, the go command assumes that the vendor
|
|
# directory holds the correct copies of dependencies and ignores
|
|
# the dependency descriptions in go.mod.
|
|
#
|
|
# Allowed values: readonly|vendor|mod
|
|
# By default, it isn't set.
|
|
modules-download-mode: readonly
|
|
|
|
# Enables skipping of directories:
|
|
# - vendor$, third_party$, testdata$, examples$, Godeps$, builtin$
|
|
# Default: true
|
|
skip-dirs-use-default: false
|
|
|
|
# note: examples will be currently omitted by the build tag
|
|
skip-dirs:
|
|
- platforms/opencv
|
|
|
|
linters:
|
|
# currently active linters:
|
|
#
|
|
#INFO [lintersdb] Active 35 linters: [asasalint asciicheck bidichk contextcheck decorder depguard durationcheck errcheck exportloopref
|
|
# gocheckcompilerdirectives gomoddirectives gomodguard goprintffuncname gosimple govet grouper ineffassign makezero mirror musttag
|
|
# nilerr nilnil nolintlint nosprintfhostport prealloc reassign revive staticcheck tagalign tenv testableexamples tparallel typecheck unused wastedassign]
|
|
|
|
enable-all: true
|
|
|
|
# https://golangci-lint.run/usage/linters/#enabled-by-default
|
|
# note: typecheck can not be disabled, it is used to check code compilation
|
|
disable:
|
|
# deprecated
|
|
- deadcode # deprecated
|
|
- exhaustivestruct # deprecated
|
|
- golint # deprecated
|
|
- ifshort # deprecated
|
|
- interfacer # deprecated
|
|
- maligned # deprecated
|
|
- nosnakecase # deprecated
|
|
- scopelint # deprecated
|
|
- structcheck # deprecated
|
|
- varcheck # deprecated
|
|
# not used for any reason
|
|
- execinquery # not needed (no sql)
|
|
- exhaustive # not used (we allow incomplete usage of enum switch, e.g. with default case)
|
|
- forbidigo # not used (we allow print statements)
|
|
- ginkgolinter # not needed (enforces standards of using ginkgo and gomega)
|
|
- gochecknoglobals # not used (we allow definition of unexposed variables at top level)
|
|
- godot # not used (seems to be counting peas)
|
|
- godox # not used (we have many TODOs, so not useful)
|
|
- goerr113 # not used (we allow error creation at return statement)
|
|
- gofumpt # not used (we use "go fmt" or "gofmt" not gofumpt"
|
|
- gosmopolitan # not needed (report i18n/l10n anti-patterns)
|
|
- importas # not needed (there is no alias rule at the moment)
|
|
- ireturn # not used (we allow return interfaces)
|
|
- loggercheck # not needed (relates to kitlog, klog, logr, zap)
|
|
- paralleltest # not used
|
|
- promlinter # not needed (prometheus metrics naming)
|
|
- rowserrcheck # not needed (sql related)
|
|
- sqlclosecheck # not needed (sql related)
|
|
- testpackage # not needed, we use the same name for test package to have access to unexposed items
|
|
- wrapcheck # not needed (we allow errors from interface methods)
|
|
- zerologlint # not needed (related to zerolog package)
|
|
# important to have
|
|
- gofmt # important to prevent "format tsunami" ("gofmt -s -w" missed), disabled due to "https://github.com/golangci/golangci-lint-action/issues/535"
|
|
- nakedret # very useful together with "nonamedreturns" (reduce bugs)
|
|
- nonamedreturns # very useful (reduce bugs)
|
|
- unconvert # very useful (reduce bugs, simplify code)
|
|
- unparam # very useful (reduce bugs, simplify code)
|
|
# useful for the future
|
|
- bodyclose # maybe useful (reduce bugs), exclusions for tests needed
|
|
- containedctx # useful (structs are not for context wrapping)
|
|
- cyclop # useful with some tweeks (better understandable code), see also gocyclo
|
|
- dogsled # useful with some tweeks (e.g. exclude tests)
|
|
- dupl # useful with some tweeks (reduce bugs and lines of code)
|
|
- dupword # useful with some tweeks, but not important
|
|
- errchkjson # useful (reduce bugs)
|
|
- errname # useful for common style
|
|
- errorlint # useful (reduce bugs), but suppress the "Use `%w` to format errors" check
|
|
- exhaustruct # useful with some exclusions for existing code (e.g. mavlink/common/common.go)
|
|
- forcetypeassert # useful (reduce bugs)
|
|
- funlen # useful with some tweeks (reduce bugs, simplify code, better understandable code)
|
|
- gci # useful (improve readability)
|
|
- gochecknoinits # useful (reduce bugs, simplify bug catching)
|
|
- gocognit # useful with some tweeks (better understandable code)
|
|
- goconst # useful (reduce bugs)
|
|
- gocritic # useful with some exclusions for existing code (e.g. mavlink/common/common.go)
|
|
- gocyclo # useful with some tweeks (better understandable code)
|
|
- goheader # useful, if we introduce a common header (e.g. for copyright)
|
|
- goimports # useful (common style), but not important
|
|
- gomnd # useful with some exclusions for existing code (e.g. mavlink.go)
|
|
- gosec # useful (security)
|
|
- interfacebloat # useful with some exclusions at usage of external packages
|
|
- lll # useful with some exclusions for existing code (e.g. mavlink/common/common.go)
|
|
- maintidx # useful with some tweeks (better understandable code), maybe use instead "gocyclo", "gocognit" , "cyclop"
|
|
- misspell # useful (better understandable code), but not important
|
|
- nestif # useful (reduce bugs, simplify code, better understandable code)
|
|
- nlreturn # more common style, but could become annoying
|
|
- noctx # maybe good (show used context explicit)
|
|
- predeclared # useful (reduce bugs)
|
|
- stylecheck # useful with some tweaking (e.g. underscores in names should be allowed - we use it for constants retrieved from C/C++)
|
|
- tagliatelle # maybe useful with some tweaking or excluding
|
|
- thelper # useful
|
|
- usestdlibvars # useful
|
|
- varnamelen # maybe useful with some tweaking, but many findings
|
|
- whitespace # more common style, but could become annoying
|
|
- wsl # more common style, but could become annoying
|
|
|
|
linters-settings:
|
|
depguard:
|
|
# Rules to apply.
|
|
#
|
|
# Variables:
|
|
# - File Variables
|
|
# you can still use and exclamation mark ! in front of a variable to say not to use it.
|
|
# Example !$test will match any file that is not a go test file.
|
|
#
|
|
# `$all` - matches all go files
|
|
# `$test` - matches all go test files
|
|
#
|
|
# - Package Variables
|
|
#
|
|
# `$gostd` - matches all of go's standard library (Pulled from `GOROOT`)
|
|
#
|
|
# Default: Only allow $gostd in all files.
|
|
rules:
|
|
main:
|
|
# Packages that are not allowed where the value is a suggestion.
|
|
deny:
|
|
- pkg: "github.com/pkg/errors"
|
|
desc: Should be replaced by standard lib errors package
|
|
|
|
nolintlint:
|
|
# Enable to require an explanation of nonzero length after each nolint directive.
|
|
# Default: false
|
|
require-explanation: true
|
|
# Enable to require nolint directives to mention the specific linter being suppressed.
|
|
# Default: false
|
|
require-specific: true
|
|
|
|
revive:
|
|
rules:
|
|
# https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#unexported-return
|
|
# disable this rule, because sometimes it has its justification
|
|
- name: unexported-return
|
|
severity: warning
|
|
disabled: true
|