Lint: add explicit per-linter settings (#4134)

mmetc · web-flow · commit 6f796d6fb139 · 2025-12-15T12:03:59.000+01:00
* lint: settings for recvcheck

* lint: settings for perfsprint

* lint: settings for usestdlibvars

* lint: settings for iface

* lint: settings for embeddedstructfieldcheck

* lint: settings for decorder

* lint: settings for exhaustive

* lint settings: section order
diff --git a/.golangci.yml b/.golangci.yml
@@ -72,13 +72,43 @@ linters:
     # Formatting only, useful in IDE but should not be forced on CI
     #
 
-    - godot                 # Check if comments end in a period
-    - nlreturn              # nlreturn checks for a new line before return and branch statements to increase code clarity
-    - whitespace            # Whitespace is a linter that checks for unnecessary newlines at the start and end of functions, if, for, etc.
-    - wsl_v5                # add or remove empty lines
+    - godot      # Check if comments end in a period
+    - nlreturn   # nlreturn checks for a new line before return and branch statements to increase code clarity
+    - whitespace # Whitespace is a linter that checks for unnecessary newlines at the start and end of functions, if, for, etc.
+    - wsl_v5     # add or remove empty lines
 
   settings:
 
+    decorder:
+      # Required order of `type`, `const`, `var` and `func` declarations inside a file.
+      # Default: types before constants before variables before functions.
+      dec-order:
+        - type
+        - const
+        - var
+        - func
+      # If true, underscore vars (vars with "_" as the name) will be ignored at all checks.
+      # Default: false (underscore vars are not ignored)
+      ignore-underscore-vars: false
+      # If true, order of declarations is not checked at all.
+      # Default: true (disabled)
+      disable-dec-order-check: true
+      # If true, `init` func can be anywhere in file (does not have to be declared before all other functions).
+      # Default: true (disabled)
+      disable-init-func-first-check: true
+      # If true, multiple global `type`, `const` and `var` declarations are allowed.
+      # Default: true (disabled)
+      disable-dec-num-check: true
+      # If true, type declarations will be ignored for dec num check.
+      # Default: false (type statements are not ignored)
+      disable-type-dec-num-check: false
+      # If true, const declarations will be ignored for dec num check.
+      # Default: false (const statements are not ignored)
+      disable-const-dec-num-check: false
+      # If true, var declarations will be ignored for dec num check.
+      # Default: false (var statements are not ignored)
+      disable-var-dec-num-check: false
+
     depguard:
       rules:
         wrap:
@@ -103,6 +133,10 @@ linters:
             - pkg: gopkg.in/yaml.v2
               desc: yaml.v2 is deprecated for new code in favor of yaml.v3
 
+    embeddedstructfieldcheck:
+      empty-line: false
+      forbid-mutex: true
+
     errcheck:
       # Report about not checking of errors in type assertions: `a := b.(MyStruct)`.
       # Such cases aren't reported by default.
@@ -135,6 +169,37 @@ linters:
       asserts: true
       comparison: true
 
+    exhaustive:
+      # Program elements to check for exhaustiveness.
+      # Default: [ switch ]
+      check:
+        - switch
+        - map
+      # Presence of "default" case in switch statements satisfies exhaustiveness,
+      # even if all enum members are not listed.
+      # Default: false
+      default-signifies-exhaustive: true
+      # Enum members matching the supplied regex do not have to be listed in
+      # switch statements to satisfy exhaustiveness.
+      # Default: ""
+      ignore-enum-members: "Example.+"
+      # Enum types matching the supplied regex do not have to be listed in
+      # switch statements to satisfy exhaustiveness.
+      # Default: ""
+      ignore-enum-types: "Example.+"
+      # Consider enums only in package scopes, not in inner scopes.
+      # Default: false
+      package-scope-only: true
+      # Only run exhaustive check on switches with "//exhaustive:enforce" comment.
+      # Default: false
+      explicit-exhaustive-switch: true
+      # Only run exhaustive check on map literals with "//exhaustive:enforce" comment.
+      # Default: false
+      explicit-exhaustive-map: true
+      # Switch statement requires default case even if exhaustive.
+      # Default: false
+      default-case-required: true
+
     gocritic:
       enable-all: true
       disabled-checks:
@@ -158,46 +223,6 @@ linters:
         ifElseChain:
           minThreshold: 4
 
-    modernize:
-      disable:
-        - any
-        - fmtappendf
-        - forvar
-        - omitzero
-        - slicessort
-        - stringsbuilder
-        - stringsseq
-        - waitgroup
-
-    perfsprint:
-      concat-loop: false
-      hex-format: false
-      integer-format: false
-      string-format: false
-
-    unused:
-      # Mark all struct fields that have been written to as used.
-      # Default: true
-      field-writes-are-uses: false
-      # Treat IncDec statement (e.g. `i++` or `i--`) as both read and write operation instead of just write.
-      # Default: false
-      post-statements-are-reads: false
-      # Mark all exported identifiers as used.
-      # Default: true
-      # exported-is-used: false
-      # Mark all exported fields as used.
-      # default: true
-      exported-fields-are-used: false
-      # Mark all function parameters as used.
-      # default: true
-      parameters-are-used: true
-      # Mark all local variables as used.
-      # default: true
-      local-variables-are-used: false
-      # Mark all identifiers inside generated files as used.
-      # Default: true
-      generated-is-used: false
-
     gomoddirectives:
       replace-allow-list:
         - golang.org/x/time
@@ -208,6 +233,17 @@ linters:
         - fieldalignment
       enable-all: true
 
+    iface:
+      enable:
+        # Identifies interfaces in the same package that have identical method sets.
+        - identical
+        # Identifies interfaces that are not used anywhere in the same package where the interface is defined.
+        # - unused
+        # Identifies functions that return interfaces, but the actual returned value is always a single concrete implementation.
+        - opaque
+        # Identifies interfaces that are not exported but are used in exported functions or methods.
+        # - unexported
+
     interfacebloat:
       max: 7
 
@@ -218,6 +254,17 @@ linters:
     misspell:
       locale: US
 
+    modernize:
+      disable:
+        - any
+        - fmtappendf
+        - forvar
+        - omitzero
+        - slicessort
+        - stringsbuilder
+        - stringsseq
+        - waitgroup
+
     nestif:
       # lower this after refactoring
       min-complexity: 15
@@ -233,6 +280,59 @@ linters:
       # report any unused nolint directives
       allow-unused: false
 
+    perfsprint:
+      # Enable/disable optimization of integer formatting.
+      # Default: true
+      integer-format: false
+      # Optimizes even if it requires an int or uint type cast.
+      # Default: true
+      int-conversion: false
+      # Enable/disable optimization of error formatting.
+      # Default: true
+      error-format: true
+      # Optimizes into `err.Error()` even if it is only equivalent for non-nil errors.
+      # Default: false
+      err-error: true
+      # Optimizes `fmt.Errorf`.
+      # Default: true
+      errorf: true
+      # Enable/disable optimization of string formatting.
+      # Default: true
+      string-format: false
+      # Optimizes `fmt.Sprintf` with only one argument.
+      # Default: true
+      sprintf1: true
+      # Optimizes into strings concatenation.
+      # Default: true
+      strconcat: false
+      # Enable/disable optimization of bool formatting.
+      # Default: true
+      bool-format: true
+      # Enable/disable optimization of hex formatting.
+      # Default: true
+      hex-format: false
+      # Enable/disable optimization of concat loop.
+      # Default: true
+      concat-loop: false
+      # Optimization of `concat-loop` even with other operations.
+      # Default: false
+      loop-other-ops: false
+
+    recvcheck:
+      # Disables the built-in method exclusions:
+      # - `MarshalText`
+      # - `MarshalJSON`
+      # - `MarshalYAML`
+      # - `MarshalXML`
+      # - `MarshalBinary`
+      # - `GobEncode`
+      disable-builtin: false
+      # User-defined method exclusions.
+      # The format is `struct_name.method_name` (ex: `Foo.MethodName`).
+      # A wildcard `*` can use as a struct name (ex: `*.MethodName`).
+      exclusions:
+        - "HCLogAdapter.SetLevel"
+
     revive:
       severity: error
       enable-all-rules: true
@@ -339,6 +439,64 @@ linters:
         - -QF1003  # could use tagged switch on ...
         - -QF1012  # QF1012: Use fmt.Fprintf(...) instead of ...
 
+    unused:
+      # Mark all struct fields that have been written to as used.
+      # Default: true
+      field-writes-are-uses: false
+      # Treat IncDec statement (e.g. `i++` or `i--`) as both read and write operation instead of just write.
+      # Default: false
+      post-statements-are-reads: false
+      # Mark all exported identifiers as used.
+      # Default: true
+      # exported-is-used: false
+      # Mark all exported fields as used.
+      # default: true
+      exported-fields-are-used: false
+      # Mark all function parameters as used.
+      # default: true
+      parameters-are-used: true
+      # Mark all local variables as used.
+      # default: true
+      local-variables-are-used: false
+      # Mark all identifiers inside generated files as used.
+      # Default: true
+      generated-is-used: false
+
+    usestdlibvars:
+      # Suggest the use of http.MethodXX.
+      # Default: true
+      http-method: true
+      # Suggest the use of http.StatusXX.
+      # Default: true
+      http-status-code: true
+      # Suggest the use of time.Month in time.Date.
+      # Default: false
+      time-date-month: false
+      # Suggest the use of time.Weekday.String().
+      # Default: true
+      time-weekday: false
+      # Suggest the use of time.Month.String().
+      # Default: false
+      time-month: false
+      # Suggest the use of time.Layout.
+      # Default: false
+      time-layout: false
+      # Suggest the use of crypto.Hash.String().
+      # Default: false
+      crypto-hash: true
+      # Suggest the use of rpc.DefaultXXPath.
+      # Default: false
+      default-rpc-path: true
+      # Suggest the use of sql.LevelXX.String().
+      # Default: false
+      sql-isolation-level: true
+      # Suggest the use of tls.SignatureScheme.String().
+      # Default: false
+      tls-signature-scheme: true
+      # Suggest the use of constant.Kind.String().
+      # Default: false
+      constant-kind: true
+
     usetesting:
       os-temp-dir: false
       context-background: true
@@ -437,17 +595,6 @@ linters:
         path: cmd/crowdsec/flags.go
         text: 'deep-exit: .*'
 
-      - linters:
-          - recvcheck
-        path: pkg/csplugin/hclog_adapter.go
-        text: the methods of "HCLogAdapter" use pointer receiver and non-pointer receiver.
-
-      # encoding to json/yaml requires value receivers
-      - linters:
-          - recvcheck
-        path: pkg/cwhub/item.go
-        text: the methods of "Item" use pointer receiver and non-pointer receiver.
-
       - linters:
           - gocritic
         path: cmd/crowdsec-cli
@@ -505,6 +652,10 @@ linters:
         path: pkg/exprhelpers/helpers.go
         text: "net.LookupHost must not be called"
 
+      - linters:
+          - embeddedstructfieldcheck
+        text: "embedded fields should be listed before regular fields"
+
     paths:
       - third_party$
       - builtin$
