-
Notifications
You must be signed in to change notification settings - Fork 2.5k
/
.golangci.yml
249 lines (216 loc) · 7.63 KB
/
.golangci.yml
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
236
237
238
239
240
241
242
243
244
245
246
247
248
249
issues:
# Excluding configuration per-path, per-linter, per-text and per-source
exclude-rules:
# Exclude some linters from running on tests files.
- path: _test\.go
linters: [gosec, bodyclose, noctx]
- path: crossdock
linters: [noctx]
# See https://github.com/jaegertracing/jaeger/issues/4488
- path: internal/grpctest/
linters: [staticcheck]
- linters: [gocritic]
text: "dupArg"
- linters: [gocritic]
text: "exitAfterDefer"
- linters: [gocritic]
text: "appendAssign"
exclude-dirs-use-default: false
exclude-dirs:
- mocks
- thrift-0.9.2
- .*-gen
exclude-files:
- ".*.pb.go$"
max-issues-per-linter: 0
max-same-issues: 0
linters:
disable:
- errcheck
enable:
# Plain ASCII identifiers.
- asciicheck
# Checks for dangerous unicode character sequences.
- bidichk
# Checks whether HTTP response body is closed successfully.
# TODO enable this but maybe find a way to disable in tests.
- bodyclose
# Check whether the function uses a non-inherited context.
- contextcheck
# Check declaration order of types, consts, vars and funcs.
- decorder
# Checks if package imports are in a list of acceptable packages (see cfg below).
- depguard
# Check for two durations multiplied together.
- durationcheck
# Checks `Err-` prefix for var and `-Error` suffix for error type.
- errname
# Suggests to use `%w` for error-wrapping.
- errorlint
# Checks for pointers to enclosing loop variables.
- copyloopvar
- gocritic
- gofmt
- gofumpt
- goimports
# Allow or ban replace directives in go.mod
# or force explanation for retract directives.
# Maybe enable once we get rid of old sarama.
# - gomoddirectives
- gosec
# Linter that specializes in simplifying code.
- gosimple
- govet
# Detects when assignments to existing variables are not used.
- ineffassign
- misspell
# Finds naked/bare returns and requires change them.
- nakedret
# Require a bit more explicit returns.
- nilerr
# Finds sending HTTP request without context.Context.
- noctx
# Reports ill-formed or insufficient nolint directives.
- nolintlint
# Checks that fmt.Sprintf can be replaced with a faster alternative.
- perfsprint
# Fast, configurable, extensible, flexible, and beautiful linter for Go. Drop-in replacement of golint.
- revive
# Checks usage of github.com/stretchr/testify.
- testifylint
# Detects the possibility to use variables/constants from the Go standard library.
- usestdlibvars
# TODO consider adding more linters, cf. https://olegk.dev/go-linters-configuration-the-right-version
linters-settings:
depguard:
rules:
disallowed-deps:
deny:
- pkg: go.uber.org/atomic
desc: "Use 'sync/atomic' instead of go.uber.org/atomic"
- pkg: io/ioutil
desc: "Use os or io instead of io/ioutil"
- pkg: github.com/hashicorp/go-multierror
desc: "Use errors.Join instead of github.com/hashicorp/go-multierror"
- pkg: go.uber.org/multierr
desc: "Use errors.Join instead of github.com/hashicorp/go-multierror"
# crossdock-go provides assert/require similar to stretchr/testify
# but we never want to use them outside of the crossdock tests.
disallow-crossdock:
deny:
- pkg: github.com/crossdock/crossdock-go
desc: "Do not refer to crossdock from other packages"
files:
- "!**/crossdock/**"
disallow-uber/goleak:
deny:
- pkg: go.uber.org/goleak
desc: "Use github.com/jaegertracing/jaeger/pkg/testutils"
files:
- "**_test.go"
disallow-otel-contrib-translator:
deny:
- pkg: github.com/open-telemetry/opentelemetry-collector-contrib/pkg/translator/jaeger
desc: "Use jptrace package instead of opentelemetry-collector-contrib/pkg/translator/jaeger"
files:
- "!**/jptrace/**"
goimports:
local-prefixes: github.com/jaegertracing/jaeger
gosec:
# To specify a set of rules to explicitly exclude.
# Available rules: https://github.com/securego/gosec#available-rules
excludes:
- G104
- G107
- G404
- G601
govet:
enable-all: true
disable:
# There is rarely performance differences due to padding,
# the most noticable impact is memory usage. However,
# the main trace data is Protobuf-generated and we ignore
# those files from linting, so this linter is not useful.
- fieldalignment
# Disable shadow
- shadow
perfsprint:
# Optimizes even if it requires an int or uint type cast.
int-conversion: true
# Optimizes into `err.Error()` even if it is only equivalent for non-nil errors.
err-error: true
# Optimizes `fmt.Errorf`.
errorf: true
# Optimizes `fmt.Sprintf` with only one argument.
sprintf1: true
# Optimizes into strings concatenation.
strconcat: true
revive:
ignore-generated-header: true
severity: error
enable-all-rules: true
# See https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md
rules:
# not a completely bad linter, but needs clean-up and sensible width (80 is too small)
- name: line-length-limit
disabled: true
arguments: [80]
# would be ok if we could exclude the test files, but otherwise too noisy
- name: add-constant
disabled: true
# maybe enable in the future, needs more investigation
- name: cognitive-complexity
disabled: true
# not sure how different from previous one
- name: cyclomatic
disabled: true
# we use storage_v2, so...
- name: var-naming
disabled: true
# could be useful to catch issues, but needs a clean-up and some ignores
- name: unchecked-type-assertion
disabled: true
# wtf: "you have exceeded the maximum number of public struct declarations"
- name: max-public-structs
disabled: true
# TBD - often triggered in tests
- name: unhandled-error
disabled: true
# often looks like a red herring, needs investigation
- name: flag-parameter
disabled: true
# looks like a good linter, needs cleanup
- name: confusing-naming
disabled: true
# too pendantic
- name: function-length
disabled: true
# definitely a good one, needs cleanup first
- name: argument-limit
disabled: true
# maybe enable, needs invesitgation of the impact
- name: import-alias-naming
disabled: true
# maybe enable, needs invesitgation of the impact
- name: get-return
disabled: true
# investigate, could be real bugs. But didn't recent Go version changed loop variables semantics?
- name: range-val-address
disabled: true
# this is idiocy, promotes less readable code. Don't enable.
- name: var-declaration
disabled: true
# "no nested structs are allowed" - don't enable, doesn't make sense
- name: nested-structs
disabled: true
# looks useful, but requires refactoring: "calls to log.Fatal only in main() or init() functions"
- name: deep-exit
disabled: true
# this rule conflicts with nolintlint which does insist on no-space in //nolint
- name: comment-spacings
disabled: true
testifylint:
enable-all: true
run:
go: "1.22"
timeout: 20m