2024-06-05 20:10:03 +00:00
# SPDX-FileCopyrightText: 2023 The Pion community <https://pion.ly>
# SPDX-License-Identifier: MIT
2022-03-10 09:44:48 +00:00
linters-settings :
govet :
check-shadowing : true
misspell :
locale : US
exhaustive :
default-signifies-exhaustive : true
gomodguard :
blocked :
modules :
- github.com/pkg/errors :
recommendations :
2024-06-05 20:10:03 +00:00
- errors
forbidigo :
forbid :
- ^fmt.Print(f|ln)?$
- ^log.(Panic|Fatal|Print)(f|ln)?$
- ^os.Exit$
- ^panic$
- ^print(ln)?$
2022-03-10 09:44:48 +00:00
linters :
enable :
- asciicheck # Simple linter to check that your code does not contain non-ASCII identifiers
2024-05-15 23:15:00 +00:00
- bidichk # Checks for dangerous unicode character sequences
2022-03-10 09:44:48 +00:00
- bodyclose # checks whether HTTP response body is closed successfully
2024-05-15 23:15:00 +00:00
- contextcheck # check the function whether use a non-inherited context
- decorder # check declaration order and count of types, constants, variables and functions
2022-03-10 09:44:48 +00:00
- dogsled # Checks assignments with too many blank identifiers (e.g. x, _, _, _, := f())
- dupl # Tool for code clone detection
2024-05-15 23:15:00 +00:00
- durationcheck # check for two durations multiplied together
2022-03-10 09:44:48 +00:00
- errcheck # Errcheck is a program for checking for unchecked errors in go programs. These unchecked errors can be critical bugs in some cases
2024-05-15 23:15:00 +00:00
- errchkjson # Checks types passed to the json encoding functions. Reports unsupported types and optionally reports occations, where the check for the returned error can be omitted.
- errname # Checks that sentinel errors are prefixed with the `Err` and error types are suffixed with the `Error`.
- errorlint # errorlint is a linter for that can be used to find code that will cause problems with the error wrapping scheme introduced in Go 1.13.
2022-03-10 09:44:48 +00:00
- exhaustive # check exhaustiveness of enum switch statements
- exportloopref # checks for pointers to enclosing loop variables
2024-06-05 20:10:03 +00:00
- forbidigo # Forbids identifiers
2024-05-15 23:15:00 +00:00
- forcetypeassert # finds forced type assertions
2022-03-10 09:44:48 +00:00
- gci # Gci control golang package import order and make it always deterministic.
- gochecknoglobals # Checks that no globals are present in Go code
- 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 # The most opinionated Go source code linter
- godox # Tool for detection of FIXME, TODO and other comment keywords
- goerr113 # Golang linter to check the errors handling expressions
- gofmt # Gofmt checks whether code was gofmt-ed. By default this tool runs with -s option to check for code simplification
- gofumpt # Gofumpt checks whether code was gofumpt-ed.
- goheader # Checks is file header matches to pattern
- goimports # Goimports does everything that gofmt does. Additionally it checks unused imports
2024-05-15 23:15:00 +00:00
- gomoddirectives # Manage the use of 'replace', 'retract', and 'excludes' directives in go.mod.
2022-03-10 09:44:48 +00:00
- gomodguard # Allow and block list linter for direct Go module dependencies. This is different from depguard where there are different block types for example version constraints and module recommendations.
- goprintffuncname # Checks that printf-like functions are named with `f` at the end
- gosec # Inspects source code for security problems
- gosimple # Linter for Go source code that specializes in simplifying a code
- govet # Vet examines Go source code and reports suspicious constructs, such as Printf calls whose arguments do not align with the format string
2024-05-15 23:15:00 +00:00
- grouper # An analyzer to analyze expression groups.
- importas # Enforces consistent import aliases
2022-03-10 09:44:48 +00:00
- ineffassign # Detects when assignments to existing variables are not used
- misspell # Finds commonly misspelled English words in comments
2024-05-15 23:15:00 +00:00
- 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.
2022-03-10 09:44:48 +00:00
- noctx # noctx finds sending http request without context.Context
2024-05-15 23:15:00 +00:00
- predeclared # find code that shadows one of Go's predeclared identifiers
- revive # golint replacement, finds style mistakes
2022-03-10 09:44:48 +00:00
- staticcheck # Staticcheck is a go vet on steroids, applying a ton of static analysis checks
- stylecheck # Stylecheck is a replacement for golint
2024-05-15 23:15:00 +00:00
- tagliatelle # Checks the struct tags.
- tenv # tenv is analyzer that detects using os.Setenv instead of t.Setenv since Go1.17
- tparallel # tparallel detects inappropriate usage of t.Parallel() method in your Go test codes
2022-03-10 09:44:48 +00:00
- typecheck # Like the front-end of a Go compiler, parses and type-checks Go code
- unconvert # Remove unnecessary type conversions
- unparam # Reports unused function parameters
- unused # Checks Go code for unused constants, variables, functions and types
2024-05-15 23:15:00 +00:00
- wastedassign # wastedassign finds wasted assignment statements
2022-03-10 09:44:48 +00:00
- whitespace # Tool for detection of leading and trailing whitespace
disable :
2024-06-05 20:10:03 +00:00
- depguard # Go linter that checks if package imports are in a list of acceptable packages
2024-05-15 23:15:00 +00:00
- containedctx # containedctx is a linter that detects struct contained context.Context field
- cyclop # checks function and package cyclomatic complexity
- exhaustivestruct # Checks if all struct's fields are initialized
2022-03-10 09:44:48 +00:00
- funlen # Tool for detection of long functions
- gocyclo # Computes and checks the cyclomatic complexity of functions
- godot # Check if comments end in a period
- gomnd # An analyzer to detect magic numbers.
2024-05-15 23:15:00 +00:00
- ifshort # Checks that your code uses short syntax for if-statements whenever possible
- ireturn # Accept Interfaces, Return Concrete Types
2022-03-10 09:44:48 +00:00
- lll # Reports long lines
2024-05-15 23:15:00 +00:00
- maintidx # maintidx measures the maintainability index of each function.
- makezero # Finds slice declarations with non-zero initial length
2022-03-10 09:44:48 +00:00
- maligned # Tool to detect Go structs that would take less memory if their fields were sorted
2024-06-05 20:10:03 +00:00
- nakedret # Finds naked returns in functions greater than a specified function length
2022-03-10 09:44:48 +00:00
- nestif # Reports deeply nested if statements
- nlreturn # nlreturn checks for a new line before return and branch statements to increase code clarity
- nolintlint # Reports ill-formed or insufficient nolint directives
2024-05-15 23:15:00 +00:00
- paralleltest # paralleltest detects missing usage of t.Parallel() method in your Go test
2022-03-10 09:44:48 +00:00
- prealloc # Finds slice declarations that could potentially be preallocated
2024-05-15 23:15:00 +00:00
- promlinter # Check Prometheus metrics naming via promlint
2022-03-10 09:44:48 +00:00
- rowserrcheck # checks whether Err of rows is checked successfully
- sqlclosecheck # Checks that sql.Rows and sql.Stmt are closed.
- testpackage # linter that makes you use a separate _test package
2024-05-15 23:15:00 +00:00
- thelper # thelper detects golang test helpers without t.Helper() call and checks the consistency of test helpers
- varnamelen # checks that the length of a variable's name matches its scope
- wrapcheck # Checks that errors returned from external packages are wrapped
2022-03-10 09:44:48 +00:00
- wsl # Whitespace Linter - Forces you to use empty lines!
issues :
exclude-use-default : false
exclude-rules :
2024-06-05 20:10:03 +00:00
# Allow complex tests and examples, better to be self contained
- path : (examples|main\.go|_test\.go)
2022-03-10 09:44:48 +00:00
linters :
2024-06-05 20:10:03 +00:00
- forbidigo
2022-03-10 09:44:48 +00:00
- gocognit
2024-06-05 20:10:03 +00:00
# Allow forbidden identifiers in CLI commands
- path : cmd
2022-03-10 09:44:48 +00:00
linters :
2024-06-05 20:10:03 +00:00
- forbidigo
2022-03-10 09:44:48 +00:00
run :
skip-dirs-use-default : false