bump loggercheck; add support to no-printf-like

Signed-off-by: Timon Wong <[email protected]>

Author: timonwong

.golangci.reference.yml

@@ -1124,9 +1124,12 @@ linters-settings:
     # Allow check for the "sugar logger" from go.uber.org/zap library.
     # Default: true
     zap: false
-    # Require all logging keys to be inlined constant strings
+    # Require all logging keys to be inlined constant strings.
     # Default: false
     require-string-key: true
+    # Require printf-like format specifier (%s, %d for example) not present.
+    # Default: false
+    no-printf-like: true
     # List of custom rules to check against, where each rule is a single logger pattern.
     # Default: empty
     rules:

go.mod

@@ -95,7 +95,7 @@ require (
 	github.com/tdakkota/asciicheck v0.1.1
 	github.com/tetafro/godot v1.4.11
 	github.com/timakin/bodyclose v0.0.0-20210704033933-f49887972144
-	github.com/timonwong/loggercheck v0.8.0
+	github.com/timonwong/loggercheck v0.9.2
 	github.com/tomarrell/wrapcheck/v2 v2.6.2
 	github.com/tommy-muehle/go-mnd/v2 v2.5.0
 	github.com/ultraware/funlen v0.0.3

go.sum

@@ -72,6 +72,7 @@ var defaultLintersSettings = LintersSettings{
 		Logr:             true,
 		Zap:              true,
 		RequireStringKey: false,
+		NoPrintfLike:     false,
 		Rules:            nil,
 	},
 	MaintIdx: MaintIdxSettings{
@@ -485,6 +486,7 @@ type LoggerCheckSettings struct {
 	Logr             bool     `mapstructure:"logr"`
 	Zap              bool     `mapstructure:"zap"`
 	RequireStringKey bool     `mapstructure:"require-string-key"`
+	NoPrintfLike     bool     `mapstructure:"no-printf-like"`
 	Rules            []string `mapstructure:"rules"`
 }
 

pkg/config/linters_settings.go

@@ -30,6 +30,7 @@ func NewLoggerCheck(settings *config.LoggerCheckSettings) *goanalysis.Linter {
 			loggercheck.WithDisable(disable),
 			loggercheck.WithRequireStringKey(settings.RequireStringKey),
 			loggercheck.WithRules(settings.Rules),
+			loggercheck.WithNoPrintfLike(settings.NoPrintfLike),
 		}
 	}
 

pkg/golinters/loggercheck.go

@@ -0,0 +1,3 @@
+linters-settings:
+  loggercheck:
+    no-printf-like: true

test/testdata/loggercheck/configs/loggercheck_noprintflike.yml

@@ -0,0 +1,15 @@
+//golangcitest:args -Eloggercheck
+//golangcitest:config_path configs/loggercheck_noprintflike.yml
+package loggercheck
+
+import (
+	"github.com/go-logr/logr"
+)
+
+func ExampleNoPrintfLike() {
+	log := logr.Discard()
+
+	log.Info("This message is ok")
+	log.Info("Should not contains printf like format specifiers: %s %d %w") // want `logging message should not use format specifier "%s"`
+	log.Info("It also checks for the key value pairs", "key", "value %.2f") // want `logging message should not use format specifier "%\.2f"`
+}