vitess/.golangci.yml at main · vitessio/vitess · 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
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
version: "2"
run:
  go: "1.25"
linters:
  default: none
  enable:
    - bodyclose
    - copyloopvar
    - depguard
    - errcheck
    - govet
    - ineffassign
    - mirror
    - modernize
    - nolintlint
    - nosprintfhostport
    - prealloc
    - perfsprint
    - sqlclosecheck
    - staticcheck
    - whitespace
  settings:
    depguard:
      rules:
        use_modern_packages:
          list-mode: lax
          deny:
            - pkg: math/rand$
              desc: Please use math/rand/v2
        mysql_package_restrictions:
          list-mode: lax
          files:
            - "**/go/mysql/**"
            - "!**/go/mysql/collations/integration/**"
            - "!**/go/mysql/collations/tools/**"
          deny:
            - pkg: vitess.io/vitess/go/vt/servenv
              desc: "mysql package should not depend on servenv - this component should be usable as a library without server infrastructure dependencies"
            - pkg: github.com/spf13/pflag
              desc: "mysql package should not depend on pflag - this component should be usable as a library with explicit configuration, not global flags"
            - pkg: vitess.io/vitess/go/vt/dbconfigs
              desc: "mysql package should not depend on dbconfigs - creates servenv dependency"
        sqlparser_package_restrictions:
          list-mode: lax
          files:
            - "**/go/vt/sqlparser/**"
          deny:
            - pkg: github.com/spf13/pflag
              desc: "sqlparser package should not depend on pflag - this component should be usable as a library with explicit configuration, not global flags"
            - pkg: vitess.io/vitess/go/vt/servenv
              desc: "sqlparser should not depend on servenv - this component should be usable as a library without server infrastructure dependencies"
        schemadiff_package_restrictions:
          list-mode: lax
          files:
            - "**/go/vt/schemadiff/**"
          deny:
            - pkg: github.com/spf13/pflag
              desc: "schemadiff package should not depend on pflag - this component should be usable as a library with explicit configuration, not global flags"
            - pkg: vitess.io/vitess/go/vt/servenv
              desc: "schemadiff should not depend on servenv - this component should be usable as a library without server infrastructure dependencies"
        collations_package_restrictions:
          list-mode: lax
          files:
            - "**/go/mysql/collations/**"
            - "!**/go/mysql/collations/integration/**"
            - "!**/go/mysql/collations/tools/**"
          deny:
            - pkg: vitess.io/vitess/go/vt/servenv
              desc: "collations package should not depend on servenv - this component should be usable as a library without server infrastructure dependencies"
            - pkg: github.com/spf13/pflag
              desc: "collations package should not depend on pflag - this component should be usable as a library with explicit configuration, not global flags"
        vindexes_package_restrictions:
          list-mode: lax
          files:
            - "**/go/vt/vtgate/vindexes/**"
          deny:
            - pkg: vitess.io/vitess/go/vt/topotools
              desc: "vindexes package should not depend on topotools - creates unnecessary dependency tree"
            - pkg: github.com/spf13/pflag
              desc: "vindexes package should not depend on pflag - this component should be usable as a library with explicit configuration, not global flags"
            - pkg: vitess.io/vitess/go/vt/servenv
              desc: "vindexes should not depend on servenv - this component should be usable as a library without server infrastructure dependencies"
    errcheck:
      exclude-functions:
        - fmt.Fprint
        - fmt.Fprintf
        - io.WriteString(fmt.State)
        - io.WriteString(net/http.ResponseWriter)
        - (net.Listener).Close
        - (net/http.ResponseWriter).Write
        - (*os.File).Close
        - os.Remove
        - os.RemoveAll
        - os.Rename
        - (*github.com/spf13/cobra.Command).Help
        - (*github.com/spf13/cobra.Command).MarkFlagRequired
        - (*github.com/spf13/cobra.Command).MarkPersistentFlagRequired
        - (*github.com/spf13/cobra.Command).MarkPersistentFlagFilename
        - (*github.com/spf13/pflag.FlagSet).MarkDeprecated
        - (*google.golang.org/grpc.ClientConn).Close
        - (*google.golang.org/grpc.Server).Serve
        - (*vitess.io/vitess/go/bytes2.Buffer).Write
        - (*vitess.io/vitess/go/bytes2.Buffer).WriteByte
        - (*vitess.io/vitess/go/bytes2.Buffer).WriteString
        - (vitess.io/vitess/go/sqltypes.BinWriter).Write
        - (*vitess.io/vitess/go/vt/vttest.LocalCluster).TearDown
    staticcheck:
      checks:
        - "all"
        - "-ST1000"
        - "-ST1003"
        - "-ST1005"
        - "-ST1016"
        - "-ST1020"
        - "-ST1021"
        - "-ST1022"
        - "-QF1001"
        - "-QF1005"
  exclusions:
    generated: lax
    presets:
      - comments
      - common-false-positives
      - legacy
      - std-error-handling
    rules:
      # prealloc is being enabled incrementally, package-by-package.
      # These exclusions will be removed as packages are fixed.
      # Unfortunately golangci-lint's regex is quite limited, so
      # we must construct this big regex match for now.
      - linters:
          - prealloc
        path: ^go/(cache|cmd|event|flagutil|mysql|pools|sqltypes|stats|test|textutil|tools)/
      - linters:
          - prealloc
        path: ^go/vt/(binlog|discovery|graph|grpcclient|mysqlctl|schemadiff|sidecardb|sqlparser|throttler|topo|vitessdriver|vtadmin|vtctl|vtexplain|vtgate|vttablet|vttest|wrangler)/
      - linters:
          - errcheck
        path: ^go/vt/proto/
      - linters:
          - errcheck
          - whitespace
        path: ^go/cmd/(vtcombo|vtgateclienttest|vtorc)/
      - linters:
          - errcheck
        path: ^go/mysql/
      - linters:
          - errcheck
        path: ^go/pools/.*_test.go
      - linters:
          - errcheck
        path: ^go/sqltypes/
      - linters:
          - whitespace
        path: ^go/vt/sqlparser/ast_format_fast.go
      - linters:
          - errcheck
        path: ^go/stats/statsd/
      - linters:
          - errcheck
          - nosprintfhostport
          - sqlclosecheck
        path: ^go/test/
      - linters:
          - errcheck
        path: ^go/vt/mysqlctl/
      - linters:
          - errcheck
        path: ^go/vt/schemamanager/
      - linters:
          - errcheck
        path: ^go/vt/servenv/
      - linters:
          - errcheck
        path: ^go/vt/sqlparser/(ast_format|ast_format_fast).go
      - linters:
          - errcheck
        path: ^go/vt/throttler/.*_test.go
      - linters:
          - errcheck
        path: ^go/vt/topo/.*/*._test.go
      - linters:
          - errcheck
        path: ^go/vt/vtcombo/
      - linters:
          - errcheck
        path: ^go/vt/vtctl/[^/]*.go
      - linters:
          - errcheck
        path: ^go/vt/vtctl/grpcvtctlclient/
      - linters:
          - errcheck
        path: ^go/vt/vtctl/grpcvtctlserver/
      - linters:
          - errcheck
        path: ^go/vt/vtctld/(schema|.*_test).go
      - linters:
          - errcheck
        path: ^go/vt/vtexplain/
      - linters:
          - errcheck
        path: ^go/vt/vtgate/.*_test.go
      - linters:
          - errcheck
        path: ^go/vt/vttablet/(customrule|filelogger|grpctmserver|onlineddl|sandboxconn|tabletserver)/
      - linters:
          - errcheck
        path: ^go/vt/vttablet/tabletmanager/vreplication
      - linters:
          - errcheck
        path: ^go/vt/vttablet/(.*endtoend.*|.*_test.go)
      - linters:
          - errcheck
        path: ^go/vt/vttest
      - linters:
          - errcheck
        path: ^go/vt/wrangler
      - linters:
          - errcheck
        path: ^go/vt/zkctl
    paths:
      - examples$
formatters:
  enable:
    - goimports
    - gofumpt
  settings:
    goimports:
      local-prefixes:
        - vitess.io/vitess
  exclusions:
    generated: lax
    paths:
      - examples$
      - ^go/vt/proto/