Panic: load embedded ruleguard rules: rules/rules.go:13: cant load fmt

我正在使用 GitHub 操作https://github.com/golangci/golangci-lint-action

我收到錯誤:

Installed golangci-lint into /home/runner/golangci-lint-1.43.0-linux-amd64/golangci-lint in 458ms
Prepared env in 606ms

run golangci-lint
 Running [/home/runner/golangci-lint-1.43.0-linux-amd64/golangci-lint run --out-format=github-actions] in [] ...
 panic: load embedded ruleguard rules: rules/rules.go:13: can't load fmt
 
 goroutine 1 [running]:
 github.com/go-critic/go-critic/checkers.init.9()
   github.com/go-critic//checkers/checkers.go:58 +0x4b4
 
 Error: golangci-lint exit with code 2
 Ran golangci-lint in 13383ms

這是golangci-lintgolang v1.18.0的一個已知問題https://github.com/golangci/golangci-lint/issues/2374

我的 GitHub 操作文件是:

name: golangci-lint
on:
 push:
   tags:
     - v*
   branches:
     - master
     - main
 pull_request:
permissions:
 contents: read
jobs:
 golangci:
   name: lint
   runs-on: ubuntu-latest
   steps:
     - uses: actions/setup-go@v2
     - uses: actions/checkout@v2
     - name: golangci-lint
       uses: golangci/golangci-lint-action@v2
       with:
         version: v1.43

我也嘗試過使用:

name: golangci-lint
on:
 push:
   tags:
     - v*
   branches:
     - master
     - main
 pull_request:
permissions:
 contents: read
jobs:
 golangci:
   strategy:
     matrix:
       go-version: [1.17.x]
   name: lint
   runs-on: ubuntu-latest
   steps:
     - uses: actions/setup-go@v3
       with:
         go-version: ${{ matrix.go }}
     - uses: actions/checkout@v3
     - name: golangci-lint
       uses: golangci/golangci-lint-action@v2
       with:
         version: v1.43

但是兩者都失敗了,在這種情況下我該怎麼辦?

我已經在項目中打開了這個問題,以防它幫助https://github.com/golangci/golangci-lint-action/issues/442

將 golangci/golangci-lint-action、actions/setup-go 和 actions/checkout 升級到 v3 對我來說是成功的。

問題 442由PR 275修復並送出 6ee1db2 (v1.4.1),基於評論:

矩陣鍵似乎不匹配,糾正會解決問題嗎?

   strategy:
     matrix:
       go-version: [1.17.x]
   name: lint
   runs-on: ubuntu-latest
   steps:
     - uses: actions/setup-go@v3
       with:
         go-version: ${{ matrix.go-version }}

以及Charlie Revett在issue 2374中提到的目前解決方法:

go version go1.17.11 darwin/arm64
  • 從 Homebrew 解除安裝所有版本的 Go
  • golangci-lint從 Homebrew解除安裝所有版本
  • 使用做一些目錄清理find / -type d -name go 2> /dev/null
  • 使用做一些目錄清理find / -type d -name "golangci-lint" 2> /dev/null
  • go1.17.11.darwin-arm64.pkg通過使用安裝go.dev/dl程序安裝 ( .pkg)
  • golangci-lint使用go install github.com/golangci/golangci-lint/cmd/(目前最新版本)安裝。

請參閱“從源安裝”

引用自:https://stackoverflow.com/questions/71758856

Open Antonboom opened this issue 10 months ago • 13 comments

Hello!

panic: load embedded ruleguard rules: rules/rules.go:13: can't load fmt

goroutine 1 [running]:
github.com/go-critic/go-critic/checkers.init.9()
        github.com/go-critic/[email protected]/checkers/checkers.go:58 +0x4b4

For any golangci-lint command :(

I can't provide source code, but can provide information about env:

$ uname -a
Darwin MacBook-Pro.local 20.6.0
Darwin Kernel Version 20.6.0: Mon Aug 30 06:12:20 PDT 2021;
root:xnu-7195.141.6~3/RELEASE_ARM64_T8101 arm64

$ golangci-lint --version
golangci-lint has version 1.43.0 built from 861262b on 2021-11-02T20:54:42Z

$ go version
go1.17.1 darwin/arm64
go env
$ go env
GO111MODULE=""
GOARCH="arm64"
GOBIN="/Users/anthony/golang_workspace/bin"
GOCACHE="/Users/anthony/Library/Caches/go-build"
GOENV="/Users/anthony/Library/Application Support/go/env"
GOEXE=""
GOEXPERIMENT=""
GOFLAGS=""
GOHOSTARCH="arm64"
GOHOSTOS="darwin"
GOINSECURE=""
GOMODCACHE="/Users/anthony/golang_workspace/pkg/mod"
GONOPROXY=""
GONOSUMDB=""
GOOS="darwin"
GOPATH="/Users/anthony/golang_workspace"
GOPRIVATE=""
GOPROXY="https://proxy.golang.org,direct"
GOROOT="/usr/local/go"
GOSUMDB="sum.golang.org"
GOTMPDIR=""
GOTOOLDIR="/usr/local/go/pkg/tool/darwin_arm64"
GOVCS=""
GOVERSION="go1.17.1"
GCCGO="gccgo"
AR="ar"
CC="clang"
CXX="clang++"
CGO_ENABLED="1"
GOMOD="/dev/null"
CGO_CFLAGS="-g -O2"
CGO_CPPFLAGS=""
CGO_CXXFLAGS="-g -O2"
CGO_FFLAGS="-g -O2"
CGO_LDFLAGS="-g -O2"
PKG_CONFIG="pkg-config"
GOGCCFLAGS="-fPIC -arch arm64 -pthread -fno-caret-diagnostics -Qunused-arguments -fmessage-length=0 -fdebug-prefix-map=/var/folders/6t/v80c8sfs5zqf38b2yhzq592h0000gn/T/go-build838314483=/tmp/go-build -gno-record-gcc-switches -fno-common

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

golangci-lint help linters

Enabled by Default

NameDescriptionPresetsAutoFixSince
errcheck ⚙️ Errcheck is a program for checking for unchecked errors in go programs. 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, such as Printf calls whose arguments do not align with the format string 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
typecheck Like the front-end of a Go compiler, parses and type-checks Go code bugs v1.3.0
unused ⚙️ Checks Go code for unused constants, variables, functions and types unused v1.20.0

Disabled by Default

NameDescriptionPresetsAutoFixSince
asasalint ⚙️ check for pass []any as any in variadic func(...any) bugs 1.47.0
asciicheck Simple linter to check that your code does not contain non-ASCII identifiers 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
containedctx containedctx is a linter that detects struct contained context.Context field style 1.44.0
contextcheck check the function whether use a non-inherited context bugs v1.43.0
cyclop ⚙️ checks function and package cyclomatic complexity complexity v1.37.0
deadcode  The owner seems to have abandoned the linter. Replaced by unused. unused v1.0.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
durationcheck check for two durations multiplied together bugs v1.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. 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
execinquery execinquery is a linter about query string checker in Query function which reads your Go src files and warning it finds sql v1.46.0
exhaustive ⚙️ check exhaustiveness of enum switch statements bugs v1.28.0
exhaustivestruct ⚙️  The owner seems to have abandoned the linter. Replaced by exhaustruct. style, test v1.32.0
exhaustruct ⚙️ Checks if all structure fields are initialized style, test v1.46.0
exportloopref checks for pointers to enclosing loop variables bugs v1.28.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 golang package import order and makes it always deterministic. format, import v1.30.0
gochecknoglobals check 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.

style v1.12.0
gochecknoinits Checks that no init functions are present in Go code style v1.12.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
goerr113 Golang linter to check the errors handling expressions style, error v1.26.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 ⚙️ In addition to fixing imports, goimports also formats your code in the same style as gofmt. format, import v1.20.0
golint ⚙️  The repository of the linter has been archived by the owner. Replaced by revive. style v1.0.0
gomnd ⚙️ An analyzer to detect magic numbers. style v1.22.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
grouper ⚙️ An analyzer to analyze expression groups. style v1.44.0
ifshort ⚙️  The repository of the linter has been deprecated by the owner. style v1.36.0
importas ⚙️ Enforces consistent import aliases style v1.38.0
interfacebloat ⚙️ A linter that checks the number of methods inside an interface. style v1.49.0
interfacer  The repository of the linter has been archived by the owner. style v1.0.0
ireturn ⚙️ Accept Interfaces, Return Concrete Types style v1.43.0
lll ⚙️ Reports long lines style v1.8.0
loggercheck ⚙️ Checks key valur 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
maligned ⚙️  The repository of the linter has been archived by the owner. Replaced by govet 'fieldalignment'. performance v1.0.0
misspell ⚙️ Finds commonly misspelled English words in comments style, comment v1.8.0
nakedret ⚙️ Finds naked returns in functions greater than a specified function length 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 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
nosnakecase  The repository of the linter has been deprecated by the owner. Replaced by revive(var-naming). style v1.47.0
nosprintfhostport Checks for misuse of Sprintf to construct a host with port in a URL. style v1.46.0
paralleltest ⚙️ paralleltest detects missing usage of t.Parallel() method in your Go test style, test v1.33.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
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 Err of rows is checked successfully bugs, sql v1.23.0
scopelint  The repository of the linter has been deprecated by the owner. Replaced by exportloopref. bugs v1.12.0
sqlclosecheck Checks that sql.Rows and sql.Stmt are closed. bugs, sql v1.28.0
structcheck ⚙️  The owner seems to have abandoned the linter. Replaced by unused. unused v1.0.0
stylecheck ⚙️ Stylecheck is a replacement for golint style v1.20.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 style v1.43.0
testableexamples linter checks if examples are testable (have an expected output) test v1.50.0
testpackage ⚙️ linter that makes you use a separate _test package style, test v1.25.0
thelper ⚙️ thelper detects golang test helpers without t.Helper() call and checks the consistency of test helpers style 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
varcheck ⚙️  The owner seems to have abandoned the linter. Replaced by unused. unused v1.0.0
varnamelen ⚙️ checks that the length of a variable's name matches its scope style v1.43.0
wastedassign wastedassign finds wasted assignment statements. style v1.38.0
whitespace ⚙️ Tool for detection of leading and trailing whitespace style v1.19.0
wrapcheck ⚙️ Checks that errors returned from external packages are wrapped style, error v1.32.0
wsl ⚙️ Whitespace Linter - Forces you to use empty lines! style v1.20.0

Linters Configuration

asasalint

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

use-builtin-exclusions: false

# Ignore *_test.go files.

# Default: false

ignore-test: true

🔼

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.

# Default: 10

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.

# Can accept both string prefixes and string glob patterns.

# Default: []

packages:

- github.com/sirupsen/logrus

- allow/**/pkg

# 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'

# Specify rules by which the linter ignores certain files for consideration.

# Can accept both string prefixes and string glob patterns.

# The ! character in front of the rule is a special character

# which signals that the linter should negate the rule.

# This allows for more precise control, but it is only available for glob patterns.

# Default: []

ignore-file-rules:

- "ignore/**/*.go"

- "!**/*_test.go"

# 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.

# Default: []

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.

# Default: []

include:

- '.*\.Test'

- 'example\.com/package\.ExampleStruct[\d]{1,2}'

# List of regular expressions to exclude struct packages and names from check.

# Default: []

exclude:

- 'cobra\.Command$'

🔼

forbidigo

linters-settings:

forbidigo:

# Forbid the following identifiers (list of regexp).

# Default: ["^(fmt\\.Print(|f|ln)|print|println)$"]

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

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

# 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.

# Skip generated files.

# Default: true

skip-generated: false

# Enable custom order of sections.

# If `true`, make the section order the same as the order of `sections`.

# Default: false

custom-order: true

🔼

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.

# Default: ""

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.

# Default: ""

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.

# 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: 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.

# Default: false

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.

# Default: []

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

# 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

linters-settings:

gofumpt:

# Select the Go version to target.

# Default: "1.15"

# Deprecated: use the global `run.go` instead.

lang-version: "1.17"

# Module path which contains the source code being formatted.

# Default: ""

module-path: github.com/org/project

# Choose whether to use the extra rules.

# Default: false

extra-rules: true

🔼

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 COMPANY

regexp:

# 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

linters-settings:

goimports:

# Put imports beginning with prefix after 3rd-party packages.

# It's a comma-separated list of prefixes.

# Default: ""

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.

# 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.

# Values always ignored: `time.Date`

# Default: []

ignored-functions:

- 'math.*'

- 'http.StatusText'

🔼

gomoddirectives

linters-settings:

gomoddirectives:

# Allow local `replace` directives.

# Default: false

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.

# Default: []

modules:

- gopkg.in/yaml.v2

# List of allowed module domains.

# Default: []

domains:

- golang.org

blocked:

# 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: false

local_replace_directives: false

🔼

gosimple

linters-settings:

gosimple:

# Select the Go version to target.

# Default: 1.13

# Deprecated: use the global `run.go` instead.

go: "1.15"

# https://staticcheck.io/docs/configuration/options/#checks

# Default: ["*"]

checks: ["all"]

🔼

gosec

linters-settings:

gosec:

# To select a subset of rules to run.

# Available rules: https://github.com/securego/gosec#available-rules

# Default: [] - means include all rules

includes:

- 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

- 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 # Deferring a method which returns an error

- G401 # Detect the usage of DES, RC4, 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)

- 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

- G601 # Implicit memory aliasing of items from a range statement

# 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

- 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 # Deferring a method which returns an error

- G401 # Detect the usage of DES, RC4, 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)

- 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

- G601 # Implicit memory aliasing of items from a range statement

# 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.

config:

# Globals are applicable to all rules.

global:

# If true, ignore #nosec in comments (and an alternative as well).

# Default: false

nosec: 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: false

show-ignored: true

# Audit mode enables addition checks that for normal code analysis might be too nosy.

# Default: false

audit: true

G101:

# 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: false

ignore_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:

# - Print

# - Printf

# - Println

# - Fprint

# - Fprintf

# - Fprintln

# strings.Builder:

# - Write

# - WriteByte

# - WriteRune

# - WriteString

# io.PipeWriter:

# - CloseWithError

# hash.Hash:

# - Write

# os:

# - Unsetenv

# Default: {}

G104:

fmt:

- Fscanf

G111:

# 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"

🔼

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:

# 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).Fatalf

shadow:

# Whether to be strict about shadowing; can be noisy.

# Default: false

strict: true

unusedresult:

# Comma-separated list of functions whose results must be used

# (in addition to defaults 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

# Disable all analyzers.

# Default: false

disable-all: true

# Enable analyzers by name (in addition to default).

# Run `go tool vet help` to see all analyzers.

# Default: []

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.

# Default: []

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

# Default: []

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

🔼

interfacebloat

linters-settings:

interfacebloat:

# The maximum number of methods allowed for an interface.

# Default: 10

max: 5

🔼

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

🔼

loggercheck

linters-settings:

loggercheck:

# Allow check for the github.com/go-kit/log library.

# Default: true

kitlog: false

# Allow check for the k8s.io/klog/v2 library.

# Default: true

klog: false

# Allow check for the github.com/go-logr/logr library.

# Default: true

logr: false

# Allow check for the "sugar logger" from go.uber.org/zap library.

# Default: true

zap: false

# Require all logging keys to be inlined constant strings.

# Default: false

require-string-key: true

# Require printf-like format specifier (%s, %d for example) not present.

# Default: false

no-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: empty

rules:

- 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

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

🔼

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

# Default: []

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

# 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

🔼

nonamedreturns

linters-settings:

nonamedreturns:

# Report named error if it is assigned inside defer.

# Default: false

report-error-in-defer: true

🔼

paralleltest

linters-settings:

paralleltest:

# Ignore missing calls to `t.Parallel()` and only report incorrect uses of it.

# Default: false

ignore-missing: 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.

# Default: []

disabled-linters:

- Help

- MetricUnits

- Counter

- HistogramSummaryReserved

- MetricTypeInName

- ReservedChars

- CamelCase

- UnitAbbreviations

🔼

reassign

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

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#argument-limit

- 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#datarace

- name: datarace

severity: warning

disabled: false

# 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:

# database/sql is always checked

# Default: []

packages:

- github.com/jmoiron/sqlx

🔼

staticcheck

linters-settings:

staticcheck:

# Select the Go version to target.

# Default: "1.13"

# Deprecated: use the global `run.go` instead.

go: "1.15"

# https://staticcheck.io/docs/configuration/options/#checks

# Default: ["*"]

checks: ["all"]

🔼

stylecheck

linters-settings:

stylecheck:

# Select the Go version to target.

# Default: 1.13

# Deprecated: use the global `run.go` instead.

go: "1.15"

# https://staticcheck.io/docs/configuration/options/#checks

# Default: ["*"]

checks: ["all", "-ST1000", "-ST1003", "-ST1016", "-ST1020", "-ST1021", "-ST1022"]

# https://staticcheck.io/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.io/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.io/docs/configuration/options/#http_status_code_whitelist

# Default: ["200", "400", "404", "500"]

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

# `camel` is used for `json` and `yaml` (can be overridden)

# Default: {}

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.

# Otherwise, only methods that take `*testing.T`, `*testing.B`, and `testing.TB` as arguments are checked.

# Default: false

all: false

🔼

testpackage

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

linters-settings:

thelper:

test:

# Check *testing.T is first param (or after context.Context) of helper function.

# Default: true

first: false

# Check *testing.T param has name t.

# Default: true

name: false

# Check t.Helper() begins helper function.

# Default: true

begin: false

benchmark:

# Check *testing.B is first param (or after context.Context) of helper function.

# Default: true

first: false

# Check *testing.B param has name b.

# Default: true

name: false

# Check b.Helper() begins helper function.

# Default: true

begin: false

tb:

# Check *testing.TB is first param (or after context.Context) of helper function.

# Default: true

first: false

# Check *testing.TB param has name tb.

# Default: true

name: false

# Check tb.Helper() begins helper function.

# Default: true

begin: false

fuzz:

# Check *testing.F is first param (or after context.Context) of helper function.

# Default: true

first: false

# Check *testing.F param has name f.

# Default: true

name: false

# Check f.Helper() begins helper function.

# Default: true

begin: false

🔼

usestdlibvars

linters-settings:

usestdlibvars:

# Suggest the use of http.MethodXX

# Default: true

http-method: false

# Suggest the use of http.StatusXX

# Default: true

http-status-code: false

# Suggest the use of time.Weekday.String()

# Default: true

time-weekday: true

# Suggest the use of time.Month.String()

# Default: false

time-month: true

# Suggest the use of time.Layout

# Default: false

time-layout: true

# Suggest the use of crypto.Hash.String()

# Default: false

crypto-hash: true

# Suggest the use of rpc.DefaultXXPath

# Default: false

default-rpc-path: true

# Suggest the use of os.DevNull

# Default: false

os-dev-null: true

# Suggest the use of sql.LevelXX.String()

# Default: false

sql-isolation-level: true

# Suggest the use of tls.SignatureScheme.String()

# Default: false

tls-signature-scheme: true

🔼

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.

# Default: [".Errorf(", "errors.New(", "errors.Unwrap(", ".Wrap(", ".Wrapf(", ".WithMessage(", ".WithMessagef(", ".WithStack("]

ignoreSigs:

- .Errorf(

- errors.New(

- errors.Unwrap(

- .Wrap(

- .Wrapf(

- .WithMessage(

- .WithMessagef(

- .WithStack(

# An array of strings that specify regular expressions of signatures to ignore.

# Default: []

ignoreSigRegexps:

- \.New.*Error\(

# An array of strings that specify globs of packages to ignore.

# Default: []

ignorePackageGlobs:

- encoding/*

- github.com/pkg/*

# An array of strings that specify regular expressions of interfaces to ignore.

# Default: []

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