linters:

disable-all: true

enable:

- asciicheck

- bodyclose

- containedctx

- copyloopvar

- depguard

- dogsled

- errcheck

- gci

- goconst

- gocritic

- gofmt

- goimports

- goprintffuncname

- gosec

- gosimple

- govet

- importas

- ineffassign

- misspell

- nakedret

- nilerr

- noctx

- nolintlint

- prealloc

- predeclared

- revive

- rowserrcheck

- staticcheck

- stylecheck

- thelper

- typecheck

- unconvert

- unparam

- unused

- whitespace

linters-settings:

godot:

# declarations - for top level declaration comments (default);

# toplevel - for top level comments;

# all - for all comments.

scope: toplevel

exclude:

- '^ \+.*'

- '^ ANCHOR.*'

ifshort:

# Maximum length of variable declaration measured in number of characters, after which linter won't suggest using short syntax.

max-decl-chars: 50

gci:

sections:

- standard

- default

- prefix(github.com/kubesphere/kubekey)

depguard:

rules:

main:

deny:

# Disable depguard for this project

allow:

- $all

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

# Controller Runtime

- pkg: sigs.k8s.io/controller-runtime

alias: ctrl

# CABPK

- pkg: sigs.k8s.io/cluster-api/bootstrap/kubeadm/api/v1alpha3

alias: bootstrapv1alpha3

- pkg: sigs.k8s.io/cluster-api/bootstrap/kubeadm/api/v1alpha4

alias: bootstrapv1alpha4

- pkg: sigs.k8s.io/cluster-api/bootstrap/kubeadm/api/v1beta1

alias: bootstrapv1

# KCP

- pkg: sigs.k8s.io/cluster-api/controlplane/kubeadm/api/v1alpha3

alias: controlplanev1alpha3

- pkg: sigs.k8s.io/cluster-api/controlplane/kubeadm/api/v1alpha4

alias: controlplanev1alpha4

- pkg: sigs.k8s.io/cluster-api/controlplane/kubeadm/api/v1beta1

alias: controlplanev1

# CAPI

- pkg: sigs.k8s.io/cluster-api/api/v1alpha3

alias: clusterv1alpha3

- pkg: sigs.k8s.io/cluster-api/api/v1alpha4

alias: clusterv1alpha4

- pkg: sigs.k8s.io/cluster-api/api/v1beta1

alias: clusterv1

# CAPI exp

- pkg: sigs.k8s.io/cluster-api/exp/api/v1alpha3

alias: expv1alpha3

- pkg: sigs.k8s.io/cluster-api/exp/api/v1alpha4

alias: expv1alpha4

- pkg: sigs.k8s.io/cluster-api/exp/api/v1beta1

alias: expv1

# CAPI exp addons

- pkg: sigs.k8s.io/cluster-api/exp/addons/api/v1alpha3

alias: addonsv1alpha3

- pkg: sigs.k8s.io/cluster-api/exp/addons/api/v1alpha4

alias: addonsv1alpha4

- pkg: sigs.k8s.io/cluster-api/exp/addons/api/v1beta1

alias: addonsv1

# CAPI exp runtime

- pkg: sigs.k8s.io/cluster-api/exp/runtime/api/v1alpha1

alias: runtimev1

- pkg: sigs.k8s.io/cluster-api/exp/runtime/hooks/api/v1alpha1

alias: runtimehooksv1

- pkg: sigs.k8s.io/cluster-api/exp/runtime/controllers

alias: runtimecontrollers

- pkg: sigs.k8s.io/cluster-api/exp/runtime/catalog

alias: runtimecatalog

- pkg: sigs.k8s.io/cluster-api/internal/runtime/client

alias: runtimeclient

- pkg: sigs.k8s.io/cluster-api/internal/runtime/registry

alias: runtimeregistry

- pkg: sigs.k8s.io/cluster-api/internal/webhooks/runtime

alias: runtimewebhooks

# CAPKK

- pkg: github.com/kubesphere/kubekey/v3/api/v1beta1

alias: infrav1

- pkg: github.com/kubesphere/kubekey/v3/bootstrap/k3s/api/v1beta1

alias: infrabootstrapv1

- pkg: github.com/kubesphere/kubekey/v3/controlplane/k3s/api/v1beta1

alias: infracontrolplanev1

nolintlint:

allow-unused: false

require-specific: true

gosec:

excludes:

- G301 # Directory permissions

- G601 # Implicit memory aliasing in for loop

- G115 # Integer overflow conversion

- G106 # SSH InsecureIgnoreHostKey

- G302 # File permissions

- G304 # File path provided as taint input

- G306 # Write to a file with weak permissions

- G307 # Deferring unsafe method Close

- G108 # Profiling endpoint is automatically exposed on /debug/pprof

- G402 # Look for bad TLS connection settings

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 # TODO This is a recommended rule with many findings which may require it's own pr.

- 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 # TODO This is a recommended rule with many findings which may require it's own pr.

- name: unreachable-code

- name: redefines-builtin-id

#

# Rules in addition to the recommended configuration above.

#

- name: bool-literal-in-expr

- name: constant-logical-expr

gocritic:

enabled-tags:

- experimental

disabled-checks:

- appendAssign

- dupImport # https://github.com/go-critic/go-critic/issues/845

- evalOrder

- ifElseChain

- octalLiteral

- regexpSimplify

- sloppyReassign

- truncateCmp

- typeDefFirst

- unnamedResult

- unnecessaryDefer

- whyNoLint

- wrapperFunc

- commentFormatting

- filepathJoin

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-files:

- "zz_generated.*\\.go$"

- "vendored_openapi\\.go$"

- "cmd"

exclude-rules:

# Disable depguard for all files since it's too restrictive

- linters:

- depguard

text: ".*"

# Disable copyloopvar for test files (Go 1.22+ loop variable scoping)

- linters:

- copyloopvar

text: "The copy of the 'for' variable.*can be deleted"

path: ".*_test\\.go$"

# Disable gci formatting issues for kubebuilder scaffold comments

- linters:

- gci

text: "File is not properly formatted"

source: "//\\+kubebuilder:scaffold:imports"

# Disable specific gocritic rules

- linters:

- gocritic

text: "uncheckedInlineErr:"

- linters:

- gocritic

text: "preferFprint:"

# Disable nakedret for specific functions

- linters:

- nakedret

text: "naked return in func"

# Disable staticcheck SA1019 for rand.Seed deprecation

- linters:

- staticcheck

text: "SA1019: rand.Seed has been deprecated"

# Disable unparam for controller methods that always return nil

- linters:

- unparam

text: "result 0.*is always nil"

path: "controllers/.*"

- linters:

- unparam

text: "result 0.*is always nil"

path: "controlplane/.*"

# Disable nolintlint for test files with gosec directives

- linters:

- nolintlint

text: "directive.*is unused for linter \"gosec\""

path: "test/.*"

# Disable gosec rules that are too restrictive for this project

- linters:

- gosec

text: "G301: Expect directory permissions to be 0750 or less"

- linters:

- gosec

text: "G601: Implicit memory aliasing in for loop"

- linters:

- gosec

text: "G115: integer overflow conversion"

- 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 revive's exported for certain packages and code, e.g. tests and fake.

- linters:

- revive

text: exported (method|function|type|const) (.+) should have comment or be unexported

source: (func|type).*Fake.*

- linters:

- revive

text: exported (method|function|type|const) (.+) should have comment or be unexported

path: fake_\.go

- linters:

- revive

text: exported (method|function|type|const) (.+) should have comment or be unexported

path: .*test/(providers|framework|e2e).*.go

- linters:

- errcheck

text: Error return value is not checked

path: _test\.go

- linters:

- errcheck

text: Error return value of (.+) is not checked

path: _test\.go

- linters:

- gosec

text: "G108: Profiling endpoint is automatically exposed on /debug/pprof"

- linters:

- godot

text: "Comment should end in a period"

path: "(.*)/(v1beta1|v1beta2)/(.*)types.go"

- 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

# With Go 1.16, the new embed directive can be used with an un-named import,

# revive (previously, golint) only allows these to be imported in a main.go, which wouldn't work for us.

# This directive allows the embed package to be imported with an underscore everywhere.

- linters:

- revive

source: _ "embed"

# This directive allows the variable in defaults.go files to have underscore

- linters:

- revive

text: "var-naming: don't use underscores in Go names; func (.+) should be (.+)"

path: .*/defaults.go

# Disable unparam "always receives" which might not be really

# useful when building libraries.

- linters:

- unparam

text: always receives

# Dot imports for gomega or ginkgo are allowed

# within test files.

- path: _test\.go

text: should not use dot imports

- path: (framework|e2e)/.*.go

text: should not use dot imports

- path: _test\.go

text: cyclomatic complexity

- linters:

- unparam

text: (.+) - (`t`|`g`) is unused

- path: _test\.go

text: cyclomatic complexity

# Append should be able to assign to a different var/slice.

- linters:

- gocritic

text: "appendAssign: append result not assigned to the same slice"

# We don't care about defer in for loops in test files.

- linters:

- gocritic

text: "deferInLoop: Possible resource leak, 'defer' is called in the 'for' loop"

path: _test\.go

run:

timeout: 10m

go: "1.23"

build-tags:

- tools

- e2e

- containers_image_openpgp

- exclude_graphdriver_devicemapper

- exclude_graphdriver_btrfs

allow-parallel-runners: true