.golangci.yml

version: "2"

########################
# 1. Execution settings
########################
run:
  timeout: 5m                      # Keep the original timeout
  tests: true                      # Analyze *_test.go files as well
  issues-exit-code: 1              # Fail CI if any issue is found
  go: "1.25"                       # Ensure 1.22+ analyses (intrange, copyloopvar) run with new semantics

########################
# 2. Issues quota
########################
issues:
  max-issues-per-linter: 0         # Do not cap issues per linter
  max-same-issues: 0               # Do not deduplicate identical issues

########################
# 3. Enabled linters
########################
linters:
  default: none
  enable:
    # Core correctness & security
    - govet
    - staticcheck
    - errcheck
    - ineffassign
    - unused
    - errchkjson
    - errorlint
    - gosec
    - goconst
    - gocritic
    - mnd
    - revive
    - unparam
    - unconvert
    - bodyclose
    - asasalint
    - misspell
    - usestdlibvars
    - testifylint
    - perfsprint
    - paralleltest
    - tagliatelle
    - thelper
    - testpackage

    # Modernization related to Go 1.22–1.25
    - intrange               # Prefer `for i := range n` where applicable (Go 1.22) [external linter]
    - copyloopvar            # Detect legacy loop-var copies; has autofix
    - exptostd               # Suggest std replacements for x/exp/*

    # Logging hygiene (slog)
    - sloglint               # Enforce consistent slog usage
    - loggercheck            # Validate slog key/value shapes

    # API/style consistency that reduces long-term churn
    - nilnesserr             # Detect inconsistent nil/err returns
    - predeclared            # Avoid shadowing predeclared identifiers
    - godot                  # Enforce periods at the end of doc comments
    - whitespace             # Normalize whitespace
    - fatcontext             # Avoid capturing/propagating "fat" contexts
    - nosprintfhostport      # Safer host:port formatting
    - depguard               # Belt-and-suspenders dependency rules

  ########################
  # 4. Per-linter settings
  # https://golangci-lint.run/docs/linters/configuration/
  ########################
  settings:
    errcheck:
      check-type-assertions: true
      check-blank: true

    staticcheck:
      checks:
        - all
        - "-SA1012"

    errchkjson:
      check-error-free-encoding: true

    errorlint:
      errorf: true
      asserts: true

    goconst:
      min-len: 2
      min-occurrences: 3

    gocritic:
      enable-all: true
      disabled-checks:
        - hugeParam
        - rangeValCopy
        - commentedOutCode
        - whyNoLint
        - importShadow            # Disable to avoid churn in legacy code
        - paramTypeCombine        # Disable to avoid cosmetic changes

    gosec:
      excludes:
        - G101                    # Exclude hardcoded credentials check (false positives in env var names)
        - G304                    # Exclude file inclusion check (necessary for dynamic file operations)

    mnd:
      checks: [argument,assign,case,return]
      ignored-functions: ["time.Duration"]

    revive:
      confidence: 0.8
      rules:
        - name: indent-error-flow
          arguments: [preserveScope]
        - name: function-length
          arguments: [80, 0]
        - name: error-strings
        - name: error-naming
        - name: var-naming
          arguments:
          # White List to preserve readability. I maintain these words by hands.
          - [
              # Network Protocols & Technologies
              "SSH", "Telnet", "TCP", "IP", "TLS", "DTLS", "CLI", "OS",
              # Network Vendors & Platforms
              "IOS", "NXOS", "ASA", "AireOS", "JunOS", "ScreenOS", "SRX", "SSG", "Yamaha",
              # Network Devices & Components
              "AP", "VLAN", "MAC", "SSID"
            ]
          # Black List to avoid confusion with common initialisms.
          - [
              # General
              "API", "ID", "URL", "URI", "UUID", "HTTP", "HTTPS",
              # Network Protocols
              "DHCP", "DNS", "SNMP", "NTP", "RADIUS", "TACACS"
            ]
          - - skip-initialism-name-checks: false

    misspell:
      locale: US

    perfsprint:
      int-conversion: true
      err-error: true
      errorf: true
      sprintf1: true

    paralleltest:
      ignore-missing: false

    tagliatelle:
      case:
        rules:
          json: snake

    testifylint:
      enable-all: true
      disable:
        - float-compare

    govet:
      enable-all: true
      disable:
        - shadow                 # Prevent noisy false positives
        - fieldalignment         # Avoid churn with marginal benefits

    sloglint:                    # See options: https://github.com/go-simpler/sloglint
      no-mixed-args: true        # Do not mix key/value pairs and Attrs
      no-global: ""              # Allow default global logger usage for simplicity

    copyloopvar:
      check-alias: true          # Also flag aliasing the loop variable

    depguard:
      rules:
        main:
          list-mode: lax
          files: [ $all ]
          allow:
            - $gostd
          deny:
            - pkg: "log$"
              desc: "Use slog (and sloglint) instead of log package"
            - pkg: "golang.org/x/exp/maps$"
              desc: "Use std `maps` and built-ins (e.g., clear) instead of x/exp/maps"
            - pkg: "golang.org/x/exp/slices$"
              desc: "Use std `slices` instead of x/exp/slices"
            - pkg: "github.com/pkg/errors$"
              desc: "Use std `errors`"
            - pkg: "math/rand$"
              desc: "Use `math/rand/v2` on Go 1.22+"

  ########################
  # 5. Exclusions
  ########################
  exclusions:
    generated: lax
    warn-unused: false