karmada/.golangci.yml at master · karmada-bot/karmada · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
# This files contains all configuration options for analysis running.
# More details please refer to: https://golangci-lint.run/usage/configuration/

version: "2"
run:
  # timeout for analysis, e.g. 30s, 5m, default timeout is disabled
  timeout: 10m

  # One of 'readonly' and 'vendor'.
  #  - readonly: the go command is disallowed from the implicit automatic updating of go.mod described above.
  #              Instead, it fails when any changes to go.mod are needed. This setting is most useful to check
  #              that go.mod does not need updates, such as in a continuous integration and testing system.
  #  - vendor: the go command assumes that the vendor directory holds the correct copies of dependencies and ignores
  #            the dependency descriptions in go.mod.
  modules-download-mode: readonly
linters:
  enable:
    - depguard
    - gocyclo
    - gosec
    - misspell
    - modernize
    - revive
    - whitespace
  settings:
    depguard:
      rules:
        main:
          deny:
            - pkg: io/ioutil
              desc: 'replaced by io and os packages since Go 1.16: https://tip.golang.org/doc/go1.16#ioutil'
            - pkg: gopkg.in/yaml.v3
              desc: 'archived since April 2, 2025; use sigs.k8s.io/yaml instead for better Kubernetes object handling'
    gocyclo:
      # minimal cyclomatic complexity to report
      min-complexity: 15
    modernize:
      disable:
        # Suggest replacing omitempty with omitzero for struct fields.
        # Disable this check for now since it introduces too many changes in our existing codebase.
        # It suggests changing metav1.ObjectMeta json tags from "metadata,omitempty" to "metadata,omitzero",
        # which is not desired as it may break existing behavior.
        # See https://pkg.go.dev/golang.org/x/tools/go/analysis/passes/modernize#hdr-Analyzer_omitzero for more details.
        - omitzero
    revive:
      rules:
        # Disable if-return as it is too strict and not always useful.
        # https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#if-return
        - name: if-return
          disabled: true
        # Disable package-comments for now since most packages in this project are primarily for internal use.
        # If we decide to provide public packages in the future, we can move them to a separate
        # repository and revisit adding package-level comments at that time.
        - name: package-comments
          disabled: true
        - name: superfluous-else
          arguments:
            - preserveScope
        - name: error-strings
        - name: error-return
        - name: receiver-naming
        - name: increment-decrement
        - name: range
        - name: error-naming
        - name: dot-imports
        - name: errorf
        - name: exported
        - name: var-declaration
        - name: blank-imports
        - name: indent-error-flow
        - name: unreachable-code
        - name: var-naming
          arguments:
            - []
            - []
            # Revive's package-name lint is too strict for our usage. We follow Effective Go instead:
            # keep package names short and accept non-unique names since the package name is only the default import name.
            # For collisions, we standardize aliases in hack/.import-aliases. Guidance: https://go.dev/doc/effective_go#package-names
            - - skip-package-name-checks: true
        - name: redefines-builtin-id
        - name: unused-parameter
        - name: context-as-argument
        - name: context-keys-type
        - name: unexported-return
        - name: time-naming
        - name: empty-block
    staticcheck:
      checks:
        - all
        # Disable QF1008 to retain embedded fields for better readability.
        - "-QF1008"
        # Disable ST1000 (staticcheck) for now since most packages in this project are primarily for internal use.
        # If we decide to provide public packages in the future, we can move them to a separate
        # repository and revisit adding package-level comments at that time.
        - "-ST1000"
  exclusions:
    generated: lax
    presets:
      - common-false-positives
      - legacy
      - std-error-handling
    paths:
      - hack/tools/preferredimports
      - (^|/)vendor($|/)
      - (^|/)third_party($|/)
      - pkg/util/lifted
formatters:
  enable:
    - gci
    - gofmt
    - goimports
  settings:
    gci:
      sections:
        - Standard
        - Default
        - Prefix(github.com/karmada-io/karmada)
    goimports:
      local-prefixes:
        - github.com/karmada-io/karmada
  exclusions:
    generated: lax
    paths:
      - hack/tools/preferredimports
      - (^|/)vendor($|/)
      - (^|/)third_party($|/)
      - pkg/util/lifted
issues:
  # Maximum issues count per one linter.
  # Set to 0 to disable.
  # Default: 50
  max-issues-per-linter: 0
  # Maximum count of issues with the same text.
  # Set to 0 to disable.
  # Default: 3
  max-same-issues: 0