🌱chore: Add golangci-lint linters (#1134)

* add golangci linters

Signed-off-by: dongjiang <[email protected]>

* sync golangci linter from controller-runtime

Signed-off-by: dongjiang <[email protected]>

* Update cmd/controller-gen/main.go

Co-authored-by: Stefan Büringer <[email protected]>

* fix asasalint linter

Signed-off-by: dongjiang <[email protected]>

---------

Signed-off-by: dongjiang <[email protected]>
Co-authored-by: Stefan Büringer <[email protected]>

Author: dongjiang1989

.golangci.yml

@@ -1,25 +1,113 @@
 run:
+  allow-parallel-runners: true
   modules-download-mode: readonly
   # Increase the default deadline from 1m as some module operations can take a
   # while if uncached!
   timeout: 10m
+  go: "1.23"
 
 linters:
+  # sync from https://github.com/kubernetes-sigs/controller-runtime/blob/main/.golangci.yml
+  disable-all: true
   enable:
-  - errcheck
-  - gosimple
-  - govet
-  - ineffassign
-  - staticcheck
-  - unused
-  - testifylint
-  - iface
-  - exptostd
-  - nilnesserr
+    - asasalint
+    - asciicheck
+    - bidichk
+    - bodyclose
+    - copyloopvar
+    - dogsled
+    - dupl
+    - errcheck
+    - errchkjson
+    - errorlint
+    - exhaustive
+    - ginkgolinter
+    - goconst
+    - gocritic
+    - gocyclo
+    - gofmt
+    - goimports
+    - goprintffuncname
+    - gosimple
+    - govet
+    - importas
+    - ineffassign
+    - makezero
+    - misspell
+    - nakedret
+    - nilerr
+    - nolintlint
+    - prealloc
+    - revive
+    - staticcheck
+    - stylecheck
+    - tagliatelle
+    - typecheck
+    - unconvert
+    - unparam
+    - unused
+    - whitespace
 
 issues:
   exclude-rules:
     # Dot imports for gomega and ginkgo are allowed
     # within test files.
   - path: _test\.go
     text: should not use dot imports
+    # Ignore error type switch case
+  - path: "pkg/loader/loader.go"
+    linters:
+      - errorlint
+    # Ignore test files
+  - linters:
+      - dupl
+      - ginkgolinter
+    path: _test\.go
+  - linters:
+      - gocritic
+    path: "pkg/markers/help.go"
+  - linters:
+      - exhaustive
+    path: "pkg/markers/parse.go|pkg/deepcopy/traverse.go|pkg/genall/help/types.go|pkg/crd/schema.go|pkg/crd/flatten.go"
+    # Ignore consider pre-allocating variables
+  - linters:
+      - prealloc
+    text: Consider pre-allocating
+linters-settings:
+  govet:
+    enable-all: true
+    disable:
+      - fieldalignment
+      - shadow
+  importas:
+    no-unaliased: true
+  revive:
+    # By default, revive will enable only the linting rules that are named in the configuration file.
+    # So, it's needed to explicitly enable all required rules here.
+    rules:
+      # The following rules are recommended https://github.com/mgechev/revive#recommended-configuration
+      - name: blank-imports
+      - name: context-as-argument
+      - name: context-keys-type
+      - name: dot-imports
+      - name: error-return
+      - name: error-strings
+      - name: error-naming
+      - name: if-return
+      - name: increment-decrement
+      - name: var-naming
+      - name: var-declaration
+      - name: range
+      - name: receiver-naming
+      - name: time-naming
+      - name: unexported-return
+      - name: indent-error-flow
+      - name: errorf
+      - name: superfluous-else
+      - name: unreachable-code
+      - name: redefines-builtin-id
+      #
+      # Rules in addition to the recommended configuration above.
+      #
+      - name: bool-literal-in-expr
+      - name: constant-logical-expr

cmd/controller-gen/main.go

@@ -17,13 +17,13 @@ package main
 
 import (
 	"encoding/json"
+	"errors"
 	"fmt"
 	"io"
 	"os"
 	"strings"
 
 	"github.com/spf13/cobra"
-
 	"sigs.k8s.io/controller-tools/pkg/crd"
 	"sigs.k8s.io/controller-tools/pkg/deepcopy"
 	"sigs.k8s.io/controller-tools/pkg/genall"
@@ -198,7 +198,8 @@ func main() {
 	})
 
 	if err := cmd.Execute(); err != nil {
-		if _, noUsage := err.(noUsageError); !noUsage {
+		var errNoUsage noUsageError
+		if !errors.As(err, &errNoUsage) {
 			// print the usage unless we suppressed it
 			if err := cmd.Usage(); err != nil {
 				panic(err)

pkg/crd/desc_visitor.go

@@ -73,7 +73,7 @@ func truncateString(desc string, maxLen int) string {
 
 	// Trying to chop off at closest word boundary (i.e. whitespace).
 	if n := strings.LastIndexFunc(desc, isWhiteSpace); n > 0 {
-		return desc[0 : n] + "..."
+		return desc[0:n] + "..."
 	}
 
 	return desc[0:maxLen] + "..."

pkg/crd/desc_visitor_test.go

@@ -19,9 +19,7 @@ package crd_test
 import (
 	. "github.com/onsi/ginkgo"
 	. "github.com/onsi/gomega"
-
 	apiext "k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1"
-
 	"sigs.k8s.io/controller-tools/pkg/crd"
 )
 

pkg/crd/flatten.go

@@ -24,7 +24,6 @@ import (
 	"sync"
 
 	apiext "k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1"
-
 	"sigs.k8s.io/controller-tools/pkg/loader"
 )
 
@@ -295,8 +294,8 @@ func RefParts(ref string) (typ string, pkgName string, err error) {
 	}
 	ref = ref[len(defPrefix):]
 	// decode the json pointer encodings
-	ref = strings.Replace(ref, "~1", "/", -1)
-	ref = strings.Replace(ref, "~0", "~", -1)
+	ref = strings.ReplaceAll(ref, "~1", "/")
+	ref = strings.ReplaceAll(ref, "~0", "~")
 	nameParts := strings.SplitN(ref, "~", 2)
 
 	if len(nameParts) == 1 {

pkg/crd/flatten_all_of_test.go

@@ -21,7 +21,6 @@ import (
 	. "github.com/onsi/gomega"
 	. "github.com/onsi/gomega/gstruct"
 	apiext "k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1"
-
 	"sigs.k8s.io/controller-tools/pkg/crd"
 )
 

pkg/crd/flatten_type_test.go

@@ -21,9 +21,8 @@ import (
 
 	. "github.com/onsi/ginkgo"
 	. "github.com/onsi/gomega"
-	apiext "k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1"
-
 	"golang.org/x/tools/go/packages"
+	apiext "k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1"
 	"sigs.k8s.io/controller-tools/pkg/crd"
 	"sigs.k8s.io/controller-tools/pkg/loader"
 )

pkg/crd/gen.go

@@ -25,7 +25,6 @@ import (
 
 	apiext "k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1"
 	"k8s.io/apimachinery/pkg/runtime/schema"
-
 	crdmarkers "sigs.k8s.io/controller-tools/pkg/crd/markers"
 	"sigs.k8s.io/controller-tools/pkg/genall"
 	"sigs.k8s.io/controller-tools/pkg/loader"

pkg/crd/gen_integration_test.go

@@ -25,7 +25,6 @@ import (
 	"github.com/google/go-cmp/cmp"
 	. "github.com/onsi/ginkgo"
 	. "github.com/onsi/gomega"
-
 	"sigs.k8s.io/controller-tools/pkg/crd"
 	crdmarkers "sigs.k8s.io/controller-tools/pkg/crd/markers"
 	"sigs.k8s.io/controller-tools/pkg/genall"
@@ -159,10 +158,10 @@ var _ = Describe("CRD Generation proper defaulting", func() {
 
 	It("should truncate CRD descriptions", func() {
 		By("calling Generate")
-		var fifty int = 50
+		fifty := 50
 		gen := &crd.Generator{
 			CRDVersions: []string{"v1"},
-			MaxDescLen: &fifty,
+			MaxDescLen:  &fifty,
 		}
 		Expect(gen.Generate(ctx)).NotTo(HaveOccurred())
 

pkg/crd/known_types.go

@@ -18,7 +18,6 @@ package crd
 import (
 	apiext "k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1"
 	"k8s.io/utils/ptr"
-
 	"sigs.k8s.io/controller-tools/pkg/loader"
 )