feat: implement -no-mixed-args (#25)

Author: n9v9

README.md

@@ -22,8 +22,8 @@ The linter has several options, so you can adjust it to your own code style.
 
 ## 🚀 Features
 
-* Forbid mixing key-value pairs and attributes within a single function call (default)
-* Enforce using either key-value pairs or attributes for the entire project (optional)
+* Enforce not mixing key-value pairs and attributes (default)
+* Enforce using either key-value pairs only or attributes only (optional)
 * Enforce using methods that accept a context (optional)
 * Enforce using static log messages (optional)
 * Enforce using constants instead of raw keys (optional)
@@ -51,6 +51,16 @@ See the list of [available options][3] to configure the linter.
 
 When using `sloglint` standalone, pass the options as flags of the same name.
 
+### No mixed arguments
+
+The `no-mixed-args` option causes `sloglint` to report mixing key-values pairs and attributes within a single function call:
+
+```go
+slog.Info("a user has logged in", "user_id", 42, slog.String("ip_address", "192.0.2.0")) // sloglint: key-value pairs and attributes should not be mixed
+```
+
+It is enabled by default.
+
 ### Key-value pairs only
 
 The `kv-only` option causes `sloglint` to report any use of attributes:

sloglint.go

@@ -19,8 +19,9 @@ import (
 
 // Options are options for the sloglint analyzer.
 type Options struct {
-	KVOnly         bool   // Enforce using key-value pairs only (incompatible with AttrOnly).
-	AttrOnly       bool   // Enforce using attributes only (incompatible with KVOnly).
+	NoMixedArgs    bool   // Enforce not mixing key-value pairs and attributes (default true).
+	KVOnly         bool   // Enforce using key-value pairs only (overrides NoMixedArgs, incompatible with AttrOnly).
+	AttrOnly       bool   // Enforce using attributes only (overrides NoMixedArgs, incompatible with KVOnly).
 	ContextOnly    bool   // Enforce using methods that accept a context.
 	StaticMsg      bool   // Enforce using static log messages.
 	NoRawKeys      bool   // Enforce using constants instead of raw keys.
@@ -31,7 +32,7 @@ type Options struct {
 // New creates a new sloglint analyzer.
 func New(opts *Options) *analysis.Analyzer {
 	if opts == nil {
-		opts = new(Options)
+		opts = &Options{NoMixedArgs: true}
 	}
 	return &analysis.Analyzer{
 		Name:     "sloglint",
@@ -69,8 +70,9 @@ func flags(opts *Options) flag.FlagSet {
 		})
 	}
 
-	boolVar(&opts.KVOnly, "kv-only", "enforce using key-value pairs only (incompatible with -attr-only)")
-	boolVar(&opts.AttrOnly, "attr-only", "enforce using attributes only (incompatible with -kv-only)")
+	boolVar(&opts.NoMixedArgs, "no-mixed-args", "enforce not mixing key-value pairs and attributes (default true)")
+	boolVar(&opts.KVOnly, "kv-only", "enforce using key-value pairs only (overrides -no-mixed-args, incompatible with -attr-only)")
+	boolVar(&opts.AttrOnly, "attr-only", "enforce using attributes only (overrides -no-mixed-args, incompatible with -kv-only)")
 	boolVar(&opts.ContextOnly, "context-only", "enforce using methods that accept a context")
 	boolVar(&opts.StaticMsg, "static-msg", "enforce using static log messages")
 	boolVar(&opts.NoRawKeys, "no-raw-keys", "enforce using constants instead of raw keys")
@@ -180,7 +182,7 @@ func run(pass *analysis.Pass, opts *Options) {
 			pass.Reportf(call.Pos(), "attributes should not be used")
 		case opts.AttrOnly && len(attrs) < len(args):
 			pass.Reportf(call.Pos(), "key-value pairs should not be used")
-		case 0 < len(attrs) && len(attrs) < len(args):
+		case opts.NoMixedArgs && 0 < len(attrs) && len(attrs) < len(args):
 			pass.Reportf(call.Pos(), "key-value pairs and attributes should not be mixed")
 		}
 

sloglint_test.go

@@ -10,9 +10,9 @@ import (
 func TestAnalyzer(t *testing.T) {
 	testdata := analysistest.TestData()
 
-	t.Run("mixed arguments", func(t *testing.T) {
+	t.Run("no mixed arguments", func(t *testing.T) {
 		analyzer := sloglint.New(nil)
-		analysistest.Run(t, testdata, analyzer, "mixed_args")
+		analysistest.Run(t, testdata, analyzer, "no_mixed_args")
 	})
 
 	t.Run("key-value pairs only", func(t *testing.T) {