.golangci.yml

# Copyright 2024 The Kubernetes Authors.
#
# Licensed under the Apache License, Version 2.0 (the 'License');
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#    http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an 'AS IS' BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

run:
  modules-download-mode: readonly
issues:
  exclude-rules:
    # gosec recommends ignoring test files
    - path: (.+)_test.go
      linters:
        - gosec
    - path: tests/e2e
      linters:
        - gosec
linters-settings:
  revive:
    rules:
      # Using += 1 instead of ++ is fine
      - name: increment-decrement
        disabled: true
  stylecheck:
    # Dot importing ginkgo and gomega is standard practice
    dot-import-whitelist:
      - "github.com/onsi/gomega"
      - "github.com/onsi/ginkgo/v2"
linters:
  enable-all: true
  disable:
    - govet # We already run with `make verify/govet`
    # We do not use
    - cyclop # Cyclomatic complexity
    - depguard # We don't guard against dependencies
    - dupl # Tracks code duplication. Too much duplication in tests. False positives in non-tests
    - execinquery # Deprecated but enabled-by-default
    - exhaustruct # Explicitly instantiating all structs is painful for K8s structs
    - exportloopref # Deprecated but enabled-by-default
    - funlen # Long func names happen
    - gocognit # Cognitive complexity
    - gocyclo # Cyclomatic complexity
    - gofumpt # We don't rely on gofumpt
    - gomnd # Magic Number Detection. Many false positives.
    - gomoddirectives # We need `replace` in `go.mod`
    - interfacebloat # No more than 10 interface methods
    - ireturn # Accept interfaces return concrete types
    - lll # Limit line length
    - maintidx # Maintainability index
    - mnd # Magic Number Detection. Many false positives
    - nestif # Don't allow too many nested if statements
    - nlreturn # Always have empty line before return
    - testpackage # Require separate test package to catch leaky unexported dependencies
    - varnamelen # Long var names happen
    - wsl # Too strict of a whitespace linter
    # Consider adding in future
    - err113 # Do not create errors dynamically from scratch. Instead, wrap static (package-level) error.
    - wrapcheck # Same as err113
    - gochecknoglobals  # Do not allow global variables
    - godox # Do not allow TODOs
    - nonamedreturns # Need to nolint/refactor a few places our code
    - paralleltest # There are many tests that aren't parallelized