disable zap by default timonwong/loggercheck#27

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

.golangci.reference.yml

@@ -1119,8 +1119,8 @@ linters-settings:
     # Default: true
     logr: false
     # Allow check for the "sugar logger" from go.uber.org/zap library.
-    # Default: true
-    zap: false
+    # Default: false
+    zap: true
     # List of rules to check against, where each rule is a single logger pattern.
     rules:
       - k8s.io/klog/v2.InfoS   # package level exported functions

pkg/config/linters_settings.go

@@ -69,7 +69,7 @@ var defaultLintersSettings = LintersSettings{
 	LoggerCheck: LoggerCheckSettings{
 		Logr: true,
 		Klog: true,
-		Zap:  true,
+		Zap:  false,
 	},
 	MaintIdx: MaintIdxSettings{
 		Under: 20,

test/testdata/loggercheck/configs/loggercheck_all.yml

@@ -0,0 +1,3 @@
+linters-settings:
+  loggercheck:
+    zap: true

test/testdata/loggercheck/loggercheck_all.go

@@ -1,4 +1,5 @@
 //golangcitest:args -Eloggercheck
+//golangcitest:config_path configs/loggercheck_all.yml
 package loggercheck
 
 import (
@@ -9,19 +10,19 @@ import (
 	"k8s.io/klog/v2"
 )
 
-func ExampleLogr() {
+func ExampleAllLogr() {
 	log := logr.Discard()
 	log = log.WithValues("key")                                         // want `odd number of arguments passed as key-value pairs for logging`
 	log.Info("message", "key1", "value1", "key2", "value2", "key3")     // want `odd number of arguments passed as key-value pairs for logging`
 	log.Error(fmt.Errorf("error"), "message", "key1", "value1", "key2") // want `odd number of arguments passed as key-value pairs for logging`
 	log.Error(fmt.Errorf("error"), "message", "key1", "value1", "key2", "value2")
 }
 
-func ExampleKlog() {
+func ExampleAllKlog() {
 	klog.InfoS("message", "key1") // want `odd number of arguments passed as key-value pairs for logging`
 }
 
-func ExampleZapSugar() {
+func ExampleAllZapSugar() {
 	sugar := zap.NewExample().Sugar()
 	defer sugar.Sync()
 	sugar.Infow("message", "key1", "value1", "key2") // want `odd number of arguments passed as key-value pairs for logging`

test/testdata/loggercheck/loggercheck_default.go

@@ -0,0 +1,28 @@
+//golangcitest:args -Eloggercheck
+package loggercheck
+
+import (
+	"fmt"
+
+	"github.com/go-logr/logr"
+	"go.uber.org/zap"
+	"k8s.io/klog/v2"
+)
+
+func ExampleDefaultLogr() {
+	log := logr.Discard()
+	log = log.WithValues("key")                                         // want `odd number of arguments passed as key-value pairs for logging`
+	log.Info("message", "key1", "value1", "key2", "value2", "key3")     // want `odd number of arguments passed as key-value pairs for logging`
+	log.Error(fmt.Errorf("error"), "message", "key1", "value1", "key2") // want `odd number of arguments passed as key-value pairs for logging`
+	log.Error(fmt.Errorf("error"), "message", "key1", "value1", "key2", "value2")
+}
+
+func ExampleDefaultKlog() {
+	klog.InfoS("message", "key1") // want `odd number of arguments passed as key-value pairs for logging`
+}
+
+func ExampleZapSugarNotChecked() {
+	sugar := zap.NewExample().Sugar()
+	defer sugar.Sync()
+	sugar.Infow("message", "key1", "value1", "key2")
+}

test/testdata/loggercheck/logrlint_compatiblity.go

@@ -24,5 +24,5 @@ func ExampleLogrlintKlog() {
 func ExampleLogrlintZapSugar() {
 	sugar := zap.NewExample().Sugar()
 	defer sugar.Sync()
-	sugar.Infow("message", "key1", "value1", "key2") // want `odd number of arguments passed as key-value pairs for logging`
+	sugar.Infow("message", "key1", "value1", "key2")
 }