Lint improvements

Author: Thomas Stromberg

.golangci.yml

@@ -39,6 +39,8 @@ linters:
     - ginkgolinter # [if you use ginkgo/gomega] enforces standards of using ginkgo and gomega
     - gochecknoglobals # checks that no global variables exist
     - cyclop # replaced by revive
+    - gocyclo # replaced by revive
+    - forbidigo # needs configuration to be useful
     - funlen # replaced by revive
     - godox # TODO's are OK
     - ireturn # It's OK
@@ -47,6 +49,7 @@ linters:
     - goconst # finds repeated strings that could be replaced by a constant
     - goheader # checks is file header matches to pattern
     - gomodguard # [use more powerful depguard] allow and block lists linter for direct Go module dependencies
+    - gomoddirectives
     - err113 # bad advice about dynamic errors
     - lll # [replaced by golines] reports long lines
     - mnd # detects magic numbers, duplicated by revive
@@ -98,6 +101,7 @@ linters:
     errcheck:
       # Report about not checking of errors in type assertions: `a := b.(MyStruct)`.
       check-type-assertions: true
+      check-blank: true
 
     exhaustive:
       # Program elements to check for exhaustiveness.
@@ -148,10 +152,10 @@ linters:
 
     nakedret:
       # Default: 30
-      max-func-lines: 4
+      max-func-lines: 7
 
     nestif:
-      min-complexity: 12
+      min-complexity: 15
 
     nolintlint:
       # Exclude following linters from requiring an explanation.
@@ -167,24 +171,21 @@ linters:
       rules:
         - name: add-constant
           severity: warning
-          disabled: false
-          exclude: [""]
-          arguments:
-            - max-lit-count: "5"
-              allow-strs: '"","\n"'
-              allow-ints: "0,1,2,3,256,1024"
-              allow-floats: "0.0,0.,1.0,1.,2.0,2."
+          disabled: true
         - name: cognitive-complexity
-          arguments: [50]
+          disabled: true # prefer maintidx
         - name: cyclomatic
-          severity: warning
-          arguments: [30]
+          disabled: true # prefer maintidx
         - name: function-length
           arguments: [150, 225]
         - name: line-length-limit
           arguments: [150]
         - name: nested-structs
           disabled: true
+        - name: max-public-structs
+          arguments: [10]
+        - name: flag-parameter # fixes are difficult
+          disabled: true
 
     rowserrcheck:
       # database/sql is always checked.
@@ -206,8 +207,14 @@ linters:
       os-temp-dir: true
 
     varnamelen:
-      max-distance: 40
+      max-distance: 75
       min-name-length: 2
+      check-receivers: false
+      ignore-names:
+        - r
+        - w
+        - f
+        - err
 
   exclusions:
     # Default: []
@@ -225,6 +232,8 @@ linters:
         linters:
           - dupl
           - gosec
+          - godot
+          - govet # alignment
           - noctx
           - perfsprint
           - revive

Makefile

@@ -37,7 +37,7 @@ LINTERS :=
 FIXERS :=
 
 GOLANGCI_LINT_CONFIG := $(LINT_ROOT)/.golangci.yml
-GOLANGCI_LINT_VERSION ?= v2.3.0
+GOLANGCI_LINT_VERSION ?= v2.5.0
 GOLANGCI_LINT_BIN := $(LINT_ROOT)/out/linters/golangci-lint-$(GOLANGCI_LINT_VERSION)-$(LINT_ARCH)
 $(GOLANGCI_LINT_BIN):
 	mkdir -p $(LINT_ROOT)/out/linters
@@ -67,9 +67,19 @@ yamllint-lint: $(YAMLLINT_BIN)
 	PYTHONPATH=$(YAMLLINT_ROOT)/dist $(YAMLLINT_ROOT)/dist/bin/yamllint .
 
 .PHONY: _lint $(LINTERS)
-_lint: $(LINTERS)
+_lint:
+	@exit_code=0; \
+	for target in $(LINTERS); do \
+		$(MAKE) $$target || exit_code=1; \
+	done; \
+	exit $$exit_code
 
 .PHONY: fix $(FIXERS)
-fix: $(FIXERS)
+fix:
+	@exit_code=0; \
+	for target in $(FIXERS); do \
+		$(MAKE) $$target || exit_code=1; \
+	done; \
+	exit $$exit_code
 
 # END: lint-install .

examples/custom_retry_function_test.go

@@ -24,8 +24,6 @@ func (e *RetriableError) Error() string {
 	return fmt.Sprintf("%s (retry after %v)", e.Err.Error(), e.RetryAfter)
 }
 
-var _ error = (*RetriableError)(nil)
-
 // TestCustomRetryFunction shows how to use a custom retry function.
 func TestCustomRetryFunction(t *testing.T) {
 	attempts := 5 // server succeeds after 5 attempts
@@ -35,12 +33,12 @@ func TestCustomRetryFunction(t *testing.T) {
 			// HTTP 429 status code with Retry-After header in seconds
 			w.Header().Add("Retry-After", "1")
 			w.WriteHeader(http.StatusTooManyRequests)
-			_, _ = w.Write([]byte("Server limit reached"))
+			w.Write([]byte("Server limit reached")) //nolint:errcheck // Test server response
 			attempts--
 			return
 		}
 		w.WriteHeader(http.StatusOK)
-		_, _ = w.Write([]byte("hello"))
+		w.Write([]byte("hello")) //nolint:errcheck // Test server response
 	}))
 	defer ts.Close()
 

examples/delay_based_on_error_test.go

@@ -38,7 +38,7 @@ func (err SomeOtherError) Error() string {
 
 func TestCustomRetryFunctionBasedOnKindOfError(t *testing.T) {
 	ts := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
-		_, _ = fmt.Fprintln(w, "hello")
+		fmt.Fprintln(w, "hello") //nolint:errcheck // Test server response
 	}))
 	defer ts.Close()
 

examples/errors_history_test.go

@@ -29,7 +29,7 @@ func TestErrorHistory(t *testing.T) {
 			if err != nil {
 				return err
 			}
-			defer func() { _ = resp.Body.Close() }()
+			defer resp.Body.Close() //nolint:errcheck // Error already checked in main function
 			if resp.StatusCode != http.StatusOK {
 				return fmt.Errorf("failed HTTP - %d", resp.StatusCode)
 			}

examples/http_get_test.go

@@ -12,7 +12,7 @@ import (
 
 func TestGet(t *testing.T) {
 	ts := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
-		_, _ = fmt.Fprintln(w, "hello")
+		fmt.Fprintln(w, "hello") //nolint:errcheck // Test server response
 	}))
 	defer ts.Close()
 

options.go

@@ -1,4 +1,4 @@
-package retry //nolint:revive // More than 5 public structs are necessary for API flexibility
+package retry
 
 import (
 	"context"

retry.go

@@ -82,7 +82,7 @@ func Do(retryableFunc RetryableFunc, opts ...Option) error {
 // By default, it will retry up to 10 times with exponential backoff and jitter.
 // The behavior can be customized using Option functions.
 //
-//nolint:gocognit,gocyclo,revive // Complexity is necessary for retry logic
+//nolint:gocognit,gocyclo // Complexity is necessary for retry logic
 func DoWithData[T any](retryableFunc RetryableFuncWithData[T], opts ...Option) (T, error) {
 	var attempt uint
 	var emptyT T

retry_test.go

@@ -741,7 +741,7 @@ func BenchmarkDo(b *testing.B) {
 	testError := errors.New("test error")
 
 	for range b.N {
-		_ = Do(
+		Do( //nolint:errcheck // Benchmark intentionally ignores errors
 			func() error {
 				return testError
 			},
@@ -755,7 +755,7 @@ func BenchmarkDoWithData(b *testing.B) {
 	testError := errors.New("test error")
 
 	for range b.N {
-		_, _ = DoWithData(
+		DoWithData( //nolint:errcheck // Benchmark intentionally ignores errors
 			func() (int, error) {
 				return 0, testError
 			},
@@ -767,7 +767,7 @@ func BenchmarkDoWithData(b *testing.B) {
 
 func BenchmarkDoNoErrors(b *testing.B) {
 	for range b.N {
-		_ = Do(
+		Do( //nolint:errcheck // Benchmark intentionally ignores errors
 			func() error {
 				return nil
 			},
@@ -779,7 +779,7 @@ func BenchmarkDoNoErrors(b *testing.B) {
 
 func BenchmarkDoWithDataNoErrors(b *testing.B) {
 	for range b.N {
-		_, _ = DoWithData(
+		DoWithData( //nolint:errcheck // Benchmark intentionally ignores errors
 			func() (int, error) {
 				return 0, nil
 			},