add linter zerologlint (#3726)

Co-authored-by: Fernandez Ludovic <[email protected]>

.golangci.reference.yml

@@ -2173,6 +2173,7 @@ linters:
     - whitespace
     - wrapcheck
     - wsl
+    - zerologlint
 
   # Enable all available linters.
   # Default: false
@@ -2285,6 +2286,7 @@ linters:
     - whitespace
     - wrapcheck
     - wsl
+    - zerologlint
 
   # Enable presets.
   # https://golangci-lint.run/usage/linters

go.mod

@@ -111,6 +111,7 @@ require (
 	github.com/xen0n/gosmopolitan v1.2.1
 	github.com/yagipy/maintidx v1.0.0
 	github.com/yeya24/promlinter v0.2.0
+	github.com/ykadowak/zerologlint v0.1.1
 	gitlab.com/bosi/decorder v0.2.3
 	golang.org/x/tools v0.8.0
 	gopkg.in/yaml.v3 v3.0.1

pkg/golinters/zerologlint.go

@@ -0,0 +1,17 @@
+package golinters
+
+import (
+	"github.com/ykadowak/zerologlint"
+	"golang.org/x/tools/go/analysis"
+
+	"github.com/golangci/golangci-lint/pkg/golinters/goanalysis"
+)
+
+func NewZerologLint() *goanalysis.Linter {
+	return goanalysis.NewLinter(
+		"zerologlint",
+		"Detects the wrong usage of `zerolog` that a user forgets to dispatch with `Send` or `Msg`.",
+		[]*analysis.Analyzer{zerologlint.Analyzer},
+		nil,
+	).WithLoadMode(goanalysis.LoadModeTypesInfo)
+}

pkg/lint/lintersdb/manager.go

@@ -890,6 +890,12 @@ func (m Manager) GetAllSupportedLinterConfigs() []*linter.Config {
 			WithSince("v1.26.0").
 			WithPresets(linter.PresetStyle).
 			WithURL("https://github.com/golangci/golangci-lint/blob/master/pkg/golinters/nolintlint/README.md"),
+
+		linter.NewConfig(golinters.NewZerologLint()).
+			WithSince("v1.53.0").
+			WithPresets(linter.PresetBugs).
+			WithLoadForGoAnalysis().
+			WithURL("https://github.com/ykadowak/zerologlint"),
 	}
 
 	enabledByDefault := map[string]bool{

test/linters_test.go

@@ -31,6 +31,7 @@ func TestSourcesFromTestdataSubDir(t *testing.T) {
 	subDirs := []string{
 		"loggercheck",
 		"ginkgolinter",
+		"zerologlint",
 	}
 
 	for _, dir := range subDirs {

test/testdata/zerologlint/go.mod

@@ -0,0 +1,14 @@
+module zerologlint
+
+go 1.19
+
+require (
+	github.com/rs/zerolog v1.29.1
+	golang.org/x/exp v0.0.0-20230321023759-10a507213a29
+)
+
+require (
+	github.com/mattn/go-colorable v0.1.13 // indirect
+	github.com/mattn/go-isatty v0.0.18 // indirect
+	golang.org/x/sys v0.7.0 // indirect
+)

test/testdata/zerologlint/zerologlint.go

@@ -0,0 +1,77 @@
+//golangcitest:args -Ezerologlint
+package zerologlint
+
+import (
+	"fmt"
+
+	"github.com/rs/zerolog"
+	"github.com/rs/zerolog/log"
+	"golang.org/x/exp/slices"
+)
+
+func expectWarnings() {
+	log.Error() // want "must be dispatched by Msg or Send method"
+	log.Info()  // want "must be dispatched by Msg or Send method"
+	log.Fatal() // want "must be dispatched by Msg or Send method"
+	log.Debug() // want "must be dispatched by Msg or Send method"
+	log.Warn()  // want "must be dispatched by Msg or Send method"
+
+	err := fmt.Errorf("foobarerror")
+	log.Error().Err(err)                                 // want "must be dispatched by Msg or Send method"
+	log.Error().Err(err).Str("foo", "bar").Int("foo", 1) // want "must be dispatched by Msg or Send method"
+
+	logger := log.Error() // want "must be dispatched by Msg or Send method"
+	logger.Err(err).Str("foo", "bar").Int("foo", 1)
+
+	// include zerolog.Dict()
+	log.Info(). // want "must be dispatched by Msg or Send method"
+			Str("foo", "bar").
+			Dict("dict", zerolog.Dict().
+				Str("bar", "baz").
+				Int("n", 1),
+		)
+
+	// conditional
+	logger2 := log.Info() // want "must be dispatched by Msg or Send method"
+	if err != nil {
+		logger2 = log.Error() // want "must be dispatched by Msg or Send method"
+	}
+	logger2.Str("foo", "bar")
+}
+
+func expectNoWarnings() {
+	log.Fatal().Send()
+	log.Panic().Msg("")
+	log.Debug().Send()
+	log.Info().Msg("")
+	log.Warn().Send()
+	log.Error().Msg("")
+
+	log.Error().Str("foo", "bar").Send()
+	err := fmt.Errorf("foobarerror")
+	log.Error().Err(err).Str("foo", "bar").Int("foo", 1).Msg("")
+
+	logger := log.Error()
+	logger.Send()
+
+	// include zerolog.Dict()
+	log.Info().
+		Str("foo", "bar").
+		Dict("dict", zerolog.Dict().
+			Str("bar", "baz").
+			Int("n", 1),
+		).Send()
+
+	// conditional
+	logger2 := log.Info()
+	if err != nil {
+		logger2 = log.Error()
+	}
+	logger2.Send()
+}
+
+// https://github.com/ykadowak/zerologlint/pull/2
+func packageNil() {
+	s := []int{1, 2, 3}
+	slices.Sort(s)
+}