forked from openebs-archive/maya
-
Notifications
You must be signed in to change notification settings - Fork 0
/
.golangci.yml
341 lines (292 loc) · 9.59 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
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
# This file contains all available
# configuration options
# options for analysis running
run:
# concurrency is the available CPU number
# default is 4
concurrency: 4
# timeout for analysis, e.g. 30s, 5m
# default is 1m
deadline: 1m
# exit code when at least one issue was found
# default is 1
issues-exit-code: 1
# include test files or not
# default is true
tests: true
# list of build tags, all linters use it
# Default is empty list
build-tags:
- maya-lint
# which dirs to skip i.e. they won't be analyzed;
# can use regexp here
# e.g. generated.*, regexp is applied on full path;
# default value is empty list,
#
# but next dirs are always skipped independently
# from this option's value
# examples
# vendor$, third_party$, testdata$, examples$, Godeps$, builtin$
skip-dirs:
- pkg/client/generated/
# which files to skip yet be analyzed, but issues
# from them won't be reported
#
# Default value is empty list
skip-files:
-
# by default isn't set
# If set we pass it to "go list -mod={option}"
# From "go help modules"
#
# If invoked with -mod=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.
#
# If invoked with -mod=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|release|vendor
modules-download-mode:
# output configuration options
output:
# colored-line-number|line-number|json|tab|checkstyle|code-climate,
# default is "colored-line-number"
format: colored-line-number
# print lines of code with issue,
# default is true
print-issued-lines: true
# print linter name in the end of issue text,
# default is true
print-linter-name: true
# all available settings of specific linters
linters-settings:
errcheck:
# report about not checking of errors in type assetions
# `a := b.(MyStruct)`
# default is false
check-type-assertions: false
# report about assignment of errors to blank identifier
# `num, _ := strconv.Atoi(numStr)`
# default is false
check-blank: false
# [deprecated] comma-separated list of pairs of the form
# pkg:regex
# the regex is used to ignore names within pkg. (default "fmt:.*").
# see https://github.com/kisielk/errcheck#the-deprecated-method
# for details
ignore: fmt:.*,io/ioutil:^Read.*
# path to a file containing a list of functions to exclude
# from checking
# see https://github.com/kisielk/errcheck#excluding-functions
# for details
#exclude: /path/to/file.txt
govet:
# report about shadowed variables
check-shadowing: true
# settings per analyzer
settings:
printf: # analyzer name, run `go tool vet help` to see all analyzers
funcs: # run `go tool vet help printf` to see available settings for `printf` analyzer
- (github.com/golangci/golangci-lint/pkg/logutils.Log).Infof
- (github.com/golangci/golangci-lint/pkg/logutils.Log).Warnf
- (github.com/golangci/golangci-lint/pkg/logutils.Log).Errorf
- (github.com/golangci/golangci-lint/pkg/logutils.Log).Fatalf
golint:
# minimal confidence for issues, default is 0.8
min-confidence: 0.8
gofmt:
# simplify code: gofmt with `-s` option, true by default
simplify: true
goimports:
# put imports beginning with prefix after 3rd-party packages;
# it's a comma-separated list of prefixes
#local-prefixes: github.com/org/project
gocyclo:
# minimal code complexity to report, 30 by default (but we recommend 10-20)
min-complexity: 10
maligned:
# print struct with more effective memory layout or not, false by default
suggest-new: true
dupl:
# tokens count to trigger issue, 150 by default
threshold: 100
goconst:
# minimal length of string constant, 3 by default
min-len: 3
# minimal occurrences count to trigger, 3 by default
min-occurrences: 3
depguard:
list-type: blacklist
include-go-root: false
#packages:
# - github.com/davecgh/go-spew/spew
misspell:
# Correct spellings using locale preferences for US or UK.
# Default is to use a neutral variety of English.
# Setting locale to US will correct the British spelling of
# 'colour' to 'color'.
locale: US
ignore-words:
- someword
lll:
# max line length, lines longer will be reported.
# Default is 120.
#
# '\t' is counted as 1 character by default, and can be
# changed with the tab-width option
line-length: 80
# tab width in spaces. Default to 1.
tab-width: 1
unused:
# treat code as a program (not a library) and report
# unused exported identifiers; default is false.
#
# XXX: if you enable this setting, unused will report a lot
# of false-positives in text editors
#
# if it's called for subdir of a project it can't find funcs
# usages. All text editor integrations with golangci-lint
# call it on a directory with the changed file.
check-exported: false
unparam:
# Inspect exported functions, default is false. Set to true
# if no external program/library imports your code.
#
# XXX: if you enable this setting, unparam will report a
# lot of false-positives in text editors
#
# if it's called for subdir of a project it can't find
# external interfaces. All text editor integrations
# with golangci-lint call it on a directory with the changed file.
check-exported: false
nakedret:
# make an issue if func has more lines of code than this
# setting and it has naked returns;
#
# default is 30
max-func-lines: 30
prealloc:
# XXX: we don't recommend using this linter before doing
# performance profiling.
#
# For most programs usage of prealloc will be a premature
# optimization.
#
# Report preallocation suggestions only on simple loops
# that have no returns/breaks/continues/gotos in them.
#
# True by default.
simple: true
range-loops: true # Report preallocation suggestions on range loops, true by default
for-loops: false # Report preallocation suggestions on for loops, false by default
gocritic:
# Which checks should be enabled; can't be combined
# with 'disabled-checks';
#
# See https://go-critic.github.io/overview#checks-overview
# To check which checks are enabled
# run `GL_DEBUG=gocritic golangci-lint run`
#
# By default list of stable checks is used.
# enabled-checks:
# -
# Which checks should be disabled; can't be combined with
# 'enabled-checks'
#
# default is empty
disabled-checks:
- regexpMust
# Enable multiple checks by tags,
# run `GL_DEBUG=gocritic golangci-lint` to see all tags and checks.
#
# Empty list by default.
# See https://github.com/go-critic/go-critic#usage -> section "Tags".
enabled-tags:
- performance
settings: # settings passed to gocritic
captLocal: # must be valid enabled check name
paramsOnly: true
rangeValCopy:
sizeThreshold: 32
linters:
enable:
- megacheck
- govet
enable-all: false
disable:
- maligned
- prealloc
disable-all: false
presets:
- bugs
- unused
fast: false
issues:
# List of regexps of issue texts to exclude,
#
# empty list by default.
#
# But independently from this option we use default
# exclude patterns, it can be disabled by
# `exclude-use-default: false`. To list all excluded by
# default patterns execute `golangci-lint run --help`
exclude:
- abcdef
# 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:
- gocyclo
- errcheck
- dupl
- gosec
# Exclude known linters from partially hard-vendored code,
# which is impossible to exclude via "nolint" comments.
- path: internal/hmac/
text: "weak cryptographic primitive"
linters:
- gosec
# Exclude some staticcheck messages
- linters:
- staticcheck
text: "SA9003:"
# Exclude lll issues for long lines with go:generate
- linters:
- lll
source: "^//go:generate "
# Independently from option `exclude` we use default exclude patterns,
# it can be disabled by this option. To list all
# excluded by default patterns execute `golangci-lint run --help`.
# Default value for this option is true.
exclude-use-default: false
# Maximum issues count per one linter
#
# Set to 0 to disable
# Default is 50
max-per-linter: 0
# Maximum count of issues with the same text.
#
# Set to 0 to disable
# Default is 3
max-same-issues: 0
# Show only new issues
# if there are unstaged changes or untracked files,
# only those changes are analyzed, else only changes in HEAD~
# are analyzed.
#
# It's a super-useful option for integration of golangci-lint
# into existing large codebase. It's not practical to fix all
# existing issues at the moment of integration
# much better don't allow issues in new code.
#
# Default is false
new: true
# Show only new issues created after git revision `REV`
#new-from-rev: REV
# Show only new issues created in git patch with set file path.
#new-from-patch: path/to/patch/file