linting

Author: Thomas Stromberg

.golangci.yml

@@ -152,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.
@@ -171,17 +171,11 @@ linters:
       rules:
         - name: add-constant
           severity: warning
-          disabled: false
-          exclude: [""]
-          arguments:
-            - max-lit-count: "5"
-              allow-strs: '"","\n","error","type","message"'
-              allow-ints: "0,1,2,3,24,30,60,100,365,0o600,0o700,0o750,0o755"
-              allow-floats: "0.0,0.,1.0,1.,2.0,2."
+          disabled: true
         - name: cognitive-complexity
-          arguments: [55]
+          disabled: true # prefer maintidx
         - name: cyclomatic
-          arguments: [60]
+          disabled: true # prefer maintidx
         - name: function-length
           arguments: [150, 225]
         - name: line-length-limit
@@ -213,8 +207,14 @@ linters:
       os-temp-dir: true
 
     varnamelen:
-      max-distance: 50
-      min-name-length: 1
+      max-distance: 75
+      min-name-length: 2
+      check-receivers: false
+      ignore-names:
+        - r
+        - w
+        - f
+        - err
 
   exclusions:
     # Default: []

Makefile

@@ -69,7 +69,7 @@ shellcheck-fix: $(SHELLCHECK_BIN)
 	$(SHELLCHECK_BIN) $(shell find . -name "*.sh") -f diff | { read -t 1 line || exit 0; { echo "$$line" && cat; } | git apply -p2; }
 
 GOLANGCI_LINT_CONFIG := $(LINT_ROOT)/.golangci.yml
-GOLANGCI_LINT_VERSION ?= v2.3.1
+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
@@ -85,10 +85,59 @@ FIXERS += golangci-lint-fix
 golangci-lint-fix: $(GOLANGCI_LINT_BIN)
 	find . -name go.mod -execdir "$(GOLANGCI_LINT_BIN)" run -c "$(GOLANGCI_LINT_CONFIG)" --fix \;
 
+YAMLLINT_VERSION ?= 1.37.1
+YAMLLINT_ROOT := $(LINT_ROOT)/out/linters/yamllint-$(YAMLLINT_VERSION)
+YAMLLINT_BIN := $(YAMLLINT_ROOT)/dist/bin/yamllint
+$(YAMLLINT_BIN):
+	mkdir -p $(LINT_ROOT)/out/linters
+	rm -rf $(LINT_ROOT)/out/linters/yamllint-*
+	curl -sSfL https://github.com/adrienverge/yamllint/archive/refs/tags/v$(YAMLLINT_VERSION).tar.gz | tar -C $(LINT_ROOT)/out/linters -zxf -
+	cd $(YAMLLINT_ROOT) && pip3 install --target dist . || pip install --target dist .
+
+LINTERS += yamllint-lint
+yamllint-lint: $(YAMLLINT_BIN)
+	PYTHONPATH=$(YAMLLINT_ROOT)/dist $(YAMLLINT_ROOT)/dist/bin/yamllint .
+
+BIOME_VERSION ?= 2.2.6
+BIOME_BIN := $(LINT_ROOT)/out/linters/biome-$(BIOME_VERSION)-$(LINT_ARCH)
+BIOME_CONFIG := $(LINT_ROOT)/biome.json
+
+# Map architecture names for Biome downloads
+BIOME_ARCH := $(LINT_ARCH)
+ifeq ($(LINT_ARCH),x86_64)
+	BIOME_ARCH := x64
+endif
+
+$(BIOME_BIN):
+	mkdir -p $(LINT_ROOT)/out/linters
+	rm -rf $(LINT_ROOT)/out/linters/biome-*
+	curl -sSfL -o $@ https://github.com/biomejs/biome/releases/download/%40biomejs%2Fbiome%40$(BIOME_VERSION)/biome-$(LINT_OS_LOWER)-$(BIOME_ARCH) \
+		|| echo "Unable to fetch biome for $(LINT_OS_LOWER)/$(BIOME_ARCH), falling back to local install"
+	test -f $@ || printf "#!/usr/bin/env biome\n" > $@
+	chmod u+x $@
+
+LINTERS += biome-lint
+biome-lint: $(BIOME_BIN)
+	$(BIOME_BIN) check --config-path=$(BIOME_CONFIG) .
+
+FIXERS += biome-fix
+biome-fix: $(BIOME_BIN)
+	$(BIOME_BIN) check --write --config-path=$(BIOME_CONFIG) .
+
 .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 .

cmd/server/main.go

@@ -87,8 +87,8 @@ func main() {
 
 	// CORS support removed - WebSocket clients should handle auth via Authorization header
 
-	h := srv.NewHub()
-	go h.Run(ctx)
+	hub := srv.NewHub()
+	go hub.Run(ctx)
 
 	// Create security components
 	rateLimiter := security.NewRateLimiter(*rateLimit, time.Minute)
@@ -117,7 +117,7 @@ func main() {
 	log.Println("Registered health check handler at /")
 
 	// Webhook handler - exact match
-	webhookHandler := webhook.NewHandler(h, webhookSecretValue, allowedEventTypes)
+	webhookHandler := webhook.NewHandler(hub, webhookSecretValue, allowedEventTypes)
 	mux.HandleFunc("/webhook", func(w http.ResponseWriter, r *http.Request) {
 		ip := security.ClientIP(r)
 		startTime := time.Now()
@@ -147,7 +147,7 @@ func main() {
 	log.Println("Registered webhook handler at /webhook")
 
 	// WebSocket handler - exact match
-	wsHandler := srv.NewWebSocketHandler(h, connLimiter, allowedEventTypes)
+	wsHandler := srv.NewWebSocketHandler(hub, connLimiter, allowedEventTypes)
 	mux.HandleFunc("/ws", func(w http.ResponseWriter, r *http.Request) {
 		startTime := time.Now()
 		ip := security.ClientIP(r)
@@ -195,7 +195,6 @@ func main() {
 
 		// Pre-validate authentication before WebSocket upgrade
 		authHeader := r.Header.Get("Authorization")
-		//nolint:nestif // Auth validation logic is necessarily complex for detailed error reporting
 		if !wsHandler.PreValidateAuth(r) {
 			// Determine specific failure reason for better debugging
 			reason := "missing"
@@ -280,7 +279,7 @@ func main() {
 		cancel()
 
 		// Stop accepting new connections
-		h.Stop()
+		hub.Stop()
 
 		// Stop the rate limiter cleanup routine
 		rateLimiter.Stop()
@@ -298,7 +297,7 @@ func main() {
 		}
 
 		// Wait for hub to finish
-		h.Wait()
+		hub.Wait()
 
 		close(done)
 	}()

pkg/client/client.go

@@ -1,5 +1,3 @@
-// Package client provides a robust WebSocket client for connecting to webhook sprinkler servers.
-// It handles automatic reconnection, ping/pong keep-alive, and comprehensive logging.
 package client
 
 import (

pkg/logger/logger.go

@@ -12,8 +12,8 @@ import (
 // Fields represents structured log fields.
 type Fields map[string]any
 
-// WithFields adds structured context to log messages.
-func WithFields(fields Fields, format string, args ...any) {
+// WithFieldsf adds structured context to log messages with printf-style formatting.
+func WithFieldsf(fields Fields, format string, args ...any) {
 	// Sort keys for consistent output
 	keys := make([]string, 0, len(fields))
 	for k := range fields {
@@ -36,7 +36,7 @@ func WithFields(fields Fields, format string, args ...any) {
 
 // Info logs an info message with optional fields.
 func Info(msg string, fields Fields) {
-	WithFields(fields, "%s", msg)
+	WithFieldsf(fields, "%s", msg)
 }
 
 // Error logs an error message with optional fields.
@@ -45,10 +45,10 @@ func Error(msg string, err error, fields Fields) {
 		fields = Fields{}
 	}
 	fields["error"] = err.Error()
-	WithFields(fields, "ERROR: %s", msg)
+	WithFieldsf(fields, "ERROR: %s", msg)
 }
 
 // Warn logs a warning message with optional fields.
 func Warn(msg string, fields Fields) {
-	WithFields(fields, "WARNING: %s", msg)
+	WithFieldsf(fields, "WARNING: %s", msg)
 }

pkg/logger/logger_test.go

@@ -126,7 +126,7 @@ func TestFieldsWithSpecialCharacters(t *testing.T) {
 
 	fields := Fields{
 		"path":  "/etc/passwd",
-		"query": "SELECT * FROM users",
+		"query": "SELECT id, name FROM users",
 		"url":   "https://example.com?foo=bar&baz=qux",
 	}
 
@@ -136,7 +136,7 @@ func TestFieldsWithSpecialCharacters(t *testing.T) {
 	if !strings.Contains(output, "path=/etc/passwd") {
 		t.Error("path field not preserved correctly")
 	}
-	if !strings.Contains(output, "query=SELECT * FROM users") {
+	if !strings.Contains(output, "query=SELECT id, name FROM users") {
 		t.Error("query field not preserved correctly")
 	}
 	if !strings.Contains(output, "url=https://example.com?foo=bar&baz=qux") {
@@ -166,14 +166,14 @@ func TestFieldsWithNilValues(t *testing.T) {
 	}
 }
 
-// TestWithFieldsFormatting tests the WithFields function with format strings
+// TestWithFieldsFormatting tests the WithFieldsf function with format strings
 func TestWithFieldsFormatting(t *testing.T) {
 	var buf bytes.Buffer
 	log.SetOutput(&buf)
 	defer log.SetOutput(nil)
 
 	fields := Fields{"user": "alice"}
-	WithFields(fields, "User %s logged in at %d", "bob", 12345)
+	WithFieldsf(fields, "User %s logged in at %d", "bob", 12345)
 
 	output := buf.String()
 	if !strings.Contains(output, "User bob logged in at 12345") {

pkg/srv/subscription.go

@@ -89,7 +89,7 @@ func (s *Subscription) Validate() error {
 
 			// Basic validation - should be a GitHub PR URL
 			// Format: https://github.com/owner/repo/pull/number
-			if !strings.HasPrefix(prURL, "https://github.com/") && !strings.HasPrefix(prURL, "http://github.com/") {
+			if !strings.HasPrefix(prURL, "https://github.com/") {
 				return errors.New("invalid PR URL format")
 			}