.golangci.yml

run:
  timeout: 10m
  go: "1.21"
  skip-files:
    - "zz_generated.*\\.go$"
    - "_conversion\\.go$"
    - "vendored_cluster_api\\.go$"
  allow-parallel-runners: true

linters:
  disable-all: true
  enable:
  - asasalint
  - asciicheck
  - bidichk
  - bodyclose
  - containedctx
  - dogsled
  - dupword
  - durationcheck
  - errcheck
  - errchkjson
  - exportloopref
  - gci
  - ginkgolinter
  - goconst
  - gocritic
  - godot
  - gofmt
  - goimports
  - goprintffuncname
  - gosec
  - gosimple
  - govet
  - importas
  - ineffassign
  - loggercheck
  - misspell
  - nakedret
  - nilerr
  - noctx
  - nolintlint
  - nosprintfhostport
  - prealloc
  - predeclared
  - revive
  - rowserrcheck
  - staticcheck
  - stylecheck
  - thelper
  - typecheck
  - unconvert
  - unparam
  - unused
  - usestdlibvars
  - whitespace

linters-settings:
  gci:
    sections:
      - standard # Standard section: captures all standard packages.
      - default # Default section: contains all imports that could not be matched to another section type.
      - prefix(sigs.k8s.io/cluster-api-provider-vsphere) # Custom section: groups all imports with the specified Prefix.
    custom-order: true
  godot:
    #   declarations - for top level declaration comments (default);
    #   toplevel     - for top level comments;
    #   all          - for all comments.
    scope: toplevel
    exclude:
      - '^ \+.*'
      - '^ ANCHOR.*'
  gocritic:
    enabled-tags:
      - diagnostic
      - experimental
      - performance
    disabled-checks:
      - appendAssign
      - dupImport # https://github.com/go-critic/go-critic/issues/845
      - evalOrder
      - ifElseChain
      - octalLiteral
      - regexpSimplify
      - sloppyReassign
      - truncateCmp
      - typeDefFirst
      - unnamedResult
      - unnecessaryDefer
      - whyNoLint
      - wrapperFunc
      - rangeValCopy
      - hugeParam
  importas:
    no-unaliased: true
    alias:
      # Kubernetes
      - pkg: k8s.io/api/core/v1
        alias: corev1
      - pkg: k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1
        alias: apiextensionsv1
      - pkg: k8s.io/apimachinery/pkg/apis/meta/v1
        alias: metav1
      - pkg: k8s.io/apimachinery/pkg/api/errors
        alias: apierrors
      - pkg: k8s.io/apimachinery/pkg/util/errors
        alias: kerrors
      - pkg: k8s.io/component-base/logs/api/v1
        alias: logsv1
      # Controller Runtime
      - pkg: sigs.k8s.io/controller-runtime
        alias: ctrl
      # CAPV
      - pkg: sigs.k8s.io/cluster-api-provider-vsphere/apis/v1beta1
        alias: infrav1
      - pkg: sigs.k8s.io/cluster-api-provider-vsphere/apis/v1alpha3
        alias: infrav1alpha3
      - pkg: sigs.k8s.io/cluster-api-provider-vsphere/apis/v1alpha4
        alias: infrav1alpha4
      - pkg: sigs.k8s.io/cluster-api-provider-vsphere/apis/vmware/v1beta1
        alias: vmwarev1
      # VMware Operator
      - pkg: "github.com/vmware-tanzu/vm-operator/api/v1alpha1"
        alias: vmoprv1 
      # CABPK
      - pkg: sigs.k8s.io/cluster-api/bootstrap/kubeadm/api/v1beta1
        alias: bootstrapv1
      # KCP
      - pkg: sigs.k8s.io/cluster-api/controlplane/kubeadm/api/v1beta1
        alias: controlplanev1
      # CAPI
      - pkg: sigs.k8s.io/cluster-api/api/v1beta1
        alias: clusterv1
      # CAPI exp
      - pkg: sigs.k8s.io/cluster-api/exp/api/v1beta1
        alias: expv1
      # CAPI exp addons
      - pkg: sigs.k8s.io/cluster-api/exp/addons/api/v1beta1
        alias: addonsv1
      # CAPI IPAM 
      - pkg: sigs.k8s.io/cluster-api/exp/ipam/api/v1beta1
        alias: ipamv1
  nolintlint:
    allow-unused: false
    allow-leading-space: false
    require-specific: true
  revive:
    rules:
      # The following rules are recommended https://github.com/mgechev/revive#recommended-configuration
      - name: blank-imports
      - name: context-as-argument
      - name: context-keys-type
      - name: dot-imports
      - name: error-return
      - name: error-strings
      - name: error-naming
      - name: exported
      - name: if-return
      - name: increment-decrement
      - name: var-naming
      - name: var-declaration
      - name: package-comments
      - name: range
      - name: receiver-naming
      - name: time-naming
      - name: unexported-return
      - name: indent-error-flow
      - name: errorf
      - name: empty-block
      - name: superfluous-else
      - name: unused-parameter
      - name: unreachable-code
      - name: redefines-builtin-id
      #
      # Rules in addition to the recommended configuration above.
      #
      - name: bool-literal-in-expr
      - name: constant-logical-expr

  ginkgolinter:
    forbid-focus-container: true
  goconst:
    ignore-tests: true

issues:
  max-same-issues: 0
  max-issues-per-linter: 0
  # We are disabling default golangci exclusions because we want to help reviewers to focus on reviewing the most relevant
  # changes in PRs and avoid nitpicking.
  exclude-use-default: false
  exclude-rules:
  # Specific exclude rules for deprecated items that are still part of the codebase. These
  # should be removed as the referenced deprecated item is removed from the project.
  - linters:
    - staticcheck
    text: "SA1019: .* is deprecated: This package will be removed in one of the next releases."
  - linters:
    - staticcheck
    text: "SA1019: .* is deprecated: This field is going to be removed in a future release."
  - linters:
    - revive
    text: "exported: exported method .*\\.(Reconcile|SetupWithManager|SetupWebhookWithManager) should have comment or be unexported"
  - linters:
    - errcheck
    text: Error return value of .((os\.)?std(out|err)\..*|.*Close|.*Flush|os\.Remove(All)?|.*print(f|ln)?|os\.(Un)?Setenv). is not checked
  # Exclude some packages or code to require comments, for example test code, or fake clients.
  - linters:
    - revive
    text: exported (method|function|type|const) (.+) should have comment or be unexported
    source: (func|type).*Fake.*
  - linters:
    - revive
    text: exported (.+) (.+) should have comment (.*)or be unexported
    path: "^(test/|packaging/|pkg/.*/fake/|pkg/util/testutil).*.go"
  - linters:
    - revive
    text: a blank import should be only in a main or test package, or have a comment justifying it
    path: "^packaging/.*.go"
  # Disable unparam "always receives" which might not be really
  # useful when building libraries.
  - linters:
    - unparam
    text: always receives
  # Dot imports for gomega and ginkgo are allowed
  # within test files and test utils.
  - linters:
    - revive
    - stylecheck
    path: _test\.go
    text: should not use dot imports
  - linters:
    - revive
    - stylecheck
    path: test/e2e/.*.go
    text: should not use dot imports
  - linters:
      - revive
      - stylecheck
    path: test/framework/.*.go
    text: should not use dot imports
  - linters:
    - revive
    - stylecheck
    path: test/helpers/vmware/.*.go
    text: should not use dot imports
  # Append should be able to assign to a different var/slice.
  - linters:
    - gocritic
    text: "appendAssign: append result not assigned to the same slice"
 # Disable linters for conversion
  - linters:
    - staticcheck
    text: "SA1019: in.(.+) is deprecated"
    path: ^apis\/.*\/.*conversion.*\.go$
  - linters:
      - revive
    # Checking if an error is nil to just after return the error or nil is redundant
    text: "if-return: redundant if ...; err != nil check, just return error instead"
    # Ignoring stylistic checks for generated code
    path: ^apis\/.*\/.*conversion.*\.go$
  - linters:
    - revive
    # Exported function and methods should have comments. This warns on undocumented exported functions and methods.
    text: exported (method|function|type|const) (.+) should have comment or be unexported
    # Ignoring stylistic checks for generated code
    path: ^apis\/.*\/.*conversion.*\.go$
  - linters:
    - revive
    # This rule warns when initialism, variable or package naming conventions are not followed.
    text: "var-naming: don't use underscores in Go names;"
    # Ignoring stylistic checks for generated code
    path: ^apis\/.*\/.*conversion.*\.go$
  - linters:
    - revive
    # By convention, receiver names in a method should reflect their identity.
    text: "receiver-naming: receiver name"
    # Ignoring stylistic checks for generated code
    path: ^apis\/.*\/.*conversion.*\.go$
  - linters:
    - stylecheck
    text: "ST1003: should not use underscores in Go names;"
    path: ^apis\/.*\/.*conversion.*\.go$
  - linters:
    - stylecheck
    text: "ST1016: methods on the same type should have the same receiver name"
    path: ^apis\/.*\/.*conversion.*\.go$
    # missing comments on v1alpha3 and v1alpha4 packages. These rules should be removed when those packages are removed.
  - linters:
    - revive
    text: "package-comments"
    path: ^(apis/(v1alpha3|v1alpha4)\/.*)\.go$
  - linters:
    - stylecheck
    text: "ST1000"
    path: ^(apis/(v1alpha3|v1alpha4)\/.*)\.go$
  - linters:
    - revive
    text: exported (.*) should have comment (.*)or be unexported
    path: ^(apis/(v1alpha3|v1alpha4)\/.*)\.go$
    # wrong comment
  - linters:
    - revive
    text: comment on exported (.*) should be of the form (.*)
    path: ^(apis/(v1alpha3|v1alpha4)\/.*)\.go$
  - linters:
    - stylecheck
    text: ST1021|ST1020
    path: ^(apis/(v1alpha3|v1alpha4)\/.*)\.go$