316 lines
14 KiB
YAML
316 lines
14 KiB
YAML
## Golden config for golangci-lint v1.49.0
|
|
|
|
run:
|
|
# Timeout for analysis, e.g. 30s, 5m.
|
|
# Default: 1m
|
|
timeout: 3m
|
|
|
|
|
|
# This file contains only configs which differ from defaults.
|
|
# All possible options can be found here https://github.com/golangci/golangci-lint/blob/master/.golangci.reference.yml
|
|
linters-settings:
|
|
cyclop:
|
|
# The maximal code complexity to report.
|
|
# Default: 10
|
|
max-complexity: 30
|
|
# The maximal average package complexity.
|
|
# If it's higher than 0.0 (float) the check is enabled
|
|
# Default: 0.0
|
|
package-average: 10.0
|
|
|
|
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
|
|
|
|
funlen:
|
|
# Checks the number of lines in a function.
|
|
# If lower than 0, disable the check.
|
|
# Default: 60
|
|
lines: 100
|
|
# Checks the number of statements in a function.
|
|
# If lower than 0, disable the check.
|
|
# Default: 40
|
|
statements: 50
|
|
|
|
gocognit:
|
|
# Minimal code complexity to report
|
|
# Default: 30 (but we recommend 10-20)
|
|
min-complexity: 20
|
|
|
|
gocritic:
|
|
# 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:
|
|
# Whether to restrict checker to params only.
|
|
# Default: true
|
|
paramsOnly: false
|
|
underef:
|
|
# Whether to skip (*x).method() calls where x is a pointer receiver.
|
|
# Default: true
|
|
skipRecvDeref: false
|
|
|
|
gomnd:
|
|
# List of function patterns to exclude from analysis.
|
|
# Values always ignored: `time.Date`
|
|
# Default: []
|
|
ignored-functions:
|
|
- os.Chmod
|
|
- os.Mkdir
|
|
- os.MkdirAll
|
|
- os.OpenFile
|
|
- os.WriteFile
|
|
- prometheus.ExponentialBuckets
|
|
- prometheus.ExponentialBucketsRange
|
|
- prometheus.LinearBuckets
|
|
- strconv.FormatFloat
|
|
- strconv.FormatInt
|
|
- strconv.FormatUint
|
|
- strconv.ParseFloat
|
|
- strconv.ParseInt
|
|
- strconv.ParseUint
|
|
|
|
gomodguard:
|
|
blocked:
|
|
# List of blocked modules.
|
|
# Default: []
|
|
modules:
|
|
- github.com/golang/protobuf:
|
|
recommendations:
|
|
- google.golang.org/protobuf
|
|
reason: "see https://developers.google.com/protocol-buffers/docs/reference/go/faq#modules"
|
|
- github.com/satori/go.uuid:
|
|
recommendations:
|
|
- github.com/google/uuid
|
|
reason: "satori's package is not maintained"
|
|
- github.com/gofrs/uuid:
|
|
recommendations:
|
|
- github.com/google/uuid
|
|
reason: "see recommendation from dev-infra team: https://confluence.gtforge.com/x/gQI6Aw"
|
|
|
|
govet:
|
|
# Enable all analyzers.
|
|
# Default: false
|
|
enable-all: true
|
|
# Disable analyzers by name.
|
|
# Run `go tool vet help` to see all analyzers.
|
|
# Default: []
|
|
disable:
|
|
- fieldalignment # too strict
|
|
# Settings per analyzer.
|
|
settings:
|
|
shadow:
|
|
# Whether to be strict about shadowing; can be noisy.
|
|
# Default: false
|
|
strict: true
|
|
|
|
nakedret:
|
|
# Make an issue if func has more lines of code than this setting, and it has naked returns.
|
|
# Default: 30
|
|
max-func-lines: 30
|
|
|
|
rowserrcheck:
|
|
# database/sql is always checked
|
|
# Default: []
|
|
packages:
|
|
- github.com/jmoiron/sqlx
|
|
|
|
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: true
|
|
|
|
goheader:
|
|
# The template use for checking.
|
|
# Default: ""
|
|
template: |-
|
|
Copyright 2023 Harness, Inc.
|
|
|
|
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
|
|
gci:
|
|
# DEPRECATED: use `sections` and `prefix(github.com/org/project)` instead.
|
|
# local-prefixes: github.com/harness/gitness
|
|
# 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.
|
|
- prefix(github.com/harness/gitness) # Custom section: groups all imports with the specified Prefix.
|
|
- default # Default section: contains all imports that could not be matched to another section type.
|
|
- 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
|
|
|
|
tagliatelle:
|
|
# Check the struck tag name case.
|
|
case:
|
|
rules:
|
|
# Any struct tag type can be used.
|
|
# Support string case: `camel`, `pascal`, `kebab`, `snake`, `goCamel`, `goPascal`, `goKebab`, `goSnake`, `upper`, `lower`
|
|
json: snake
|
|
db: snake
|
|
yaml: snake
|
|
xml: snake
|
|
bson: snake
|
|
avro: snake
|
|
mapstructure: snake
|
|
|
|
|
|
linters:
|
|
disable-all: true
|
|
enable:
|
|
## enabled by default
|
|
- errcheck # checking for unchecked errors, these unchecked errors can be critical bugs in some cases
|
|
- gosimple # specializes in simplifying a code
|
|
- govet # reports suspicious constructs, such as Printf calls whose arguments do not align with the format string
|
|
- ineffassign # detects when assignments to existing variables are not used
|
|
- staticcheck # is a go vet on steroids, applying a ton of static analysis checks
|
|
- typecheck # like the front-end of a Go compiler, parses and type-checks Go code
|
|
- unused # checks for unused constants, variables, functions and types
|
|
## disabled by default
|
|
- asasalint # checks for pass []any as any in variadic func(...any)
|
|
- asciicheck # checks that your code does not contain non-ASCII identifiers
|
|
- bidichk # checks for dangerous unicode character sequences
|
|
- bodyclose # checks whether HTTP response body is closed successfully
|
|
#- contextcheck # checks the function whether use a non-inherited context # TODO: enable after golangci-lint uses https://github.com/sylvia7788/contextcheck/releases/tag/v1.0.7
|
|
- cyclop # checks function and package cyclomatic complexity
|
|
# - dupl # tool for code clone detection
|
|
- durationcheck # checks for two durations multiplied together
|
|
- errname # checks that sentinel errors are prefixed with the Err and error types are suffixed with the Error
|
|
- errorlint # finds code that will cause problems with the error wrapping scheme introduced in Go 1.13
|
|
- execinquery # checks query string in Query function which reads your Go src files and warning it finds
|
|
- exhaustive # checks exhaustiveness of enum switch statements
|
|
- exportloopref # checks for pointers to enclosing loop variables
|
|
- forbidigo # forbids identifiers
|
|
#- funlen # tool for detection of long functions
|
|
#- gochecknoglobals # checks that no global variables exist
|
|
#- gochecknoinits # checks that no init functions are present in Go code
|
|
- gocognit # computes and checks the cognitive complexity of functions
|
|
- goconst # finds repeated strings that could be replaced by a constant
|
|
- gocritic # provides diagnostics that check for bugs, performance and style issues
|
|
- gocyclo # computes and checks the cyclomatic complexity of functions
|
|
- godot # checks if comments end in a period
|
|
- goimports # in addition to fixing imports, goimports also formats your code in the same style as gofmt
|
|
- gomnd # detects magic numbers
|
|
- gomoddirectives # manages the use of 'replace', 'retract', and 'excludes' directives in go.mod
|
|
- gomodguard # allow and block lists linter for direct Go module dependencies. This is different from depguard where there are different block types for example version constraints and module recommendations
|
|
- goprintffuncname # checks that printf-like functions are named with f at the end
|
|
- gosec # inspects source code for security problems
|
|
- lll # reports long lines
|
|
- makezero # finds slice declarations with non-zero initial length
|
|
- nakedret # finds naked returns in functions greater than a specified function length
|
|
- nestif # reports deeply nested if statements
|
|
- nilerr # finds the code that returns nil even if it checks that the error is not nil
|
|
- nilnil # checks that there is no simultaneous return of nil error and an invalid value
|
|
- noctx # finds sending http request without context.Context
|
|
# - nolintlint # reports ill-formed or insufficient nolint directives
|
|
# - nonamedreturns # reports all named returns
|
|
- nosprintfhostport # checks for misuse of Sprintf to construct a host with port in a URL
|
|
- predeclared # finds code that shadows one of Go's predeclared identifiers
|
|
- promlinter # checks Prometheus metrics naming via promlint
|
|
- reassign # checks that package variables are not reassigned
|
|
- revive # fast, configurable, extensible, flexible, and beautiful linter for Go, drop-in replacement of golint
|
|
- rowserrcheck # checks whether Err of rows is checked successfully
|
|
- sqlclosecheck # checks that sql.Rows and sql.Stmt are closed
|
|
- stylecheck # is a replacement for golint
|
|
- tagliatelle # checks the struct tags
|
|
- tenv # detects using os.Setenv instead of t.Setenv since Go1.17
|
|
#- testpackage # makes you use a separate _test package
|
|
- tparallel # detects inappropriate usage of t.Parallel() method in your Go test codes
|
|
- unconvert # removes unnecessary type conversions
|
|
- unparam # reports unused function parameters
|
|
- usestdlibvars # detects the possibility to use variables/constants from the Go standard library
|
|
- wastedassign # finds wasted assignment statements
|
|
- whitespace # detects leading and trailing whitespace
|
|
|
|
## you may want to enable
|
|
#- decorder # checks declaration order and count of types, constants, variables and functions
|
|
#- exhaustruct # checks if all structure fields are initialized
|
|
- gci # controls golang package import order and makes it always deterministic
|
|
#- godox # detects FIXME, TODO and other comment keywords
|
|
- goheader # checks is file header matches to pattern
|
|
#- interfacebloat # checks the number of methods inside an interface
|
|
#- ireturn # accept interfaces, return concrete types
|
|
#- prealloc # [premature optimization, but can be used in some cases] finds slice declarations that could potentially be preallocated
|
|
#- varnamelen # [great idea, but too many false positives] checks that the length of a variable's name matches its scope
|
|
#- wrapcheck # checks that errors returned from external packages are wrapped
|
|
|
|
## disabled
|
|
#- containedctx # detects struct contained context.Context field
|
|
#- depguard # [replaced by gomodguard] checks if package imports are in a list of acceptable packages
|
|
#- dogsled # checks assignments with too many blank identifiers (e.g. x, _, _, _, := f())
|
|
#- errchkjson # [don't see profit + I'm against of omitting errors like in the first example https://github.com/breml/errchkjson] checks types passed to the json encoding functions. Reports unsupported types and optionally reports occasions, where the check for the returned error can be omitted
|
|
#- forcetypeassert # [replaced by errcheck] finds forced type assertions
|
|
#- goerr113 # [too strict] checks the errors handling expressions
|
|
#- gofmt # [replaced by goimports] checks whether code was gofmt-ed
|
|
#- gofumpt # [replaced by goimports, gofumports is not available yet] checks whether code was gofumpt-ed
|
|
#- grouper # analyzes expression groups
|
|
#- importas # enforces consistent import aliases
|
|
#- logrlint # [owner archived repository] checks logr arguments
|
|
#- maintidx # measures the maintainability index of each function
|
|
- misspell # [useless] finds commonly misspelled English words in comments
|
|
#- nlreturn # [too strict and mostly code is not more readable] checks for a new line before return and branch statements to increase code clarity
|
|
#- paralleltest # [too many false positives] detects missing usage of t.Parallel() method in your Go test
|
|
#- thelper # detects golang test helpers without t.Helper() call and checks the consistency of test helpers
|
|
#- wsl # [too strict and mostly code is not more readable] whitespace linter forces you to use empty lines
|
|
|
|
|
|
issues:
|
|
# Maximum count of issues with the same text.
|
|
# Set to 0 to disable.
|
|
# Default: 3
|
|
max-same-issues: 50
|
|
|
|
exclude-rules:
|
|
- text: 'shadow: declaration of "(err|ctx)" shadows declaration at'
|
|
linters: [ govet ]
|
|
- source: "^//\\s*go:generate\\s"
|
|
linters: [ lll ]
|
|
- text: 'replacement are not allowed: github.com/docker/docker'
|
|
linters: [ gomoddirectives ]
|
|
- source: "(noinspection|TODO)"
|
|
linters: [ godot ]
|
|
- source: "//noinspection"
|
|
linters: [ gocritic ]
|
|
- source: "^\\s+if _, ok := err\\.\\([^.]+\\.InternalError\\); ok {"
|
|
linters: [ errorlint ]
|
|
- path: "^cli/"
|
|
linters: [forbidigo]
|
|
- text: "mnd: Magic number: \\d"
|
|
linters:
|
|
- gomnd
|
|
- path: "_test\\.go"
|
|
linters:
|
|
- bodyclose
|
|
- dupl
|
|
- funlen
|
|
- goconst
|
|
- gosec
|
|
- noctx
|
|
- wrapcheck |