lint

Author: pascal-blokur

.golangci.yml

@@ -1,159 +1,112 @@
-linters-settings:
-  funlen:
-    lines: 100
-    statements: 50
-
-  cyclop:
-    skip-tests: true
-    max-complexity: 30
-    package-average: 5
-
-  gocyclo:
-    min-complexity: 15
-
-  goconst:
-    min-len: 2
-    min-occurrences: 3
-
-  gocritic:
-    enable-all: true
-
-  godot:
-    capital: true
-
-  gosimple:
-    checks: [ "all" ]
-
-  govet:
-    settings:
-      printf:
-        funcs:
-          - (github.com/golangci/golangci-lint/pkg/logutils.Log).Infof
-          - (github.com/golangci/golangci-lint/pkg/logutils.Log).Warnf
-          - (github.com/golangci/golangci-lint/pkg/logutils.Log).Errorf
-          - (github.com/golangci/golangci-lint/pkg/logutils.Log).Fatalf
-    disable-all: true
-    enable:
-      - assign
-      - atomic
-      - atomicalign
-      - bools
-      - buildtag
-      - cgocall
-      - composites
-      - copylocks
-      - deepequalerrors
-      - errorsas
-      - fieldalignment
-      - findcall
-      - framepointer
-      - httpresponse
-      - ifaceassert
-      - loopclosure
-      - lostcancel
-      - nilfunc
-      - printf
-      - reflectvaluecompare
-      - shift
-      - sigchanyzer
-      - sortslice
-      - stdmethods
-      - stringintconv
-      - structtag
-      - testinggoroutine
-      - tests
-      - unmarshal
-      - unreachable
-      - unsafeptr
-      - unusedresult
-
-  misspell:
-    locale: UK
-
-  staticcheck:
-    checks: [ "all" ]
-
-  stylecheck:
-    checks: [ "all" ]
-
-  unparam:
-    check-exported: true
-
-  wrapcheck:
-    ignoreSigs:
-      - .Errorf(
-      - errors.New(
-      - errors.Unwrap(
-      - errors.Join(
-      - .Wrap(
-      - .Wrapf(
-      - .WithMessage(
-      - .WithMessagef(
-      - .WithStack(
-      - (context.Context).Err()
-
-  nlreturn:
-    block-size: 2
-
-issues:
-  # Excluding configuration per-path, per-linter, per-text and per-source
-  exclude-rules:
-    - path: _test\.go
-      linters:
-        - contextcheck
-        - dupl
-        - errcheck
-        - funlen
-        - gochecknoinits
-        - goconst
-        - gocritic
-        - gosec
-        - govet
-        - lll
-        - nlreturn
-        - nosprintfhostport
-        - revive
-        - testifylint
-        - unparam
-        - wrapcheck
-    - path: mocks
-      linters:
-        - lll
-        - revive
-        - stylecheck
-    - path: docs.go
-      linters:
-        - dupword
-  exclude-dirs:
-    - model
-    - tmp
-    - bin
-    - scripts
-  fix: true
-  exclude-use-default: false
-
+version: "2"
 run:
-  timeout: 5m
-  allow-parallel-runners: true
-  tests: true
   build-tags:
     - integration
-
+  tests: true
+  allow-parallel-runners: true
 linters:
-  enable-all: true
+  default: all
   disable:
-    - containedctx # We need to use internal contexts.
-    - depguard # because I don't want to write a dedicated config file.
-    - err113 # We do not like its style.
-    - exhaustive # Is very strict.
-    - exhaustruct # I want to use zero values... and sometime leave a field uninitialised, because it'll be later.
-    - gochecknoglobals # We rely on globals.
-    - ireturn # We need to use them in logs.
-    - nlreturn
-    - gomnd # We have magic numbers.
-    - mnd # Same as gomnd.
-    - nolintlint # Sometimes we want to disable linters in specific places.
-    - nonamedreturns # Conflicts with paramTypeCombine.
-    - paralleltest # Full of false-positives.
-    - varnamelen # Very strict.
-    - wsl # Too restrictive for this project (maybe in the future).
+    - depguard # As much as I would like to use this, it is completely unmanageable.
+    - exhaustruct # This lib is usually pointless.
+  settings:
+    cyclop:
+      max-complexity: 30
+      package-average: 5
+    funlen:
+      lines: 100
+      statements: 50
+    settings:
+      gci:
+        sections:
+          - standard
+          - default
+          - prefix(github.com/blokur)
+          - localmodule
+    goconst:
+      min-len: 2
+      min-occurrences: 3
+    gocritic:
+      enable-all: true
+    gocyclo:
+      min-complexity: 15
+    godot:
+      capital: true
+    govet:
+      settings:
+        printf:
+          funcs:
+            - (github.com/golangci/golangci-lint/pkg/logutils.Log).Infof
+            - (github.com/golangci/golangci-lint/pkg/logutils.Log).Warnf
+            - (github.com/golangci/golangci-lint/pkg/logutils.Log).Errorf
+            - (github.com/golangci/golangci-lint/pkg/logutils.Log).Fatalf
+    misspell:
+      locale: UK
+    nlreturn:
+      block-size: 2
+    staticcheck:
+      checks:
+        - all
+    unparam:
+      check-exported: true
+    wrapcheck:
+      ignore-sigs:
+        - .Errorf(
+        - errors.New(
+        - errors.Unwrap(
+        - errors.Join(
+        - .Wrap(
+        - .Wrapf(
+        - .WithMessage(
+        - .WithMessagef(
+        - .WithStack(
+        - (context.Context).Err()
+  exclusions:
+    generated: lax
+    rules:
+      - linters:
+          - err113
+          - errcheck
+          - gochecknoinits # I'm OK with inits for tests.
+          - gocritic # Some of these are actually correct and should not be ignored / changed.
+          - gosec # Some errors I tried to fix, others (such as forcing crypto/rand) make no sense.
+          - testifylint # I tried to remove a few of them.
+          - wrapcheck
+        path: _test\.go
+      - linters:
+          - lll
+          - revive
+          - staticcheck
+        path: mocks
+      - linters:
+          - dupword
+        path: docs.go
+      - linters:
+          - cyclop
+        path: (.+)_test\.go
+    paths:
+      - model
+      - tmp
+      - bin
+      - scripts
+      - third_party$
+      - builtin$
+      - examples$
+issues:
+  fix: false
+formatters:
+  enable:
+    - gci
+    - gofmt
+    - gofumpt
+    - goimports
+  exclusions:
+    generated: lax
+    paths:
+      - model
+      - tmp
+      - bin
+      - scripts
+      - third_party$
+      - builtin$
+      - examples$

config.go

@@ -2,7 +2,6 @@ package harego
 
 import (
 	"context"
-	"errors"
 	"fmt"
 	"time"
 
@@ -20,6 +19,8 @@ type rabbitWrapper struct {
 }
 
 // Channel returns the underlying channel.
+//
+//nolint:ireturn // This is a wrapper around connection.Channel
 func (r *rabbitWrapper) Channel() (Channel, error) {
 	return r.Connection.Channel() //nolint:wrapcheck // Okay here.
 }
@@ -35,28 +36,29 @@ func URLConnector(url string) Connector {
 		if err != nil {
 			return nil, fmt.Errorf("creating a connection to %q: %w", url, err)
 		}
+
 		return &rabbitWrapper{conn}, nil
 	}
 }
 
-// AMQPConnector uses r everytime the Client needs a new connection. You should
-// make sure r keep being alive.
-func AMQPConnector(r *amqp.Connection) Connector {
+// AMQPConnector uses the amqp connection everytime the Client needs a new connection. You should
+// make sure it is kept alive.
+func AMQPConnector(amqpConn *amqp.Connection) Connector {
 	return func() (RabbitMQ, error) {
-		if r.IsClosed() {
-			return nil, errors.New("connection is closed")
+		if amqpConn.IsClosed() {
+			return nil, fmt.Errorf("connection is closed: %w", amqp.ErrClosed)
 		}
-		return &rabbitWrapper{r}, nil
+
+		return &rabbitWrapper{amqpConn}, nil
 	}
 }
 
-// nolint:govet // most likely not an issue, but cleaner this way.
 type config struct {
 	workers      int
 	consumerName string
 	retryDelay   time.Duration
 	logger       logr.Logger
-	ctx          context.Context
+	ctx          context.Context //nolint:containedctx // Helps us know when the parent is shut down.
 
 	global bool
 
@@ -85,15 +87,20 @@ type config struct {
 }
 
 func defaultConfig() *config {
+	const (
+		defaultChannelBufferSize = 10
+		defaultRetryDelay        = 100 * time.Millisecond
+	)
+
 	return &config{
 		exchName:     "default",
 		workers:      1,
-		chBuff:       10,
+		chBuff:       defaultChannelBufferSize,
 		exchType:     ExchangeTypeTopic,
 		deliveryMode: DeliveryModePersistent,
 		durable:      true,
 		consumerName: internal.GetRandomName(),
-		retryDelay:   100 * time.Millisecond,
+		retryDelay:   defaultRetryDelay,
 		logger:       logr.Discard(),
 		ctx:          context.Background(),
 	}

constants.go

@@ -59,7 +59,7 @@ func (e ExchangeType) IsValid() bool {
 }
 
 func (e ExchangeType) String() string {
-	switch e {
+	switch e { //nolint:exhaustive // I don't want to panic here.
 	case ExchangeTypeDirect:
 		return "direct"
 	case ExchangeTypeFanout:
@@ -69,6 +69,7 @@ func (e ExchangeType) String() string {
 	case ExchangeTypeHeaders:
 		return "headers"
 	}
+
 	return ""
 }