.golangci.yml

version: "2"

linters:
  enable:
    - contextcheck
    - errorlint
    - exhaustive
    - forbidigo
    - gocognit
    - gocritic
    - gocyclo
    - nilerr
    - revive
    - unparam
    - unused

  settings:
    gocyclo:
      # TODO: lower to 25 as complex functions are refactored.
      min-complexity: 42
    gocognit:
      # TODO: lower to 40 as complex functions are refactored.
      min-complexity: 62
    gocritic:
      # TODO: Enable more checks, it is detecting actual potential issues.
      disable-all: true
      enabled-checks:
        - appendAssign
        - exitAfterDefer
        - offBy1

        # Enabled for the custom rules below.
        - ruleguard
      settings:
        ruleguard:
          rules: '${base-path}/scripts/ruleguard/rules/rules.go'
          failOn: all
    forbidigo:
      forbid:
        - pattern: 'os\.Chdir'
          msg: "use t.Chdir in tests; os.Chdir mutates global process state"
    revive:
      rules:
        # TODO: lower to default 8 once BuildIntegrationPackagePolicy, CreatePackagePolicy,
        # and processResults are refactored to use option structs.
        - name: argument-limit
          arguments: [11]

  exclusions:
    rules:
      # defer x.Close() errors are conventionally ignored.
      - linters: [errcheck]
        text: 'Error return value of `.+\.Close` is not checked'

      # fmt.Fprint* write to io.Writer sinks (stderr, logs) where errors are
      # not actionable — callers cannot recover from a write failure there.
      - linters: [errcheck]
        text: 'Error return value of `fmt\.Fprint'

      # Test helpers: network mock servers ignore conn.Write, io.ReadFull errors.
      - linters: [errcheck]
        path: '_test\.go'

      # go-pretty's SetTitle has a printf-style signature but is not a format function;
      # govet incorrectly flags non-constant strings passed to it.
      - linters: [govet]
        text: 'printf: non-constant format string in call to.*SetTitle'

      # NewProject and NewKibanaClientFromProfile are constructors that intentionally do not
      # take a context: NewProject does file I/O only, and NewKibanaClientFromProfile calls
      # checkClientStackAvailability which deliberately uses context.Background() to avoid
      # cancellation on initial availability checks.
      # NewForPackage makes a network call (kibanaVersion) and could accept a context in future.
      - linters: [contextcheck]
        text: 'Function `.*\b(NewProject|NewKibanaClientFromProfile|NewElasticsearchClientFromProfile|NewForPackage|NewKibanaClient|checkClientStackAvailability)\b.*` should pass the context parameter'

      # elastic-go-common MapStr/mapstr operations: Put/Delete errors are structural
      # (wrong value type), not runtime failures.
      # TODO: consider replacing MapStr with a typed API to eliminate these error returns entirely.
      - linters: [errcheck]
        text: 'Error return value of `.*\.(Put|Delete)` is not checked'

      # testscript command handlers must match the testscript.Cmd signature (neg bool is required).
      # TODO: upstream a linter exception or type alias so the interface is explicit.
      - linters: [unparam]
        path: 'internal/testrunner/script/'
        text: 'neg is unused'