conf/.golangci.yml

2017 lines
72 KiB
YAML
Raw Normal View History

2024-05-04 22:01:57 +02:00
# 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:
2024-05-04 22:01:57 +02:00
# The default concurrency value is the number of available CPU.
#concurrency: 4
2024-05-04 22:01:57 +02:00
# Timeout for analysis, e.g. 30s, 5m.
# Default: 1m
#timeout: 5m
2024-05-04 22:01:57 +02:00
# Exit code when at least one issue was found.
# Default: 1
#issues-exit-code: 2
2024-05-04 22:01:57 +02:00
# Include test files or not.
# Default: true
#tests: false
2024-05-04 22:01:57 +02:00
# List of build tags, all linters use it.
# Default: [].
#build-tags:
# - mytag
2024-05-04 22:01:57 +02:00
# 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
2024-05-04 22:01:57 +02:00
# 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
2024-05-04 22:01:57 +02:00
# 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.
2024-05-04 22:01:57 +02:00
#
# 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.
2024-05-04 22:01:57 +02:00
#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:
2024-05-04 22:01:57 +02:00
# 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: true
2024-05-04 22:01:57 +02:00
# All available settings of specific linters.
linters-settings:
2024-05-04 22:01:57 +02:00
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
decorder:
# Required order of `type`, `const`, `var` and `func` declarations inside a file.
# Default: types before constants before variables before functions.
dec-order:
- const
- var
- type
- 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
dogsled:
2024-05-04 22:01:57 +02:00
# Checks assignments with too many blank identifiers.
# Default: 2
#max-blank-identifiers: 3
dupl:
2024-05-04 22:01:57 +02:00
# Tokens count to trigger issue.
# Default: 150
threshold: 100
2024-05-04 22:01:57 +02:00
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:
2024-05-04 22:01:57 +02:00
# 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
2024-05-04 22:01:57 +02:00
# report about assignment of errors to blank identifier: `num, _ := strconv.Atoi(numStr)`.
# Such cases aren't reported by default.
# Default: false
check-blank: true
2024-05-04 22:01:57 +02:00
# 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
2024-05-04 22:01:57 +02:00
# 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)
2024-05-04 22:01:57 +02:00
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: false
# Issue on struct encoding that doesn't have exported fields.
# Default: false
report-no-exported: true
errorlint:
2024-05-04 22:01:57 +02:00
# 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:
2024-05-04 22:01:57 +02:00
# 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
2024-05-04 22:01:57 +02:00
# 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
forbidigo:
2024-05-04 22:01:57 +02:00
# 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
gci:
2024-05-04 22:01:57 +02:00
# DEPRECATED: use `sections` and `prefix(github.com/org/project)` instead.
#local-prefixes: github.com/org/project
2024-05-04 22:01:57 +02:00
# 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 # Captures all standard packages if they do not match another section.
- default # Contains all imports that could not be matched to another section type.
- prefix(code.bcarlin.xyz/go/conf) # 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
gocritic:
2024-05-04 22:01:57 +02:00
# 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:
2024-05-04 22:01:57 +02:00
# - nestingReduce
# - unnamedResult
# - ruleguard
# - truncateCmp
2024-05-04 22:01:57 +02:00
# 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.
2024-05-04 22:01:57 +02:00
# See https://github.com/go-critic/go-critic#usage -> section "Tags".
# Default: []
enabled-tags:
- diagnostic
- style
2024-05-04 22:01:57 +02:00
- performance
- experimental
2024-05-04 22:01:57 +02:00
- 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:
captLocal: # must be valid enabled check name
# whether to restrict checker to params only (default true)
paramsOnly: true
elseif:
2024-05-04 22:01:57 +02:00
# Whether to skip balanced if-else pairs.
# Default: true
#skipBalanced: false
hugeParam:
2024-05-04 22:01:57 +02:00
# 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:
2024-05-04 22:01:57 +02:00
# Size in bytes that makes the warning trigger.
# Default: 512
#sizeThreshold: 516
# Whether to check test functions
# Default: true
#skipTestFuncs: false
rangeValCopy:
2024-05-04 22:01:57 +02:00
# 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:
2024-05-04 22:01:57 +02:00
# 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
godot:
2024-05-04 22:01:57 +02:00
# Comments to be checked: `declarations`, `toplevel`, or `all`.
# Default: declarations
#scope: toplevel
# List of regexps for excluding particular comment lines from check.
# Default: []
exclude:
2024-05-04 22:01:57 +02:00
# Exclude todo and fixme comments.
- "^fixme:|^FIXME:"
- "^todo:|^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:
2024-05-04 22:01:57 +02:00
# Report any comments starting with keywords, this is useful for TODO or FIXME comments that
# might be left in the code accidentally and should be resolved before merging.
# Default: TODO, BUG, and FIXME.
keywords:
- NOTE
- OPTIMIZE # marks code that should be optimized before merging
2024-05-04 22:01:57 +02:00
- HACK # marks hack-around that should be removed before merging
gofmt:
2024-05-04 22:01:57 +02:00
# 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:
2024-05-04 22:01:57 +02:00
# Module path which contains the source code being formatted.
# Default: ""
module-path: code.bcarlin.xyz/go/conf
2024-05-04 22:01:57 +02:00
# Choose whether to use the extra rules.
# Default: false
extra-rules: true
goheader:
2024-05-04 22:01:57 +02:00
# Supports two types 'const` and `regexp`.
# Values can be used recursively.
# Default: {}
values:
const:
2024-05-04 22:01:57 +02:00
# Define here const type values in format k:v.
# For example:
COMPANY: MY COMPANY
regexp:
2024-05-04 22:01:57 +02:00
# 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.
2024-05-04 22:01:57 +02:00
# 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:
2024-05-04 22:01:57 +02:00
# 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: code.bcarlin.xyz/go/conf
gomoddirectives:
2024-05-04 22:01:57 +02:00
# 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:
2024-05-04 22:01:57 +02:00
# List of allowed modules.
# Default: []
modules: # List of allowed modules
- github.com/pelletier/go-toml/v2
2024-05-04 22:01:57 +02:00
- github.com/stretchr/testify
# - gopkg.in/yaml.v2
2024-05-04 22:01:57 +02:00
# List of allowed module domains.
# Default: []
domains:
- golang.org
- code.bcarlin.xyz
- code.waarp.fr
blocked:
2024-05-04 22:01:57 +02:00
# 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
2024-05-04 22:01:57 +02:00
# 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
#excludes:
2024-05-04 22:01:57 +02:00
# - G101
2024-05-04 22:01:57 +02:00
# 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: true
# 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"
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:
2024-05-04 22:01:57 +02:00
# 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.
#enable:
2024-05-04 22:01:57 +02:00
# - asmdecl
# 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.
disable:
- fieldalignment
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: false
# 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
importas:
2024-05-04 22:01:57 +02:00
# 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
2024-05-04 22:01:57 +02:00
# Default: []
alias:
2024-05-04 22:01:57 +02:00
# Using `servingv1` alias for `knative.dev/serving/pkg/apis/serving/v1` package.
#- pkg: knative.dev/serving/pkg/apis/serving/v1
# alias: servingv1
2024-05-04 22:01:57 +02:00
# 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
2024-05-04 22:01:57 +02:00
- 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:
2024-05-04 22:01:57 +02:00
- anon
- error
- empty
- stdlib
2024-05-04 22:01:57 +02:00
- github.com\/asdine\/storm\/q\.Matcher
# You can specify idiomatic endings for interface
#- (or|er)$
2024-05-04 22:01:57 +02:00
# reject-list of interfaces
reject:
#- github.com\/user\/package\/v4\.Type
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:
2024-05-04 22:01:57 +02:00
# Allow only slices initialized with a length of zero.
# Default: false
#always: true
maligned:
2024-05-04 22:01:57 +02:00
# 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'.
2024-05-04 22:01:57 +02:00
# Default is to use a neutral variety of English.
locale: US
ignore-words:
2024-05-04 22:01:57 +02:00
#- 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/jmoiron/sqlx.Get
# # The struct tag whose presence should be ensured.
# tag: db
# # The position of the argument to check.
# arg-pos: 1
nakedret:
2024-05-04 22:01:57 +02:00
# 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
# Disable to ensure that nolint directives don't have a leading space.
# Default: true
allow-leading-space: false
# Exclude following linters from requiring an explanation.
# Default: []
allow-no-explanation: [ ]
# Enable to require an explanation of nonzero length after each nolint directive.
# Default: false
require-explanation: true
# Enable to require nolint directives to mention the specific linter being suppressed.
# Default: false
require-specific: true
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
prealloc:
2024-05-04 22:01:57 +02:00
# IMPORTANT: we don't recommend using this linter before doing performance profiling.
# For most programs usage of prealloc will be a premature optimization.
2024-05-04 22:01:57 +02:00
# 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.
2024-05-04 22:01:57 +02:00
# Default: false
strict: true
# Please refer to https://github.com/yeya24/promlinter#usage for detailed usage.
2024-05-04 22:01:57 +02:00
# Default: []
#disabled-linters:
# - Help
# - MetricUnits
# - Counter
# - HistogramSummaryReserved
# - MetricTypeInName
# - ReservedChars
# - CamelCase
# - UnitAbbreviations
reassign:
# Patterns for global variable names that are checked for reassignment.
# See https://github.com/curioswitch/go-reassign#usage
# Default: ["EOF", "Err.*"]
#patterns:
# - ".*"
2024-05-04 22:01:57 +02:00
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
2024-05-04 22:01:57 +02:00
# 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,0o600,0o700,10,64"
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: [ 3 ]
# https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#atomic
- name: atomic
severity: error
disabled: false
# https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#banned-characters
- name: banned-characters
severity: warning
disabled: false
arguments: [ "Ω","Σ","σ" ]
# 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: error
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: error
disabled: false
arguments: [ 7 ]
# https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#comment-spacings
- name: comment-spacings
severity: warning
disabled: false
arguments:
- nolint
#- 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: info
disabled: false
# https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#context-as-argument
- name: context-as-argument
severity: info
disabled: false
arguments:
- allowTypesBefore: "*testing.T"
# 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: [ 15 ]
# 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: error
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: error
disabled: false
# https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#early-return
- name: early-return
severity: info
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: info
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: true
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: [20, 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: info
disabled: false
# https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#increment-decrement
- name: increment-decrement
severity: info
disabled: false
# https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#indent-error-flow
- name: indent-error-flow
severity: info
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: [ 5 ]
# 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: info
disabled: false
# https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#package-comments
- name: package-comments
severity: info
disabled: false
# https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#range
- name: range
severity: info
disabled: false
# https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#range-val-in-closure
- name: range-val-in-closure
severity: error
disabled: false
# https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#range-val-address
- name: range-val-address
severity: error
disabled: false
# https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#receiver-naming
- name: receiver-naming
severity: info
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: error
disabled: false
# https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#string-of-int
- name: string-of-int
severity: error
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: info
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
- name: use-any
severity: info
disabled: true
# 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: info
disabled: false
# https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#unconditional-recursion
- name: unconditional-recursion
severity: error
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: info
disabled: false
# https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#unreachable-code
- name: unreachable-code
severity: info
disabled: false
# https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#unused-parameter
- name: unused-parameter
severity: info
disabled: false
arguments:
- allowRegex: "^_"
# https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#unused-receiver
- name: unused-receiver
severity: info
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: error
disabled: false
rowserrcheck:
2024-05-04 22:01:57 +02:00
# 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 constants instead of raw keys.
# Default: false
#no-raw-keys: true
# Enforce putting arguments on separate lines.
# Default: false
#args-on-sep-lines: true
staticcheck:
2024-05-04 22:01:57 +02:00
# SAxxxx checks in https://staticcheck.io/docs/configuration/options/#checks
# Default: ["*"]
#checks: [ "all" ]
stylecheck:
2024-05-04 22:01:57 +02:00
# STxxxx checks in https://staticcheck.io/docs/configuration/options/#checks
# Default: ["*"]
#checks: [ "all", "-ST1000", "-ST1003", "-ST1016", "-ST1020", "-ST1021", "-ST1022" ]
2024-05-04 22:01:57 +02:00
# 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:
2024-05-04 22:01:57 +02:00
#- 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: []
tagliatelle:
2024-05-04 22:01:57 +02:00
# Check the struct tag name case.
case:
2024-05-04 22:01:57 +02:00
# Use the struct field name to check the name of the struct tag.
# Default: false
use-field-name: true
2024-05-04 22:01:57 +02:00
# `camel` is used for `json` and `yaml`, and `header` is used for `header` (can be overridden)
# Default: {}
rules:
2024-05-04 22:01:57 +02:00
# 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
2024-05-04 22:01:57 +02:00
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.
# Default: false
enable-all: true
# Enable specific checkers.
# https://github.com/Antonboom/testifylint#checkers
# Default: ["bool-compare", "compares", "empty", "error-is-as", "error-nil", "expected-actual", "float-compare", "len", "require-error", "suite-dont-use-pkg", "suite-extra-assert-call"]
enable:
#- bool-compare
#- compares
#- empty
#- error-is-as
#- error-nil
#- expected-actual
#- float-compare
#- len
#- 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
suite-extra-assert-call:
# To require or remove extra Assert() call?
# Default: remove
#mode: require
testpackage:
2024-05-04 22:01:57 +02:00
# Regexp pattern to skip files.
# Default: "(export|internal)_test\\.go"
skip-regexp: (export|internal)_test\.go
thelper:
test:
2024-05-04 22:01:57 +02:00
# 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:
2024-05-04 22:01:57 +02:00
# 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:
2024-05-04 22:01:57 +02:00
# 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
# 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
unused:
2024-05-04 22:01:57 +02:00
# 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
varnamelen:
2024-05-04 22:01:57 +02:00
# The longest distance, in source lines, that is being considered a "small scope".
# Variables used in at most this many lines will be ignored.
2024-05-04 22:01:57 +02:00
# Default: 5
max-distance: 15
2024-05-04 22:01:57 +02:00
# The minimum length of a variable's name that is considered "long".
# Variable names that are at least this long will be ignored.
2024-05-04 22:01:57 +02:00
# 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
2024-05-04 22:01:57 +02:00
# added because ignore-decls seemsto be ignored
- tx
2024-05-04 22:01:57 +02:00
# Optional list of variable declarations that should be ignored completely. (defaults to empty list)
# Entries must be in the form of "<variable name> <type>" or "<variable name> *<type>" for
# variables, or "const <name>" for constants.
ignore-decls:
- t *testing.T
- w http.ResponseWriter
- r *http.Request
- r io.Reader
- c convey.C
- i int
- T any
- ds *Datastore
- db storm.Node
whitespace:
2024-05-04 22:01:57 +02:00
# 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.
2024-05-04 22:01:57 +02:00
# 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:
2024-05-04 22:01:57 +02:00
# 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
2024-05-04 22:01:57 +02:00
# 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
2024-05-04 22:01:57 +02:00
# 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: 2
# Allow blocks to end with comments.
allow-trailing-comment: false
2024-05-04 22:01:57 +02:00
# 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", "defer" ]
# 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: true
# 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", "err2", "err3" ]
# 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
2024-05-04 22:01:57 +02:00
# 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:
2024-05-04 22:01:57 +02:00
# Disable all linters.
# Default: false
#disable-all: true
# Enable specific linter
# https://golangci-lint.run/usage/linters/#enabled-by-default
#enable:
# - asasalint
# Enable all available linters.
# Default: false
enable-all: true
2024-05-04 22:01:57 +02:00
# Disable specific linter
# https://golangci-lint.run/usage/linters/#disabled-by-default
disable:
2024-05-04 22:01:57 +02:00
- cyclop # Done by revive
- depguard # gomodguard is better
- deadcode # Deprecated
- execinquery # Deprecated
- exhaustivestruct
2024-05-04 01:31:43 +02:00
- exhaustruct
2024-05-04 22:01:57 +02:00
- funlen # Done by revive
- gocognit # Done by revive
- goconst # Done by revive
- gocyclo # Done by revive
- goheader
2024-05-04 22:01:57 +02:00
- golint # Deprecated
- gomnd # revive also does it
- grouper # # not very useful
- ifshort # Deprecated
- interfacer # Deprecated
- lll # Done by revive with better messages
- maligned # Deprecated
- mnd # revive also does it
- nosnakecase # Deprecated
- prealloc
2024-05-04 22:01:57 +02:00
- scopelint # Deprecated
- structcheck # Deprecated
- tagalign # Too much noise
- unparam # alsodone by revive
- varcheck # also done by unused and deadcode
- whitespace # conflicts with revive and wsl
# Enable presets.
# https://golangci-lint.run/usage/linters
#presets:
# - bugs
2024-05-04 22:01:57 +02:00
# - comment
# - complexity
# - error
# - format
# - import
# - metalinter
# - module
# - performance
# - sql
# - style
# - test
# - unused
2024-05-04 22:01:57 +02:00
# Run only fast linters from enabled linters set (first run won't be fast)
# Default: false
#fast: true
issues:
2024-05-04 22:01:57 +02:00
# 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: []
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:
2024-05-04 22:01:57 +02:00
- cyclop
- dupl
- errcheck
- funlen
- goconst
- gocognit
- gocyclo
2024-05-04 22:01:57 +02:00
- goerr113
- gosec
2024-05-04 22:01:57 +02:00
- maintidx
- varnamelen
2024-05-04 22:01:57 +02:00
- path: _test\.go
linters: [ revive ]
text: "cognitive-complexity|line-length-limit"
# Exclude known linters from partially hard-vendored code,
2024-05-04 22:01:57 +02:00
# which is impossible to exclude via `nolint` comments.
- path: internal/hmac/
text: "weak cryptographic primitive"
linters:
- gosec
2024-05-04 22:01:57 +02:00
# Exclude some `staticcheck` messages.
#- linters:
# - staticcheck
# text: "SA9003:"
2024-05-04 22:01:57 +02:00
# Exclude `lll` issues for long lines with `go:generate`.
- linters:
- lll
source: "^//go:generate "
2024-05-04 22:01:57 +02:00
# 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
2024-05-04 22:01:57 +02:00
# If set to true exclude and exclude-rules regular expressions become case-sensitive.
# Default: false
exclude-case-sensitive: false
2024-05-04 22:01:57 +02:00
# The list of ids of default excludes to include or disable.
# https://golangci-lint.run/usage/false-positives/#default-exclusions
# Default: []
include:
#- EXC0002 # disable excluding of issues about comments from golint.
2024-05-04 22:01:57 +02:00
# Maximum issues count per one linter.
# Set to 0 to disable.
# Default: 50
max-issues-per-linter: 0
2024-05-04 22:01:57 +02:00
# 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.
2024-05-04 22:01:57 +02:00
# 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
2024-05-04 22:01:57 +02:00
# 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
2024-05-04 22:01:57 +02:00
# Fix found issues (if it's supported by the linter).
fix: false
2024-05-04 22:01:57 +02:00
severity:
2024-05-04 22:01:57 +02:00
# 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
2024-05-04 22:01:57 +02:00
# - Checkstyle: https://checkstyle.sourceforge.io/property_types.html#severity
# - 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: warning
# 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.
2024-05-04 22:01:57 +02:00
#
# Default: []
rules:
- linters:
2024-05-04 22:01:57 +02:00
- dupl
severity: info