You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
326 lines
12 KiB
326 lines
12 KiB
# options for analysis running
|
|
run:
|
|
# default concurrency is a available CPU number
|
|
concurrency: 4
|
|
|
|
# timeout for analysis, e.g. 30s, 5m, default is 1m
|
|
timeout: 1m
|
|
|
|
# exit code when at least one issue was found, default is 1
|
|
issues-exit-code: 1
|
|
|
|
# include test files or not, default is true
|
|
tests: true
|
|
|
|
# default is true. Enables skipping of directories:
|
|
# vendor$, third_party$, testdata$, examples$, Godeps$, builtin$
|
|
skip-dirs-use-default: true
|
|
|
|
# by default isn't set. 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.
|
|
#modules-download-mode: release|readonly|vendor
|
|
|
|
# Allow multiple parallel golangci-lint instances running.
|
|
# If false (default) - golangci-lint acquires file lock on start.
|
|
allow-parallel-runners: true
|
|
|
|
# output configuration options
|
|
output:
|
|
# colored-line-number|line-number|json|tab|checkstyle|code-climate, default is "colored-line-number"
|
|
format: colored-line-number
|
|
|
|
# print lines of code with issue, default is true
|
|
print-issued-lines: true
|
|
|
|
# print linter name in the end of issue text, default is true
|
|
print-linter-name: true
|
|
|
|
# make issues output unique by line, default is true
|
|
uniq-by-line: true
|
|
|
|
|
|
# all available settings of specific linters
|
|
linters-settings:
|
|
dogsled:
|
|
# checks assignments with too many blank identifiers; default is 2
|
|
max-blank-identifiers: 2
|
|
dupl:
|
|
# tokens count to trigger issue, 150 by default
|
|
threshold: 100
|
|
errcheck:
|
|
# report about not checking of errors in type assertions: `a := b.(MyStruct)`;
|
|
# default is false: such cases aren't reported by default.
|
|
check-type-assertions: false
|
|
|
|
# report about assignment of errors to blank identifier: `num, _ := strconv.Atoi(numStr)`;
|
|
# default is false: such cases aren't reported by default.
|
|
check-blank: false
|
|
|
|
# path to a file containing a list of functions to exclude from checking
|
|
# see https://github.com/kisielk/errcheck#excluding-functions for details
|
|
#exclude: errcheck.txt
|
|
exhaustive:
|
|
# indicates that switch statements are to be considered exhaustive if a
|
|
# 'default' case is present, even if all enum members aren't listed in the
|
|
# switch
|
|
default-signifies-exhaustive: false
|
|
funlen:
|
|
lines: 150
|
|
statements: 40
|
|
gocognit:
|
|
# minimal code complexity to report, 30 by default (but we recommend 10-20)
|
|
min-complexity: 30
|
|
nestif:
|
|
# minimal complexity of if statements to report, 5 by default
|
|
min-complexity: 4
|
|
goconst:
|
|
# minimal length of string constant, 3 by default
|
|
min-len: 5
|
|
# minimal occurrences count to trigger, 3 by default
|
|
min-occurrences: 5
|
|
gocyclo:
|
|
# minimal code complexity to report, 30 by default (but we recommend 10-20)
|
|
min-complexity: 30
|
|
godot:
|
|
# check all top-level comments, not only declarations
|
|
check-all: false
|
|
godox:
|
|
# report any comments starting with keywords, this is useful for TODO or FIXME comments that
|
|
# might be left in the code accidentally and should be resolved before merging
|
|
keywords: # default keywords are TODO, BUG, and FIXME, these can be overwritten by this setting
|
|
- OPTIMIZE # marks code that should be optimized before merging
|
|
- HACK # marks hack-arounds that should be removed before merging
|
|
gofmt:
|
|
# simplify code: gofmt with `-s` option, true by default
|
|
simplify: true
|
|
goimports:
|
|
# put imports beginning with prefix after 3rd-party packages;
|
|
# it's a comma-separated list of prefixes
|
|
local-prefixes: github.com/org/project
|
|
golint:
|
|
# minimal confidence for issues, default is 0.8
|
|
min-confidence: 0.9
|
|
gomnd:
|
|
settings:
|
|
mnd:
|
|
# the list of enabled checks, see https://github.com/tommy-muehle/go-mnd/#checks for description.
|
|
checks: argument,case,condition,operation,return,assign
|
|
gomodguard:
|
|
allowed:
|
|
modules: # List of allowed modules
|
|
# - gopkg.in/yaml.v2
|
|
domains: # List of allowed module domains
|
|
# - golang.org
|
|
govet:
|
|
# report about shadowed variables
|
|
check-shadowing: true
|
|
|
|
# enable or disable analyzers by name
|
|
enable:
|
|
- atomicalign
|
|
enable-all: false
|
|
disable:
|
|
- shadow
|
|
disable-all: false
|
|
depguard:
|
|
list-type: blacklist
|
|
include-go-root: false
|
|
packages:
|
|
packages-with-error-message:
|
|
lll:
|
|
# max line length, lines longer will be reported. Default is 120.
|
|
# '\t' is counted as 1 character by default, and can be changed with the tab-width option
|
|
line-length: 120
|
|
# tab width in spaces. Default to 1.
|
|
tab-width: 1
|
|
maligned:
|
|
# print struct with more effective memory layout or not, false by default
|
|
suggest-new: true
|
|
misspell:
|
|
# Correct spellings using locale preferences for US or UK.
|
|
# Default is to use a neutral variety of English.
|
|
# Setting locale to US will correct the British spelling of 'colour' to 'color'.
|
|
locale: US
|
|
ignore-words:
|
|
- someword
|
|
nakedret:
|
|
# make an issue if func has more lines of code than this setting and it has naked returns; default is 30
|
|
max-func-lines: 30
|
|
prealloc:
|
|
# XXX: we don't recommend using this linter before doing performance profiling.
|
|
# For most programs usage of prealloc will be a premature optimization.
|
|
|
|
# Report preallocation suggestions only on simple loops that have no returns/breaks/continues/gotos in them.
|
|
# True by default.
|
|
simple: true
|
|
range-loops: true # Report preallocation suggestions on range loops, true by default
|
|
for-loops: false # Report preallocation suggestions on for loops, false by default
|
|
nolintlint:
|
|
# Enable to ensure that nolint directives are all used. Default is true.
|
|
allow-unused: false
|
|
# Disable to ensure that nolint directives don't have a leading space. Default is true.
|
|
allow-leading-space: true
|
|
# Exclude following linters from requiring an explanation. Default is [].
|
|
allow-no-explanation: []
|
|
# Enable to require an explanation of nonzero length after each nolint directive. Default is false.
|
|
require-explanation: true
|
|
# Enable to require nolint directives to mention the specific linter being suppressed. Default is false.
|
|
require-specific: true
|
|
unparam:
|
|
# Inspect exported functions, default is false. Set to true if no external program/library imports your code.
|
|
# XXX: if you enable this setting, unparam will report a lot of false-positives in text editors:
|
|
# if it's called for subdir of a project it can't find external interfaces. All text editor integrations
|
|
# with golangci-lint call it on a directory with the changed file.
|
|
check-exported: false
|
|
unused:
|
|
# treat code as a program (not a library) and report unused exported identifiers; default is false.
|
|
# XXX: if you enable this setting, unused will report a lot of false-positives in text editors:
|
|
# if it's called for subdir of a project it can't find funcs usages. All text editor integrations
|
|
# with golangci-lint call it on a directory with the changed file.
|
|
check-exported: false
|
|
whitespace:
|
|
multi-if: false # Enforces newlines (or comments) after every multi-line if statement
|
|
multi-func: false # Enforces newlines (or comments) after every multi-line function signature
|
|
wsl:
|
|
# If true append is only allowed to be cuddled if appending value is
|
|
# matching variables, fields or types on line above. Default is true.
|
|
strict-append: true
|
|
# Allow calls and assignments to be cuddled as long as the lines have any
|
|
# matching variables, fields or types. Default is true.
|
|
allow-assign-and-call: true
|
|
# Allow multiline assignments to be cuddled. Default is true.
|
|
allow-multiline-assign: true
|
|
# Allow declarations (var) to be cuddled.
|
|
allow-cuddle-declarations: false
|
|
# Allow trailing comments in ending of blocks
|
|
allow-trailing-comment: false
|
|
# Force newlines in end of case at this limit (0 = never).
|
|
force-case-trailing-whitespace: 0
|
|
# Force cuddling of err checks with err var assignment
|
|
force-err-cuddling: false
|
|
# Allow leading comments to be separated with empty liens
|
|
allow-separated-leading-comment: false
|
|
|
|
linters:
|
|
# please, do not use `enable-all`: it's deprecated and will be removed soon.
|
|
# inverted configuration with `enable-all` and `disable` is not scalable during updates of golangci-lint
|
|
disable-all: true
|
|
enable:
|
|
- bodyclose
|
|
- deadcode
|
|
- depguard
|
|
- dogsled
|
|
- dupl
|
|
- errcheck
|
|
- funlen
|
|
- gochecknoinits
|
|
- goconst
|
|
- gocritic
|
|
- gocyclo
|
|
- gofmt
|
|
- goimports
|
|
- golint
|
|
- goprintffuncname
|
|
- gosec
|
|
- gosimple
|
|
- govet
|
|
- ineffassign
|
|
- interfacer
|
|
- lll
|
|
- misspell
|
|
- nakedret
|
|
- nolintlint
|
|
- rowserrcheck
|
|
- scopelint
|
|
- staticcheck
|
|
- structcheck
|
|
- stylecheck
|
|
- typecheck
|
|
- unconvert
|
|
- unparam
|
|
- unused
|
|
- varcheck
|
|
- whitespace
|
|
- asciicheck
|
|
- gocognit
|
|
- godot
|
|
- godox
|
|
- maligned
|
|
- nestif
|
|
- prealloc
|
|
- gomodguard
|
|
# don't enable:
|
|
#- goerr113
|
|
#- wsl
|
|
#- testpackage
|
|
#- exhaustive (TODO: enable after next release; current release at time of writing is v1.27)
|
|
#- gochecknoglobals
|
|
#- gomnd
|
|
|
|
issues:
|
|
# Excluding configuration per-path, per-linter, per-text and per-source
|
|
|
|
# Independently from 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 value for this option is true.
|
|
exclude-use-default: true
|
|
|
|
# The default value is false. If set to true exclude and exclude-rules
|
|
# regular expressions become case sensitive.
|
|
exclude-case-sensitive: false
|
|
|
|
# The list of ids of default excludes to include or disable. By default it's empty.
|
|
include:
|
|
- EXC0002 # disable excluding of issues about comments from golint
|
|
|
|
# Maximum issues count per one linter. Set to 0 to disable. Default is 50.
|
|
max-issues-per-linter: 0
|
|
|
|
# Maximum count of issues with the same text. Set to 0 to disable. Default is 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 is false.
|
|
new: false
|
|
|
|
# Show only new issues created after git revision `REV`
|
|
# new-from-rev: REV
|
|
|
|
# Show only new issues created in git patch with set file path.
|
|
#new-from-patch: path/to/patch/file
|
|
|
|
severity:
|
|
# Default value is empty string.
|
|
# 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#severity
|
|
# - Github: https://help.github.com/en/actions/reference/workflow-commands-for-github-actions#setting-an-error-message
|
|
default-severity: error
|
|
|
|
# The default value is false.
|
|
# If set to true severity-rules regular expressions become case sensitive.
|
|
case-sensitive: false
|
|
|
|
# Default value is empty list.
|
|
# 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.
|
|
rules:
|
|
- linters:
|
|
- dupl
|
|
severity: info |