golangci-lint

Linters

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

golangci-lint help linters

Enabled by Default

NameDescriptionPresetsAutoFixSince
deadcodeFinds unused codeunusedv1.0.0
errcheck ⚙️Errcheck is a program for checking for unchecked errors in go programs. These unchecked errors can be critical bugs in some casesbugs, errorv1.0.0
gosimple ⚙️Linter for Go source code that specializes in simplifying a codestylev1.20.0
govet ⚙️Vet 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
staticcheck ⚙️Staticcheck is a go vet on steroids, applying a ton of static analysis checksbugs, metalinterv1.0.0
structcheck ⚙️Finds unused struct fieldsunusedv1.0.0
typecheckLike the front-end of a Go compiler, parses and type-checks Go codebugsv1.3.0
unused ⚙️Checks Go code for unused constants, variables, functions and typesunusedv1.20.0
varcheck ⚙️Finds unused global variables and constantsunusedv1.0.0

Disabled by Default

NameDescriptionPresetsAutoFixSince
asciicheckSimple linter to check that your code does not contain non-ASCII identifiersbugs, stylev1.26.0
bidichk ⚙️Checks for dangerous unicode character sequencesbugs1.43.0
bodyclosechecks whether HTTP response body is closed successfullyperformance, bugsv1.18.0
containedctxcontainedctx is a linter that detects struct contained context.Context fieldstyle1.44.0
contextcheckcheck the function whether use a non-inherited contextbugsv1.43.0
cyclop ⚙️checks function and package cyclomatic complexitycomplexityv1.37.0
decorder ⚙️check declaration order and count of types, constants, variables and functionsformat, stylev1.44.0
depguard ⚙️Go linter that checks if package imports are in a list of acceptable packagesstyle, import, modulev1.4.0
dogsled ⚙️Checks assignments with too many blank identifiers (e.g. x, , , _, := f())stylev1.19.0
dupl ⚙️Tool for code clone detectionstylev1.0.0
durationcheckcheck for two durations multiplied togetherbugsv1.37.0
errchkjson ⚙️Checks types passed to the json encoding functions. Reports unsupported types and optionally reports occasions, where the check for the returned error can be omitted.bugs1.44.0
errnameChecks that sentinel errors are prefixed with the Err and error types are suffixed with the Error.stylev1.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, errorv1.32.0
execinqueryexecinquery is a linter about query string checker in Query function which reads your Go src files and warning it findssqlv1.46.0
exhaustive ⚙️check exhaustiveness of enum switch statementsbugsv1.28.0
exhaustivestruct ⚙️ The owner seems to have abandoned the linter. Replaced by exhaustruct.style, testv1.32.0
exhaustruct ⚙️Checks if all structure fields are initializedstyle, testv1.46.0
exportlooprefchecks for pointers to enclosing loop variablesbugsv1.28.0
forbidigo ⚙️Forbids identifiersstylev1.34.0
forcetypeassertfinds forced type assertionsstylev1.38.0
funlen ⚙️Tool for detection of long functionscomplexityv1.18.0
gci ⚙️Gci controls golang package import order and makes 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
gocognit ⚙️Computes and checks the cognitive complexity of functionscomplexityv1.20.0
goconst ⚙️Finds repeated strings that could be replaced by a constantstylev1.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, metalinterv1.12.0
gocyclo ⚙️Computes and checks the cyclomatic complexity of functionscomplexityv1.0.0
godot ⚙️Check if comments end in a periodstyle, commentv1.25.0
godox ⚙️Tool for detection of FIXME, TODO and other comment keywordsstyle, commentv1.19.0
goerr113Golang linter to check the errors handling expressionsstyle, errorv1.26.0
gofmt ⚙️Gofmt checks whether code was gofmt-ed. By default this tool runs with -s option to check for code simplificationformatv1.0.0
gofumpt ⚙️Gofumpt checks whether code was gofumpt-ed.formatv1.28.0
goheader ⚙️Checks is file header matches to patternstylev1.28.0
goimports ⚙️In addition to fixing imports, goimports also formats your code in the same style as gofmt.format, importv1.20.0
golint ⚙️ The repository of the linter has been archived by the owner. Replaced by revive.stylev1.0.0
gomnd ⚙️An analyzer to detect magic numbers.stylev1.22.0
gomoddirectives ⚙️Manage the use of 'replace', 'retract', and 'excludes' directives in go.mod.style, modulev1.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, modulev1.25.0
goprintffuncnameChecks that printf-like functions are named with f at the endstylev1.23.0
gosec ⚙️Inspects source code for security problemsbugsv1.0.0
grouper ⚙️An analyzer to analyze expression groups.stylev1.44.0
ifshort ⚙️Checks that your code uses short syntax for if-statements whenever possiblestylev1.36.0
importas ⚙️Enforces consistent import aliasesstylev1.38.0
interfacer The repository of the linter has been archived by the owner.stylev1.0.0
ireturn ⚙️Accept Interfaces, Return Concrete Typesstylev1.43.0
lll ⚙️Reports long linesstylev1.8.0
maintidx ⚙️maintidx measures the maintainability index of each function.complexityv1.44.0
makezero ⚙️Finds 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
misspell ⚙️Finds commonly misspelled English words in commentsstyle, commentv1.8.0
nakedret ⚙️Finds naked returns in functions greater than a specified function lengthstylev1.19.0
nestif ⚙️Reports 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
nilnil ⚙️Checks that there is no simultaneous return of nil error and an invalid value.stylev1.43.0
nlreturn ⚙️nlreturn 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
nolintlint ⚙️Reports ill-formed or insufficient nolint directivesstylev1.26.0
nonamedreturnsReports all named returnsstylev1.46.0
nosprintfhostportChecks for misuse of Sprintf to construct a host with port in a URL.stylev1.46.0
paralleltestparalleltest detects missing usage of t.Parallel() method in your Go teststyle, testv1.33.0
prealloc ⚙️Finds slice declarations that could potentially be preallocatedperformancev1.19.0
predeclared ⚙️find code that shadows one of Go's predeclared identifiersstylev1.35.0
promlinter ⚙️Check Prometheus metrics naming via promlintstylev1.40.0
revive ⚙️Fast, configurable, extensible, flexible, and beautiful linter for Go. Drop-in replacement of golint.style, metalinterv1.37.0
rowserrcheck ⚙️checks 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
stylecheck ⚙️Stylecheck is a replacement for golintstylev1.20.0
tagliatelle ⚙️Checks the struct tags.stylev1.40.0
tenv ⚙️tenv is analyzer that detects using os.Setenv instead of t.Setenv since Go1.17stylev1.43.0
testpackage ⚙️linter that makes you use a separate _test packagestyle, testv1.25.0
thelper ⚙️thelper 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
unparam ⚙️Reports unused function parametersunusedv1.9.0
varnamelen ⚙️checks that the length of a variable's name matches its scopestylev1.43.0
wastedassignwastedassign finds wasted assignment statements.stylev1.38.0
whitespace ⚙️Tool for detection of leading and trailing whitespacestylev1.19.0
wrapcheck ⚙️Checks that errors returned from external packages are wrappedstyle, errorv1.32.0
wsl ⚙️Whitespace Linter - Forces you to use empty lines!stylev1.20.0

Linters Configuration

bidichk

linters-settings:
bidichk:
# The following configurations check for all mentioned invisible unicode runes.
# All runes are enabled by default.
left-to-right-embedding: false
right-to-left-embedding: false
pop-directional-formatting: false
left-to-right-override: false
right-to-left-override: false
left-to-right-isolate: false
right-to-left-isolate: false
first-strong-isolate: false
pop-directional-isolate: false

🔼

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.5
# Should ignore tests.
# Default: false
skip-tests: true

🔼

decorder

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, 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

🔼

depguard

linters-settings:
depguard:
# Kind of list is passed in.
# Allowed values: allowlist|denylist
# Default: denylist
list-type: allowlist
# Check the list against standard lib.
# Default: false
include-go-root: true
# A list of packages for the list type specified.
# Default: []
packages:
- github.com/sirupsen/logrus
# A list of packages for the list type specified.
# Specify an error message to output when a denied package is used.
# Default: []
packages-with-error-message:
- github.com/sirupsen/logrus: 'logging is allowed only by logutils.Log'
# Create additional guards that follow the same configuration pattern.
# Results from all guards are aggregated together.
additional-guards:
- list-type: denylist
include-go-root: false
packages:
- github.com/stretchr/testify
# Specify rules by which the linter ignores certain files for consideration.
ignore-file-rules:
- "**/*_test.go"
- "**/mock/**/*.go"

🔼

dogsled

linters-settings:
dogsled:
# Checks assignments with too many blank identifiers.
# Default: 2
max-blank-identifiers: 3

🔼

dupl

linters-settings:
dupl:
# Tokens count to trigger issue.
# Default: 150
threshold: 100

🔼

errcheck

linters-settings:
errcheck:
# Report about not checking of errors in type assertions: `a := b.(MyStruct)`.
# Such cases aren't reported by default.
# Default: false
check-type-assertions: true
# report about assignment of errors to blank identifier: `num, _ := strconv.Atoi(numStr)`.
# Such cases aren't reported by default.
# Default: false
check-blank: true
# 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.*
# To disable the errcheck built-in exclude list.
# See `-excludeonly` option in https://github.com/kisielk/errcheck#excluding-functions for details.
# Default: false
disable-default-exclusions: true
# DEPRECATED use exclude-functions instead.
#
# 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
# 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

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: false
check-error-free-encoding: true
# Issue on struct encoding that doesn't have exported fields.
# Default: false
report-no-exported: false

🔼

errorlint

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: true
errorf: false
# Check for plain type assertions and type switches.
# Default: true
asserts: false
# Check for plain error comparisons.
# Default: true
comparison: false

🔼

exhaustive

linters-settings:
exhaustive:
# Check switch statements in generated files also.
# Default: false
check-generated: true
# Presence of "default" case in switch statements satisfies exhaustiveness,
# even if all enum members are not listed.
# Default: false
default-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.+"
# Consider enums only in package scopes, not in inner scopes.
# Default: false
package-scope-only: true

🔼

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'

🔼

exhaustruct

linters-settings:
exhaustruct:
# List of regular expressions to match struct packages and names.
# If this list is empty, all structs are tested.
include:
- '.*\.Test'
- 'example\.com/package\.ExampleStruct[\d]{1,2}'
# List of regular expressions to exclude struct packages and names from check.
exclude:
- 'cobra\.Command$'

🔼

forbidigo

linters-settings:
forbidigo:
# Forbid the following identifiers (list of regexp).
forbid:
- ^print.*$
- 'fmt\.Print.*'
# Optionally put comments at the end of the regex, surrounded by `(# )?`
# Escape any special characters.
- 'fmt\.Print.*(# Do not commit print statements\.)?'
# Exclude godoc examples from forbidigo checks.
# Default: true
exclude_godoc_examples: false

🔼

funlen

linters-settings:
funlen:
# Checks the number of lines in a function.
# If lower than 0, disable the check.
# Default: 60
lines: -1
# Checks the number of statements in a function.
# If lower than 0, disable the check.
# Default: 40
statements: -1

🔼

gci

linters-settings:
gci:
# DEPRECATED: use `sections` and `prefix(github.com/org/project)` instead.
local-prefixes: github.com/org/project
# Checks that no inline Comments are present.
# Default: false
no-inline-comments: true
# Checks that no prefix Comments(comment lines above an import) are present.
# Default: false
no-prefix-comments: true
# Section configuration to compare against.
# Section names are case-insensitive and may contain parameters in ().
# Default: ["standard", "default"]
sections:
- standard # Captures all standard packages if they do not match another section.
- default # Contains all imports that could not be matched to another section type.
- comment(your text here) # Prints the specified indented comment.
- newLine # Prints an empty line
- prefix(github.com/org/project) # Groups all imports with the specified Prefix.
# Separators that should be present between sections.
# Default: ["newLine"]
section-separators:
- newLine

🔼

gocognit

linters-settings:
gocognit:
# Minimal code complexity to report
# Default: 30 (but we recommend 10-20)
min-complexity: 10

🔼

goconst

linters-settings:
goconst:
# Minimal length of string constant.
# Default: 3
min-len: 2
# Minimum occurrences of constant string count to trigger issue.
# Default: 3
min-occurrences: 2
# Ignore test files.
# Default: false
ignore-tests: true
# Look for existing constants matching the values.
# Default: true
match-constant: false
# Search also for duplicated numbers.
# Default: false
numbers: true
# Minimum value, only works with goconst.numbers
# Default: 3
min: 2
# Maximum value, only works with goconst.numbers
# Default: 3
max: 2
# Ignore when constant is not used as function argument.
# Default: true
ignore-calls: false

🔼

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:
- nestingReduce
- unnamedResult
- ruleguard
- truncateCmp
# Which checks should be disabled; can't be combined with 'enabled-checks'.
# Default: []
disabled-checks:
- regexpMust
# Enable multiple checks by tags, run `GL_DEBUG=gocritic golangci-lint run` to see all tags and checks.
# See https://github.com/go-critic/go-critic#usage -> section "Tags".
# Default: []
enabled-tags:
- diagnostic
- style
- performance
- experimental
- opinionated
disabled-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: true
paramsOnly: false
elseif:
# Whether to skip balanced if-else pairs.
# Default: true
skipBalanced: false
hugeParam:
# Size in bytes that makes the warning trigger.
# Default: 80
sizeThreshold: 70
nestingReduce:
# Min number of statements inside a branch to trigger a warning.
# Default: 5
bodyWidth: 4
rangeExprCopy:
# Size in bytes that makes the warning trigger.
# Default: 512
sizeThreshold: 516
# Whether to check test functions
# Default: true
skipTestFuncs: false
rangeValCopy:
# Size in bytes that makes the warning trigger.
# Default: 128
sizeThreshold: 32
# Whether to check test functions.
# Default: true
skipTestFuncs: false
ruleguard:
# 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 flag is passed to the ruleguard 'debug-group' argument.
debug: 'emptyDecl'
# Deprecated, use 'failOn' param.
# If set to true, identical to failOn='all', otherwise failOn=''
failOnError: false
# 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.
failOn: dsl
# 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.
rules: '${configDir}/ruleguard/rules-*.go,${configDir}/myrule1.go'
tooManyResultsChecker:
# Maximum number of results.
# Default: 5
maxResults: 10
truncateCmp:
# Whether to skip int/uint/uintptr types.
# Default: true
skipArchDependent: false
underef:
# Whether to skip (*x).method() calls where x is a pointer receiver.
# Default: true
skipRecvDeref: false
unnamedResult:
# Whether to check exported functions.
checkExported: true

🔼

gocyclo

linters-settings:
gocyclo:
# Minimal code complexity to report.
# Default: 30 (but we recommend 10-20)
min-complexity: 10

🔼

godot

linters-settings:
godot:
# Comments to be checked: `declarations`, `toplevel`, or `all`.
# Default: declarations
scope: toplevel
# List of regexps for excluding particular comment lines from check.
exclude:
# Exclude todo and fixme comments.
- "^fixme:"
- "^todo:"
# Check that each sentence ends with a period.
# Default: true
period: false
# Check that each sentence starts with a capital letter.
# Default: false
capital: true

🔼

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.
# Default: TODO, BUG, and FIXME.
keywords:
- NOTE
- OPTIMIZE # marks code that should be optimized before merging
- HACK # marks hack-around that should be removed before merging

🔼

gofmt

linters-settings:
gofmt:
# Simplify code: gofmt with `-s` option.
# Default: true
simplify: false

🔼

gofumpt

linters-settings:
gofumpt:
# Select the Go version to target.
# Default: 1.15
lang-version: "1.17"
# Module path which contains the source code being formatted.
# Default: empty string
module-path: github.com/org/project
# Choose whether to use the extra rules.
# Default: false
extra-rules: true

🔼

goheader

linters-settings:
goheader:
# Supports two types 'const` and `regexp`.
# Values can be used recursively.
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
# The template use for checking.
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.
template-path: /path/to/my/template.tmpl

🔼

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: 0.8
min-confidence: 0.7

🔼

gomnd

linters-settings:
gomnd:
# List of enabled checks, see https://github.com/tommy-muehle/go-mnd/#checks for description.
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"
ignored-numbers:
- '0666'
- '0755'
- '42'
# List of file patterns to exclude from analysis.
# Values always ignored: `.+_test.go`
ignored-files:
- 'magic1_.*.go'
# List of function patterns to exclude from analysis.
# Values always ignored: `time.Time`
ignored-functions:
- 'math.*'
- 'http.StatusText'

🔼

gomoddirectives

linters-settings:
gomoddirectives:
# Allow local `replace` directives.
replace-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: false
retract-allow-no-explanation: false
# Forbid the use of the `exclude` directives.
# Default: false
exclude-forbidden: false

🔼

gomodguard

linters-settings:
gomodguard:
allowed:
# List of allowed modules.
modules:
- gopkg.in/yaml.v2
# List of allowed module domains.
domains:
- golang.org
blocked:
# List of blocked modules.
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.
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.
local_replace_directives: false

🔼

gosimple

linters-settings:
gosimple:
# Select the Go version to target.
# Default: 1.13
go: "1.15"
# https://staticcheck.io/docs/options#checks
checks: ["all"]

🔼

gosec

linters-settings:
gosec:
# To select a subset of rules to run.
# Available rules: https://github.com/securego/gosec#available-rules
includes:
- G101
- G102
- G103
- G104
- G106
- G107
- G108
- G109
- G110
- G111
- G201
- G202
- G203
- G204
- G301
- G302
- G303
- G304
- G305
- G306
- G307
- G401
- G402
- G403
- G404
- G501
- G502
- G503
- G504
- G505
- G601
# To specify a set of rules to explicitly exclude.
# Available rules: https://github.com/securego/gosec#available-rules
excludes:
- G101
- G102
- G103
- G104
- G106
- G107
- G108
- G109
- G110
- G111
- G201
- G202
- G203
- G204
- G301
- G302
- G303
- G304
- G305
- G306
- G307
- G401
- G402
- G403
- G404
- G501
- G502
- G503
- G504
- G505
- G601
# Exclude generated files
# Default: false
exclude-generated: true
# Filter out the issues with a lower severity than the given value.
# Valid options are: low, medium, high.
# Default: low
severity: medium
# Filter out the issues with a lower confidence than the given value.
# Valid options are: low, medium, high.
# Default: low
confidence: medium
# Concurrency value.
# Default: the number of logical CPUs usable by the current process.
concurrency: 12
# 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"

🔼

govet

linters-settings:
govet:
# Report about shadowed variables.
# Default: false
check-shadowing: true
# Settings per analyzer.
settings:
# Analyzer name, run `go tool vet help` to see all analyzers.
printf:
# Run `go tool vet help printf` to see available settings for `printf` analyzer.
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).Fatalf
# Disable all analyzers.
# Default: false
disable-all: true
# Enable analyzers by name.
# Run `go tool vet help` to see all analyzers.
enable:
- asmdecl
- assign
- atomic
- atomicalign
- bools
- buildtag
- cgocall
- composites
- copylocks
- deepequalerrors
- errorsas
- fieldalignment
- findcall
- framepointer
- httpresponse
- ifaceassert
- loopclosure
- lostcancel
- nilfunc
- nilness
- printf
- reflectvaluecompare
- shadow
- shift
- sigchanyzer
- sortslice
- stdmethods
- stringintconv
- structtag
- testinggoroutine
- tests
- unmarshal
- unreachable
- unsafeptr
- unusedresult
- unusedwrite
# Enable all analyzers.
# Default: false
enable-all: true
# Disable analyzers by name.
# Run `go tool vet help` to see all analyzers.
disable:
- asmdecl
- assign
- atomic
- atomicalign
- bools
- buildtag
- cgocall
- composites
- copylocks
- deepequalerrors
- errorsas
- fieldalignment
- findcall
- framepointer
- httpresponse
- ifaceassert
- loopclosure
- lostcancel
- nilfunc
- nilness
- printf
- reflectvaluecompare
- shadow
- shift
- sigchanyzer
- sortslice
- stdmethods
- stringintconv
- structtag
- testinggoroutine
- tests
- unmarshal
- unreachable
- unsafeptr
- unusedresult
- unusedwrite

🔼

grouper

linters-settings:
grouper:
# Require the use of a single global 'const' declaration only.
# Default: false
const-require-single-const: true
# Require the use of grouped global 'const' declarations.
# Default: false
const-require-grouping: true
# Require the use of a single 'import' declaration only.
# Default: false
import-require-single-import: true
# Require the use of grouped 'import' declarations.
# Default: false
import-require-grouping: true
# Require the use of a single global 'type' declaration only.
# Default: false
type-require-single-type: true
# Require the use of grouped global 'type' declarations.
# Default: false
type-require-grouping: true
# Require the use of a single global 'var' declaration only.
# Default: false
var-require-single-var: true
# Require the use of grouped global 'var' declarations.
# Default: false
var-require-grouping: true

🔼

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.
# Default: 1
max-decl-lines: 2
# Maximum length of variable declaration measured in number of characters, after which linter won't suggest using short syntax.
# Default: 30
max-decl-chars: 40

🔼

importas

linters-settings:
importas:
# Do not allow unaliased imports of aliased packages.
# Default: false
no-unaliased: true
# Do not allow non-required aliases.
# Default: false
no-extra-aliases: 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

🔼

ireturn

linters-settings:
ireturn:
# ireturn allows using `allow` and `reject` settings at the same time.
# Both settings are lists of the keywords and regular expressions matched to interface or package names.
# keywords:
# - `empty` for `interface{}`
# - `error` for errors
# - `stdlib` for standard library
# - `anon` for anonymous interfaces
# By default, it allows using errors, empty interfaces, anonymous interfaces,
# and interfaces provided by the standard library.
allow:
- anon
- error
- empty
- stdlib
# You can specify idiomatic endings for interface
- (or|er)$
# reject-list of interfaces
reject:
- github.com\/user\/package\/v4\.Type

🔼

lll

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: 1
tab-width: 1

🔼

maintidx

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: 20
under: 100

🔼

makezero

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

🔼

maligned

linters-settings:
maligned:
# Print struct with more effective memory layout or not.
# Default: false
suggest-new: true

🔼

misspell

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
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: 30
max-func-lines: 31

🔼

nestif

linters-settings:
nestif:
# Minimal complexity of if statements to report.
# Default: 5
min-complexity: 4

🔼

nilnil

linters-settings:
nilnil:
# Checks that there is no simultaneous return of `nil` error and an invalid value.
# Default: ptr, func, iface, map, chan
checked-types:
- ptr
- func
- iface
- map
- chan

🔼

nlreturn

linters-settings:
nlreturn:
# Size of the block (including return statement that is still "OK")
# so no return split required.
# Default: 1
block-size: 2

🔼

nolintlint

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

🔼

prealloc

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: true
simple: false
# Report pre-allocation suggestions on range loops.
# Default: true
range-loops: false
# Report pre-allocation suggestions on for loops.
# Default: false
for-loops: true

🔼

predeclared

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: false
q: true

🔼

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

🔼

revive

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: false
ignore-generated-header: true
# Sets the default severity.
# See https://github.com/mgechev/revive#configuration
# Default: warning
severity: error
# Enable all available rules.
# Default: false
enable-all-rules: true
# Sets the default failure confidence.
# This means that linting errors with less than 0.8 confidence will be ignored.
# Default: 0.8
confidence: 0.1
rules:
# https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#add-constant
- name: add-constant
severity: warning
disabled: false
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#atomic
- name: argument-limit
severity: warning
disabled: false
arguments: [4]
# https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#atomic
- name: atomic
severity: warning
disabled: false
# https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#banned-characters
- name: banned-characters
severity: warning
disabled: false
arguments: ["Ω", "Σ", "σ", "7"]
# https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#bare-return
- name: bare-return
severity: warning
disabled: false
# https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#blank-imports
- name: blank-imports
severity: warning
disabled: false
# https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#bool-literal-in-expr
- name: bool-literal-in-expr
severity: warning
disabled: false
# https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#call-to-gc
- name: call-to-gc
severity: warning
disabled: false
# https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#cognitive-complexity
- name: cognitive-complexity
severity: warning
disabled: false
arguments: [7]
# https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#confusing-naming
- name: confusing-naming
severity: warning
disabled: false
# https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#confusing-results
- name: confusing-results
severity: warning
disabled: false
# https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#constant-logical-expr
- name: constant-logical-expr
severity: warning
disabled: false
# https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#context-as-argument
- name: context-as-argument
severity: warning
disabled: false
# https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#context-keys-type
- name: context-keys-type
severity: warning
disabled: false
# https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#cyclomatic
- name: cyclomatic
severity: warning
disabled: false
arguments: [3]
# https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#deep-exit
- name: deep-exit
severity: warning
disabled: false
# https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#defer
- name: defer
severity: warning
disabled: false
arguments:
- ["call-chain", "loop"]
# https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#dot-imports
- name: dot-imports
severity: warning
disabled: false
# https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#duplicated-imports
- name: duplicated-imports
severity: warning
disabled: false
# https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#early-return
- name: early-return
severity: warning
disabled: false
# https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#empty-block
- name: empty-block
severity: warning
disabled: false
# https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#empty-lines
- name: empty-lines
severity: warning
disabled: false
# https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#error-naming
- name: error-naming
severity: warning
disabled: false
# https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#error-return
- name: error-return
severity: warning
disabled: false
# https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#error-strings
- name: error-strings
severity: warning
disabled: false
# https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#errorf
- name: errorf
severity: warning
disabled: false
# https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#exported
- name: exported
severity: warning
disabled: false
arguments:
- "checkPrivateReceivers"
- "sayRepetitiveInsteadOfStutters"
# https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#file-header
- name: file-header
severity: warning
disabled: false
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-parameter
severity: warning
disabled: false
# https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#function-result-limit
- name: function-result-limit
severity: warning
disabled: false
arguments: [2]
# https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#function-length
- name: function-length
severity: warning
disabled: false
arguments: [10, 0]
# https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#get-return
- name: get-return
severity: warning
disabled: false
# https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#identical-branches
- name: identical-branches
severity: warning
disabled: false
# https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#if-return
- name: if-return
severity: warning
disabled: false
# https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#increment-decrement
- name: increment-decrement
severity: warning
disabled: false
# https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#indent-error-flow
- name: indent-error-flow
severity: warning
disabled: false
# https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#imports-blacklist
- name: imports-blacklist
severity: warning
disabled: false
arguments:
- "crypto/md5"
- "crypto/sha1"
# https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#import-shadowing
- name: import-shadowing
severity: warning
disabled: false
# https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#line-length-limit
- name: line-length-limit
severity: warning
disabled: false
arguments: [80]
# https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#max-public-structs
- name: max-public-structs
severity: warning
disabled: false
arguments: [3]
# https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#modifies-parameter
- name: modifies-parameter
severity: warning
disabled: false
# https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#modifies-value-receiver
- name: modifies-value-receiver
severity: warning
disabled: false
# https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#nested-structs
- name: nested-structs
severity: warning
disabled: false
# https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#optimize-operands-order
- name: optimize-operands-order
severity: warning
disabled: false
# https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#package-comments
- name: package-comments
severity: warning
disabled: false
# https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#range
- name: range
severity: warning
disabled: false
# https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#range-val-in-closure
- name: range-val-in-closure
severity: warning
disabled: false
# https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#range-val-address
- name: range-val-address
severity: warning
disabled: false
# https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#receiver-naming
- name: receiver-naming
severity: warning
disabled: false
# https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#redefines-builtin-id
- name: redefines-builtin-id
severity: warning
disabled: false
# https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#string-of-int
- name: string-of-int
severity: warning
disabled: false
# https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#string-format
- name: string-format
severity: warning
disabled: false
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#struct-tag
- name: struct-tag
severity: warning
disabled: false
# https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#superfluous-else
- name: superfluous-else
severity: warning
disabled: false
# https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#time-equal
- name: time-equal
severity: warning
disabled: false
# https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#time-naming
- name: time-naming
severity: warning
disabled: false
# https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#var-naming
- name: var-naming
severity: warning
disabled: false
arguments:
- ["ID"] # AllowList
- ["VM"] # DenyList
# https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#var-declaration
- name: var-declaration
severity: warning
disabled: false
# https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#unconditional-recursion
- name: unconditional-recursion
severity: warning
disabled: false
# https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#unexported-naming
- name: unexported-naming
severity: warning
disabled: false
# https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#unexported-return
- name: unexported-return
severity: warning
disabled: false
# https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#unhandled-error
- name: unhandled-error
severity: warning
disabled: false
arguments:
- "fmt.Printf"
- "myFunction"
# https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#unnecessary-stmt
- name: unnecessary-stmt
severity: warning
disabled: false
# https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#unreachable-code
- name: unreachable-code
severity: warning
disabled: false
# https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#unused-parameter
- name: unused-parameter
severity: warning
disabled: false
# https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#unused-receiver
- name: unused-receiver
severity: warning
disabled: false
# https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#useless-break
- name: useless-break
severity: warning
disabled: false
# https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#waitgroup-by-value
- name: waitgroup-by-value
severity: warning
disabled: false

🔼

rowserrcheck

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

🔼

staticcheck

linters-settings:
staticcheck:
# Select the Go version to target.
# Default: 1.13
go: "1.15"
# https://staticcheck.io/docs/options#checks
checks: ["all"]

🔼

stylecheck

linters-settings:
stylecheck:
# Select the Go version to target.
# Default: 1.13
go: "1.15"
# https://staticcheck.io/docs/options#checks
checks: ["all", "-ST1000", "-ST1003", "-ST1016", "-ST1020", "-ST1021", "-ST1022"]
# https://staticcheck.io/docs/options#dot_import_whitelist
dot-import-whitelist:
- fmt
# https://staticcheck.io/docs/options#initialisms
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"]
# https://staticcheck.io/docs/options#http_status_code_whitelist
http-status-code-whitelist: ["200", "400", "404", "500"]

🔼

tagliatelle

linters-settings:
tagliatelle:
# Check the struck tag name case.
case:
# Use the struct field name to check the name of the struct tag.
# Default: false
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

🔼

tenv

linters-settings:
tenv:
# The option `all` will run against whole test files (`_test.go`) regardless of method/function signatures.
# By default, only methods that take `*testing.T`, `*testing.B`, and `testing.TB` as arguments are checked.
all: false

🔼

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.
# All checks are enabled by default.
test:
first: false
name: false
begin: false
benchmark:
first: false
name: false
begin: false
tb:
first: false
name: false
begin: false

🔼

unparam

linters-settings:
unparam:
# Inspect exported functions.
#
# 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.
#
# Default: false
check-exported: true

🔼

varcheck

linters-settings:
varcheck:
# Check usage of exported fields and variables.
# Default: false
exported-fields: true

🔼

varnamelen

linters-settings:
varnamelen:
# The longest distance, in source lines, that is being considered a "small scope".
# Variables used in at most this many lines will be ignored.
# Default: 5
max-distance: 6
# The minimum length of a variable's name that is considered "long".
# Variable names that are at least this long will be ignored.
# Default: 3
min-name-length: 2
# Check method receivers.
# Default: false
check-receiver: true
# Check named return values.
# Default: false
check-return: true
# Check type parameters.
# Default: false
check-type-param: true
# Ignore "ok" variables that hold the bool return value of a type assertion.
# Default: false
ignore-type-assert-ok: true
# Ignore "ok" variables that hold the bool return value of a map index.
# Default: false
ignore-map-index-ok: true
# Ignore "ok" variables that hold the bool return value of a channel receive.
# Default: false
ignore-chan-recv-ok: true
# Optional list of variable names that should be ignored completely.
# Default: []
ignore-names:
- err
# Optional list of variable declarations that should be ignored completely.
# Entries must be in one of the following forms (see below for examples):
# - for variables, parameters, named return values, method receivers, or type parameters:
# <name> <type> (<type> can also be a pointer/slice/map/chan/...)
# - for constants: const <name>
#
# Default: []
ignore-decls:
- c echo.Context
- t testing.T
- f *foo.Bar
- e error
- i int
- const C
- T any
- m map[string]int

🔼

whitespace

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

🔼

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(
- .WithMessagef(
- .WithStack(
ignoreSigRegexps:
- \.New.*Error\(
ignorePackageGlobs:
- encoding/*
- github.com/pkg/*
ignoreInterfaceRegexps:
- ^(?i)c(?-i)ach(ing|e)

🔼

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`.
# Controls if you may cuddle assignments and anything without needing an empty line between them.
# Default: false
allow-assign-and-anything: false
# Controls if you may cuddle assignments and calls without needing an empty line between them.
# Default: true
allow-assign-and-call: true
# Controls if you're allowed to cuddle multiple declarations.
# This is false by default to encourage you to group them in one var block.
# One major benefit with this is that if the variables are assigned the assignments will be tabulated.
# Default: false
allow-cuddle-declarations: false
# Controls if you may cuddle assignments even if they span over multiple lines.
# Default: true
allow-multiline-assign: true
# This option allows whitespace after each comment group that begins a block.
# Default: false
allow-separated-leading-comment: false
# Controls if blocks can end with comments.
# This is not encouraged sine it's usually code smell but might be useful do improve understanding or learning purposes.
# To be allowed there must be no whitespace between the comment and the last statement or the comment and the closing brace.
# Default: false
allow-trailing-comment: false
# Can be set to force trailing newlines at the end of case blocks to improve readability.
# If the number of lines (including comments) in a case block exceeds this number
# a linter error will be yielded if the case does not end with a newline.
# Default: 0
force-case-trailing-whitespace: 0
# Enforces that an `if` statement checking an error variable is cuddled
# with the line that assigned that error variable.
# Default: false
force-err-cuddling: false
# Enforces that an assignment which is actually a short declaration (using `:=`)
# is only allowed to cuddle with other short declarations, and not plain assignments, blocks, etc.
# This rule helps make declarations stand out by themselves, much the same as grouping var statement.
# Default: false
force-short-decl-cuddling: false
# Controls if the checks for slice append should be "strict"
# in the sense that it will only allow these assignments to be cuddled with variables being appended.
# Default: true
strict-append: true

🔼

custom

linters-settings:
# The custom section can be used to define linter plugins to be loaded at runtime.
# See README documentation 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.
description: This is an example usage of a plugin linter.
# Intended to point to the repo location of the linter.
# Optional.
original-url: github.com/golangci/example-linter

🔼

Edit this page on GitHub