Complete iter20. #12
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
# This file contains all available configuration options | |
# with their default values (in comments). | |
# | |
# This file is not a configuration example, | |
# it contains the exhaustive configuration with explanations of the options. | |
# Options for analysis running. | |
run: | |
# The default concurrency value is the number of available CPU. | |
concurrency: 4 | |
# Timeout for analysis, e.g. 30s, 5m. | |
# Default: 1m | |
timeout: 5m | |
# Exit code when at least one issue was found. | |
# Default: 1 | |
issues-exit-code: 2 | |
# Include test files or not. | |
# Default: true | |
tests: false | |
# List of build tags, all linters use it. | |
# Default: []. | |
build-tags: | |
- mytag | |
# Which dirs to skip: issues from them won't be reported. | |
# Can use regexp here: `generated.*`, regexp is applied on full path, | |
# including the path prefix if one is set. | |
# Default value is empty list, | |
# but default dirs are skipped independently of this option's value (see skip-dirs-use-default). | |
# "/" will be replaced by current OS file path separator to properly work on Windows. | |
skip-dirs: | |
- src/external_libs | |
- autogenerated_by_my_lib | |
# Enables skipping of directories: | |
# - vendor$, third_party$, testdata$, examples$, Godeps$, builtin$ | |
# Default: true | |
skip-dirs-use-default: false | |
# Which files to skip: they will be analyzed, but issues from them won't be reported. | |
# Default value is empty list, | |
# but there is no need to include all autogenerated files, | |
# we confidently recognize autogenerated files. | |
# If it's not please let us know. | |
# "/" will be replaced by current OS file path separator to properly work on Windows. | |
skip-files: | |
- ".*\\.my\\.go$" | |
- lib/bad.go | |
# If set we pass it to "go list -mod={option}". From "go help modules": | |
# If invoked with -mod=readonly, the go command is disallowed from the implicit | |
# automatic updating of go.mod described above. Instead, it fails when any changes | |
# to go.mod are needed. This setting is most useful to check that go.mod does | |
# not need updates, such as in a continuous integration and testing system. | |
# If invoked with -mod=vendor, the go command assumes that the vendor | |
# directory holds the correct copies of dependencies and ignores | |
# the dependency descriptions in go.mod. | |
# | |
# Allowed values: readonly|vendor|mod | |
# By default, it isn't set. | |
modules-download-mode: readonly | |
# Allow multiple parallel golangci-lint instances running. | |
# If false (default) - golangci-lint acquires file lock on start. | |
allow-parallel-runners: false | |
# Define the Go version limit. | |
# Mainly related to generics support since go1.18. | |
# Default: use Go version from the go.mod file, fallback on the env var `GOVERSION`, fallback on 1.18 | |
go: '1.19' | |
# output configuration options | |
output: | |
# Format: colored-line-number|line-number|json|colored-tab|tab|checkstyle|code-climate|junit-xml|github-actions|teamcity | |
# | |
# Multiple can be specified by separating them by comma, output can be provided | |
# for each of them by separating format name and path by colon symbol. | |
# Output path can be either `stdout`, `stderr` or path to the file to write to. | |
# Example: "checkstyle:report.xml,json:stdout,colored-line-number" | |
# | |
# Default: colored-line-number | |
format: json | |
# Print lines of code with issue. | |
# Default: true | |
print-issued-lines: false | |
# Print linter name in the end of issue text. | |
# Default: true | |
print-linter-name: false | |
# Make issues output unique by line. | |
# Default: true | |
uniq-by-line: false | |
# Add a prefix to the output file references. | |
# Default is no prefix. | |
path-prefix: "" | |
# Sort results by: filepath, line and column. | |
sort-results: false | |
# All available settings of specific linters. | |
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: | |
# 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: | |
# 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: | |
# Required order of `type`, `const`, `var` and `func` declarations inside a file. | |
# Default: types before constants before variables before functions. | |
dec-order: | |
- type | |
- const | |
- var | |
- func | |
# If true, underscore vars (vars with "_" as the name) will be ignored at all checks | |
# Default: false (underscore vars are not ignored) | |
ignore-underscore-vars: false | |
# If true, order of declarations is not checked at all. | |
# Default: true (disabled) | |
disable-dec-order-check: false | |
# If true, `init` func can be anywhere in file (does not have to be declared before all other functions). | |
# Default: true (disabled) | |
disable-init-func-first-check: false | |
# If true, multiple global `type`, `const` and `var` declarations are allowed. | |
# Default: true (disabled) | |
disable-dec-num-check: false | |
# If true, type declarations will be ignored for dec num check | |
# Default: false (type statements are not ignored) | |
disable-type-dec-num-check: false | |
# If true, const declarations will be ignored for dec num check | |
# Default: false (const statements are not ignored) | |
disable-const-dec-num-check: false | |
# If true, var declarations will be ignored for dec num check | |
# Default: false (var statements are not ignored) | |
disable-var-dec-num-check: false | |
depguard: | |
# Rules to apply. | |
# | |
# Variables: | |
# - File Variables | |
# you can still use and exclamation mark ! in front of a variable to say not to use it. | |
# Example !$test will match any file that is not a go test file. | |
# | |
# `$all` - matches all go files | |
# `$test` - matches all go test files | |
# | |
# - Package Variables | |
# | |
# `$gostd` - matches all of go's standard library (Pulled from `GOROOT`) | |
# | |
# Default: Only allow $gostd in all files. | |
rules: | |
# Name of a rule. | |
main: | |
# Used to determine the package matching priority. | |
# There are three different modes: `original`, `strict`, and `lax`. | |
# Default: "original" | |
list-mode: lax | |
# List of file globs that will match this list of settings to compare against. | |
# Default: $all | |
files: | |
- "!**/*_a _file.go" | |
# List of allowed packages. | |
allow: | |
- $gostd | |
- github.com/OpenPeeDeeP | |
# Packages that are not allowed where the value is a suggestion. | |
deny: | |
- pkg: "github.com/sirupsen/logrus" | |
desc: not allowed | |
- pkg: "github.com/pkg/errors" | |
desc: Should be replaced by standard lib errors package | |
dogsled: | |
# Checks assignments with too many blank identifiers. | |
# Default: 2 | |
max-blank-identifiers: 3 | |
dupl: | |
# Tokens count to trigger issue. | |
# Default: 150 | |
threshold: 100 | |
dupword: | |
# Keywords for detecting duplicate words. | |
# If this list is not empty, only the words defined in this list will be detected. | |
# Default: [] | |
keywords: | |
- "the" | |
- "and" | |
- "a" | |
# Keywords used to ignore detection. | |
# Default: [] | |
ignore: | |
- "0C0C" | |
errcheck: | |
# 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: | |
# 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: | |
# 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 | |
# Permit more than 1 %w verb, valid per Go 1.20 (Requires errorf:true) | |
# Default: true | |
errorf-multi: false | |
# Check for plain type assertions and type switches. | |
# Default: true | |
asserts: false | |
# Check for plain error comparisons. | |
# Default: true | |
comparison: false | |
exhaustive: | |
# Program elements to check for exhaustiveness. | |
# Default: [ switch ] | |
check: | |
- switch | |
- map | |
# 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.+" | |
# Enum types matching the supplied regex do not have to be listed in | |
# switch statements to satisfy exhaustiveness. | |
# Default: "" | |
ignore-enum-types: "Example.+" | |
# Consider enums only in package scopes, not in inner scopes. | |
# Default: false | |
package-scope-only: true | |
# Only run exhaustive check on switches with "//exhaustive:enforce" comment. | |
# Default: false | |
explicit-exhaustive-switch: true | |
# Only run exhaustive check on map literals with "//exhaustive:enforce" comment. | |
# Default: false | |
explicit-exhaustive-map: true | |
# Switch statement requires default case even if exhaustive. | |
# Default: false | |
default-case-required: true | |
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: | |
# List of regular expressions to match struct packages and their names. | |
# Regular expressions must match complete canonical struct package/name/structname. | |
# If this list is empty, all structs are tested. | |
# Default: [] | |
include: | |
- '.+\.Test' | |
- 'example\.com/package\.ExampleStruct[\d]{1,2}' | |
# List of regular expressions to exclude struct packages and their names from checks. | |
# Regular expressions must match complete canonical struct package/name/structname. | |
# Default: [] | |
exclude: | |
- '.+/cobra\.Command$' | |
forbidigo: | |
# Forbid the following identifiers (list of regexp). | |
# Default: ["^(fmt\\.Print(|f|ln)|print|println)$"] | |
forbid: | |
# Builtin function: | |
- ^print.*$ | |
# Optional message that gets included in error reports. | |
- p: ^fmt\.Print.*$ | |
msg: Do not commit print statements. | |
# Alternatively, put messages at the end of the regex, surrounded by `(# )?` | |
# Escape any special characters. Those messages get included in error reports. | |
- 'fmt\.Print.*(# Do not commit print statements\.)?' | |
# Forbid spew Dump, whether it is called as function or method. | |
# Depends on analyze-types below. | |
- ^spew\.(ConfigState\.)?Dump$ | |
# The package name might be ambiguous. | |
# The full import path can be used as additional criteria. | |
# Depends on analyze-types below. | |
- p: ^v1.Dump$ | |
pkg: ^example.com/pkg/api/v1$ | |
# Exclude godoc examples from forbidigo checks. | |
# Default: true | |
exclude-godoc-examples: false | |
# Instead of matching the literal source code, | |
# use type information to replace expressions with strings that contain the package name | |
# and (for methods and fields) the type name. | |
# This makes it possible to handle import renaming and forbid struct fields and methods. | |
# Default: false | |
analyze-types: true | |
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 | |
# Ignore comments when counting lines. | |
# Default false | |
ignore-comments: true | |
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 | |
ginkgolinter: | |
# Suppress the wrong length assertion warning. | |
# Default: false | |
suppress-len-assertion: true | |
# Suppress the wrong nil assertion warning. | |
# Default: false | |
suppress-nil-assertion: true | |
# Suppress the wrong error assertion warning. | |
# Default: false | |
suppress-err-assertion: true | |
# Suppress the wrong comparison assertion warning. | |
# Default: false | |
suppress-compare-assertion: true | |
# Suppress the function all in async assertion warning. | |
# Default: false | |
suppress-async-assertion: true | |
# Suppress warning for comparing values from different types, like int32 and uint32 | |
# Default: false | |
suppress-type-compare-assertion: true | |
# Trigger warning for ginkgo focus containers like FDescribe, FContext, FWhen or FIt | |
# Default: false | |
forbid-focus-container: true | |
# Don't trigger warnings for HaveLen(0) | |
# Default: false | |
allow-havelen-zero: true | |
gocognit: | |
# Minimal code complexity to report. | |
# Default: 30 (but we recommend 10-20) | |
min-complexity: 10 | |
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 | |
# Exclude strings matching the given regular expression. | |
# Default: "" | |
ignore-strings: 'foo.+' | |
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: | |
# Minimal code complexity to report. | |
# Default: 30 (but we recommend 10-20) | |
min-complexity: 10 | |
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: | |
# 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: | |
# 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: | |
# 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 | |
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: | |
# A comma-separated list of prefixes, which, if set, checks import paths | |
# with the given prefixes are grouped after 3rd-party packages. | |
# Default: "" | |
local-prefixes: github.com/org/project | |
golint: | |
# Minimal confidence for issues. | |
# Default: 0.8 | |
min-confidence: 0.7 | |
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. | |
# Following functions are always ignored: `time.Date`, | |
# `strconv.FormatInt`, `strconv.FormatUint`, `strconv.FormatFloat`, | |
# `strconv.ParseInt`, `strconv.ParseUint`, `strconv.ParseFloat`. | |
# Default: [] | |
ignored-functions: | |
- '^math\.' | |
- '^http\.StatusText$' | |
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: | |
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: | |
# Deprecated: use the global `run.go` instead. | |
go: "1.15" | |
# Sxxxx checks in https://staticcheck.io/docs/configuration/options/#checks | |
# Default: ["*"] | |
checks: [ "all" ] | |
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 # Poor file permissions used when creating a file with os.Create | |
- 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 | |
- G602 # Slice access out of bounds | |
# To specify a set of rules to explicitly exclude. | |
# Available rules: https://github.com/securego/gosec#available-rules | |
# Default: [] | |
excludes: | |
- G101 # Look for hard coded credentials | |
- G102 # Bind to all interfaces | |
- G103 # Audit the use of unsafe block | |
- G104 # Audit errors not checked | |
- G106 # Audit the use of ssh.InsecureIgnoreHostKey | |
- G107 # Url provided to HTTP request as taint input | |
- G108 # Profiling endpoint automatically exposed on /debug/pprof | |
- G109 # Potential Integer overflow made by strconv.Atoi result conversion to int16/32 | |
- G110 # Potential DoS vulnerability via decompression bomb | |
- G111 # Potential directory traversal | |
- G112 # Potential slowloris attack | |
- G113 # Usage of Rat.SetString in math/big with an overflow (CVE-2022-23772) | |
- G114 # Use of net/http serve function that has no support for setting timeouts | |
- G201 # SQL query construction using format string | |
- G202 # SQL query construction using string concatenation | |
- G203 # Use of unescaped data in HTML templates | |
- G204 # Audit use of command execution | |
- G301 # Poor file permissions used when creating a directory | |
- G302 # Poor file permissions used with chmod | |
- G303 # Creating tempfile using a predictable path | |
- G304 # File path provided as taint input | |
- G305 # File traversal when extracting zip/tar archive | |
- G306 # Poor file permissions used when writing to a new file | |
- G307 # Poor file permissions used when creating a file with os.Create | |
- G401 # Detect the usage of 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 | |
- G602 # Slice access out of bounds | |
# 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: | |
# - 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" | |
gosmopolitan: | |
# Allow and ignore `time.Local` usages. | |
# | |
# Default: false | |
allow-time-local: true | |
# List of fully qualified names in the `full/pkg/path.name` form, to act as "i18n escape hatches". | |
# String literals inside call-like expressions to, or struct literals of those names, | |
# are exempt from the writing system check. | |
# | |
# Default: [] | |
escape-hatches: | |
- 'github.com/nicksnyder/go-i18n/v2/i18n.Message' | |
- 'example.com/your/project/i18n/markers.Raw' | |
- 'example.com/your/project/i18n/markers.OK' | |
- 'example.com/your/project/i18n/markers.TODO' | |
- 'command-line-arguments.Simple' | |
# Ignore test files. | |
# | |
# Default: true | |
ignore-tests: false | |
# List of Unicode scripts to watch for any usage in string literals. | |
# https://pkg.go.dev/unicode#pkg-variables | |
# | |
# Default: ["Han"] | |
watch-for-scripts: | |
- Devanagari | |
- Han | |
- Hangul | |
- Hiragana | |
- Katakana | |
govet: | |
# 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 default: | |
# context.WithCancel, context.WithDeadline, context.WithTimeout, context.WithValue, errors.New, fmt.Errorf, | |
# fmt.Sprint, fmt.Sprintf, sort.Reverse | |
# ). | |
# Default: [] | |
funcs: | |
- pkg.MyFunc | |
# Comma-separated list of names of methods of type func() string whose results must be used | |
# (in addition to default Error,String) | |
# Default: [] | |
stringmethods: | |
- MyMethod | |
# Disable all analyzers. | |
# Default: false | |
disable-all: true | |
# Enable analyzers by name. | |
# (in addition to default: | |
# appends, asmdecl, assign, atomic, bools, buildtag, cgocall, composites, copylocks, defers, directive, errorsas, | |
# framepointer, httpresponse, ifaceassert, loopclosure, lostcancel, nilfunc, printf, shift, sigchanyzer, slog, | |
# stdmethods, stringintconv, structtag, testinggoroutine, tests, timeformat, unmarshal, unreachable, unsafeptr, | |
# unusedresult | |
# ). | |
# Run `go tool vet help` to see all analyzers. | |
# Default: [] | |
enable: | |
- appends | |
- asmdecl | |
- assign | |
- atomic | |
- atomicalign | |
- bools | |
- buildtag | |
- cgocall | |
- composites | |
- copylocks | |
- deepequalerrors | |
- defers | |
- directive | |
- errorsas | |
- fieldalignment | |
- findcall | |
- framepointer | |
- httpresponse | |
- ifaceassert | |
- loopclosure | |
- lostcancel | |
- nilfunc | |
- nilness | |
- printf | |
- reflectvaluecompare | |
- shadow | |
- shift | |
- sigchanyzer | |
- slog | |
- sortslice | |
- stdmethods | |
- stringintconv | |
- structtag | |
- testinggoroutine | |
- tests | |
- unmarshal | |
- unreachable | |
- unsafeptr | |
- unusedresult | |
- unusedwrite | |
# Enable all analyzers. | |
# Default: false | |
enable-all: true | |
# Disable analyzers by name. | |
# (in addition to default | |
# atomicalign, deepequalerrors, fieldalignment, findcall, nilness, reflectvaluecompare, shadow, sortslice, | |
# timeformat, unusedwrite | |
# ). | |
# Run `go tool vet help` to see all analyzers. | |
# Default: [] | |
disable: | |
- appends | |
- asmdecl | |
- assign | |
- atomic | |
- atomicalign | |
- bools | |
- buildtag | |
- cgocall | |
- composites | |
- copylocks | |
- deepequalerrors | |
- defers | |
- directive | |
- errorsas | |
- fieldalignment | |
- findcall | |
- framepointer | |
- httpresponse | |
- ifaceassert | |
- loopclosure | |
- lostcancel | |
- nilfunc | |
- nilness | |
- printf | |
- reflectvaluecompare | |
- shadow | |
- shift | |
- sigchanyzer | |
- slog | |
- sortslice | |
- stdmethods | |
- stringintconv | |
- structtag | |
- testinggoroutine | |
- tests | |
- unmarshal | |
- unreachable | |
- unsafeptr | |
- unusedresult | |
- unusedwrite | |
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: | |
# 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: | |
# 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: | |
# The maximum number of methods allowed for an interface. | |
# Default: 10 | |
max: 5 | |
ireturn: | |
# ireturn does not allow 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 | |
# - `generic` for generic interfaces added in go 1.18 | |
# 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: | |
# 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: | |
# 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: | |
# 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: | |
# Allow only slices initialized with a length of zero. | |
# Default: false | |
always: true | |
maligned: | |
# Print struct with more effective memory layout or not. | |
# Default: false | |
suggest-new: true | |
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 | |
musttag: | |
# A set of custom functions to check in addition to the builtin ones. | |
# Default: json, xml, gopkg.in/yaml.v3, BurntSushi/toml, mitchellh/mapstructure, jmoiron/sqlx | |
functions: | |
# The full name of the function, including the package. | |
- name: github.com/hashicorp/hcl/v2/hclsimple.DecodeFile | |
# The struct tag whose presence should be ensured. | |
tag: hcl | |
# The position of the argument to check. | |
arg-pos: 2 | |
nakedret: | |
# 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: | |
# Minimal complexity of if statements to report. | |
# Default: 5 | |
min-complexity: 4 | |
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: | |
# Size of the block (including return statement that is still "OK") | |
# so no return split required. | |
# Default: 1 | |
block-size: 2 | |
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: | |
# Report named error if it is assigned inside defer. | |
# Default: false | |
report-error-in-defer: true | |
paralleltest: | |
# Ignore missing calls to `t.Parallel()` and only report incorrect uses of it. | |
# Default: false | |
ignore-missing: true | |
# Ignore missing calls to `t.Parallel()` in subtests. Top-level tests are | |
# still required to have `t.Parallel`, but subtests are allowed to skip it. | |
# Default: false | |
ignore-missing-subtests: true | |
perfsprint: | |
# Optimizes even if it requires an int or uint type cast. | |
# Default: true | |
int-conversion: false | |
# Optimizes into `err.Error()` even if it is only equivalent for non-nil errors. | |
# Default: false | |
err-error: true | |
# Optimizes `fmt.Errorf`. | |
# Default: true | |
errorf: false | |
# Optimizes `fmt.Sprintf` with only one argument | |
# Default: true | |
sprintf1: false | |
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: | |
# 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: | |
# 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 | |
protogetter: | |
# Skip files generated by specified generators from the checking. | |
# Checks only the file's initial comment, which must follow the format: "// Code generated by <generator-name>". | |
# Files generated by protoc-gen-go, protoc-gen-go-grpc, and protoc-gen-grpc-gateway are always excluded automatically. | |
# Default: [] | |
skip-generated-by: ["protoc-gen-go-my-own-generator"] | |
# Skip files matching the specified glob pattern from the checking. | |
# Default: [] | |
skip-files: | |
- "*.pb.go" | |
- "*/vendor/*" | |
- "/full/path/to/file.go" | |
# Skip any generated files from the checking. | |
# Default: false | |
skip-any-generated: true | |
reassign: | |
# Patterns for global variable names that are checked for reassignment. | |
# See https://github.com/curioswitch/go-reassign#usage | |
# Default: ["EOF", "Err.*"] | |
patterns: | |
- ".*" | |
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#comment-spacings | |
- name: comment-spacings | |
severity: warning | |
disabled: false | |
arguments: | |
- mypragma | |
- otherpragma | |
# 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 | |
arguments: | |
- allowTypesBefore: "*testing.T,*github.com/user/repo/testing.Harness" | |
# https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#context-keys-type | |
- name: context-keys-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 | |
arguments: | |
- "preserveScope" | |
# 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#enforce-map-style | |
- name: enforce-map-style | |
severity: warning | |
disabled: false | |
arguments: | |
- "make" | |
# 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: | |
- "preserveScope" | |
- "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 | |
arguments: | |
- "preserveScope" | |
# https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#import-alias-naming | |
- name: import-alias-naming | |
severity: warning | |
disabled: false | |
arguments: | |
- "^[a-z][a-z0-9]{0,}$" | |
# 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#redundant-import-alias | |
- name: redundant-import-alias | |
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 | |
arguments: | |
- "json,inline" | |
- "bson,outline,gnu" | |
severity: warning | |
disabled: false | |
# https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#superfluous-else | |
- name: superfluous-else | |
severity: warning | |
disabled: false | |
arguments: | |
- "preserveScope" | |
# 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 | |
- - upperCaseConst: true | |
# 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 | |
arguments: | |
- allowRegex: "^_" | |
# https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#unused-receiver | |
- name: unused-receiver | |
severity: warning | |
disabled: false | |
arguments: | |
- allowRegex: "^_" | |
# 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: | |
# database/sql is always checked | |
# Default: [] | |
packages: | |
- github.com/jmoiron/sqlx | |
sloglint: | |
# Enforce using key-value pairs only (incompatible with attr-only). | |
# Default: false | |
kv-only: true | |
# Enforce using attributes only (incompatible with kv-only). | |
# Default: false | |
attr-only: true | |
# Enforce using methods that accept a context. | |
# Default: false | |
context-only: true | |
# Enforce using static values for log messages. | |
# Default: false | |
static-msg: true | |
# Enforce using constants instead of raw keys. | |
# Default: false | |
no-raw-keys: true | |
# Enforce a single key naming convention. | |
# Values: snake, kebab, camel, pascal | |
# Default: "" | |
key-naming-case: snake | |
# Enforce putting arguments on separate lines. | |
# Default: false | |
args-on-sep-lines: true | |
staticcheck: | |
# Deprecated: use the global `run.go` instead. | |
go: "1.15" | |
# SAxxxx checks in https://staticcheck.io/docs/configuration/options/#checks | |
# Default: ["*"] | |
checks: [ "all" ] | |
stylecheck: | |
# Deprecated: use the global `run.go` instead. | |
go: "1.15" | |
# STxxxx checks in 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" ] | |
tagalign: | |
# Align and sort can be used together or separately. | |
# | |
# Whether enable align. If true, the struct tags will be aligned. | |
# eg: | |
# type FooBar struct { | |
# Bar string `json:"bar" validate:"required"` | |
# FooFoo int8 `json:"foo_foo" validate:"required"` | |
# } | |
# will be formatted to: | |
# type FooBar struct { | |
# Bar string `json:"bar" validate:"required"` | |
# FooFoo int8 `json:"foo_foo" validate:"required"` | |
# } | |
# Default: true. | |
align: false | |
# Whether enable tags sort. | |
# If true, the tags will be sorted by name in ascending order. | |
# eg: `xml:"bar" json:"bar" validate:"required"` -> `json:"bar" validate:"required" xml:"bar"` | |
# Default: true | |
sort: false | |
# Specify the order of tags, the other tags will be sorted by name. | |
# This option will be ignored if `sort` is false. | |
# Default: [] | |
order: | |
- json | |
- yaml | |
- yml | |
- toml | |
- mapstructure | |
- binding | |
- validate | |
# Whether enable strict style. | |
# In this style, the tags will be sorted and aligned in the dictionary order, | |
# and the tags with the same name will be aligned together. | |
# Note: This option will be ignored if 'align' or 'sort' is false. | |
# Default: false | |
strict: true | |
tagliatelle: | |
# Check the struct 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`, and `header` is used for `header` (can be overridden) | |
# Default: {} | |
rules: | |
# Any struct tag type can be used. | |
# Support string case: `camel`, `pascal`, `kebab`, `snake`, `upperSnake`, `goCamel`, `goPascal`, `goKebab`, `goSnake`, `upper`, `lower`, `header` | |
json: camel | |
yaml: camel | |
xml: camel | |
bson: camel | |
avro: snake | |
mapstructure: kebab | |
env: upperSnake | |
envconfig: upperSnake | |
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 | |
testifylint: | |
# Enable all checkers (https://github.com/Antonboom/testifylint#checkers). | |
# Default: false | |
enable-all: true | |
# Disable checkers by name | |
# (in addition to default | |
# suite-thelper | |
# ). | |
disable: | |
- bool-compare | |
- compares | |
- empty | |
- error-is-as | |
- error-nil | |
- expected-actual | |
- go-require | |
- float-compare | |
- len | |
- nil-compare | |
- require-error | |
- suite-dont-use-pkg | |
- suite-extra-assert-call | |
- suite-thelper | |
# Disable all checkers (https://github.com/Antonboom/testifylint#checkers). | |
# Default: false | |
disable-all: true | |
# Enable checkers by name | |
# (in addition to default | |
# bool-compare, compares, empty, error-is-as, error-nil, expected-actual, go-require, float-compare, len, | |
# nil-compare, require-error, suite-dont-use-pkg, suite-extra-assert-call | |
# ). | |
enable: | |
- bool-compare | |
- compares | |
- empty | |
- error-is-as | |
- error-nil | |
- expected-actual | |
- go-require | |
- float-compare | |
- len | |
- nil-compare | |
- require-error | |
- suite-dont-use-pkg | |
- suite-extra-assert-call | |
- suite-thelper | |
expected-actual: | |
# Regexp for expected variable name. | |
# Default: (^(exp(ected)?|want(ed)?)([A-Z]\w*)?$)|(^(\w*[a-z])?(Exp(ected)?|Want(ed)?)$) | |
pattern: ^expected | |
require-error: | |
# Regexp for assertions to analyze. If defined then only matched assertions will be reported. | |
# Default: "" | |
fn-pattern: ^(Errorf?|NoErrorf?)$ | |
suite-extra-assert-call: | |
# To require or remove extra Assert() call? | |
# Default: remove | |
mode: require | |
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: | |
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: | |
# 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 | |
# DEPRECATED 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 | |
# Suggest the use of constant.Kind.String(). | |
# Default: false | |
constant-kind: true | |
# DEPRECATED Suggest the use of syslog.Priority. | |
# Default: false | |
syslog-priority: true | |
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 | |
unused: | |
# Mark all struct fields that have been written to as used. | |
# Default: true | |
field-writes-are-uses: false | |
# Treat IncDec statement (e.g. `i++` or `i--`) as both read and write operation instead of just write. | |
# Default: false | |
post-statements-are-reads: true | |
# Mark all exported identifiers as used. | |
# Default: true | |
exported-is-used: false | |
# Mark all exported fields as used. | |
# default: true | |
exported-fields-are-used: false | |
# Mark all function parameters as used. | |
# default: true | |
parameters-are-used: false | |
# Mark all local variables as used. | |
# default: true | |
local-variables-are-used: false | |
# Mark all identifiers inside generated files as used. | |
# Default: true | |
generated-is-used: false | |
varcheck: | |
# Check usage of exported fields and variables. | |
# Default: false | |
exported-fields: true | |
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: | |
# 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: | |
# 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: | |
# See https://github.com/bombsimon/wsl/blob/master/doc/configuration.md for documentation of available settings. | |
# These are the defaults for `golangci-lint`. | |
# Do strict checking when assigning from append (x = append(x, y)). If | |
# this is set to true - the append call must append either a variable | |
# assigned, called or used on the line above. | |
strict-append: true | |
# Allows assignments to be cuddled with variables used in calls on | |
# line above and calls to be cuddled with assignments of variables | |
# used in call on line above. | |
allow-assign-and-call: true | |
# Allows assignments to be cuddled with anything. | |
allow-assign-and-anything: false | |
# Allows cuddling to assignments even if they span over multiple lines. | |
allow-multiline-assign: true | |
# If the number of lines in a case block is equal to or lager than this | |
# number, the case *must* end white a newline. | |
force-case-trailing-whitespace: 0 | |
# Allow blocks to end with comments. | |
allow-trailing-comment: false | |
# Allow multiple comments in the beginning of a block separated with newline. | |
allow-separated-leading-comment: false | |
# Allow multiple var/declaration statements to be cuddled. | |
allow-cuddle-declarations: false | |
# A list of call idents that everything can be cuddled with. | |
# Defaults to calls looking like locks. | |
allow-cuddle-with-calls: [ "Lock", "RLock" ] | |
# AllowCuddleWithRHS is a list of right hand side variables that is allowed | |
# to be cuddled with anything. Defaults to assignments or calls looking | |
# like unlocks. | |
allow-cuddle-with-rhs: [ "Unlock", "RUnlock" ] | |
# Causes an error when an If statement that checks an error variable doesn't | |
# cuddle with the assignment of that variable. | |
force-err-cuddling: false | |
# When force-err-cuddling is enabled this is a list of names | |
# used for error variables to check for in the conditional. | |
error-variable-names: [ "err" ] | |
# Causes an error if a short declaration (:=) cuddles with anything other than | |
# another short declaration. | |
# This logic overrides force-err-cuddling among others. | |
force-short-decl-cuddling: false | |
# 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 | |
linters: | |
# Disable all linters. | |
# Default: false | |
disable-all: true | |
# Enable specific linter | |
# https://golangci-lint.run/usage/linters/#enabled-by-default | |
enable: | |
- asasalint | |
- asciicheck | |
- bidichk | |
- bodyclose | |
- containedctx | |
- contextcheck | |
- cyclop | |
- deadcode | |
- decorder | |
- depguard | |
- dogsled | |
- dupl | |
- dupword | |
- durationcheck | |
- errcheck | |
- errchkjson | |
- errname | |
- errorlint | |
- execinquery | |
- exhaustive | |
- exhaustivestruct | |
- exhaustruct | |
- exportloopref | |
- forbidigo | |
- forcetypeassert | |
- funlen | |
- gci | |
- ginkgolinter | |
- gocheckcompilerdirectives | |
- gochecknoglobals | |
- gochecknoinits | |
- gochecksumtype | |
- gocognit | |
- goconst | |
- gocritic | |
- gocyclo | |
- godot | |
- godox | |
- goerr113 | |
- gofmt | |
- gofumpt | |
- goheader | |
- goimports | |
- golint | |
- gomnd | |
- gomoddirectives | |
- gomodguard | |
- goprintffuncname | |
- gosec | |
- gosimple | |
- gosmopolitan | |
- govet | |
- grouper | |
- ifshort | |
- importas | |
- inamedparam | |
- ineffassign | |
- interfacebloat | |
- interfacer | |
- ireturn | |
- lll | |
- loggercheck | |
- maintidx | |
- makezero | |
- maligned | |
- mirror | |
- misspell | |
- musttag | |
- nakedret | |
- nestif | |
- nilerr | |
- nilnil | |
- nlreturn | |
- noctx | |
- nolintlint | |
- nonamedreturns | |
- nosnakecase | |
- nosprintfhostport | |
- paralleltest | |
- perfsprint | |
- prealloc | |
- predeclared | |
- promlinter | |
- protogetter | |
- reassign | |
- revive | |
- rowserrcheck | |
- scopelint | |
- sloglint | |
- sqlclosecheck | |
- staticcheck | |
- structcheck | |
- stylecheck | |
- tagalign | |
- tagliatelle | |
- tenv | |
- testableexamples | |
- testifylint | |
- testpackage | |
- thelper | |
- tparallel | |
- typecheck | |
- unconvert | |
- unparam | |
- unused | |
- usestdlibvars | |
- varcheck | |
- varnamelen | |
- wastedassign | |
- whitespace | |
- wrapcheck | |
- wsl | |
- zerologlint | |
# Enable all available linters. | |
# Default: false | |
enable-all: true | |
# Disable specific linter | |
# https://golangci-lint.run/usage/linters/#disabled-by-default | |
disable: | |
- asasalint | |
- asciicheck | |
- bidichk | |
- bodyclose | |
- containedctx | |
- contextcheck | |
- cyclop | |
- deadcode | |
- decorder | |
- depguard | |
- dogsled | |
- dupl | |
- dupword | |
- durationcheck | |
- errcheck | |
- errchkjson | |
- errname | |
- errorlint | |
- execinquery | |
- exhaustive | |
- exhaustivestruct | |
- exhaustruct | |
- exportloopref | |
- forbidigo | |
- forcetypeassert | |
- funlen | |
- gci | |
- ginkgolinter | |
- gocheckcompilerdirectives | |
- gochecknoglobals | |
- gochecknoinits | |
- gochecksumtype | |
- gocognit | |
- goconst | |
- gocritic | |
- gocyclo | |
- godot | |
- godox | |
- goerr113 | |
- gofmt | |
- gofumpt | |
- goheader | |
- goimports | |
- golint | |
- gomnd | |
- gomoddirectives | |
- gomodguard | |
- goprintffuncname | |
- gosec | |
- gosimple | |
- gosmopolitan | |
- govet | |
- grouper | |
- ifshort | |
- importas | |
- inamedparam | |
- ineffassign | |
- interfacebloat | |
- interfacer | |
- ireturn | |
- lll | |
- loggercheck | |
- maintidx | |
- makezero | |
- maligned | |
- mirror | |
- misspell | |
- musttag | |
- nakedret | |
- nestif | |
- nilerr | |
- nilnil | |
- nlreturn | |
- noctx | |
- nolintlint | |
- nonamedreturns | |
- nosnakecase | |
- nosprintfhostport | |
- paralleltest | |
- perfsprint | |
- prealloc | |
- predeclared | |
- promlinter | |
- protogetter | |
- reassign | |
- revive | |
- rowserrcheck | |
- scopelint | |
- sloglint | |
- sqlclosecheck | |
- staticcheck | |
- structcheck | |
- stylecheck | |
- tagalign | |
- tagliatelle | |
- tenv | |
- testableexamples | |
- testifylint | |
- testpackage | |
- thelper | |
- tparallel | |
- typecheck | |
- unconvert | |
- unparam | |
- unused | |
- usestdlibvars | |
- varcheck | |
- varnamelen | |
- wastedassign | |
- whitespace | |
- wrapcheck | |
- wsl | |
- zerologlint | |
# Enable presets. | |
# https://golangci-lint.run/usage/linters | |
presets: | |
- bugs | |
- comment | |
- complexity | |
- error | |
- format | |
- import | |
- metalinter | |
- module | |
- performance | |
- sql | |
- style | |
- test | |
- unused | |
# Run only fast linters from enabled linters set (first run won't be fast) | |
# Default: false | |
fast: true | |
issues: | |
# List of regexps of issue texts to exclude. | |
# | |
# But independently of this option we use default exclude patterns, | |
# it can be disabled by `exclude-use-default: false`. | |
# To list all excluded by default patterns execute `golangci-lint run --help` | |
# | |
# Default: https://golangci-lint.run/usage/false-positives/#default-exclusions | |
exclude: | |
- abcdef | |
# Excluding configuration per-path, per-linter, per-text and per-source | |
exclude-rules: | |
# Exclude some linters from running on tests files. | |
- path: _test\.go | |
linters: | |
- gocyclo | |
- errcheck | |
- dupl | |
- gosec | |
# Run some linter only for test files by excluding its issues for everything else. | |
- path-except: _test\.go | |
linters: | |
- forbidigo | |
# Exclude known linters from partially hard-vendored code, | |
# which is impossible to exclude via `nolint` comments. | |
# `/` will be replaced by current OS file path separator to properly work on Windows. | |
- path: internal/hmac/ | |
text: "weak cryptographic primitive" | |
linters: | |
- gosec | |
# Exclude some `staticcheck` messages. | |
- linters: | |
- staticcheck | |
text: "SA9003:" | |
# Exclude `lll` issues for long lines with `go:generate`. | |
- linters: | |
- lll | |
source: "^//go:generate " | |
# Independently of option `exclude` we use default exclude patterns, | |
# it can be disabled by this option. | |
# To list all excluded by default patterns execute `golangci-lint run --help`. | |
# Default: true. | |
exclude-use-default: false | |
# If set to true exclude and exclude-rules regular expressions become case-sensitive. | |
# Default: false | |
exclude-case-sensitive: false | |
# The list of ids of default excludes to include or disable. | |
# https://golangci-lint.run/usage/false-positives/#default-exclusions | |
# Default: [] | |
include: | |
- EXC0001 | |
- EXC0002 | |
- EXC0003 | |
- EXC0004 | |
- EXC0005 | |
- EXC0006 | |
- EXC0007 | |
- EXC0008 | |
- EXC0009 | |
- EXC0010 | |
- EXC0011 | |
- EXC0012 | |
- EXC0013 | |
- EXC0014 | |
- EXC0015 | |
# Maximum issues count per one linter. | |
# Set to 0 to disable. | |
# Default: 50 | |
max-issues-per-linter: 0 | |
# Maximum count of issues with the same text. | |
# Set to 0 to disable. | |
# Default: 3 | |
max-same-issues: 0 | |
# Show only new issues: if there are unstaged changes or untracked files, | |
# only those changes are analyzed, else only changes in HEAD~ are analyzed. | |
# It's a super-useful option for integration of golangci-lint into existing large codebase. | |
# It's not practical to fix all existing issues at the moment of integration: | |
# much better don't allow issues in new code. | |
# | |
# Default: false. | |
new: true | |
# Show only new issues created after git revision `REV`. | |
new-from-rev: HEAD | |
# Show only new issues created in git patch with set file path. | |
new-from-patch: path/to/patch/file | |
# Fix found issues (if it's supported by the linter). | |
fix: true | |
severity: | |
# Set the default severity for issues. | |
# | |
# If severity rules are defined and the issues do not match or no severity is provided to the rule | |
# this will be the default severity applied. | |
# Severities should match the supported severity names of the selected out format. | |
# - Code climate: https://docs.codeclimate.com/docs/issues#issue-severity | |
# - Checkstyle: https://checkstyle.sourceforge.io/property_types.html#SeverityLevel | |
# - GitHub: https://help.github.com/en/actions/reference/workflow-commands-for-github-actions#setting-an-error-message | |
# - TeamCity: https://www.jetbrains.com/help/teamcity/service-messages.html#Inspection+Instance | |
# | |
# Default value is an empty string. | |
default-severity: error | |
# If set to true `severity-rules` regular expressions become case-sensitive. | |
# Default: false | |
case-sensitive: true | |
# When a list of severity rules are provided, severity information will be added to lint issues. | |
# Severity rules have the same filtering capability as exclude rules | |
# except you are allowed to specify one matcher per severity rule. | |
# Only affects out formats that support setting severity information. | |
# | |
# Default: [] | |
rules: | |
- linters: | |
- dupl | |
severity: info |