From 8573fb342f44864d44377c4c48c0e2acaa26ee0c Mon Sep 17 00:00:00 2001
From: Dave Protasowski <dprotaso@gmail.com>
Date: Wed, 11 Jun 2025 09:41:42 -0400
Subject: [PATCH] add linter and fix any warnings

---
 .golangci.yaml                                | 217 ++++++++++++++++++
 pkg/apis/caching/v1alpha1/image_defaults.go   |   2 +-
 .../caching/v1alpha1/image_lifecycle_test.go  |  13 +-
 pkg/apis/caching/v1alpha1/image_types.go      |  11 +-
 pkg/apis/caching/v1alpha1/image_validation.go |   4 +-
 5 files changed, 234 insertions(+), 13 deletions(-)
 create mode 100644 .golangci.yaml

diff --git a/.golangci.yaml b/.golangci.yaml
new file mode 100644
index 000000000..16493350b
--- /dev/null
+++ b/.golangci.yaml
@@ -0,0 +1,217 @@
+version: "2"
+run:
+  build-tags:
+    - e2e
+    - hpa
+    - upgrade
+  allow-parallel-runners: true
+output:
+  sort-order:
+    - linter
+    - file
+linters:
+  enable:
+    # Check for pass []any as any in variadic func(...any).
+    - asasalint
+
+    # Only use ASCII chars in indentifiers
+    - asciicheck
+
+    # Dangerous unicode characters
+    - bidichk
+
+    # Checks whether HTTP response body is closed successfully.
+    - bodyclose
+
+    # Canonicalheader checks whether net/http.Header uses canonical header.
+    - canonicalheader
+
+    # TODO - do a follow up PR
+    # # Containedctx is a linter that detects struct contained context.Context
+    # # field.
+    # - containedctx
+    #
+    # TODO - do a follow up PR
+    # # Check whether the function uses a non-inherited context.
+    # - contextcheck
+
+    # Copyloopvar is a linter detects places where loop variables are copied.
+    - copyloopvar
+
+    # Check declaration order of types, consts, vars and funcs.
+    - decorder
+
+    # Check for two durations multiplied together.
+    - durationcheck
+
+    # Checks that sentinel errors are prefixed with the Err- and error types
+    # are suffixed with the -Error.
+    - errname
+
+    # Errorlint is a linter for that can be used to find code that will cause
+    # problems with the error wrapping scheme introduced in Go 1.13.
+    - errorlint
+
+    # Detects nested contexts in loops.
+    - fatcontext
+
+    # Checks that go compiler directive comments (//go:) are valid.
+    - gocheckcompilerdirectives
+
+    # Provides diagnostics that check for bugs, performance and style issues.
+    # Extensible without recompilation through dynamic rules.
+    # Dynamic rules are written declaratively with AST patterns, filters,
+    # report message and optional suggestion.
+    - gocritic
+
+    # See config below
+    - gomodguard
+
+    # Inspects source code for security problems.
+    - gosec
+
+    # Intrange is a linter to find places where for loops could make use of
+    # an integer range.
+    - intrange
+
+    # Checks key value pairs for common logger libraries (kitlog,klog,logr,zap).
+    - loggercheck
+
+    # Finds slice declarations with non-zero initial length.
+    - makezero
+
+    # Reports wrong mirror patterns of bytes/strings usage
+    - mirror
+
+    # Finds commonly misspelled English words.
+    - misspell
+
+    # Finds the code that returns nil even if it checks that the error is not nil.
+    - nilerr
+
+    # Finds sending HTTP request without context.Context.
+    - noctx
+
+    # Reports ill-formed or insufficient nolint directives.
+    - nolintlint
+
+    # Checks for misuse of Sprintf to construct a host with port in a URL.
+    - nosprintfhostport
+
+    # Checks that fmt.Sprintf can be replaced with a faster alternative.
+    - perfsprint
+
+    # Finds slice declarations that could potentially be pre-allocated.
+    - prealloc
+
+    # Reports direct reads from proto message fields when getters should be used.
+    - protogetter
+
+    # Checks that package variables are not reassigned.
+    - reassign
+
+    # Fast, configurable, extensible, flexible, and beautiful linter for
+    # Go. Drop-in replacement of golint.
+    - revive
+
+    # Checks for mistakes with OpenTelemetry/Census spans.
+    - spancheck
+
+    - staticcheck
+
+    # Linter checks if examples are testable (have an expected output).
+    - testableexamples
+
+    # Remove unnecessary type conversions.
+    - unconvert
+
+    # Reports unused function parameters and results in your code.
+    - unparam
+
+    # A linter that detect the possibility to use variables/constants from the
+    # Go standard library.
+    - usestdlibvars
+
+    # Finds wasted assignment statements.
+    - wastedassign
+
+    # Whitespace is a linter that checks for unnecessary newlines at the start
+    # and end of functions, if, for, etc.
+    - whitespace
+  disable:
+    - errcheck
+  settings:
+    staticcheck:
+      checks:
+      - all
+      - "-QF1008" # Disable https://staticcheck.dev/docs/checks/#QF1008
+    gocritic:
+      disabled-checks:
+        - exitAfterDefer
+        - appendAssign
+    gomodguard:
+      blocked:
+        modules:
+          - github.com/ghodss/yaml:
+              recommendations:
+                - sigs.k8s.io/yaml
+          - go.uber.org/atomic:
+              recommendations:
+                - sync/atomic
+          - io/ioutil:
+              recommendations:
+                - os
+                - io
+          - github.com/hashicorp/go-multierror:
+              recommendations:
+                - errors
+              reason: use errors.Join
+          - go.uber.org/multierr:
+              recommendations:
+                - errors
+              reason: use errors.Join
+    revive:
+      rules:
+        - name: unused-parameter
+          disabled: true
+  exclusions:
+    generated: lax
+    presets:
+      - comments
+      - common-false-positives
+      - legacy
+      - std-error-handling
+    rules:
+      - linters:
+          - staticcheck
+        text: corev1.Endpoint.* is deprecated
+      - linters:
+          - gosec
+          - noctx
+          - protogetter
+          - unparam
+        path: test
+      - linters:
+          - gocritic
+        text: ifElseChain
+    paths:
+      - pkg/client
+      - third_party$
+      - builtin$
+      - examples$
+issues:
+  max-issues-per-linter: 0
+  max-same-issues: 0
+  uniq-by-line: true
+formatters:
+  enable:
+    - gofmt
+    - gofumpt
+    - goimports
+  exclusions:
+    generated: lax
+    paths:
+      - pkg/client
+      - third_party$
+      - builtin$
+      - examples$
diff --git a/pkg/apis/caching/v1alpha1/image_defaults.go b/pkg/apis/caching/v1alpha1/image_defaults.go
index 5aa4471c4..53c2c5cc0 100644
--- a/pkg/apis/caching/v1alpha1/image_defaults.go
+++ b/pkg/apis/caching/v1alpha1/image_defaults.go
@@ -18,6 +18,6 @@ package v1alpha1
 
 import "context"
 
-func (r *Image) SetDefaults(ctx context.Context) {
+func (i *Image) SetDefaults(ctx context.Context) {
 	// TODO(mattmoor): This
 }
diff --git a/pkg/apis/caching/v1alpha1/image_lifecycle_test.go b/pkg/apis/caching/v1alpha1/image_lifecycle_test.go
index 69b30804f..92cc4f1e3 100644
--- a/pkg/apis/caching/v1alpha1/image_lifecycle_test.go
+++ b/pkg/apis/caching/v1alpha1/image_lifecycle_test.go
@@ -41,11 +41,13 @@ func TestIsReady(t *testing.T) {
 		status: ImageStatus{
 			Status: duckv1.Status{
 				ObservedGeneration: 0,
-				Conditions: duckv1.Conditions{{
-					Type:   "foo",
-					Status: corev1.ConditionTrue,
+				Conditions: duckv1.Conditions{
+					{
+						Type:   "foo",
+						Status: corev1.ConditionTrue,
+					},
 				},
-				}},
+			},
 		},
 		isReady: false,
 	}, {
@@ -155,7 +157,8 @@ func TestIsReady(t *testing.T) {
 				ObjectMeta: metav1.ObjectMeta{
 					Generation: tc.generation,
 				},
-				Status: tc.status}
+				Status: tc.status,
+			}
 			if e, a := tc.isReady, m.IsReady(); e != a {
 				t.Errorf("Ready = %v, want: %v", a, e)
 			}
diff --git a/pkg/apis/caching/v1alpha1/image_types.go b/pkg/apis/caching/v1alpha1/image_types.go
index f113b4634..6fdb57e6e 100644
--- a/pkg/apis/caching/v1alpha1/image_types.go
+++ b/pkg/apis/caching/v1alpha1/image_types.go
@@ -46,14 +46,15 @@ type Image struct {
 }
 
 // Check that Image can be validated and defaulted.
-var _ apis.Validatable = (*Image)(nil)
-var _ apis.Defaultable = (*Image)(nil)
-var _ kmeta.OwnerRefable = (*Image)(nil)
-var _ duckv1.KRShaped = (*Image)(nil)
+var (
+	_ apis.Validatable   = (*Image)(nil)
+	_ apis.Defaultable   = (*Image)(nil)
+	_ kmeta.OwnerRefable = (*Image)(nil)
+	_ duckv1.KRShaped    = (*Image)(nil)
+)
 
 // ImageSpec holds the desired state of the Image (from the client).
 type ImageSpec struct {
-
 	// Image is the name of the container image url to cache across the cluster.
 	Image string `json:"image"`
 
diff --git a/pkg/apis/caching/v1alpha1/image_validation.go b/pkg/apis/caching/v1alpha1/image_validation.go
index d43d4627e..7c27c1ba2 100644
--- a/pkg/apis/caching/v1alpha1/image_validation.go
+++ b/pkg/apis/caching/v1alpha1/image_validation.go
@@ -26,8 +26,8 @@ import (
 	"knative.dev/pkg/apis"
 )
 
-func (rt *Image) Validate(ctx context.Context) *apis.FieldError {
-	return rt.Spec.Validate(ctx).ViaField("spec")
+func (i *Image) Validate(ctx context.Context) *apis.FieldError {
+	return i.Spec.Validate(ctx).ViaField("spec")
 }
 
 func (rs *ImageSpec) Validate(ctx context.Context) (errs *apis.FieldError) {