cloud-on-k8s/.golangci.yml at fe1d27504efb804b72abca2eeb99761b2d6890dc · moukoublen/cloud-on-k8s · 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
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
version: "2"
linters:
  settings:
    exhaustive:
      default-signifies-exhaustive: true

    forbidigo:
      forbid:
        - pattern: '^source\.Kind$'
          msg: "use watches.NamespacedKind (pkg/controller/common/watches) instead of source.Kind directly, so namespace-selector filtering is respected"

    goheader:
      template: |-
        Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
        or more contributor license agreements. Licensed under the Elastic License 2.0;
        you may not use this file except in compliance with the Elastic License 2.0.


    nolintlint:
      require-specific: true
      allow-unused: false

    predeclared:
      ignore:
        - min
        - max

    revive:
      enable-all-rules: false
      rules:
        - name: blank-imports
          disabled: false
        - name: context-as-argument
          disabled: false
        - name: context-keys-type
          disabled: false
        - name: dot-imports
          disabled: false
        - name: empty-block
          disabled: false
        - name: error-naming
          disabled: false
        - name: error-return
          disabled: false
        - name: error-strings
          disabled: false
        - name: errorf
          disabled: false
        - name: exported
          disabled: false
        - name: increment-decrement
          disabled: false
        - name: indent-error-flow
          disabled: false
        - name: package-comments
          disabled: false
        - name: range
          disabled: false
        - name: receiver-naming
          disabled: false
        - name: redefines-builtin-id
          disabled: false
        - name: superfluous-else
          disabled: false
        - name: time-naming
          disabled: false
        - name: unexported-return
          disabled: false
        - name: unreachable-code
          disabled: false
        - name: unused-parameter
          disabled: true
        - name: var-declaration
          disabled: false
        - name: var-naming
          disabled: false

    # https://golangci-lint.run/docs/linters/configuration/#staticcheck
    staticcheck:
      checks:
        # SAxxxx checks in https://staticcheck.dev/docs/configuration/options/#checks
        # Default: ["all", "-ST1000", "-ST1003", "-ST1016", "-ST1020", "-ST1021", "-ST1022"]
        - 'all'
        - '-ST1000'
        - '-ST1003'
        - '-ST1016'
        - '-ST1020'
        - '-ST1021'
        - '-ST1022'
        # disabled while migrating cloud-on-k8s to v2 to avoid a lot of auto-fixes
        - '-QF1008'
        - '-QF1001'

  exclusions:
    generated: lax
    presets:
      - comments
      - common-false-positives
      - legacy
      - std-error-handling
    rules:
      - linters:
          - gosec
          - unparam
          - forbidigo
        path: .*_test\.go
      - linters:
          - staticcheck
        path: pkg/controller/common/tracing/apmclientgo/client.go
        text: SA1019
      - linters:
          - staticcheck
        # added exclusion until ElasticsearchAutoscalingSpecAnnotationName is completely removed
        text: 'SA1019: .* is deprecated: the autoscaling annotation has been deprecated in favor of the ElasticsearchAutoscaler custom resource.'
      - linters:
          - staticcheck
        # added exclusion until ManagedAnnotation is completely removed
        text: 'SA1019: common.IsUnmanaged is deprecated: Migrate to IsOrchestrationPaused instead. See https://github.com/elastic/cloud-on-k8s/issues/9295.'
      - linters:
          - staticcheck
        # added exclusion until ManagedAnnotation is completely removed
        text: 'SA1019: common.ManagedAnnotation is deprecated: Use PauseOrchestrationAnnotation instead. See https://github.com/elastic/cloud-on-k8s/issues/9295.'
      - linters:
          - revive
        # revive naming rules are not that happy with our packages/var names in common/utils/shared packages
        path: '.*/(common|utils|shared|test)/.*.go|pkg/controller/(maps|elasticsearch/driver|elasticsearch/user|elasticsearch/version).*.go|hack/deployer/exec/.*.go'
        text: 'var-naming: avoid (package names that conflict with Go standard library package names|meaningless package names)'
    paths:
      - third_party$
      - builtin$
      - examples$

  default: none

  enable:
    - asciicheck
    - bodyclose
    - dogsled
    - durationcheck
    - errcheck
    - errorlint
    - exhaustive
    - forbidigo
    - forcetypeassert
    - gocritic
    - goheader
    - goprintffuncname
    - gosec
    - govet
    - importas
    - ineffassign
    - makezero
    - misspell
    - modernize
    - nakedret
    - nestif
    - nilerr
    - noctx
    - nolintlint
    - prealloc
    - predeclared
    - revive
    - staticcheck
    - thelper
    - tparallel
    - unconvert
    - unparam
    - unused
    - wastedassign
    - whitespace

issues:
  max-issues-per-linter: 25
  max-same-issues: 0
  fix: true

formatters:
  enable:
    - goimports
  settings:
    goimports:
      local-prefixes:
        - github.com/elastic/cloud-on-k8s
  exclusions:
    generated: lax
    paths:
      - third_party$
      - builtin$
      - examples$