Merge pull request #120 from seatgeek/codell-linter-config

Upgrade golangci-lint to v2.10.0 and configure new linters

Author: colinodell

Makefile

@@ -1,5 +1,5 @@
 # renovate: datasource=go depName=github.com/golangci/golangci-lint
-GOLANGCI_LINT_VERSION=v2.6.2
+GOLANGCI_LINT_VERSION=v2.10.0
 # renovate: datasource=go depName=gotest.tools/gotestsum
 GOTESTSUM_VERSION=v1.13.0
 # renovate: datasource=go depName=github.com/boumenot/gocover-cobertura

build/config/.golangci.yml

@@ -22,6 +22,7 @@ formatters:
     ## disabled
     #- gofmt # checks if the code is formatted according to 'gofmt' command
     #- golines # checks if code is formatted, and fixes long lines
+    #- swaggo # check if swaggo comments are formatted
 
 linters:
   default: none
@@ -37,6 +38,7 @@ linters:
     - decorder # checks declaration order and count of types, constants, variables and functions
     - dogsled # checks assignments with too many blank identifiers (e.g. x, _, _, _, := f())
     - durationcheck # checks for two durations multiplied together
+    - embeddedstructfieldcheck # embedded types should be first in the struct definition
     - errcheck # checking for unchecked errors, these unchecked errors can be critical bugs in some cases
     - 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
     - errname # checks that sentinel errors are prefixed with the Err and error types are suffixed with the Error
@@ -49,6 +51,7 @@ linters:
     - 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
+    - godoclint # checks Golang's documentation practice (godoc)
     - 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
@@ -59,10 +62,12 @@ linters:
     - ineffassign # detects when assignments to existing variables are not used
     - interfacebloat # checks the number of methods inside an interface
     - intrange # check for loops that could use int ranges instead (Go 1.22+)
+    - iotamixing # checks for mixing of iota and non-iota constants in the same block
     - loggercheck # checks key value pairs for common logger libraries (kitlog,klog,logr,zap)
     - makezero # finds slice declarations with non-zero initial length
     - mirror # suggests alternative functions to avoid unnecessary []byte/string conversions
     - misspell # finds commonly misspelled English words in comments
+    - modernize # suggests simplifications to Go code, using modern language and library features
     - musttag # checks that struct tags are present
     - nakedret # finds naked returns in functions greater than a specified function length
     - nestif # reports deeply nested if statements
@@ -95,13 +100,15 @@ linters:
     - whitespace # detects leading and trailing whitespace
 
     ## disabled
+    #- arangolint # opinionated best practices for arangodb client
     #- cyclop # checks function and package cyclomatic complexity
     #- depguard # [replaced by gomodguard] checks if package imports are in a list of acceptable packages
     #- dupl # finds duplicated code
     #- dupword # [useless without config] checks for duplicate words in the source code
     #- err113 # [too strict] checks the errors handling expression
     #- exhaustruct # [highly recommend to enable] checks if all structure fields are initialized
     #- forcetypeassert # [replaced by errcheck] finds forced type assertions
+    #- funcorder # checks the order of functions, methods, and constructors
     #- funlen # tool for detection of long functions
     #- ginkgolinter # [if you use ginkgo/gomega] enforces standards of using ginkgo and gomega
     #- gochecknoglobals # checks that no global variables exist
@@ -121,20 +128,26 @@ linters:
     #- maintidx # measures the maintainability index of each function
     #- mnd # detects magic numbers
     #- nilnil # checks that there is no simultaneous return of nil error and an invalid value
+    #- noinlineerr # disallows inline error handling
     #- nonamedreturns # reports all named returns
     #- nlreturn # [too strict and mostly code is not more readable] checks for a new line before return and branch statements to increase code clarity
     #- promlinter # checks Prometheus metrics naming via promlint
     #- stylecheck # is a replacement for golint
     #- tagliatelle # checks the struct tags
     #- testpackage # makes you use a separate _test package
     #- unparam # reports unused function parameters
+    #- unqueryvet # checks for SQL issues
     #- usestdlibvars # detects the possibility to use variables/constants from the Go standard library
     #- 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
     #- wsl # [too strict and mostly code is not more readable] whitespace linter forces you to use empty lines
     #- zerologlint # [if you use zerolog] detects the wrong usage of zerolog that a user forgets to dispatch with Send or Msg
 
   settings:
+    embeddedstructfieldcheck:
+      empty-line: false
+      forbid-mutex: true
+
     errcheck:
       check-type-assertions: true
       exclude-functions:
@@ -146,6 +159,13 @@ linters:
     goconst:
       min-occurrences: 3
 
+    godoclint:
+      default: none
+      enable:
+        - deprecated
+        - require-stdlib-doclink
+        - single-pkg-doc
+
     gomodguard:
       blocked:
         modules:
@@ -203,17 +223,25 @@ linters:
         - name: early-return
           disabled: false
           arguments: [preserveScope]
+        - name: epoch-naming
+          disabled: false
         - name: error-naming
           disabled: false
         - name: error-return
           disabled: false
+        - name: forbidden-call-in-wg-go
+          disabled: false
         - name: if-return
           disabled: false
+        - name: inefficient-map-lookup
+          disabled: false
         - name: max-control-nesting
           disabled: false
           arguments: [3]
         - name: optimize-operands-order
           disabled: false
+        - name: package-directory-mismatch
+          disabled: false
         - name: range
           disabled: false
         - name: receiver-naming
@@ -237,14 +265,24 @@ linters:
           disabled: false
         - name: unexported-naming
           disabled: false
+        - name: unnecessary-format
+          disabled: false
+        - name: unnecessary-if
+          disabled: false
         - name: unnecessary-stmt
           disabled: false
         - name: unreachable-code
           disabled: false
         - name: use-any
           disabled: false
+        - name: use-fmt-print
+          disabled: false
+        - name: use-slices-sort
+          disabled: false
         - name: useless-break
           disabled: false
+        - name: useless-fallthrough
+          disabled: false
         - name: var-declaration
           disabled: false
         - name: waitgroup-by-value

pkg/notifier/slack/slack_test.go

@@ -26,13 +26,13 @@ func TestNewTransport(t *testing.T) {
 		token string
 		opts  []slackgo.Option
 	}{
-		{
+		{ //nolint:gosec // fake test token
 			name:  "creates transport with key and token",
 			key:   "slack",
 			token: "xoxb-test-token",
 			opts:  nil,
 		},
-		{
+		{ //nolint:gosec // fake test token
 			name:  "creates transport with options",
 			key:   "custom-slack",
 			token: "xoxb-another-token",
@@ -296,10 +296,10 @@ func TestTransport_Validate(t *testing.T) {
 		token   string
 		wantErr bool
 	}{
-		{
+		{ //nolint:gosec // fake test token
 			name:    "validation with fake token returns error",
 			token:   "xoxb-fake-token",
-			wantErr: true, // Expect error with fake token
+			wantErr: true,
 		},
 		{
 			name:    "validation with empty token returns error",