Exclude types defined in generated files; update go version; make basic check the default; refactor

Signed-off-by: Oliver Eikemeier <[email protected]>

Author: eikemeier

.github/workflows/test.yml

@@ -9,7 +9,7 @@ name: Test
       - main
 jobs:
   test:
-    name: Test on Go ${{ matrix.go-version }}
+    name: Test on Go ${{ matrix.go }}
     permissions:
       checks: write
       contents: read
@@ -18,29 +18,34 @@ jobs:
     runs-on: ubuntu-24.04
     strategy:
       matrix:
-        go-version: ["1.24.0-rc.3", "1.23.6", "1.22.12"]
+        go: ["1.24", "1.23"]
         include:
-          - go-version: "1.23.6"
+          - go: "1.24"
+            go-version: "1.24.2"
             update-coverage: true
+          - go: "1.23"
+            go-version: "1.23.8"
     env:
       GOTOOLCHAIN: local
     steps:
       - name: ✔ Check out
-        uses: actions/checkout@v4
+        uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683  # v4.2.2
       - name: 🐹 Set up Go ${{ matrix.go-version }}
-        uses: actions/setup-go@v5
+        uses: actions/setup-go@0aaccfd150d50ccaeb58ebd88d36e91967a5f35b  # v5.4.0
         with:
           go-version: ${{ matrix.go-version }}
       - name: 🧸 golangci-lint
-        uses: golangci/golangci-lint-action@v6
+        uses: golangci/golangci-lint-action@1481404843c368bc19ca9406f87d6e0fc97bdcfd  # v7.0.0
         with:
-          version: v1.63.4
+          version: v2.0.2
       - name: 🔨 Test
         run: |
-          go get -C ./pkg/analyzer/testdata golang.org/x/exp/errors
+          (cd ./pkg/internal/visitor/testdata && go mod download)
           go test -coverprofile=cover.out ./...
+        env:
+          GOEXPERIMENT: aliastypeparams
       - name: 🧑🏻‍💻 codecov
-        uses: codecov/codecov-action@v5
+        uses: codecov/codecov-action@0565863a31f2c772f9f0395002a31e3f06189574  # v5.4.0
         if: ${{ matrix.update-coverage }}
         with:
           files: ./cover.out

.golangci.yaml

@@ -1,12 +1,19 @@
 ---
+version: "2"
+
 run:
   modules-download-mode: readonly
+
+formatters:
+  enable:
+    - gofumpt
+  settings:
+    gofumpt:
+      module-path: fillmore-labs.com/zerolint
+
 linters:
-  enable-all: true
+  default: all
   disable:
-    # deprecated
-    - exportloopref
-    # disabled
     - depguard
     - dupl
     - exhaustruct
@@ -15,41 +22,70 @@ linters:
     - varnamelen
     - wrapcheck
     - wsl
-linters-settings:
-  govet:
-    enable-all: true
-    disable:
-      - fieldalignment
-    settings:
-      shadow:
-        strict: true
-  testifylint:
-    enable-all: true
-    disable:
-      - require-error
-  ireturn:
-    allow:
-      - anon
-      - error
-      - empty
-      - stdlib
-      - generic
-  predeclared:
-    ignore: "new"
-issues:
-  exclude-rules:
-    - path: _test\.go$
-      linters:
-        - revive
-      text: "dot-imports"
-    - path: _test\.go$
-      linters:
-        - govet
-      text: "lostcancel"
-    - path: ^main\.go$
-      linters:
-        - gocheckcompilerdirectives
-      text: "go:debug"
-    - linters:
-        - govet
-      text: '^shadow: declaration of "(ctx|err|ok)" shadows declaration at line \d+$'
+  settings:
+    errcheck:
+      exclude-functions:
+        - (io/fs.File).Close
+    govet:
+      enable-all: true
+      disable:
+        - fieldalignment
+      settings:
+        shadow:
+          strict: true
+    testifylint:
+      enable-all: true
+      disable:
+        - require-error
+    ireturn:
+      allow:
+        - anon
+        - error
+        - empty
+        - stdlib
+        - generic
+    predeclared:
+      ignore: ["new"]
+    revive:
+      rules:
+        - name: atomic
+        - name: blank-imports
+        - name: context-as-argument
+        - name: context-keys-type
+        - name: dot-imports
+          exclude: ["TEST"]
+        - name: early-return
+        - name: error-return
+        - name: error-strings
+        - name: error-naming
+        - name: exported
+        - 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: empty-block
+        - name: superfluous-else
+        - name: unused-parameter
+        - name: unreachable-code
+        - name: redefines-builtin-id
+        - name: file-header
+          arguments:
+            - "Copyright 2024 Oliver Eikemeier. All Rights Reserved."
+  exclusions:
+    rules:
+      - path: _test\.go$
+        linters:
+          - govet
+        text: "lostcancel"
+      - path: ^main\.go$
+        linters:
+          - gocheckcompilerdirectives
+        text: "go:debug"
+      - linters:
+          - govet
+        text: '^shadow: declaration of "(ctx|err|ok)" shadows declaration at line \d+$'

README.md

@@ -20,7 +20,8 @@ Usage: `zerolint [-flag] [package]`
 Flags:
 
 - **-c** int display offending line with this many lines of context (default -1)
-- **-basic** basic analysis only
+- **-full** full analysis
 - **-excluded** `<filename>` read excluded types from this file
 - **-zerotrace** trace found zero-sized types
 - **-fix** apply all suggested fixes
+- **-generated** analyze generated files and types defined in generated files

go.mod

@@ -1,12 +1,12 @@
 module fillmore-labs.com/zerolint
 
-go 1.22.0
+go 1.23.0
 
-toolchain go1.23.6
+toolchain go1.24.2
 
-require golang.org/x/tools v0.29.0
+require golang.org/x/tools v0.31.0
 
 require (
-	golang.org/x/mod v0.23.0 // indirect
-	golang.org/x/sync v0.11.0 // indirect
+	golang.org/x/mod v0.24.0 // indirect
+	golang.org/x/sync v0.13.0 // indirect
 )

go.sum

@@ -1,8 +1,8 @@
 github.com/google/go-cmp v0.6.0 h1:ofyhxvXcZhMsU5ulbFiLKl/XBFqE1GSq7atu8tAmTRI=
 github.com/google/go-cmp v0.6.0/go.mod h1:17dUlkBOakJ0+DkrSSNjCkIjxS6bF9zb3elmeNGIjoY=
-golang.org/x/mod v0.23.0 h1:Zb7khfcRGKk+kqfxFaP5tZqCnDZMjC5VtUBs87Hr6QM=
-golang.org/x/mod v0.23.0/go.mod h1:6SkKJ3Xj0I0BrPOZoBy3bdMptDDU9oJrpohJ3eWZ1fY=
-golang.org/x/sync v0.11.0 h1:GGz8+XQP4FvTTrjZPzNKTMFtSXH80RAzG+5ghFPgK9w=
-golang.org/x/sync v0.11.0/go.mod h1:Czt+wKu1gCyEFDUtn0jG5QVvpJ6rzVqr5aXyt9drQfk=
-golang.org/x/tools v0.29.0 h1:Xx0h3TtM9rzQpQuR4dKLrdglAmCEN5Oi+P74JdhdzXE=
-golang.org/x/tools v0.29.0/go.mod h1:KMQVMRsVxU6nHCFXrBPhDB8XncLNLM0lIy/F14RP588=
+golang.org/x/mod v0.24.0 h1:ZfthKaKaT4NrhGVZHO1/WDTwGES4De8KtWO0SIbNJMU=
+golang.org/x/mod v0.24.0/go.mod h1:IXM97Txy2VM4PJ3gI61r1YEk/gAj6zAHN3AdZt6S9Ww=
+golang.org/x/sync v0.13.0 h1:AauUjRAJ9OSnvULf/ARrrVywoJDy0YS2AwQ98I37610=
+golang.org/x/sync v0.13.0/go.mod h1:1dzgHSNfp02xaA81J2MS99Qcpr2w7fw1gpm99rleRqA=
+golang.org/x/tools v0.31.0 h1:0EedkvKDbh+qistFTd0Bcwe/YLh4vHwWEkiI0toFIBU=
+golang.org/x/tools v0.31.0/go.mod h1:naFTU+Cev749tSJRXJlna0T3WxKvb1kWEx15xA4SdmQ=

main.go

@@ -14,8 +14,6 @@
 //
 // SPDX-License-Identifier: Apache-2.0
 
-//go:debug gotypesalias=1
-
 // This is the main program for the zerolint linter.
 package main
 

pkg/analyzer/analyzer.go

@@ -14,6 +14,7 @@
 //
 // SPDX-License-Identifier: Apache-2.0
 
+//nolint:gochecknoglobals
 package analyzer
 
 import (
@@ -22,6 +23,7 @@ import (
 	"golang.org/x/tools/go/analysis/passes/inspect"
 )
 
+// Documentation constants.
 const (
 	Name = "zerolint"
 	Doc  = `checks for usage of pointers to zero-length variables
@@ -30,35 +32,36 @@ Pointer to zero-length variables carry very little information and
 can often be avoided.`
 )
 
-var Analyzer = &analysis.Analyzer{ //nolint:gochecknoglobals
+// Analyzer checks for usage of pointers to zero-length variables.
+var Analyzer = &analysis.Analyzer{
 	Name:     Name,
 	Doc:      Doc,
 	URL:      "https://pkg.go.dev/fillmore-labs.com/zerolint/pkg/analyzer",
 	Run:      run,
 	Requires: []*analysis.Analyzer{inspect.Analyzer},
 }
 
-func init() { //nolint:gochecknoinits
-	Analyzer.Flags.StringVar(&Excludes, "excluded", "", "read excluded types from this file")
-	Analyzer.Flags.BoolVar(&ZeroTrace, "zerotrace", false, "trace found zero-sized types")
-	Analyzer.Flags.BoolVar(&Basic, "basic", false, "basic analysis only")
-	Analyzer.Flags.BoolVar(&Generated, "generated", false, "check generated files")
-}
-
 var (
-	// Excludes is a list of types to exclude from the analysis.
-	Excludes string //nolint:gochecknoglobals
+	// Excludes is a file containing a list of types to exclude from the analysis.
+	Excludes string
 
 	// ZeroTrace enables tracing of found zero-sized types.
-	ZeroTrace bool //nolint:gochecknoglobals
+	ZeroTrace bool
 
-	// Basic enables basic analysis only.
-	Basic bool //nolint:gochecknoglobals
+	// Full enables full analysis, which should be handles manually.
+	Full bool
 
 	// Generated enables checking generated files.
-	Generated bool //nolint:gochecknoglobals
+	Generated bool
 )
 
+func init() { //nolint:gochecknoinits
+	Analyzer.Flags.StringVar(&Excludes, "excluded", "", "read excluded types from this file")
+	Analyzer.Flags.BoolVar(&ZeroTrace, "zerotrace", false, "trace found zero-sized types")
+	Analyzer.Flags.BoolVar(&Full, "full", false, "full analysis")
+	Analyzer.Flags.BoolVar(&Generated, "generated", false, "check generated files")
+}
+
 // run applies the analyzer to a package.
 func run(pass *analysis.Pass) (any, error) {
 	// Read the list of excluded types from the file specified by the "excluded" flag.
@@ -70,7 +73,7 @@ func run(pass *analysis.Pass) (any, error) {
 	return NewRun(
 		WithExcludes(ex),
 		WithZeroTrace(ZeroTrace),
-		WithBasic(Basic),
+		WithFull(Full),
 		WithGenerated(Generated),
 	)(pass)
 }

pkg/analyzer/analyzer_test.go

@@ -23,22 +23,27 @@ import (
 	"golang.org/x/tools/go/analysis/analysistest"
 )
 
-func TestAnalyzer(t *testing.T) { //nolint:paralleltest
-	dir := analysistest.TestData()
-	a := analyzer.Analyzer
-
-	analyzer.Basic = false
-	analyzer.Excludes = dir + "/excluded.txt"
+func TestAnalyzer(t *testing.T) { //nolint:tparallel
+	t.Parallel()
 
-	analysistest.RunWithSuggestedFixes(t, dir, a, "go.test/a")
-}
-
-func TestAnalyzerBasic(t *testing.T) { //nolint:paralleltest
 	dir := analysistest.TestData()
-	a := analyzer.Analyzer
-
-	analyzer.Basic = true
-	analyzer.Excludes = ""
 
-	analysistest.RunWithSuggestedFixes(t, dir, a, "go.test/basic")
+	type args struct {
+		excludes string
+	}
+	tests := []struct {
+		name string
+		args args
+	}{
+		{"basic", args{dir + "/excluded.txt"}},
+	}
+
+	for _, tt := range tests { //nolint:paralleltest
+		a := analyzer.Analyzer
+		analyzer.Excludes = tt.args.excludes
+
+		t.Run(tt.name, func(t *testing.T) {
+			analysistest.Run(t, dir, a, "go.test/basic")
+		})
+	}
 }

pkg/analyzer/osfs.go

@@ -26,5 +26,5 @@ type osFS struct{}
 var _ fs.FS = osFS{}
 
 func (osFS) Open(name string) (fs.File, error) {
-	return os.Open(name)
+	return os.Open(name) //nolint:gosec
 }