loggercheck: add missing slog option (#5155)

Author: alexandear

.golangci.next.reference.yml

@@ -2032,6 +2032,9 @@ linters-settings:
     # Allow check for the github.com/go-logr/logr library.
     # Default: true
     logr: false
+    # Allow check for the log/slog library.
+    # Default: true
+    slog: false
     # Allow check for the "sugar logger" from go.uber.org/zap library.
     # Default: true
     zap: false

.golangci.reference.yml

@@ -2032,6 +2032,9 @@ linters-settings:
     # Allow check for the github.com/go-logr/logr library.
     # Default: true
     logr: false
+    # Allow check for the log/slog library.
+    # Default: true
+    slog: false
     # Allow check for the "sugar logger" from go.uber.org/zap library.
     # Default: true
     zap: false

jsonschema/golangci.jsonschema.json

@@ -2111,6 +2111,11 @@
               "type": "boolean",
               "default": true
             },
+            "slog": {
+              "description": "Allow check for the log/slog library.",
+              "type": "boolean",
+              "default": true
+            },
             "zap": {
               "description": "Allow check for the \"sugar logger\" from go.uber.org/zap library.",
               "type": "boolean",

jsonschema/golangci.next.jsonschema.json

@@ -2111,6 +2111,11 @@
               "type": "boolean",
               "default": true
             },
+            "slog": {
+              "description": "Allow check for the log/slog library.",
+              "type": "boolean",
+              "default": true
+            },
             "zap": {
               "description": "Allow check for the \"sugar logger\" from go.uber.org/zap library.",
               "type": "boolean",

pkg/config/linters_settings.go

@@ -105,6 +105,7 @@ var defaultLintersSettings = LintersSettings{
 		Kitlog:           true,
 		Klog:             true,
 		Logr:             true,
+		Slog:             true,
 		Zap:              true,
 		RequireStringKey: false,
 		NoPrintfLike:     false,
@@ -687,6 +688,7 @@ type LoggerCheckSettings struct {
 	Kitlog           bool     `mapstructure:"kitlog"`
 	Klog             bool     `mapstructure:"klog"`
 	Logr             bool     `mapstructure:"logr"`
+	Slog             bool     `mapstructure:"slog"`
 	Zap              bool     `mapstructure:"zap"`
 	RequireStringKey bool     `mapstructure:"require-string-key"`
 	NoPrintfLike     bool     `mapstructure:"no-printf-like"`

pkg/golinters/loggercheck/loggercheck.go

@@ -22,6 +22,9 @@ func New(settings *config.LoggerCheckSettings) *goanalysis.Linter {
 		if !settings.Logr {
 			disable = append(disable, "logr")
 		}
+		if !settings.Slog {
+			disable = append(disable, "slog")
+		}
 		if !settings.Zap {
 			disable = append(disable, "zap")
 		}

pkg/golinters/loggercheck/testdata/loggercheck_default.go

@@ -3,6 +3,7 @@ package loggercheck
 
 import (
 	"fmt"
+	"log/slog"
 
 	"github.com/go-logr/logr"
 	"go.uber.org/zap"
@@ -26,3 +27,10 @@ func ExampleZapSugarNotChecked() {
 	defer sugar.Sync()
 	sugar.Infow("message", "key1", "value1", "key2") // want `odd number of arguments passed as key-value pairs for logging`
 }
+
+func ExampleSlog() {
+	logger := slog.With("key1", "value1")
+
+	logger.Info("msg", "key1") // want `odd number of arguments passed as key-value pairs for logging`
+	slog.Info("msg", "key1")   // want `odd number of arguments passed as key-value pairs for logging`
+}

pkg/golinters/loggercheck/testdata/loggercheck_kitlogonly.yml

@@ -3,4 +3,5 @@ linters-settings:
     kitlog: true
     klog: false
     logr: false
+    slog: false
     zap: false

pkg/golinters/loggercheck/testdata/loggercheck_logronly.yml

@@ -2,4 +2,5 @@ linters-settings:
   loggercheck:
     logr: true
     klog: false
+    slog: false
     zap: false

pkg/golinters/loggercheck/testdata/loggercheck_slogonly.go

@@ -0,0 +1,12 @@
+//golangcitest:args -Eloggercheck
+//golangcitest:config_path testdata/loggercheck_slogonly.yml
+package loggercheck
+
+import "log/slog"
+
+func ExampleSlogOnly() {
+	logger := slog.With("key1", "value1")
+
+	logger.Info("msg", "key1") // want `odd number of arguments passed as key-value pairs for logging`
+	slog.Info("msg", "key1")   // want `odd number of arguments passed as key-value pairs for logging`
+}