|
| 1 | +--- |
| 2 | +run: |
| 3 | + # Timeout for analysis. |
| 4 | + timeout: 5m |
| 5 | + |
| 6 | + # Modules download mode (do not modify go.mod) |
| 7 | + module-download-mode: readonly |
| 8 | + |
| 9 | + # Include test files (see below to exclude certain linters) |
| 10 | + tests: true |
| 11 | + |
| 12 | +issues: |
| 13 | + exclude-rules: |
| 14 | + # Exclude certain linters for test code |
| 15 | + - path: "_test\\.go" |
| 16 | + linters: |
| 17 | + - bodyclose |
| 18 | + - dupl |
| 19 | + - dogsled |
| 20 | + - funlen |
| 21 | + |
| 22 | +output: |
| 23 | + formats: colored-line-number |
| 24 | + print-issued-lines: true |
| 25 | + print-linter-name: true |
| 26 | + |
| 27 | +linters-settings: |
| 28 | + depguard: |
| 29 | + rules: |
| 30 | + main: |
| 31 | + # Packages that are not allowed where the value is a suggestion. |
| 32 | + deny: |
| 33 | + - pkg: "github.com/pkg/errors" |
| 34 | + desc: Should be replaced by standard lib errors package |
| 35 | + cyclop: |
| 36 | + # The maximal code complexity to report. |
| 37 | + max-complexity: 15 |
| 38 | + skip-tests: true |
| 39 | + funlen: |
| 40 | + lines: 100 |
| 41 | + nestif: |
| 42 | + min-complexity: 6 |
| 43 | + forbidigo: |
| 44 | + forbid: |
| 45 | + - http\.NotFound.* # return RFC 7807 problem details instead |
| 46 | + - http\.Error.* # return RFC 7807 problem details instead |
| 47 | + gomoddirectives: |
| 48 | + replace-allow-list: |
| 49 | + - github.com/abbot/go-http-auth |
| 50 | + tagliatelle: |
| 51 | + case: |
| 52 | + rules: |
| 53 | + json: snake # since betterstack uses snake instead of camel case for JSON |
| 54 | + |
| 55 | +linters: |
| 56 | + disable-all: true |
| 57 | + enable: |
| 58 | + # enabled by default by golangci-lint |
| 59 | + - errcheck # checking for unchecked errors, these unchecked errors can be critical bugs in some cases |
| 60 | + - gosimple # specializes in simplifying a code |
| 61 | + - govet # reports suspicious constructs, such as Printf calls whose arguments do not align with the format string |
| 62 | + - ineffassign # detects when assignments to existing variables are not used |
| 63 | + - staticcheck # is a go vet on steroids, applying a ton of static analysis checks |
| 64 | + - typecheck # like the front-end of a Go compiler, parses and type-checks Go code |
| 65 | + - unused # checks for unused constants, variables, functions and types |
| 66 | + # extra enabled by us |
| 67 | + - asasalint # checks for pass []any as any in variadic func(...any) |
| 68 | + - asciicheck # checks that your code does not contain non-ASCII identifiers |
| 69 | + - bidichk # checks for dangerous unicode character sequences |
| 70 | + - bodyclose # checks whether HTTP response body is closed successfully |
| 71 | + - cyclop # checks function and package cyclomatic complexity |
| 72 | + - dupl # tool for code clone detection |
| 73 | + - durationcheck # checks for two durations multiplied together |
| 74 | + - dogsled # find assignments/declarations with too many blank identifiers |
| 75 | + - errname # checks that sentinel errors are prefixed with the Err and error types are suffixed with the Error |
| 76 | + - errorlint # finds code that will cause problems with the error wrapping scheme introduced in Go 1.13 |
| 77 | + - exhaustive # checks exhaustiveness of enum switch statements |
| 78 | + - exptostd # detects functions from golang.org/x/exp/ that can be replaced by std functions |
| 79 | + - copyloopvar # checks for pointers to enclosing loop variables |
| 80 | + - fatcontext # detects nested contexts in loops and function literals |
| 81 | + - forbidigo # forbids identifiers |
| 82 | + - funlen # tool for detection of long functions |
| 83 | + - gocheckcompilerdirectives # validates go compiler directive comments (//go:) |
| 84 | + - goconst # finds repeated strings that could be replaced by a constant |
| 85 | + - gocritic # provides diagnostics that check for bugs, performance and style issues |
| 86 | + - gofmt # checks if the code is formatted according to 'gofmt' command |
| 87 | + - goimports # in addition to fixing imports, goimports also formats your code in the same style as gofmt |
| 88 | + - gomoddirectives # manages the use of 'replace', 'retract', and 'excludes' directives in go.mod |
| 89 | + - 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 |
| 90 | + - goprintffuncname # checks that printf-like functions are named with f at the end |
| 91 | + - gosec # inspects source code for security problems |
| 92 | + - loggercheck # checks key value pairs for common logger libraries (kitlog,klog,logr,zap) |
| 93 | + - makezero # finds slice declarations with non-zero initial length |
| 94 | + - mirror # reports wrong mirror patterns of bytes/strings usage |
| 95 | + - misspell # finds commonly misspelled English words |
| 96 | + - nakedret # finds naked returns in functions greater than a specified function length |
| 97 | + - nestif # reports deeply nested if statements |
| 98 | + - nilerr # finds the code that returns nil even if it checks that the error is not nil |
| 99 | + - nolintlint # reports ill-formed or insufficient nolint directives |
| 100 | + - nosprintfhostport # checks for misuse of Sprintf to construct a host with port in a URL |
| 101 | + - perfsprint # Golang linter for performance, aiming at usages of fmt.Sprintf which have faster alternatives |
| 102 | + - predeclared # finds code that shadows one of Go's predeclared identifiers |
| 103 | + - promlinter # checks Prometheus metrics naming via promlint |
| 104 | + - reassign # checks that package variables are not reassigned |
| 105 | + - revive # fast, configurable, extensible, flexible, and beautiful linter for Go, drop-in replacement of golint |
| 106 | + - rowserrcheck # checks whether Err of rows is checked successfully |
| 107 | + - sqlclosecheck # checks that sql.Rows and sql.Stmt are closed |
| 108 | + - sloglint # A Go linter that ensures consistent code style when using log/slog |
| 109 | + - tagliatelle # checks the struct tags. |
| 110 | + - usetesting # detects using os.Setenv instead of t.Setenv since Go1.17 |
| 111 | + - testableexamples # checks if examples are testable (have an expected output) |
| 112 | + - tparallel # detects inappropriate usage of t.Parallel() method in your Go test codes |
| 113 | + - unconvert # removes unnecessary type conversions |
| 114 | + - unparam # reports unused function parameters |
| 115 | + - usestdlibvars # detects the possibility to use variables/constants from the Go standard library |
| 116 | + - wastedassign # finds wasted assignment statements |
| 117 | + fast: false |
0 commit comments