golangci-lint

Linters

To see a list of supported linters and which linters are enabled/disabled:

golangci-lint help linters

Enabled By Default Linters

NameDescriptionPresetsAutoFixSince
deadcodeFinds unused codeunusedv1.0.0
errcheckErrcheck is a program for checking for unchecked errors in go programs. These unchecked errors can be critical bugs in some casesbugs, errorv1.0.0
gosimpleLinter for Go source code that specializes in simplifying a codestylev1.20.0
govetVet examines Go source code and reports suspicious constructs, such as Printf calls whose arguments do not align with the format stringbugs, metalinterv1.0.0
ineffassignDetects when assignments to existing variables are not usedunusedv1.0.0
staticcheckStaticcheck is a go vet on steroids, applying a ton of static analysis checksbugs, metalinterv1.0.0
structcheckFinds unused struct fieldsunusedv1.0.0
typecheckLike the front-end of a Go compiler, parses and type-checks Go codebugsv1.3.0
unusedChecks Go code for unused constants, variables, functions and typesunusedv1.20.0
varcheckFinds unused global variables and constantsunusedv1.0.0

Disabled By Default Linters (-E/--enable)

NameDescriptionPresetsAutoFixSince
asciicheckSimple linter to check that your code does not contain non-ASCII identifiersbugs, stylev1.26.0
bodyclosechecks whether HTTP response body is closed successfullyperformance, bugsv1.18.0
cyclopchecks function and package cyclomatic complexitycomplexityv1.37.0
depguardGo linter that checks if package imports are in a list of acceptable packagesstyle, import, modulev1.4.0
dogsledChecks assignments with too many blank identifiers (e.g. x, , , _, := f())stylev1.19.0
duplTool for code clone detectionstylev1.0.0
durationcheckcheck for two durations multiplied togetherbugsv1.37.0
errorlinterrorlint 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, errorv1.32.0
exhaustivecheck exhaustiveness of enum switch statementsbugsv1.28.0
exhaustivestructChecks if all struct's fields are initializedstyle, testv1.32.0
exportlooprefchecks for pointers to enclosing loop variablesbugsv1.28.0
forbidigoForbids identifiersstylev1.34.0
forcetypeassertfinds forced type assertionsstylev1.38.0
funlenTool for detection of long functionscomplexityv1.18.0
gciGci control golang package import order and make it always deterministic.format, importv1.30.0
gochecknoglobalscheck that no global variables exist

This analyzer checks for global variables and errors on any found.

A global variable is a variable declared in package scope and that can be read
and written to by any function within the package. Global variables can cause
side effects which are difficult to keep track of. A code in one function may
change the variables state while another unrelated chunk of code may be
effected by it.
stylev1.12.0
gochecknoinitsChecks that no init functions are present in Go codestylev1.12.0
gocognitComputes and checks the cognitive complexity of functionscomplexityv1.20.0
goconstFinds repeated strings that could be replaced by a constantstylev1.0.0
gocriticProvides many 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, metalinterv1.12.0
gocycloComputes and checks the cyclomatic complexity of functionscomplexityv1.0.0
godotCheck if comments end in a periodstyle, commentv1.25.0
godoxTool for detection of FIXME, TODO and other comment keywordsstyle, commentv1.19.0
goerr113Golang linter to check the errors handling expressionsstyle, errorv1.26.0
gofmtGofmt checks whether code was gofmt-ed. By default this tool runs with -s option to check for code simplificationformatv1.0.0
gofumptGofumpt checks whether code was gofumpt-ed.formatv1.28.0
goheaderChecks is file header matches to patternstylev1.28.0
goimportsGoimports does everything that gofmt does. Additionally it checks unused importsformat, importv1.20.0
golint The repository of the linter has been archived by the owner. Replaced by revive.stylev1.0.0
gomndAn analyzer to detect magic numbers.stylev1.22.0
gomoddirectivesManage the use of 'replace', 'retract', and 'excludes' directives in go.mod.style, modulev1.39.0
gomodguardAllow 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, modulev1.25.0
goprintffuncnameChecks that printf-like functions are named with f at the endstylev1.23.0
gosecInspects source code for security problemsbugsv1.0.0
ifshortChecks that your code uses short syntax for if-statements whenever possiblestylev1.36.0
importasEnforces consistent import aliasesstylev1.38.0
interfacer The repository of the linter has been archived by the owner.stylev1.0.0
lllReports long linesstylev1.8.0
makezeroFinds slice declarations with non-zero initial lengthstyle, bugsv1.34.0
maligned The repository of the linter has been archived by the owner. Replaced by govet 'fieldalignment'.performancev1.0.0
misspellFinds commonly misspelled English words in commentsstyle, commentv1.8.0
nakedretFinds naked returns in functions greater than a specified function lengthstylev1.19.0
nestifReports deeply nested if statementscomplexityv1.25.0
nilerrFinds the code that returns nil even if it checks that the error is not nil.bugsv1.38.0
nlreturnnlreturn checks for a new line before return and branch statements to increase code claritystylev1.30.0
noctxnoctx finds sending http request without context.Contextperformance, bugsv1.28.0
nolintlintReports ill-formed or insufficient nolint directivesstylev1.26.0
paralleltestparalleltest detects missing usage of t.Parallel() method in your Go teststyle, testv1.33.0
preallocFinds slice declarations that could potentially be preallocatedperformancev1.19.0
predeclaredfind code that shadows one of Go's predeclared identifiersstylev1.35.0
promlinterCheck Prometheus metrics naming via promlintstylev1.40.0
reviveFast, configurable, extensible, flexible, and beautiful linter for Go. Drop-in replacement of golint.style, metalinterv1.37.0
rowserrcheckchecks whether Err of rows is checked successfullybugs, sqlv1.23.0
scopelint The repository of the linter has been deprecated by the owner. Replaced by exportloopref.bugsv1.12.0
sqlclosecheckChecks that sql.Rows and sql.Stmt are closed.bugs, sqlv1.28.0
stylecheckStylecheck is a replacement for golintstylev1.20.0
tagliatelleChecks the struct tags.stylev1.40.0
testpackagelinter that makes you use a separate _test packagestyle, testv1.25.0
thelperthelper detects golang test helpers without t.Helper() call and checks the consistency of test helpersstylev1.34.0
tparalleltparallel detects inappropriate usage of t.Parallel() method in your Go test codesstyle, testv1.32.0
unconvertRemove unnecessary type conversionsstylev1.0.0
unparamReports unused function parametersunusedv1.9.0
wastedassignwastedassign finds wasted assignment statements.stylev1.38.0
whitespaceTool for detection of leading and trailing whitespacestylev1.19.0
wrapcheckChecks that errors returned from external packages are wrappedstyle, errorv1.32.0
wslWhitespace Linter - Forces you to use empty lines!stylev1.20.0

Linters Configuration

cyclop

linters-settings:
cyclop:
# the maximal code complexity to report
max-complexity: 10
# the maximal average package complexity. If it's higher than 0.0 (float) the check is enabled (default 0.0)
package-average: 0.0
# should ignore tests (default false)
skip-tests: false

dogsled

linters-settings:
dogsled:
# checks assignments with too many blank identifiers; default is 2
max-blank-identifiers: 2

dupl

linters-settings:
dupl:
# tokens count to trigger issue, 150 by default
threshold: 100

errcheck

linters-settings:
errcheck:
# report about not checking of errors in type assertions: `a := b.(MyStruct)`;
# default is false: such cases aren't reported by default.
check-type-assertions: false
# report about assignment of errors to blank identifier: `num, _ := strconv.Atoi(numStr)`;
# default is false: such cases aren't reported by default.
check-blank: false
# [deprecated] comma-separated list of pairs of the form pkg:regex
# the regex is used to ignore names within pkg. (default "fmt:.*").
# see https://github.com/kisielk/errcheck#the-deprecated-method for details
ignore: fmt:.*,io/ioutil:^Read.*
# path to a file containing a list of functions to exclude from checking
# see https://github.com/kisielk/errcheck#excluding-functions for details
exclude: /path/to/file.txt

errorlint

linters-settings:
errorlint:
# Check whether fmt.Errorf uses the %w verb for formatting errors. See the readme for caveats
errorf: true
# Check for plain type assertions and type switches
asserts: true
# Check for plain error comparisons
comparison: true

exhaustive

linters-settings:
exhaustive:
# check switch statements in generated files also
check-generated: false
# indicates that switch statements are to be considered exhaustive if a
# 'default' case is present, even if all enum members aren't listed in the
# switch
default-signifies-exhaustive: false

exhaustivestruct

linters-settings:
exhaustivestruct:
# Struct Patterns is list of expressions to match struct packages and names
# The struct packages have the form example.com/package.ExampleStruct
# The matching patterns can use matching syntax from https://pkg.go.dev/path#Match
# If this list is empty, all structs are tested.
struct-patterns:
- '*.Test'
- 'example.com/package.ExampleStruct'

forbidigo

linters-settings:
forbidigo:
# Forbid the following identifiers
forbid:
- fmt.Errorf # consider errors.Errorf in github.com/pkg/errors
- fmt.Print.* # too much log noise
- ginkgo\\.F.* # these are used just for local development
# Exclude godoc examples from forbidigo checks. Default is true.
exclude_godoc_examples: false

funlen

linters-settings:
funlen:
lines: 60
statements: 40

gci

linters-settings:
gci:
# put imports beginning with prefix after 3rd-party packages;
# only support one prefix
# if not set, use goimports.local-prefixes
local-prefixes: github.com/org/project

gocognit

linters-settings:
gocognit:
# minimal code complexity to report, 30 by default (but we recommend 10-20)
min-complexity: 10

nestif

linters-settings:
nestif:
# minimal complexity of if statements to report, 5 by default
min-complexity: 4

goconst

linters-settings:
goconst:
# minimal length of string constant, 3 by default
min-len: 3
# minimal occurrences count to trigger, 3 by default
min-occurrences: 3

gocritic

linters-settings:
gocritic:
# Which checks should be enabled; can't be combined with 'disabled-checks';
# See https://go-critic.github.io/overview#checks-overview
# To check which checks are enabled run `GL_DEBUG=gocritic golangci-lint run`
# By default list of stable checks is used.
enabled-checks:
- rangeValCopy
# Which checks should be disabled; can't be combined with 'enabled-checks'; default is empty
disabled-checks:
- regexpMust
# Enable multiple checks by tags, run `GL_DEBUG=gocritic golangci-lint run` to see all tags and checks.
# Empty list by default. See https://github.com/go-critic/go-critic#usage -> section "Tags".
enabled-tags:
- performance
disabled-tags:
- experimental
# 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:
captLocal: # must be valid enabled check name
# whether to restrict checker to params only (default true)
paramsOnly: true
elseif:
# whether to skip balanced if-else pairs (default true)
skipBalanced: true
hugeParam:
# size in bytes that makes the warning trigger (default 80)
sizeThreshold: 80
nestingReduce:
# min number of statements inside a branch to trigger a warning (default 5)
bodyWidth: 5
rangeExprCopy:
# size in bytes that makes the warning trigger (default 512)
sizeThreshold: 512
# whether to check test functions (default true)
skipTestFuncs: true
rangeValCopy:
# size in bytes that makes the warning trigger (default 128)
sizeThreshold: 32
# whether to check test functions (default true)
skipTestFuncs: true
ruleguard:
# path to a gorules file for the ruleguard checker
rules: ''
truncateCmp:
# whether to skip int/uint/uintptr types (default true)
skipArchDependent: true
underef:
# whether to skip (*x).method() calls where x is a pointer receiver (default true)
skipRecvDeref: true
unnamedResult:
# whether to check exported functions
checkExported: true

gocyclo

linters-settings:
gocyclo:
# minimal code complexity to report, 30 by default (but we recommend 10-20)
min-complexity: 10

godot

linters-settings:
godot:
# comments to be checked: `declarations`, `toplevel`, or `all`
scope: declarations
# list of regexps for excluding particular comment lines from check
exclude:
# example: exclude comments which contain numbers
# - '[0-9]+'
# check that each sentence starts with a capital letter
capital: false

godox

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
keywords: # default keywords are TODO, BUG, and FIXME, these can be overwritten by this setting
- NOTE
- OPTIMIZE # marks code that should be optimized before merging
- HACK # marks hack-arounds that should be removed before merging

gofmt

linters-settings:
gofmt:
# simplify code: gofmt with `-s` option, true by default
simplify: true

gofumpt

linters-settings:
gofumpt:
# Choose whether or not to use the extra rules that are disabled
# by default
extra-rules: false

goheader

linters-settings:
goheader:
values:
const:
# define here const type values in format k:v, for example:
# COMPANY: MY COMPANY
regexp:
# define here regexp type values, for example
# AUTHOR: .*@mycompany\.com
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.
template-path:
# also as alternative of directive 'template' you may put the path to file with the template source

goimports

linters-settings:
goimports:
# put imports beginning with prefix after 3rd-party packages;
# it's a comma-separated list of prefixes
local-prefixes: github.com/org/project

golint

linters-settings:
golint:
# minimal confidence for issues, default is 0.8
min-confidence: 0.8

gomnd

linters-settings:
gomnd:
settings:
mnd:
# the list of enabled checks, see https://github.com/tommy-muehle/go-mnd/#checks for description.
checks: argument,case,condition,operation,return,assign
# ignored-numbers: 1000
# ignored-files: magic_.*.go
# ignored-functions: math.*

gomoddirectives

linters-settings:
gomoddirectives:
# Allow local `replace` directives. Default is false.
replace-local: false
# List of allowed `replace` directives. Default is empty.
replace-allow-list:
- launchpad.net/gocheck
# Allow to not explain why the version has been retracted in the `retract` directives. Default is false.
retract-allow-no-explanation: false
# Forbid the use of the `exclude` directives. Default is false.
exclude-forbidden: false

gomodguard

linters-settings:
gomodguard:
allowed:
modules: # List of allowed modules
# - gopkg.in/yaml.v2
domains: # List of allowed module domains
# - golang.org
blocked:
modules: # List of blocked modules
# - github.com/uudashr/go-module: # Blocked module
# recommendations: # Recommended modules that should be used instead (Optional)
# - golang.org/x/mod
# reason: "`mod` is the official go.mod parser library." # Reason why the recommended module should be used (Optional)
versions: # List of blocked module version constraints
# - github.com/mitchellh/go-homedir: # Blocked module with version constraint
# version: "< 1.1.0" # Version constraint, see https://github.com/Masterminds/semver#basic-comparisons
# reason: "testing if blocked version constraint works." # Reason why the version constraint exists. (Optional)
local_replace_directives: false # Set to true to raise lint issues for packages that are loaded from a local path via replace directive

gosec

linters-settings:
gosec:
# To select a subset of rules to run.
# Available rules: https://github.com/securego/gosec#available-rules
includes:
- G401
- G306
- G101
# To specify a set of rules to explicitly exclude.
# Available rules: https://github.com/securego/gosec#available-rules
excludes:
- G204
# To specify the configuration of rules.
# The configuration of rules is not fully documented by gosec:
# https://github.com/securego/gosec#configuration
# https://github.com/securego/gosec/blob/569328eade2ccbad4ce2d0f21ee158ab5356a5cf/rules/rulelist.go#L60-L102
config:
G306: "0600"
G101:
pattern: "(?i)example"
ignore_entropy: false
entropy_threshold: "80.0"
per_char_threshold: "3.0"
truncate: "32"

gosimple

linters-settings:
gosimple:
# Select the Go version to target. The default is '1.13'.
go: "1.15"

govet

linters-settings:
govet:
# report about shadowed variables
check-shadowing: true
# settings per analyzer
settings:
printf: # analyzer name, run `go tool vet help` to see all analyzers
funcs: # run `go tool vet help printf` to see available settings for `printf` analyzer
- (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).Fatalf
# enable or disable analyzers by name
# run `go tool vet help` to see all analyzers
enable:
- atomicalign
enable-all: false
disable:
- shadow
disable-all: false

depguard

linters-settings:
depguard:
list-type: blacklist
include-go-root: false
packages:
- github.com/sirupsen/logrus
packages-with-error-message:
- # specify an error message to output when a blacklisted package is used
github.com/sirupsen/logrus: "logging is allowed only by logutils.Log"

ifshort

linters-settings:
ifshort:
# Maximum length of variable declaration measured in number of lines, after which linter won't suggest using short syntax.
# Has higher priority than max-decl-chars.
max-decl-lines: 1
# Maximum length of variable declaration measured in number of characters, after which linter won't suggest using short syntax.
max-decl-chars: 30

importas

linters-settings:
importas:
# if set to `true`, force to use alias.
no-unaliased: true
# List of aliases
alias:
- # using `servingv1` alias for `knative.dev/serving/pkg/apis/serving/v1` package
pkg: knative.dev/serving/pkg/apis/serving/v1
alias: servingv1
- # using `autoscalingv1alpha1` alias for `knative.dev/serving/pkg/apis/autoscaling/v1alpha1` package
pkg: knative.dev/serving/pkg/apis/autoscaling/v1alpha1
alias: 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

lll

linters-settings:
lll:
# max line length, lines longer will be reported. Default is 120.
# '\t' is counted as 1 character by default, and can be changed with the tab-width option
line-length: 120
# tab width in spaces. Default to 1.
tab-width: 1

makezero

linters-settings:
makezero:
# Allow only slices initialized with a length of zero. Default is false.
always: false

maligned

linters-settings:
maligned:
# print struct with more effective memory layout or not, false by default
suggest-new: true

misspell

linters-settings:
misspell:
# Correct spellings using locale preferences for US or UK.
# Default is to use a neutral variety of English.
# Setting locale to US will correct the British spelling of 'colour' to 'color'.
locale: US
ignore-words:
- someword

nakedret

linters-settings:
nakedret:
# make an issue if func has more lines of code than this setting and it has naked returns; default is 30
max-func-lines: 30

prealloc

linters-settings:
prealloc:
# Report preallocation suggestions only on simple loops that have no returns/breaks/continues/gotos in them.
# True by default.
simple: true
# XXX: we don't recommend using this linter before doing performance profiling.
# For most programs usage of prealloc will be a premature optimization.
range-loops: true # Report preallocation suggestions on range loops, true by default
for-loops: false # Report preallocation suggestions on for loops, false by default

promlinter

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.
strict: false
# Please refer to https://github.com/yeya24/promlinter#usage for detailed usage.
disabled-linters:
# - "Help"
# - "MetricUnits"
# - "Counter"
# - "HistogramSummaryReserved"
# - "MetricTypeInName"
# - "ReservedChars"
# - "CamelCase"
# - "lintUnitAbbreviations"

predeclared

linters-settings:
predeclared:
# comma-separated list of predeclared identifiers to not report on
ignore: ""
# include method names and field names (i.e., qualified names) in checks
q: false

nolintlint

linters-settings:
nolintlint:
# Enable to ensure that nolint directives are all used. Default is true.
allow-unused: false
# Disable to ensure that nolint directives don't have a leading space. Default is true.
allow-leading-space: true
# Exclude following linters from requiring an explanation. Default is [].
allow-no-explanation: []
# Enable to require an explanation of nonzero length after each nolint directive. Default is false.
require-explanation: true
# Enable to require nolint directives to mention the specific linter being suppressed. Default is false.
require-specific: true

rowserrcheck

linters-settings:
rowserrcheck:
packages:
- github.com/jmoiron/sqlx
-

revive

linters-settings:
revive:
# see https://github.com/mgechev/revive#available-rules for details.
ignore-generated-header: true
severity: warning
rules:
- name: indent-error-flow
severity: warning

staticcheck

linters-settings:
staticcheck:
# Select the Go version to target. The default is '1.13'.
go: "1.15"

stylecheck

linters-settings:
stylecheck:
# Select the Go version to target. The default is '1.13'.
go: "1.15"

tagliatelle

linters-settings:
tagliatelle:
# check the struck tag name case
case:
# use the struct field name to check the name of the struct tag
use-field-name: true
rules:
# any struct tag type can be used.
# support string case: `camel`, `pascal`, `kebab`, `snake`, `goCamel`, `goPascal`, `goKebab`, `goSnake`, `upper`, `lower`
json: camel
yaml: camel
xml: camel
bson: camel
avro: snake
mapstructure: kebab

testpackage

linters-settings:
testpackage:
# regexp pattern to skip files
skip-regexp: (export|internal)_test\.go

thelper

linters-settings:
thelper:
# The following configurations enable all checks. It can be omitted because all checks are enabled by default.
# You can enable only required checks deleting unnecessary checks.
test:
first: true
name: true
begin: true
benchmark:
first: true
name: true
begin: true
tb:
first: true
name: true
begin: true

unparam

linters-settings:
unparam:
# Inspect exported functions, default is false. Set to true if no external program/library imports your code.
# XXX: if you enable this setting, unparam will report a lot of false-positives in text editors:
# if it's called for subdir of a project it can't find external interfaces. All text editor integrations
# with golangci-lint call it on a directory with the changed file.
check-exported: false

unused

linters-settings:
unused:
# Select the Go version to target. The default is '1.13'.
go: "1.15"

whitespace

linters-settings:
whitespace:
multi-if: false # Enforces newlines (or comments) after every multi-line if statement
multi-func: false # Enforces newlines (or comments) after every multi-line function signature

wrapcheck

linters-settings:
wrapcheck:
# An array of strings that specify substrings of signatures to ignore.
# If this set, it will override the default set of ignored signatures.
# See https://github.com/tomarrell/wrapcheck#configuration for more information.
ignoreSigs:
- .Errorf(
- errors.New(
- errors.Unwrap(
- .Wrap(
- .Wrapf(
- .WithMessage(

wsl

linters-settings:
wsl:
# See https://github.com/bombsimon/wsl/blob/master/doc/configuration.md for
# documentation of available settings. These are the defaults for
# `golangci-lint`.
allow-assign-and-anything: false
allow-assign-and-call: true
allow-cuddle-declarations: false
allow-multiline-assign: true
allow-separated-leading-comment: false
allow-trailing-comment: false
force-case-trailing-whitespace: 0
force-err-cuddling: false
force-short-decl-cuddling: false
strict-append: true

custom

linters-settings:
# The custom section can be used to define linter plugins to be loaded at runtime.
# See README doc for more info.
custom:
# Each custom linter should have a unique name.
example:
# The path to the plugin *.so. Can be absolute or local. Required for each custom linter
path: /path/to/example.so
# The description of the linter. Optional, just for documentation purposes.
description: This is an example usage of a plugin linter.
# Intended to point to the repo location of the linter. Optional, just for documentation purposes.
original-url: github.com/golangci/example-linter
Edit this page on GitHub