.golangci.yml

version: "2"

run:
  timeout: 10m

linters:
  default: none
  enable:
    - asasalint
    - asciicheck
    - bidichk
    - copyloopvar
    - decorder
    - dupl
    - durationcheck
    - errcheck
    - errname
    - errorlint
    - exhaustive
    - ginkgolinter
    - gocheckcompilerdirectives
    - govet
    - grouper
    - importas
    - ineffassign
    - makezero
    - misspell
    - nakedret
    - nilnil
    - promlinter
    - revive
    - sloglint
    - staticcheck
    - unconvert
    - unused
    - usestdlibvars
    - whitespace
    - defercleanupcluster
    - defercleanupctx
    - ginkgoreturnctx
    - describefunc
  settings:
    dupl:
      threshold: 400
    exhaustive:
      check:
        - switch
        - map
      ignore-enum-types: ResourceName|Atom
      default-signifies-exhaustive: true
    importas:
      no-unaliased: true
      alias:
        # Kubernetes
        - pkg: k8s\.io/api/(\w+)/(v[\w\d]+)
          alias: $1$2
        - pkg: k8s\.io/apimachinery/pkg/api/(\w+)/(v[\w\d]+)
          alias: $1$2
        - pkg: k8s.io/apimachinery/pkg/api/errors
          alias: kerrors
        - pkg: k8s.io/apimachinery/pkg/apis/meta/internalversion
          alias: metainternalversion
    revive:
      rules:
        - name: dot-imports
          disabled: false
          arguments:
            - allowed-packages: [ "github.com/onsi/ginkgo/v2", "github.com/onsi/gomega" ]
    tagalign:
      order:
        - protobuf
        - json
        - yaml
        - xml
        - form
    custom:
      defercleanupcluster:
        type: module
        description: "Checks that cluster.Create calls have a matching DeferCleanup(cluster.Destroy(...))"
        original-url: github.com/loft-sh/e2e-framework/linters/defercleanupcluster
      defercleanupctx:
        type: module
        description: "Checks that DeferCleanup is not called with a setup.Func; use e2e.DeferCleanupCtx(ctx, fn) instead"
        original-url: github.com/loft-sh/e2e-framework/linters/defercleanupctx
      ginkgoreturnctx:
        type: module
        description: "Checks that Ginkgo node functions that reassign context.Context also return it"
        original-url: github.com/loft-sh/e2e-framework/linters/ginkgoreturnctx
      describefunc:
        type: module
        description: "Checks that Ginkgo Describe calls with cluster.Use use the exported function pattern instead of auto-registration"
        original-url: github.com/loft-sh/e2e-framework/linters/describefunc
    staticcheck:
      dot-import-whitelist:
        - github.com/onsi/ginkgo/v2
        - github.com/onsi/gomega
      checks:
        - all
        # All below staticcheck exclusions have been added when migrating golangci-lint config from
        # v1 to v2 and for the sake of not making source code changes when upgrading golangci-lint.
        - "-QF1001" # exclude 'could apply De Morgan's law'
        - "-QF1003" # exclude 'could use tagged switch on value'
        - "-QF1004" # exclude 'could use strings.ReplaceAll instead'
        - "-QF1008" # exclude 'could remove embedded field "<field>" from selector'
        - "-QF1012" # exclude 'Use fmt.Fprintf(...) instead of WriteString(fmt.Sprintf(...))'
  exclusions:
    generated: lax
    presets:
      - comments
      - common-false-positives
      - legacy
      - std-error-handling
    rules:
      # We are still using the deprecated exportKubeConfig.Secret field in a couple of places in code (as the support for
      # exportKubeConfig.secret config is still not entirely removed).
      - path: config/config.go
        text: 'SA1019: (.+)Secret is deprecated: Use AdditionalSecrets instead.'
      - path: pkg/config/validation.go
        text: 'SA1019: (.+)Secret is deprecated: Use AdditionalSecrets instead.'
      # Skip ST1003 (package name with underscores) for e2e-next folder
      - path: ^e2e-next/
        linters: [staticcheck]
        text: 'ST1003: should not use underscores in package names'
      # The following exceptions apply only to existing packages that need refactoring.
      # The rule remains enabled globally.
      - path: ^pkg/(cli/util|server/types|snapshot/types|syncer/types|util|plugin/types)/[^/]+\.go$
        linters: [revive]
        text: avoid meaningless package names
      - path-except: 'e2e-next/'
        linters:
          - defercleanupcluster
      - path-except: 'e2e-next/'
        linters:
          - defercleanupctx
      - path-except: 'e2e-next/'
        linters:
          - ginkgoreturnctx
      - path-except: 'e2e-next/'
        linters:
          - describefunc
    paths:
      - licenses
      # Paths below are added by 'golangci-lint migrate' when migrating from v1 to v2. They are the
      # equivalent of v1 config 'issues.exclude-dirs-use-default: true'.
      - third_party$
      - builtin$
      - examples$

issues:
  # Maximum issues count per one linter. Set to 0 to disable. Default is 50.
  max-issues-per-linter: 0
  # Maximum count of issues with the same text. Set to 0 to disable. Default is 3.
  max-same-issues: 0

formatters:
  enable:
    - gofmt
    - goimports
  settings:
    gofmt:
      simplify: true
  exclusions:
    generated: lax
    paths:
      - licenses
      # Paths below are added by 'golangci-lint migrate' when migrating from v1 to v2. They are the
      # equivalent of v1 config 'issues.exclude-dirs-use-default: true'.
      - third_party$
      - builtin$
      - examples$