Table of Contents
To see a list of supported linters and which linters are enabled/disabled:
golangci-lint help linters
Enabled by Default
Name | Description | Presets | AutoFix | Since | |
---|---|---|---|---|---|
errcheck | Errcheck is a program for checking for unchecked errors in Go code. These unchecked errors can be critical bugs in some cases. | bugs, error | v1.0.0 | ||
gosimple | Linter for Go source code that specializes in simplifying code. | style | v1.20.0 | ||
govet | Vet examines Go source code and reports suspicious constructs. It is roughly the same as 'go vet' and uses its passes. | bugs, metalinter | v1.0.0 | ||
ineffassign | Detects when assignments to existing variables are not used. | unused | v1.0.0 | ||
staticcheck | 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. | bugs, metalinter | v1.0.0 | ||
unused | Checks Go code for unused constants, variables, functions and types. | unused | v1.20.0 |
Disabled by Default
Name | Description | Presets | AutoFix | Since | |
---|---|---|---|---|---|
asasalint | Check for pass []any as any in variadic func(...any). | bugs | 1.47.0 | ||
asciicheck | Checks that all code identifiers does not have non-ASCII symbols in the name. | bugs, style | v1.26.0 | ||
bidichk | Checks for dangerous unicode character sequences. | bugs | 1.43.0 | ||
bodyclose | Checks whether HTTP response body is closed successfully. | performance, bugs | v1.18.0 | ||
canonicalheader | Canonicalheader checks whether net/http.Header uses canonical header. | style | v1.58.0 | ||
containedctx | Containedctx is a linter that detects struct contained context.Context field. | style | 1.44.0 | ||
contextcheck | Check whether the function uses a non-inherited context. | bugs | v1.43.0 | ||
copyloopvar | Copyloopvar is a linter detects places where loop variables are copied. | style | v1.57.0 | ||
cyclop | Checks function and package cyclomatic complexity. | complexity | v1.37.0 | ||
decorder | Check declaration order and count of types, constants, variables and functions. | format, style | v1.44.0 | ||
depguard | Go linter that checks if package imports are in a list of acceptable packages. | style, import, module | v1.4.0 | ||
dogsled | Checks assignments with too many blank identifiers (e.g. x, , , _, := f()). | style | v1.19.0 | ||
dupl | Tool for code clone detection. | style | v1.0.0 | ||
dupword | Checks for duplicate words in the source code. | comment | 1.50.0 | ||
durationcheck | Check for two durations multiplied together. | bugs | v1.37.0 | ||
err113 | Go linter to check the errors handling expressions. | style, error | v1.26.0 | ||
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. | bugs | 1.44.0 | ||
errname | Checks that sentinel errors are prefixed with the Err and error types are suffixed with the Error . | style | v1.42.0 | ||
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. | bugs, error | v1.32.0 | ||
exhaustive | Check exhaustiveness of enum switch statements. | bugs | v1.28.0 | ||
exhaustruct | Checks if all structure fields are initialized. | style, test | v1.46.0 | ||
fatcontext | Detects nested contexts in loops and function literals. | performance | 1.58.0 | ||
forbidigo | Forbids identifiers. | style | v1.34.0 | ||
forcetypeassert | Finds forced type assertions. | style | v1.38.0 | ||
funlen | Tool for detection of long functions. | complexity | v1.18.0 | ||
gci | Gci controls Go package import order and makes it always deterministic. | format, import | ✔ | v1.30.0 | |
ginkgolinter | Enforces standards of using ginkgo and gomega. | style | v1.51.0 | ||
gocheckcompilerdirectives | Checks that go compiler directive comments (//go:) are valid. | bugs | v1.51.0 | ||
gochecknoglobals | Check that no global variables exist. | style | v1.12.0 | ||
gochecknoinits | Checks that no init functions are present in Go code. | style | v1.12.0 | ||
gochecksumtype | Run exhaustiveness checks on Go "sum types". | bugs | v1.55.0 | ||
gocognit | Computes and checks the cognitive complexity of functions. | complexity | v1.20.0 | ||
goconst | Finds repeated strings that could be replaced by a constant. | style | v1.0.0 | ||
gocritic | Provides diagnostics that check for bugs, performance and style issues. Extensible without recompilation through dynamic rules. Dynamic rules are written declaratively with AST patterns, filters, report message and optional suggestion. | style, metalinter | ✔ | v1.12.0 | |
gocyclo | Computes and checks the cyclomatic complexity of functions. | complexity | v1.0.0 | ||
godot | Check if comments end in a period. | style, comment | ✔ | v1.25.0 | |
godox | Tool for detection of FIXME, TODO and other comment keywords. | style, comment | v1.19.0 | ||
gofmt | Gofmt checks whether code was gofmt-ed. By default this tool runs with -s option to check for code simplification. | format | ✔ | v1.0.0 | |
gofumpt | Gofumpt checks whether code was gofumpt-ed. | format | ✔ | v1.28.0 | |
goheader | Checks is file header matches to pattern. | style | ✔ | v1.28.0 | |
goimports | Check import statements are formatted according to the 'goimport' command. Reformat imports in autofix mode. | format, import | ✔ | v1.20.0 | |
gomoddirectives | Manage the use of 'replace', 'retract', and 'excludes' directives in go.mod. | style, module | v1.39.0 | ||
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. | style, import, module | v1.25.0 | ||
goprintffuncname | Checks that printf-like functions are named with f at the end. | style | v1.23.0 | ||
gosec | Inspects source code for security problems. | bugs | v1.0.0 | ||
gosmopolitan | Report certain i18n/l10n anti-patterns in your Go codebase. | bugs | v1.53.0 | ||
grouper | Analyze expression groups. | style | v1.44.0 | ||
importas | Enforces consistent import aliases. | style | v1.38.0 | ||
inamedparam | Reports interfaces with unnamed method parameters. | style | v1.55.0 | ||
interfacebloat | A linter that checks the number of methods inside an interface. | style | v1.49.0 | ||
intrange | Intrange is a linter to find places where for loops could make use of an integer range. | style | v1.57.0 | ||
ireturn | Accept Interfaces, Return Concrete Types. | style | v1.43.0 | ||
lll | Reports long lines. | style | v1.8.0 | ||
loggercheck | Checks key value pairs for common logger libraries (kitlog,klog,logr,zap). | style, bugs | v1.49.0 | ||
maintidx | Maintidx measures the maintainability index of each function. | complexity | v1.44.0 | ||
makezero | Finds slice declarations with non-zero initial length. | style, bugs | v1.34.0 | ||
mirror | Reports wrong mirror patterns of bytes/strings usage. | style | ✔ | v1.53.0 | |
misspell | Finds commonly misspelled English words. | style, comment | ✔ | v1.8.0 | |
mnd | An analyzer to detect magic numbers. | style | v1.22.0 | ||
musttag | Enforce field tags in (un)marshaled structs. | style, bugs | v1.51.0 | ||
nakedret | Checks that functions with naked returns are not longer than a maximum size (can be zero). | style | v1.19.0 | ||
nestif | Reports deeply nested if statements. | complexity | v1.25.0 | ||
nilerr | Finds the code that returns nil even if it checks that the error is not nil. | bugs | v1.38.0 | ||
nilnil | Checks that there is no simultaneous return of nil error and an invalid value. | style | v1.43.0 | ||
nlreturn | Nlreturn checks for a new line before return and branch statements to increase code clarity. | style | v1.30.0 | ||
noctx | Finds sending http request without context.Context. | performance, bugs | v1.28.0 | ||
nolintlint | Reports ill-formed or insufficient nolint directives. | style | ✔ | v1.26.0 | |
nonamedreturns | Reports all named returns. | style | v1.46.0 | ||
nosprintfhostport | Checks for misuse of Sprintf to construct a host with port in a URL. | style | v1.46.0 | ||
paralleltest | Detects missing usage of t.Parallel() method in your Go test. | style, test | v1.33.0 | ||
perfsprint | Checks that fmt.Sprintf can be replaced with a faster alternative. | performance | v1.55.0 | ||
prealloc | Finds slice declarations that could potentially be pre-allocated. | performance | v1.19.0 | ||
predeclared | Find code that shadows one of Go's predeclared identifiers. | style | v1.35.0 | ||
promlinter | Check Prometheus metrics naming via promlint. | style | v1.40.0 | ||
protogetter | Reports direct reads from proto message fields when getters should be used. | bugs | ✔ | v1.55.0 | |
reassign | Checks that package variables are not reassigned. | bugs | 1.49.0 | ||
revive | Fast, configurable, extensible, flexible, and beautiful linter for Go. Drop-in replacement of golint. | style, metalinter | v1.37.0 | ||
rowserrcheck | Checks whether Rows.Err of rows is checked successfully. | bugs, sql | v1.23.0 | ||
sloglint | Ensure consistent code style when using log/slog. | style, format | v1.55.0 | ||
spancheck | Checks for mistakes with OpenTelemetry/Census spans. | bugs | v1.56.0 | ||
sqlclosecheck | Checks that sql.Rows, sql.Stmt, sqlx.NamedStmt, pgx.Query are closed. | bugs, sql | v1.28.0 | ||
stylecheck | Stylecheck is a replacement for golint. | style | v1.20.0 | ||
tagalign | Check that struct tags are well aligned. | style, format | ✔ | v1.53.0 | |
tagliatelle | Checks the struct tags. | style | v1.40.0 | ||
tenv | Tenv is analyzer that detects using os.Setenv instead of t.Setenv since Go1.17. | test | v1.43.0 | ||
testableexamples | Linter checks if examples are testable (have an expected output). | test | v1.50.0 | ||
testifylint | Checks usage of github.com/stretchr/testify. | test, bugs | v1.55.0 | ||
testpackage | Linter that makes you use a separate _test package. | style, test | v1.25.0 | ||
thelper | Thelper detects tests helpers which is not start with t.Helper() method. | test | v1.34.0 | ||
tparallel | Tparallel detects inappropriate usage of t.Parallel() method in your Go test codes. | style, test | v1.32.0 | ||
unconvert | Remove unnecessary type conversions. | style | v1.0.0 | ||
unparam | Reports unused function parameters. | unused | v1.9.0 | ||
usestdlibvars | A linter that detect the possibility to use variables/constants from the Go standard library. | style | v1.48.0 | ||
varnamelen | Checks that the length of a variable's name matches its scope. | style | v1.43.0 | ||
wastedassign | Finds wasted assignment statements. | style | v1.38.0 | ||
whitespace | Whitespace is a linter that checks for unnecessary newlines at the start and end of functions, if, for, etc. | style | ✔ | v1.19.0 | |
wrapcheck | Checks that errors returned from external packages are wrapped. | style, error | v1.32.0 | ||
wsl | Add or remove empty lines. | style | v1.20.0 | ||
zerologlint | Detects the wrong usage of zerolog that a user forgets to dispatch with Send or Msg . | bugs | v1.53.0 | ||
execinquery ⚠ | The repository of the linter has been archived by the owner. | sql | v1.46.0 | ||
exportloopref ⚠ | Since Go1.22 (loopvar) this linter is no longer relevant. Replaced by copyloopvar. | bugs | v1.28.0 | ||
gomnd ⚠ | The linter has been renamed. Replaced by mnd. | style | v1.22.0 |
Linters Configuration
asasalint
Check for pass []any as any in variadic func(...any).
linters-settings:asasalint:# To specify a set of function names to exclude.# The values are merged with the builtin exclusions.# The builtin exclusions can be disabled by setting `use-builtin-exclusions` to `false`.# Default: ["^(fmt|log|logger|t|)\.(Print|Fprint|Sprint|Fatal|Panic|Error|Warn|Warning|Info|Debug|Log)(|f|ln)$"]exclude:- Append- \.Wrapf# To enable/disable the asasalint builtin exclusions of function names.# See the default value of `exclude` to get the builtin exclusions.# Default: trueuse-builtin-exclusions: false# Ignore *_test.go files.# Default: falseignore-test: true
bidichk
Checks for dangerous unicode character sequences.
linters-settings:bidichk:# The following configurations check for all mentioned invisible unicode runes.# All runes are enabled by default.left-to-right-embedding: falseright-to-left-embedding: falsepop-directional-formatting: falseleft-to-right-override: falseright-to-left-override: falseleft-to-right-isolate: falseright-to-left-isolate: falsefirst-strong-isolate: falsepop-directional-isolate: false
copyloopvar
Copyloopvar is a linter detects places where loop variables are copied.
linters-settings:copyloopvar:# Check all assigning the loop variable to another variable.# Default: falsecheck-alias: true
cyclop
Checks function and package cyclomatic complexity.
linters-settings:cyclop:# The maximal code complexity to report.# Default: 10max-complexity: 10# The maximal average package complexity.# If it's higher than 0.0 (float) the check is enabled# Default: 0.0package-average: 0.5# Should ignore tests.# Default: falseskip-tests: true
decorder
Check declaration order and count of types, constants, variables and functions.
linters-settings:decorder:# Required order of `type`, `const`, `var` and `func` declarations inside a file.# Default: types before constants before variables before functions.dec-order:- type- const- var- func# If true, underscore vars (vars with "_" as the name) will be ignored at all checks# Default: false (underscore vars are not ignored)ignore-underscore-vars: false# If true, order of declarations is not checked at all.# Default: true (disabled)disable-dec-order-check: false# If true, `init` func can be anywhere in file (does not have to be declared before all other functions).# Default: true (disabled)disable-init-func-first-check: false# If true, multiple global `type`, `const` and `var` declarations are allowed.# Default: true (disabled)disable-dec-num-check: false# If true, type declarations will be ignored for dec num check# Default: false (type statements are not ignored)disable-type-dec-num-check: false# If true, const declarations will be ignored for dec num check# Default: false (const statements are not ignored)disable-const-dec-num-check: false# If true, var declarations will be ignored for dec num check# Default: false (var statements are not ignored)disable-var-dec-num-check: false
depguard
Go linter that checks if package imports are in a list of acceptable packages.
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:# Name of a rule.main:# Used to determine the package matching priority.# There are three different modes: `original`, `strict`, and `lax`.# Default: "original"list-mode: lax# List of file globs that will match this list of settings to compare against.# Default: $allfiles:- "!**/*_a _file.go"# List of allowed packages.allow:- $gostd- github.com/OpenPeeDeeP# Packages that are not allowed where the value is a suggestion.deny:- pkg: "github.com/sirupsen/logrus"desc: not allowed- pkg: "github.com/pkg/errors"desc: Should be replaced by standard lib errors package
dogsled
Checks assignments with too many blank identifiers (e.g. x, , , _, := f()).
linters-settings:dogsled:# Checks assignments with too many blank identifiers.# Default: 2max-blank-identifiers: 3
dupl
Tool for code clone detection.
linters-settings:dupl:# Tokens count to trigger issue.# Default: 150threshold: 100
dupword
Checks for duplicate words in the source code.
linters-settings:dupword:# Keywords for detecting duplicate words.# If this list is not empty, only the words defined in this list will be detected.# Default: []keywords:- "the"- "and"- "a"# Keywords used to ignore detection.# Default: []ignore:- "0C0C"
errcheck
Errcheck is a program for checking for unchecked errors in Go code. These unchecked errors can be critical bugs in some cases.
linters-settings:errcheck:# Report about not checking of errors in type assertions: `a := b.(MyStruct)`.# Such cases aren't reported by default.# Default: falsecheck-type-assertions: true# report about assignment of errors to blank identifier: `num, _ := strconv.Atoi(numStr)`.# Such cases aren't reported by default.# Default: falsecheck-blank: true# To disable the errcheck built-in exclude list.# See `-excludeonly` option in https://github.com/kisielk/errcheck#excluding-functions for details.# Default: falsedisable-default-exclusions: true# List of functions to exclude from checking, where each entry is a single function to exclude.# See https://github.com/kisielk/errcheck#excluding-functions for details.exclude-functions:- io/ioutil.ReadFile- io.Copy(*bytes.Buffer)- io.Copy(os.Stdout)
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.
linters-settings:errchkjson:# With check-error-free-encoding set to true, errchkjson does warn about errors# from json encoding functions that are safe to be ignored,# because they are not possible to happen.## if check-error-free-encoding is set to true and errcheck linter is enabled,# it is recommended to add the following exceptions to prevent from false positives:## linters-settings:# errcheck:# exclude-functions:# - encoding/json.Marshal# - encoding/json.MarshalIndent## Default: falsecheck-error-free-encoding: true# Issue on struct encoding that doesn't have exported fields.# Default: falsereport-no-exported: false
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.
linters-settings:errorlint:# Check whether fmt.Errorf uses the %w verb for formatting errors.# See the https://github.com/polyfloyd/go-errorlint for caveats.# Default: trueerrorf: false# Permit more than 1 %w verb, valid per Go 1.20 (Requires errorf:true)# Default: trueerrorf-multi: false# Check for plain type assertions and type switches.# Default: trueasserts: false# Check for plain error comparisons.# Default: truecomparison: false# Allowed errors.# Default: []allowed-errors:- err: "io.EOF"fun: "example.com/pkg.Read"# Allowed error "wildcards".# Default: []allowed-errors-wildcard:- err: "example.com/pkg.ErrMagic"fun: "example.com/pkg.Magic"
exhaustive
Check exhaustiveness of enum switch statements.
linters-settings:exhaustive:# Program elements to check for exhaustiveness.# Default: [ switch ]check:- switch- map# Check switch statements in generated files also.# Default: falsecheck-generated: true# Presence of "default" case in switch statements satisfies exhaustiveness,# even if all enum members are not listed.# Default: falsedefault-signifies-exhaustive: true# Enum members matching the supplied regex do not have to be listed in# switch statements to satisfy exhaustiveness.# Default: ""ignore-enum-members: "Example.+"# Enum types matching the supplied regex do not have to be listed in# switch statements to satisfy exhaustiveness.# Default: ""ignore-enum-types: "Example.+"# Consider enums only in package scopes, not in inner scopes.# Default: falsepackage-scope-only: true# Only run exhaustive check on switches with "//exhaustive:enforce" comment.# Default: falseexplicit-exhaustive-switch: true# Only run exhaustive check on map literals with "//exhaustive:enforce" comment.# Default: falseexplicit-exhaustive-map: true# Switch statement requires default case even if exhaustive.# Default: falsedefault-case-required: true
exhaustruct
Checks if all structure fields are initialized.
linters-settings:exhaustruct:# List of regular expressions to match struct packages and their names.# Regular expressions must match complete canonical struct package/name/structname.# If this list is empty, all structs are tested.# Default: []include:- '.+\.Test'- 'example\.com/package\.ExampleStruct[\d]{1,2}'# List of regular expressions to exclude struct packages and their names from checks.# Regular expressions must match complete canonical struct package/name/structname.# Default: []exclude:- '.+/cobra\.Command$'
forbidigo
Forbids identifiers.
linters-settings:forbidigo:# Forbid the following identifiers (list of regexp).# Default: ["^(fmt\\.Print(|f|ln)|print|println)$"]forbid:# Builtin function:- ^print.*$# Optional message that gets included in error reports.- p: ^fmt\.Print.*$msg: Do not commit print statements.# Alternatively, put messages at the end of the regex, surrounded by `(# )?`# Escape any special characters. Those messages get included in error reports.- 'fmt\.Print.*(# Do not commit print statements\.)?'# Forbid spew Dump, whether it is called as function or method.# Depends on analyze-types below.- ^spew\.(ConfigState\.)?Dump$# The package name might be ambiguous.# The full import path can be used as additional criteria.# Depends on analyze-types below.- p: ^v1.Dump$pkg: ^example.com/pkg/api/v1$# Exclude godoc examples from forbidigo checks.# Default: trueexclude-godoc-examples: false# Instead of matching the literal source code,# use type information to replace expressions with strings that contain the package name# and (for methods and fields) the type name.# This makes it possible to handle import renaming and forbid struct fields and methods.# Default: falseanalyze-types: true
funlen
Tool for detection of long functions.
linters-settings:funlen:# Checks the number of lines in a function.# If lower than 0, disable the check.# Default: 60lines: -1# Checks the number of statements in a function.# If lower than 0, disable the check.# Default: 40statements: -1# Ignore comments when counting lines.# Default falseignore-comments: true
gci
Gci controls Go package import order and makes it always deterministic.
linters-settings:gci:# Section configuration to compare against.# Section names are case-insensitive and may contain parameters in ().# The default order of sections is `standard > default > custom > blank > dot > alias > localmodule`,# If `custom-order` is `true`, it follows the order of `sections` option.# Default: ["standard", "default"]sections:- standard # Standard section: captures all standard packages.- default # Default section: contains all imports that could not be matched to another section type.- prefix(github.com/org/project) # Custom section: groups all imports with the specified Prefix.- blank # Blank section: contains all blank imports. This section is not present unless explicitly enabled.- dot # Dot section: contains all dot imports. This section is not present unless explicitly enabled.- alias # Alias section: contains all alias imports. This section is not present unless explicitly enabled.- localmodule # Local module section: contains all local packages. This section is not present unless explicitly enabled.# Skip generated files.# Default: trueskip-generated: false# Enable custom order of sections.# If `true`, make the section order the same as the order of `sections`.# Default: falsecustom-order: true# Drops lexical ordering for custom sections.# Default: falseno-lex-order: true
ginkgolinter
Enforces standards of using ginkgo and gomega.
linters-settings:ginkgolinter:# Suppress the wrong length assertion warning.# Default: falsesuppress-len-assertion: true# Suppress the wrong nil assertion warning.# Default: falsesuppress-nil-assertion: true# Suppress the wrong error assertion warning.# Default: falsesuppress-err-assertion: true# Suppress the wrong comparison assertion warning.# Default: falsesuppress-compare-assertion: true# Suppress the function all in async assertion warning.# Default: falsesuppress-async-assertion: true# Suppress warning for comparing values from different types, like `int32` and `uint32`# Default: falsesuppress-type-compare-assertion: true# Trigger warning for ginkgo focus containers like `FDescribe`, `FContext`, `FWhen` or `FIt`# Default: falseforbid-focus-container: true# Don't trigger warnings for HaveLen(0)# Default: falseallow-havelen-zero: true# Force using `Expect` with `To`, `ToNot` or `NotTo`.# Reject using `Expect` with `Should` or `ShouldNot`.# Default: falseforce-expect-to: true# Best effort validation of async intervals (timeout and polling).# Ignored the suppress-async-assertion is true.# Default: falsevalidate-async-intervals: true# Trigger a warning for variable assignments in ginkgo containers like `Describe`, `Context` and `When`, instead of in `BeforeEach()`.# Default: falseforbid-spec-pollution: true
gocognit
Computes and checks the cognitive complexity of functions.
linters-settings:gocognit:# Minimal code complexity to report.# Default: 30 (but we recommend 10-20)min-complexity: 10
goconst
Finds repeated strings that could be replaced by a constant.
linters-settings:goconst:# Minimal length of string constant.# Default: 3min-len: 2# Minimum occurrences of constant string count to trigger issue.# Default: 3min-occurrences: 2# Ignore test files.# Default: falseignore-tests: true# Look for existing constants matching the values.# Default: truematch-constant: false# Search also for duplicated numbers.# Default: falsenumbers: true# Minimum value, only works with goconst.numbers# Default: 3min: 2# Maximum value, only works with goconst.numbers# Default: 3max: 2# Ignore when constant is not used as function argument.# Default: trueignore-calls: false# Exclude strings matching the given regular expression.# Default: ""ignore-strings: 'foo.+'
gocritic
Provides diagnostics that check for bugs, performance and style issues.
Extensible without recompilation through dynamic rules.
Dynamic rules are written declaratively with AST patterns, filters, report message and optional suggestion.
linters-settings:gocritic:# Disable all checks.# Default: falsedisable-all: true# Which checks should be enabled in addition to default checks; can't be combined with 'disabled-checks'.# By default, list of stable checks is used (https://go-critic.github.io/overview#checks-overview):# appendAssign, argOrder, assignOp, badCall, badCond, captLocal, caseOrder, codegenComment, commentFormatting,# defaultCaseOrder, deprecatedComment, dupArg, dupBranchBody, dupCase, dupSubExpr, elseif, exitAfterDefer,# flagDeref, flagName, ifElseChain, mapKey, newDeref, offBy1, regexpMust, singleCaseSwitch, sloppyLen,# sloppyTypeAssert, switchTrue, typeSwitchVar, underef, unlambda, unslice, valSwap, wrapperFunc# To see which checks are enabled run `GL_DEBUG=gocritic golangci-lint run --enable=gocritic`.enabled-checks:- nestingReduce- unnamedResult- ruleguard- truncateCmp# Enable all checks.# Default: falseenable-all: true# Which checks should be disabled; can't be combined with 'enabled-checks'.# Default: []disabled-checks:- regexpMust# Enable multiple checks by tags in addition to default checks.# Run `GL_DEBUG=gocritic golangci-lint run --enable=gocritic` to see all tags and checks.# See https://github.com/go-critic/go-critic#usage -> section "Tags".# Default: []enabled-tags:- diagnostic- style- performance- experimental- opinionateddisabled-tags:- diagnostic- style- performance- experimental- opinionated# Settings passed to gocritic.# The settings key is the name of a supported gocritic checker.# The list of supported checkers can be find in https://go-critic.github.io/overview.settings:# Must be valid enabled check name.captLocal:# Whether to restrict checker to params only.# Default: trueparamsOnly: falsecommentedOutCode:# Min length of the comment that triggers a warning.# Default: 15minLength: 50elseif:# Whether to skip balanced if-else pairs.# Default: trueskipBalanced: falsehugeParam:# Size in bytes that makes the warning trigger.# Default: 80sizeThreshold: 70ifElseChain:# Min number of if-else blocks that makes the warning trigger.# Default: 2minThreshold: 4nestingReduce:# Min number of statements inside a branch to trigger a warning.# Default: 5bodyWidth: 4rangeExprCopy:# Size in bytes that makes the warning trigger.# Default: 512sizeThreshold: 516# Whether to check test functions# Default: trueskipTestFuncs: falserangeValCopy:# Size in bytes that makes the warning trigger.# Default: 128sizeThreshold: 32# Whether to check test functions.# Default: trueskipTestFuncs: falseruleguard:# Enable debug to identify which 'Where' condition was rejected.# The value of the parameter is the name of a function in a ruleguard file.## When a rule is evaluated:# If:# The Match() clause is accepted; and# One of the conditions in the Where() clause is rejected,# Then:# ruleguard prints the specific Where() condition that was rejected.## The option is passed to the ruleguard 'debug-group' argument.# Default: ""debug: 'emptyDecl'# Determines the behavior when an error occurs while parsing ruleguard files.# If flag is not set, log error and skip rule files that contain an error.# If flag is set, the value must be a comma-separated list of error conditions.# - 'all': fail on all errors.# - 'import': ruleguard rule imports a package that cannot be found.# - 'dsl': gorule file does not comply with the ruleguard DSL.# Default: ""failOn: dsl,import# Comma-separated list of file paths containing ruleguard rules.# If a path is relative, it is relative to the directory where the golangci-lint command is executed.# The special '${configDir}' variable is substituted with the absolute directory containing the golangci config file.# Glob patterns such as 'rules-*.go' may be specified.# Default: ""rules: '${configDir}/ruleguard/rules-*.go,${configDir}/myrule1.go'# Comma-separated list of enabled groups or skip empty to enable everything.# Tags can be defined with # character prefix.# Default: "<all>"enable: "myGroupName,#myTagName"# Comma-separated list of disabled groups or skip empty to enable everything.# Tags can be defined with # character prefix.# Default: ""disable: "myGroupName,#myTagName"tooManyResultsChecker:# Maximum number of results.# Default: 5maxResults: 10truncateCmp:# Whether to skip int/uint/uintptr types.# Default: trueskipArchDependent: falseunderef:# Whether to skip (*x).method() calls where x is a pointer receiver.# Default: trueskipRecvDeref: falseunnamedResult:# Whether to check exported functions.# Default: falsecheckExported: true
gocyclo
Computes and checks the cyclomatic complexity of functions.
linters-settings:gocyclo:# Minimal code complexity to report.# Default: 30 (but we recommend 10-20)min-complexity: 10
godot
Check if comments end in a period.
linters-settings:godot:# Comments to be checked: `declarations`, `toplevel`, or `all`.# Default: declarationsscope: toplevel# List of regexps for excluding particular comment lines from check.# Default: []exclude:# Exclude todo and fixme comments.- "^fixme:"- "^todo:"# Check that each sentence ends with a period.# Default: trueperiod: false# Check that each sentence starts with a capital letter.# Default: falsecapital: true
godox
Tool for detection of FIXME, TODO and other comment keywords.
linters-settings:godox:# Report any comments starting with keywords, this is useful for TODO or FIXME comments that# might be left in the code accidentally and should be resolved before merging.# Default: ["TODO", "BUG", "FIXME"]keywords:- NOTE- OPTIMIZE # marks code that should be optimized before merging- HACK # marks hack-around that should be removed before merging
gofmt
Gofmt checks whether code was gofmt-ed. By default this tool runs with -s option to check for code simplification.
linters-settings:gofmt:# Simplify code: gofmt with `-s` option.# Default: truesimplify: false# Apply the rewrite rules to the source before reformatting.# https://pkg.go.dev/cmd/gofmt# Default: []rewrite-rules:- pattern: 'interface{}'replacement: 'any'- pattern: 'a[b:len(a)]'replacement: 'a[b:]'
gofumpt
Gofumpt checks whether code was gofumpt-ed.
linters-settings:gofumpt:# Module path which contains the source code being formatted.# Default: ""module-path: github.com/org/project# Choose whether to use the extra rules.# Default: falseextra-rules: true
goheader
Checks is file header matches to pattern.
linters-settings:goheader:# Supports two types 'const` and `regexp`.# Values can be used recursively.# Default: {}values:const:# Define here const type values in format k:v.# For example:COMPANY: MY COMPANYregexp:# Define here regexp type values.# for example:AUTHOR: .*@mycompany\.com# The template use for checking.# Default: ""template: |-# Put here copyright header template for source code files# For example:# Note: {{ YEAR }} is a builtin value that returns the year relative to the current machine time.## {{ AUTHOR }} {{ COMPANY }} {{ YEAR }}# SPDX-License-Identifier: Apache-2.0# Licensed under the Apache License, Version 2.0 (the "License");# you may not use this file except in compliance with the License.# You may obtain a copy of the License at:# http://www.apache.org/licenses/LICENSE-2.0# Unless required by applicable law or agreed to in writing, software# distributed under the License is distributed on an "AS IS" BASIS,# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.# See the License for the specific language governing permissions and# limitations under the License.# As alternative of directive 'template', you may put the path to file with the template source.# Useful if you need to load the template from a specific file.# Default: ""template-path: /path/to/my/template.tmpl
goimports
Check import statements are formatted according to the 'goimport' command. Reformat imports in autofix mode.
linters-settings:goimports:# A comma-separated list of prefixes, which, if set, checks import paths# with the given prefixes are grouped after 3rd-party packages.# Default: ""local-prefixes: github.com/org/project
gomoddirectives
Manage the use of 'replace', 'retract', and 'excludes' directives in go.mod.
linters-settings:gomoddirectives:# Allow local `replace` directives.# Default: falsereplace-local: false# List of allowed `replace` directives.# Default: []replace-allow-list:- launchpad.net/gocheck# Allow to not explain why the version has been retracted in the `retract` directives.# Default: falseretract-allow-no-explanation: false# Forbid the use of the `exclude` directives.# Default: falseexclude-forbidden: false
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.
linters-settings:gomodguard:allowed:# List of allowed modules.# Default: []modules:- gopkg.in/yaml.v2# List of allowed module domains.# Default: []domains:- golang.orgblocked:# List of blocked modules.# Default: []modules:# Blocked module.- github.com/uudashr/go-module:# Recommended modules that should be used instead. (Optional)recommendations:- golang.org/x/mod# Reason why the recommended module should be used. (Optional)reason: "`mod` is the official go.mod parser library."# List of blocked module version constraints.# Default: []versions:# Blocked module with version constraint.- github.com/mitchellh/go-homedir:# Version constraint, see https://github.com/Masterminds/semver#basic-comparisons.version: "< 1.1.0"# Reason why the version constraint exists. (Optional)reason: "testing if blocked version constraint works."# Set to true to raise lint issues for packages that are loaded from a local path via replace directive.# Default: falselocal_replace_directives: false
gosimple
Linter for Go source code that specializes in simplifying code.
linters-settings:gosimple:# Sxxxx checks in https://staticcheck.dev/docs/configuration/options/#checks# Default: ["*"]checks: ["all"]
gosec
Inspects source code for security problems.
linters-settings:gosec:# To select a subset of rules to run.# Available rules: https://github.com/securego/gosec#available-rules# Default: [] - means include all rulesincludes:- G101 # Look for hard coded credentials- G102 # Bind to all interfaces- G103 # Audit the use of unsafe block- G104 # Audit errors not checked- G106 # Audit the use of ssh.InsecureIgnoreHostKey- G107 # Url provided to HTTP request as taint input- G108 # Profiling endpoint automatically exposed on /debug/pprof- G109 # Potential Integer overflow made by strconv.Atoi result conversion to int16/32- G110 # Potential DoS vulnerability via decompression bomb- G111 # Potential directory traversal- G112 # Potential slowloris attack- G113 # Usage of Rat.SetString in math/big with an overflow (CVE-2022-23772)- G114 # Use of net/http serve function that has no support for setting timeouts- G115 # Potential integer overflow when converting between integer types- G201 # SQL query construction using format string- G202 # SQL query construction using string concatenation- G203 # Use of unescaped data in HTML templates- G204 # Audit use of command execution- G301 # Poor file permissions used when creating a directory- G302 # Poor file permissions used with chmod- G303 # Creating tempfile using a predictable path- G304 # File path provided as taint input- G305 # File traversal when extracting zip/tar archive- G306 # Poor file permissions used when writing to a new file- G307 # Poor file permissions used when creating a file with os.Create- G401 # Detect the usage of MD5 or SHA1- G402 # Look for bad TLS connection settings- G403 # Ensure minimum RSA key length of 2048 bits- G404 # Insecure random number source (rand)- G405 # Detect the usage of DES or RC4- G406 # Detect the usage of MD4 or RIPEMD160- G501 # Import blocklist: crypto/md5- G502 # Import blocklist: crypto/des- G503 # Import blocklist: crypto/rc4- G504 # Import blocklist: net/http/cgi- G505 # Import blocklist: crypto/sha1- G506 # Import blocklist: golang.org/x/crypto/md4- G507 #Import blocklist: golang.org/x/crypto/ripemd160- G601 # Implicit memory aliasing of items from a range statement- G602 # Slice access out of bounds# To specify a set of rules to explicitly exclude.# Available rules: https://github.com/securego/gosec#available-rules# Default: []excludes:- G101 # Look for hard coded credentials- G102 # Bind to all interfaces- G103 # Audit the use of unsafe block- G104 # Audit errors not checked- G106 # Audit the use of ssh.InsecureIgnoreHostKey- G107 # Url provided to HTTP request as taint input- G108 # Profiling endpoint automatically exposed on /debug/pprof- G109 # Potential Integer overflow made by strconv.Atoi result conversion to int16/32- G110 # Potential DoS vulnerability via decompression bomb- G111 # Potential directory traversal- G112 # Potential slowloris attack- G113 # Usage of Rat.SetString in math/big with an overflow (CVE-2022-23772)- G114 # Use of net/http serve function that has no support for setting timeouts- G115 # Potential integer overflow when converting between integer types- G201 # SQL query construction using format string- G202 # SQL query construction using string concatenation- G203 # Use of unescaped data in HTML templates- G204 # Audit use of command execution- G301 # Poor file permissions used when creating a directory- G302 # Poor file permissions used with chmod- G303 # Creating tempfile using a predictable path- G304 # File path provided as taint input- G305 # File traversal when extracting zip/tar archive- G306 # Poor file permissions used when writing to a new file- G307 # Poor file permissions used when creating a file with os.Create- G401 # Detect the usage of MD5 or SHA1- G402 # Look for bad TLS connection settings- G403 # Ensure minimum RSA key length of 2048 bits- G404 # Insecure random number source (rand)- G405 # Detect the usage of DES or RC4- G406 # Detect the usage of MD4 or RIPEMD160- G501 # Import blocklist: crypto/md5- G502 # Import blocklist: crypto/des- G503 # Import blocklist: crypto/rc4- G504 # Import blocklist: net/http/cgi- G505 # Import blocklist: crypto/sha1- G506 # Import blocklist: golang.org/x/crypto/md4- G507 #Import blocklist: golang.org/x/crypto/ripemd160- G601 # Implicit memory aliasing of items from a range statement- G602 # Slice access out of bounds# Exclude generated files# Default: falseexclude-generated: true# Filter out the issues with a lower severity than the given value.# Valid options are: low, medium, high.# Default: lowseverity: medium# Filter out the issues with a lower confidence than the given value.# Valid options are: low, medium, high.# Default: lowconfidence: medium# Concurrency value.# Default: the number of logical CPUs usable by the current process.concurrency: 12# To specify the configuration of rules.config:# Globals are applicable to all rules.global:# If true, ignore #nosec in comments (and an alternative as well).# Default: falsenosec: true# Add an alternative comment prefix to #nosec (both will work at the same time).# Default: """#nosec": "#my-custom-nosec"# Define whether nosec issues are counted as finding or not.# Default: falseshow-ignored: true# Audit mode enables addition checks that for normal code analysis might be too nosy.# Default: falseaudit: trueG101:# Regexp pattern for variables and constants to find.# Default: "(?i)passwd|pass|password|pwd|secret|token|pw|apiKey|bearer|cred"pattern: "(?i)example"# If true, complain about all cases (even with low entropy).# Default: falseignore_entropy: false# Maximum allowed entropy of the string.# Default: "80.0"entropy_threshold: "80.0"# Maximum allowed value of entropy/string length.# Is taken into account if entropy >= entropy_threshold/2.# Default: "3.0"per_char_threshold: "3.0"# Calculate entropy for first N chars of the string.# Default: "16"truncate: "32"# Additional functions to ignore while checking unhandled errors.# Following functions always ignored:# bytes.Buffer:# - Write# - WriteByte# - WriteRune# - WriteString# fmt:# - Printf# - Println# - Fprint# - Fprintf# - Fprintln# strings.Builder:# - Write# - WriteByte# - WriteRune# - WriteString# io.PipeWriter:# - CloseWithError# hash.Hash:# - Write# os:# - Unsetenv# Default: {}G104:fmt:- FscanfG111:# Regexp pattern to find potential directory traversal.# Default: "http\\.Dir\\(\"\\/\"\\)|http\\.Dir\\('\\/'\\)"pattern: "custom\\.Dir\\(\\)"# Maximum allowed permissions mode for os.Mkdir and os.MkdirAll# Default: "0750"G301: "0750"# Maximum allowed permissions mode for os.OpenFile and os.Chmod# Default: "0600"G302: "0600"# Maximum allowed permissions mode for os.WriteFile and ioutil.WriteFile# Default: "0600"G306: "0600"
gosmopolitan
Report certain i18n/l10n anti-patterns in your Go codebase.
linters-settings:gosmopolitan:# Allow and ignore `time.Local` usages.## Default: falseallow-time-local: true# List of fully qualified names in the `full/pkg/path.name` form, to act as "i18n escape hatches".# String literals inside call-like expressions to, or struct literals of those names,# are exempt from the writing system check.## Default: []escape-hatches:- 'github.com/nicksnyder/go-i18n/v2/i18n.Message'- 'example.com/your/project/i18n/markers.Raw'- 'example.com/your/project/i18n/markers.OK'- 'example.com/your/project/i18n/markers.TODO'- 'command-line-arguments.Simple'# Ignore test files.## Default: trueignore-tests: false# List of Unicode scripts to watch for any usage in string literals.# https://pkg.go.dev/unicode#pkg-variables## Default: ["Han"]watch-for-scripts:- Devanagari- Han- Hangul- Hiragana- Katakana
govet
Vet examines Go source code and reports suspicious constructs. It is roughly the same as 'go vet' and uses its passes.
linters-settings:govet:# Disable all analyzers.# Default: falsedisable-all: true# Enable analyzers by name.# (in addition to default:# appends, asmdecl, assign, atomic, bools, buildtag, cgocall, composites, copylocks, defers, directive, errorsas,# framepointer, httpresponse, ifaceassert, loopclosure, lostcancel, nilfunc, printf, shift, sigchanyzer, slog,# stdmethods, stringintconv, structtag, testinggoroutine, tests, timeformat, unmarshal, unreachable, unsafeptr,# unusedresult# ).# Run `GL_DEBUG=govet golangci-lint run --enable=govet` to see default, all available analyzers, and enabled analyzers.# Default: []enable:- appends- asmdecl- assign- atomic- atomicalign- bools- buildtag- cgocall- composites- copylocks- deepequalerrors- defers- directive- errorsas- fieldalignment- findcall- framepointer- httpresponse- ifaceassert- loopclosure- lostcancel- nilfunc- nilness- printf- reflectvaluecompare- shadow- shift- sigchanyzer- slog- sortslice- stdmethods- stringintconv- structtag- testinggoroutine- tests- unmarshal- unreachable- unsafeptr- unusedresult- unusedwrite# Enable all analyzers.# Default: falseenable-all: true# Disable analyzers by name.# (in addition to default# atomicalign, deepequalerrors, fieldalignment, findcall, nilness, reflectvaluecompare, shadow, sortslice,# timeformat, unusedwrite# ).# Run `GL_DEBUG=govet golangci-lint run --enable=govet` to see default, all available analyzers, and enabled analyzers.# Default: []disable:- appends- asmdecl- assign- atomic- atomicalign- bools- buildtag- cgocall- composites- copylocks- deepequalerrors- defers- directive- errorsas- fieldalignment- findcall- framepointer- httpresponse- ifaceassert- loopclosure- lostcancel- nilfunc- nilness- printf- reflectvaluecompare- shadow- shift- sigchanyzer- slog- sortslice- stdmethods- stringintconv- structtag- testinggoroutine- tests- unmarshal- unreachable- unsafeptr- unusedresult- unusedwrite# Settings per analyzer.settings:# Analyzer name, run `go tool vet help` to see all analyzers.printf:# Comma-separated list of print function names to check (in addition to default, see `go tool vet help printf`).# Default: []funcs:- (github.com/golangci/golangci-lint/pkg/logutils.Log).Infof- (github.com/golangci/golangci-lint/pkg/logutils.Log).Warnf- (github.com/golangci/golangci-lint/pkg/logutils.Log).Errorf- (github.com/golangci/golangci-lint/pkg/logutils.Log).Fatalfshadow:# Whether to be strict about shadowing; can be noisy.# Default: falsestrict: trueunusedresult:# Comma-separated list of functions whose results must be used# (in addition to default:# context.WithCancel, context.WithDeadline, context.WithTimeout, context.WithValue, errors.New, fmt.Errorf,# fmt.Sprint, fmt.Sprintf, sort.Reverse# ).# Default: []funcs:- pkg.MyFunc# Comma-separated list of names of methods of type func() string whose results must be used# (in addition to default Error,String)# Default: []stringmethods:- MyMethod
grouper
Analyze expression groups.
linters-settings:grouper:# Require the use of a single global 'const' declaration only.# Default: falseconst-require-single-const: true# Require the use of grouped global 'const' declarations.# Default: falseconst-require-grouping: true# Require the use of a single 'import' declaration only.# Default: falseimport-require-single-import: true# Require the use of grouped 'import' declarations.# Default: falseimport-require-grouping: true# Require the use of a single global 'type' declaration only.# Default: falsetype-require-single-type: true# Require the use of grouped global 'type' declarations.# Default: falsetype-require-grouping: true# Require the use of a single global 'var' declaration only.# Default: falsevar-require-single-var: true# Require the use of grouped global 'var' declarations.# Default: falsevar-require-grouping: true
importas
Enforces consistent import aliases.
linters-settings:importas:# Do not allow unaliased imports of aliased packages.# Default: falseno-unaliased: true# Do not allow non-required aliases.# Default: falseno-extra-aliases: true# List of aliases# Default: []alias:# Using `servingv1` alias for `knative.dev/serving/pkg/apis/serving/v1` package.- pkg: knative.dev/serving/pkg/apis/serving/v1alias: servingv1# Using `autoscalingv1alpha1` alias for `knative.dev/serving/pkg/apis/autoscaling/v1alpha1` package.- pkg: knative.dev/serving/pkg/apis/autoscaling/v1alpha1alias: autoscalingv1alpha1# You can specify the package path by regular expression,# and alias by regular expression expansion syntax like below.# see https://github.com/julz/importas#use-regular-expression for details- pkg: knative.dev/serving/pkg/apis/(\w+)/(v[\w\d]+)alias: $1$2
inamedparam
Reports interfaces with unnamed method parameters.
linters-settings:inamedparam:# Skips check for interface methods with only a single parameter.# Default: falseskip-single-param: true
interfacebloat
A linter that checks the number of methods inside an interface.
linters-settings:interfacebloat:# The maximum number of methods allowed for an interface.# Default: 10max: 5
ireturn
Accept Interfaces, Return Concrete Types.
linters-settings:ireturn:# List of interfaces to allow.# Lists of the keywords and regular expressions matched to interface or package names can be used.# `allow` and `reject` settings cannot be used at the same time.## Keywords:# - `empty` for `interface{}`# - `error` for errors# - `stdlib` for standard library# - `anon` for anonymous interfaces# - `generic` for generic interfaces added in go 1.18## Default: [anon, error, empty, stdlib]allow:- anon# You can specify idiomatic endings for interface- (or|er)$# List of interfaces to reject.# Lists of the keywords and regular expressions matched to interface or package names can be used.# `allow` and `reject` settings cannot be used at the same time.## Keywords:# - `empty` for `interface{}`# - `error` for errors# - `stdlib` for standard library# - `anon` for anonymous interfaces# - `generic` for generic interfaces added in go 1.18## Default: []reject:- github.com\/user\/package\/v4\.Type
lll
Reports long lines.
linters-settings:lll:# Max line length, lines longer will be reported.# '\t' is counted as 1 character by default, and can be changed with the tab-width option.# Default: 120.line-length: 120# Tab width in spaces.# Default: 1tab-width: 1
loggercheck
Checks key value pairs for common logger libraries (kitlog,klog,logr,zap).
linters-settings:loggercheck:# Allow check for the github.com/go-kit/log library.# Default: truekitlog: false# Allow check for the k8s.io/klog/v2 library.# Default: trueklog: false# Allow check for the github.com/go-logr/logr library.# Default: truelogr: false# Allow check for the "sugar logger" from go.uber.org/zap library.# Default: truezap: false# Require all logging keys to be inlined constant strings.# Default: falserequire-string-key: true# Require printf-like format specifier (%s, %d for example) not present.# Default: falseno-printf-like: true# List of custom rules to check against, where each rule is a single logger pattern, useful for wrapped loggers.# For example: https://github.com/timonwong/loggercheck/blob/7395ab86595781e33f7afba27ad7b55e6956ebcd/testdata/custom-rules.txt# Default: emptyrules:- k8s.io/klog/v2.InfoS # package level exported functions- (github.com/go-logr/logr.Logger).Error # "Methods"- (*go.uber.org/zap.SugaredLogger).With # Also "Methods", but with a pointer receiver
maintidx
Maintidx measures the maintainability index of each function.
linters-settings:maintidx:# Show functions with maintainability index lower than N.# A high index indicates better maintainability (it's kind of the opposite of complexity).# Default: 20under: 100
makezero
Finds slice declarations with non-zero initial length.
linters-settings:makezero:# Allow only slices initialized with a length of zero.# Default: falsealways: true
misspell
Finds commonly misspelled English words.
linters-settings:misspell:# Correct spellings using locale preferences for US or UK.# Setting locale to US will correct the British spelling of 'colour' to 'color'.# Default is to use a neutral variety of English.locale: US# Typos to ignore.# Should be in lower case.# Default: []ignore-words:- someword# Extra word corrections.# `typo` and `correction` should only contain letters.# The words are case-insensitive.# Default: []extra-words:- typo: "iff"correction: "if"- typo: "cancelation"correction: "cancellation"# Mode of the analysis:# - default: checks all the file content.# - restricted: checks only comments.# Default: ""mode: restricted
mnd
An analyzer to detect magic numbers.
linters-settings:mnd:# List of enabled checks, see https://github.com/tommy-muehle/go-mnd/#checks for description.# Default: ["argument", "case", "condition", "operation", "return", "assign"]checks:- argument- case- condition- operation- return- assign# List of numbers to exclude from analysis.# The numbers should be written as string.# Values always ignored: "1", "1.0", "0" and "0.0"# Default: []ignored-numbers:- '0666'- '0755'- '42'# List of file patterns to exclude from analysis.# Values always ignored: `.+_test.go`# Default: []ignored-files:- 'magic1_.+\.go$'# List of function patterns to exclude from analysis.# Following functions are always ignored: `time.Date`,# `strconv.FormatInt`, `strconv.FormatUint`, `strconv.FormatFloat`,# `strconv.ParseInt`, `strconv.ParseUint`, `strconv.ParseFloat`.# Default: []ignored-functions:- '^math\.'- '^http\.StatusText$'
musttag
Enforce field tags in (un)marshaled structs.
linters-settings:musttag:# A set of custom functions to check in addition to the builtin ones.# Default: json, xml, gopkg.in/yaml.v3, BurntSushi/toml, mitchellh/mapstructure, jmoiron/sqlxfunctions:# The full name of the function, including the package.- name: github.com/hashicorp/hcl/v2/hclsimple.DecodeFile# The struct tag whose presence should be ensured.tag: hcl# The position of the argument to check.arg-pos: 2
nakedret
Checks that functions with naked returns are not longer than a maximum size (can be zero).
linters-settings:nakedret:# Make an issue if func has more lines of code than this setting, and it has naked returns.# Default: 30max-func-lines: 31
nestif
Reports deeply nested if statements.
linters-settings:nestif:# Minimal complexity of if statements to report.# Default: 5min-complexity: 4
nilnil
Checks that there is no simultaneous return of nil
error and an invalid value.
linters-settings:nilnil:# List of return types to check.# Default: ["ptr", "func", "iface", "map", "chan", "uintptr", "unsafeptr"]checked-types:- ptr- func- iface- map- chan- uintptr- unsafeptr
nlreturn
Nlreturn checks for a new line before return and branch statements to increase code clarity.
linters-settings:nlreturn:# Size of the block (including return statement that is still "OK")# so no return split required.# Default: 1block-size: 2
nolintlint
Reports ill-formed or insufficient nolint directives.
linters-settings:nolintlint:# Disable to ensure that all nolint directives actually have an effect.# Default: falseallow-unused: true# Exclude following linters from requiring an explanation.# Default: []allow-no-explanation: []# Enable to require an explanation of nonzero length after each nolint directive.# Default: falserequire-explanation: true# Enable to require nolint directives to mention the specific linter being suppressed.# Default: falserequire-specific: true
nonamedreturns
Reports all named returns.
linters-settings:nonamedreturns:# Report named error if it is assigned inside defer.# Default: falsereport-error-in-defer: true
paralleltest
Detects missing usage of t.Parallel() method in your Go test.
linters-settings:paralleltest:# Ignore missing calls to `t.Parallel()` and only report incorrect uses of it.# Default: falseignore-missing: true# Ignore missing calls to `t.Parallel()` in subtests. Top-level tests are# still required to have `t.Parallel`, but subtests are allowed to skip it.# Default: falseignore-missing-subtests: true
perfsprint
Checks that fmt.Sprintf can be replaced with a faster alternative.
linters-settings:perfsprint:# Optimizes even if it requires an int or uint type cast.# Default: trueint-conversion: false# Optimizes into `err.Error()` even if it is only equivalent for non-nil errors.# Default: falseerr-error: true# Optimizes `fmt.Errorf`.# Default: trueerrorf: false# Optimizes `fmt.Sprintf` with only one argument.# Default: truesprintf1: false# Optimizes into strings concatenation.# Default: truestrconcat: false
prealloc
Finds slice declarations that could potentially be pre-allocated.
linters-settings:prealloc:# IMPORTANT: we don't recommend using this linter before doing performance profiling.# For most programs usage of prealloc will be a premature optimization.# Report pre-allocation suggestions only on simple loops that have no returns/breaks/continues/gotos in them.# Default: truesimple: false# Report pre-allocation suggestions on range loops.# Default: truerange-loops: false# Report pre-allocation suggestions on for loops.# Default: falsefor-loops: true
predeclared
Find code that shadows one of Go's predeclared identifiers.
linters-settings:predeclared:# Comma-separated list of predeclared identifiers to not report on.# Default: ""ignore: "new,int"# Include method names and field names (i.e., qualified names) in checks.# Default: falseq: true
promlinter
Check Prometheus metrics naming via promlint.
linters-settings:promlinter:# Promlinter cannot infer all metrics name in static analysis.# Enable strict mode will also include the errors caused by failing to parse the args.# Default: falsestrict: true# Please refer to https://github.com/yeya24/promlinter#usage for detailed usage.# Default: []disabled-linters:- Help- MetricUnits- Counter- HistogramSummaryReserved- MetricTypeInName- ReservedChars- CamelCase- UnitAbbreviations
protogetter
Reports direct reads from proto message fields when getters should be used.
linters-settings:protogetter:# Skip files generated by specified generators from the checking.# Checks only the file's initial comment, which must follow the format: "// Code generated by <generator-name>".# Files generated by protoc-gen-go, protoc-gen-go-grpc, and protoc-gen-grpc-gateway are always excluded automatically.# Default: []skip-generated-by: ["protoc-gen-go-my-own-generator"]# Skip files matching the specified glob pattern from the checking.# Default: []skip-files:- "*.pb.go"- "*/vendor/*"- "/full/path/to/file.go"# Skip any generated files from the checking.# Default: falseskip-any-generated: true# Skip first argument of append function.# Default: falsereplace-first-arg-in-append: true
reassign
Checks that package variables are not reassigned.
linters-settings:reassign:# Patterns for global variable names that are checked for reassignment.# See https://github.com/curioswitch/go-reassign#usage# Default: ["EOF", "Err.*"]patterns:- ".*"
revive
Fast, configurable, extensible, flexible, and beautiful linter for Go. Drop-in replacement of golint.
linters-settings:revive:# Maximum number of open files at the same time.# See https://github.com/mgechev/revive#command-line-flags# Defaults to unlimited.max-open-files: 2048# When set to false, ignores files with "GENERATED" header, similar to golint.# See https://github.com/mgechev/revive#available-rules for details.# Default: falseignore-generated-header: true# Sets the default severity.# See https://github.com/mgechev/revive#configuration# Default: warningseverity: error# Enable all available rules.# Default: falseenable-all-rules: true# Sets the default failure confidence.# This means that linting errors with less than 0.8 confidence will be ignored.# Default: 0.8confidence: 0.1rules:# https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#add-constant- name: add-constantseverity: warningdisabled: falseexclude: [""]arguments:- maxLitCount: "3"allowStrs: '""'allowInts: "0,1,2"allowFloats: "0.0,0.,1.0,1.,2.0,2."# https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#argument-limit- name: argument-limitseverity: warningdisabled: falseexclude: [""]arguments: [4]# https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#atomic- name: atomicseverity: warningdisabled: falseexclude: [""]# https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#banned-characters- name: banned-charactersseverity: warningdisabled: falseexclude: [""]arguments: ["Ω", "Σ", "σ", "7"]# https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#bare-return- name: bare-returnseverity: warningdisabled: falseexclude: [""]# https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#blank-imports- name: blank-importsseverity: warningdisabled: falseexclude: [""]# https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#bool-literal-in-expr- name: bool-literal-in-exprseverity: warningdisabled: falseexclude: [""]# https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#call-to-gc- name: call-to-gcseverity: warningdisabled: falseexclude: [""]# https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#cognitive-complexity- name: cognitive-complexityseverity: warningdisabled: falseexclude: [""]arguments: [7]# https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#comment-spacings- name: comment-spacingsseverity: warningdisabled: falseexclude: [""]arguments:- mypragma- otherpragma# https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#comments-density- name: comments-densityseverity: warningdisabled: falseexclude: [""]arguments: [15]# https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#confusing-naming- name: confusing-namingseverity: warningdisabled: falseexclude: [""]# https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#confusing-results- name: confusing-resultsseverity: warningdisabled: falseexclude: [""]# https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#constant-logical-expr- name: constant-logical-exprseverity: warningdisabled: falseexclude: [""]# https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#context-as-argument- name: context-as-argumentseverity: warningdisabled: falseexclude: [""]arguments:- allowTypesBefore: "*testing.T,*github.com/user/repo/testing.Harness"# https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#context-keys-type- name: context-keys-typeseverity: warningdisabled: falseexclude: [""]# https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#cyclomatic- name: cyclomaticseverity: warningdisabled: falseexclude: [""]arguments: [3]# https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#datarace- name: dataraceseverity: warningdisabled: falseexclude: [""]# https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#deep-exit- name: deep-exitseverity: warningdisabled: falseexclude: [""]# https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#defer- name: deferseverity: warningdisabled: falseexclude: [""]arguments:- ["call-chain", "loop"]# https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#dot-imports- name: dot-importsseverity: warningdisabled: falseexclude: [""]arguments: []# https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#duplicated-imports- name: duplicated-importsseverity: warningdisabled: falseexclude: [""]# https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#early-return- name: early-returnseverity: warningdisabled: falseexclude: [""]arguments:- "preserveScope"# https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#empty-block- name: empty-blockseverity: warningdisabled: falseexclude: [""]# https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#empty-lines- name: empty-linesseverity: warningdisabled: falseexclude: [""]# https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#enforce-map-style- name: enforce-map-styleseverity: warningdisabled: falseexclude: [""]arguments:- "make"# https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#enforce-repeated-arg-type-style- name: enforce-repeated-arg-type-styleseverity: warningdisabled: falseexclude: [""]arguments:- "short"# https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#enforce-slice-style- name: enforce-slice-styleseverity: warningdisabled: falseexclude: [""]arguments:- "make"# https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#error-naming- name: error-namingseverity: warningdisabled: falseexclude: [""]# https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#error-return- name: error-returnseverity: warningdisabled: falseexclude: [""]# https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#error-strings- name: error-stringsseverity: warningdisabled: falseexclude: [""]# https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#errorf- name: errorfseverity: warningdisabled: falseexclude: [""]# https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#exported- name: exportedseverity: warningdisabled: falseexclude: [""]arguments:- "preserveScope"- "checkPrivateReceivers"- "sayRepetitiveInsteadOfStutters"# https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#file-header- name: file-headerseverity: warningdisabled: falseexclude: [""]arguments:- This is the text that must appear at the top of source files.# https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#flag-parameter- name: flag-parameterseverity: warningdisabled: falseexclude: [""]# https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#function-length- name: function-lengthseverity: warningdisabled: falseexclude: [""]arguments: [10, 0]# https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#function-result-limit- name: function-result-limitseverity: warningdisabled: falseexclude: [""]arguments: [3]# https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#get-return- name: get-returnseverity: warningdisabled: falseexclude: [""]# https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#identical-branches- name: identical-branchesseverity: warningdisabled: falseexclude: [""]# https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#if-return- name: if-returnseverity: warningdisabled: falseexclude: [""]# https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#import-alias-naming- name: import-alias-namingseverity: warningdisabled: falseexclude: [""]arguments:- "^[a-z][a-z0-9]{0,}$"# https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#import-shadowing- name: import-shadowingseverity: warningdisabled: falseexclude: [""]# https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#imports-blocklist- name: imports-blocklistseverity: warningdisabled: falseexclude: [""]arguments:- "crypto/md5"- "crypto/sha1"# https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#increment-decrement- name: increment-decrementseverity: warningdisabled: falseexclude: [""]# https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#indent-error-flow- name: indent-error-flowseverity: warningdisabled: falseexclude: [""]arguments:- "preserveScope"# https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#line-length-limit- name: line-length-limitseverity: warningdisabled: falseexclude: [""]arguments: [80]# https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#max-control-nesting- name: max-control-nestingseverity: warningdisabled: falseexclude: [""]arguments: [3]# https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#max-public-structs- name: max-public-structsseverity: warningdisabled: falseexclude: [""]arguments: [3]# https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#modifies-parameter- name: modifies-parameterseverity: warningdisabled: falseexclude: [""]# https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#modifies-value-receiver- name: modifies-value-receiverseverity: warningdisabled: falseexclude: [""]# https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#nested-structs- name: nested-structsseverity: warningdisabled: falseexclude: [""]# https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#optimize-operands-order- name: optimize-operands-orderseverity: warningdisabled: falseexclude: [""]# https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#package-comments- name: package-commentsseverity: warningdisabled: falseexclude: [""]# https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#range- name: rangeseverity: warningdisabled: falseexclude: [""]# https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#range-val-address- name: range-val-addressseverity: warningdisabled: falseexclude: [""]# https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#range-val-in-closure- name: range-val-in-closureseverity: warningdisabled: falseexclude: [""]# https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#receiver-naming- name: receiver-namingseverity: warningdisabled: falseexclude: [""]# https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#redefines-builtin-id- name: redefines-builtin-idseverity: warningdisabled: falseexclude: [""]# https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#redundant-import-alias- name: redundant-import-aliasseverity: warningdisabled: falseexclude: [""]# https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#string-format- name: string-formatseverity: warningdisabled: falseexclude: [""]arguments:- - 'core.WriteError[1].Message'- '/^([^A-Z]|$)/'- must not start with a capital letter- - 'fmt.Errorf[0]'- '/(^|[^\.!?])$/'- must not end in punctuation- - panic- '/^[^\n]*$/'- must not contain line breaks# https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#string-of-int- name: string-of-intseverity: warningdisabled: falseexclude: [""]# https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#struct-tag- name: struct-tagseverity: warningdisabled: falseexclude: [""]arguments:- "json,inline"- "bson,outline,gnu"# https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#superfluous-else- name: superfluous-elseseverity: warningdisabled: falseexclude: [""]arguments:- "preserveScope"# https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#time-equal- name: time-equalseverity: warningdisabled: falseexclude: [""]# https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#time-naming- name: time-namingseverity: warningdisabled: falseexclude: [""]# https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#unchecked-type-assertion- name: unchecked-type-assertionseverity: warningdisabled: falseexclude: [""]arguments:- acceptIgnoredAssertionResult: true# https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#unconditional-recursion- name: unconditional-recursionseverity: warningdisabled: falseexclude: [""]# https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#unexported-naming- name: unexported-namingseverity: warningdisabled: falseexclude: [""]# https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#unexported-return- name: unexported-returnseverity: warningdisabled: falseexclude: [""]# https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#unhandled-error- name: unhandled-errorseverity: warningdisabled: falseexclude: [""]arguments:- "fmt.Printf"- "myFunction"# https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#unnecessary-stmt- name: unnecessary-stmtseverity: warningdisabled: falseexclude: [""]# https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#unreachable-code- name: unreachable-codeseverity: warningdisabled: falseexclude: [""]# https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#unused-parameter- name: unused-parameterseverity: warningdisabled: falseexclude: [""]arguments:- allowRegex: "^_"# https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#unused-receiver- name: unused-receiverseverity: warningdisabled: falseexclude: [""]arguments:- allowRegex: "^_"# https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#use-any- name: use-anyseverity: warningdisabled: falseexclude: [""]# https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#useless-break- name: useless-breakseverity: warningdisabled: falseexclude: [""]# https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#var-declaration- name: var-declarationseverity: warningdisabled: falseexclude: [""]# https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#var-naming- name: var-namingseverity: warningdisabled: falseexclude: [""]arguments:- ["ID"] # AllowList- ["VM"] # DenyList- - upperCaseConst: true # Extra parameter (upperCaseConst|skipPackageNameChecks)# https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#waitgroup-by-value- name: waitgroup-by-valueseverity: warningdisabled: falseexclude: [""]
rowserrcheck
Checks whether Rows.Err of rows is checked successfully.
linters-settings:rowserrcheck:# database/sql is always checked# Default: []packages:- github.com/jmoiron/sqlx
sloglint
Ensure consistent code style when using log/slog.
linters-settings:sloglint:# Enforce not mixing key-value pairs and attributes.# https://github.com/go-simpler/sloglint?tab=readme-ov-file#no-mixed-arguments# Default: trueno-mixed-args: false# Enforce using key-value pairs only (overrides no-mixed-args, incompatible with attr-only).# https://github.com/go-simpler/sloglint?tab=readme-ov-file#key-value-pairs-only# Default: falsekv-only: true# Enforce using attributes only (overrides no-mixed-args, incompatible with kv-only).# https://github.com/go-simpler/sloglint?tab=readme-ov-file#attributes-only# Default: falseattr-only: true# Enforce not using global loggers.# Values:# - "": disabled# - "all": report all global loggers# - "default": report only the default slog logger# https://github.com/go-simpler/sloglint?tab=readme-ov-file#no-global# Default: ""no-global: "all"# Enforce using methods that accept a context.# Values:# - "": disabled# - "all": report all contextless calls# - "scope": report only if a context exists in the scope of the outermost function# https://github.com/go-simpler/sloglint?tab=readme-ov-file#context-only# Default: ""context: "all"# Enforce using static values for log messages.# https://github.com/go-simpler/sloglint?tab=readme-ov-file#static-messages# Default: falsestatic-msg: true# Enforce using constants instead of raw keys.# https://github.com/go-simpler/sloglint?tab=readme-ov-file#no-raw-keys# Default: falseno-raw-keys: true# Enforce a single key naming convention.# Values: snake, kebab, camel, pascal# https://github.com/go-simpler/sloglint?tab=readme-ov-file#key-naming-convention# Default: ""key-naming-case: snake# Enforce not using specific keys.# Default: []forbidden-keys:- time- level- msg- source- foo# Enforce putting arguments on separate lines.# https://github.com/go-simpler/sloglint?tab=readme-ov-file#forbidden-keys# Default: falseargs-on-sep-lines: true
spancheck
Checks for mistakes with OpenTelemetry/Census spans.
linters-settings:spancheck:# Checks to enable.# Options include:# - `end`: check that `span.End()` is called# - `record-error`: check that `span.RecordError(err)` is called when an error is returned# - `set-status`: check that `span.SetStatus(codes.Error, msg)` is called when an error is returned# Default: ["end"]checks:- end- record-error- set-status# A list of regexes for function signatures that silence `record-error` and `set-status` reports# if found in the call path to a returned error.# https://github.com/jjti/go-spancheck#ignore-check-signatures# Default: []ignore-check-signatures:- "telemetry.RecordError"# A list of regexes for additional function signatures that create spans.# This is useful if you have a utility method to create spans.# Each entry should be of the form `<regex>:<telemetry-type>`, where `telemetry-type` can be `opentelemetry` or `opencensus`.# https://github.com/jjti/go-spancheck#extra-start-span-signatures# Default: []extra-start-span-signatures:- "github.com/user/repo/telemetry/trace.Start:opentelemetry"
staticcheck
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.
linters-settings:staticcheck:# SAxxxx checks in https://staticcheck.dev/docs/configuration/options/#checks# Default: ["*"]checks: ["all"]
stylecheck
Stylecheck is a replacement for golint.
linters-settings:stylecheck:# STxxxx checks in https://staticcheck.dev/docs/configuration/options/#checks# Default: ["*"]checks: ["all", "-ST1000", "-ST1003", "-ST1016", "-ST1020", "-ST1021", "-ST1022"]# https://staticcheck.dev/docs/configuration/options/#dot_import_whitelist# Default: ["github.com/mmcloughlin/avo/build", "github.com/mmcloughlin/avo/operand", "github.com/mmcloughlin/avo/reg"]dot-import-whitelist:- fmt# https://staticcheck.dev/docs/configuration/options/#initialisms# Default: ["ACL", "API", "ASCII", "CPU", "CSS", "DNS", "EOF", "GUID", "HTML", "HTTP", "HTTPS", "ID", "IP", "JSON", "QPS", "RAM", "RPC", "SLA", "SMTP", "SQL", "SSH", "TCP", "TLS", "TTL", "UDP", "UI", "GID", "UID", "UUID", "URI", "URL", "UTF8", "VM", "XML", "XMPP", "XSRF", "XSS", "SIP", "RTP", "AMQP", "DB", "TS"]initialisms: ["ACL", "API", "ASCII", "CPU", "CSS", "DNS", "EOF", "GUID", "HTML", "HTTP", "HTTPS", "ID", "IP", "JSON", "QPS", "RAM", "RPC", "SLA", "SMTP", "SQL", "SSH", "TCP", "TLS", "TTL", "UDP", "UI", "GID", "UID", "UUID", "URI", "URL", "UTF8", "VM", "XML", "XMPP", "XSRF", "XSS", "SIP", "RTP", "AMQP", "DB", "TS"]# https://staticcheck.dev/docs/configuration/options/#http_status_code_whitelist# Default: ["200", "400", "404", "500"]http-status-code-whitelist: ["200", "400", "404", "500"]
tagalign
Check that struct tags are well aligned.
linters-settings:tagalign:# Align and sort can be used together or separately.## Whether enable align. If true, the struct tags will be aligned.# e.g.:# type FooBar struct {# Bar string `json:"bar" validate:"required"`# FooFoo int8 `json:"foo_foo" validate:"required"`# }# will be formatted to:# type FooBar struct {# Bar string `json:"bar" validate:"required"`# FooFoo int8 `json:"foo_foo" validate:"required"`# }# Default: true.align: false# Whether enable tags sort.# If true, the tags will be sorted by name in ascending order.# e.g.: `xml:"bar" json:"bar" validate:"required"` -> `json:"bar" validate:"required" xml:"bar"`# Default: truesort: false# Specify the order of tags, the other tags will be sorted by name.# This option will be ignored if `sort` is false.# Default: []order:- json- yaml- yml- toml- mapstructure- binding- validate# Whether enable strict style.# In this style, the tags will be sorted and aligned in the dictionary order,# and the tags with the same name will be aligned together.# Note: This option will be ignored if 'align' or 'sort' is false.# Default: falsestrict: true
tagliatelle
Checks the struct tags.
linters-settings:tagliatelle:# Check the struct tag name case.case:# Use the struct field name to check the name of the struct tag.# Default: falseuse-field-name: true# `camel` is used for `json` and `yaml`, and `header` is used for `header` (can be overridden)# Default: {}rules:# Any struct tag type can be used.# Support string case: `camel`, `pascal`, `kebab`, `snake`, `upperSnake`, `goCamel`, `goPascal`, `goKebab`, `goSnake`, `upper`, `lower`, `header`json: camelyaml: camelxml: cameltoml: camelbson: camelavro: snakemapstructure: kebabenv: upperSnakeenvconfig: upperSnake
tenv
Tenv is analyzer that detects using os.Setenv instead of t.Setenv since Go1.17.
linters-settings:tenv:# The option `all` will run against whole test files (`_test.go`) regardless of method/function signatures.# Otherwise, only methods that take `*testing.T`, `*testing.B`, and `testing.TB` as arguments are checked.# Default: falseall: false
testifylint
Checks usage of github.com/stretchr/testify.
linters-settings:testifylint:# Enable all checkers (https://github.com/Antonboom/testifylint#checkers).# Default: falseenable-all: true# Disable checkers by name# (in addition to default# suite-thelper# ).disable:- blank-import- bool-compare- compares- empty- error-is-as- error-nil- expected-actual- float-compare- formatter- go-require- len- negative-positive- nil-compare- require-error- suite-broken-parallel- suite-dont-use-pkg- suite-extra-assert-call- suite-subtest-run- suite-thelper- useless-assert# Disable all checkers (https://github.com/Antonboom/testifylint#checkers).# Default: falsedisable-all: true# Enable checkers by name# (in addition to default# blank-import, bool-compare, compares, empty, error-is-as, error-nil, expected-actual, go-require, float-compare,# formatter, len, negative-positive, nil-compare, require-error, suite-broken-parallel, suite-dont-use-pkg,# suite-extra-assert-call, suite-subtest-run, useless-assert# ).enable:- blank-import- bool-compare- compares- empty- error-is-as- error-nil- expected-actual- float-compare- formatter- go-require- len- negative-positive- nil-compare- require-error- suite-broken-parallel- suite-dont-use-pkg- suite-extra-assert-call- suite-subtest-run- suite-thelper- useless-assertbool-compare:# To ignore user defined types (over builtin bool).# Default: falseignore-custom-types: trueexpected-actual:# Regexp for expected variable name.# Default: (^(exp(ected)?|want(ed)?)([A-Z]\w*)?$)|(^(\w*[a-z])?(Exp(ected)?|Want(ed)?)$)pattern: ^expectedformatter:# To enable go vet's printf checks.# Default: truecheck-format-string: false# To require f-assertions if format string is used.# Default: falserequire-f-funcs: truego-require:# To ignore HTTP handlers (like http.HandlerFunc).# Default: falseignore-http-handlers: truerequire-error:# Regexp for assertions to analyze. If defined, then only matched error assertions will be reported.# Default: ""fn-pattern: ^(Errorf?|NoErrorf?)$suite-extra-assert-call:# To require or remove extra Assert() call?# Default: removemode: require
testpackage
Linter that makes you use a separate _test package.
linters-settings:testpackage:# Regexp pattern to skip files.# Default: "(export|internal)_test\\.go"skip-regexp: (export|internal)_test\.go# List of packages that don't end with _test that tests are allowed to be in.# Default: "main"allow-packages:- example- main
thelper
Thelper detects tests helpers which is not start with t.Helper() method.
linters-settings:thelper:test:# Check *testing.T is first param (or after context.Context) of helper function.# Default: truefirst: false# Check *testing.T param has name t.# Default: truename: false# Check t.Helper() begins helper function.# Default: truebegin: falsebenchmark:# Check *testing.B is first param (or after context.Context) of helper function.# Default: truefirst: false# Check *testing.B param has name b.# Default: truename: false# Check b.Helper() begins helper function.# Default: truebegin: falsetb:# Check *testing.TB is first param (or after context.Context) of helper function.# Default: truefirst: false# Check *testing.TB param has name tb.# Default: truename: false# Check tb.Helper() begins helper function.# Default: truebegin: falsefuzz:# Check *testing.F is first param (or after context.Context) of helper function.# Default: truefirst: false# Check *testing.F param has name f.# Default: truename: false# Check f.Helper() begins helper function.# Default: truebegin: false
usestdlibvars
A linter that detect the possibility to use variables/constants from the Go standard library.
linters-settings:usestdlibvars:# Suggest the use of http.MethodXX.# Default: truehttp-method: false# Suggest the use of http.StatusXX.# Default: truehttp-status-code: false# Suggest the use of time.Weekday.String().# Default: truetime-weekday: true# Suggest the use of time.Month.String().# Default: falsetime-month: true# Suggest the use of time.Layout.# Default: falsetime-layout: true# Suggest the use of crypto.Hash.String().# Default: falsecrypto-hash: true# Suggest the use of rpc.DefaultXXPath.# Default: falsedefault-rpc-path: true# Suggest the use of sql.LevelXX.String().# Default: falsesql-isolation-level: