-
Notifications
You must be signed in to change notification settings - Fork 32
/
.golangci.yml
764 lines (697 loc) · 28.4 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
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
# This file contains all available configuration options
# with their default values.
# options for analysis running
run:
# default concurrency is a available CPU number
#concurrency: 4
# timeout for analysis, e.g. 30s, 5m, default is 1m
timeout: 3m
# 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:
# - mytag
# default is true. Enables skipping of directories:
# vendor$, third_party$, testdata$, examples$, Godeps$, builtin$
skip-dirs-use-default: true
# which files to skip: they will be analyzed, but issues from them
# won't be reported. Default value is empty list, but there is
# no need to include all autogenerated files, we confidently recognize
# autogenerated files. If it's not please let us know.
# "/" will be replaced by current OS file path separator to properly work
# on Windows.
# skip-files:
# - ".*\\.my\\.go$"
# - lib/bad.go
# 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|vendor|mod
# Allow multiple parallel golangci-lint instances running.
# If false (default) - golangci-lint acquires file lock on start.
allow-parallel-runners: false
# output configuration options
output:
# colored-line-number|line-number|json|tab|checkstyle|code-climate|junit-xml|github-actions
# default is "colored-line-number"
formats:
- format: colored-line-number
path: stdout
# 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
# make issues output unique by line, default is true
uniq-by-line: true
# add a prefix to the output file references; default is no prefix
path-prefix: ""
# sorts results by: filepath, line and column
sort-results: true
linters-settings:
# depguard:
# list-type: blacklist
# include-go-root: false
# packages:
# - github.com/sirupsen/logrus
# packages-with-error-message:
# # specify an error message to output when a blacklisted package is used
# - github.com/sirupsen/logrus: "logging is allowed only by logutils.Log"
#
# dupl:
# # tokens count to trigger issue, 150 by default
# threshold: 100
errcheck:
# report about not checking of errors in type assertions: `a := b.(MyStruct)`;
# default is false: such cases aren't reported by default.
check-type-assertions: false
# report about assignment of errors to blank identifier: `num, _ := strconv.Atoi(numStr)`;
# default is false: such cases aren't reported by default.
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
# errorlint:
# # Check whether fmt.Errorf uses the %w verb for formatting errors. See the readme for caveats
# errorf: true
# # Check for plain type assertions and type switches
# asserts: true
# # Check for plain error comparisons
# comparison: true
#
# exhaustive:
# # check switch statements in generated files also
# check-generated: false
# # indicates that switch statements are to be considered exhaustive if a
# # 'default' case is present, even if all enum members aren't listed in the
# # switch
# default-signifies-exhaustive: false
#
# exhaustivestruct:
# # Struct Patterns is list of expressions to match struct packages and names
# # The struct packages have the form example.com/package.ExampleStruct
# # The matching patterns can use matching syntax from https://pkg.go.dev/path#Match
# # If this list is empty, all structs are tested.
# struct-patterns:
# - '*.Test'
# - 'example.com/package.ExampleStruct'
#
# forbidigo:
# # Forbid the following identifiers (identifiers are written using regexp):
# forbid:
# - ^print.*$
# - 'fmt\.Print.*'
# # Exclude godoc examples from forbidigo checks. Default is true.
# exclude_godoc_examples: false
#
# funlen:
# lines: 100
# statements: 50
gci:
# Section configuration to compare against.
# Section names are case-insensitive and may contain parameters in ().
# The default order of sections is `standard > default > custom > blank > dot > alias > localmodule`,
# If `custom-order` is `true`, it follows the order of `sections` option.
# Default: ["standard", "default"]
sections:
- standard # Standard section: captures all standard packages.
- default # Default section: contains all imports that could not be matched to another section type.
- prefix(github.com/c2fo/) # Custom section: groups all imports with the specified Prefix.
# - blank # Blank section: contains all blank imports. This section is not present unless explicitly enabled.
# - dot # Dot section: contains all dot imports. This section is not present unless explicitly enabled.
# - alias # Alias section: contains all alias imports. This section is not present unless explicitly enabled.
# - localmodule # Local module section: contains all local packages. This section is not present unless explicitly enabled.
# Skip generated files.
# Default: true
skip-generated: true
# Enable custom order of sections.
# If `true`, make the section order the same as the order of `sections`.
# Default: false
custom-order: false
# gocognit:
# # minimal code complexity to report, 30 by default (but we recommend 10-20)
# min-complexity: 10
#
# nestif:
# # minimal complexity of if statements to report, 5 by default
# min-complexity: 4
#
# goconst:
# # minimal length of string constant, 3 by default
# min-len: 3
# # minimal occurrences count to trigger, 3 by default
# min-occurrences: 2
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:
# - rangeValCopy
# Which checks should be disabled; can't be combined with 'enabled-checks'; default is empty
disabled-checks:
- dupImport # https://github.com/go-critic/go-critic/issues/845
- ifElseChain
- octalLiteral
- whyNoLint
- wrapperFunc
- hugeParam
# Enable multiple checks by tags, run `GL_DEBUG=gocritic golangci-lint run` to see all tags and checks.
# Empty list by default. See https://github.com/go-critic/go-critic#usage -> section "Tags".
enabled-tags:
- diagnostic
- experimental
- opinionated
- performance
- style
# Settings passed to gocritic.
# The settings key is the name of a supported gocritic checker.
# The list of supported checkers can be find in https://go-critic.github.io/overview.
settings:
captLocal: # must be valid enabled check name
# whether to restrict checker to params only (default true)
paramsOnly: true
elseif:
# whether to skip balanced if-else pairs (default true)
skipBalanced: true
# hugeParam:
# size in bytes that makes the warning trigger (default 80)
# sizeThreshold: 80
nestingReduce:
# min number of statements inside a branch to trigger a warning (default 5)
bodyWidth: 5
rangeExprCopy:
# size in bytes that makes the warning trigger (default 512)
sizeThreshold: 512
# whether to check test functions (default true)
skipTestFuncs: true
rangeValCopy:
# size in bytes that makes the warning trigger (default 128)
sizeThreshold: 128
# whether to check test functions (default true)
skipTestFuncs: true
truncateCmp:
# whether to skip int/uint/uintptr types (default true)
skipArchDependent: true
underef:
# whether to skip (*x).method() calls where x is a pointer receiver (default true)
skipRecvDeref: true
unnamedResult:
# whether to check exported functions
checkExported: true
gocyclo:
# minimal code complexity to report, 30 by default (but we recommend 10-20)
min-complexity: 15
# godot:
# # comments to be checked: `declarations`, `toplevel`, or `all`
# scope: declarations
# # list of regexps for excluding particular comment lines from check
# exclude:
# # example: exclude comments which contain numbers
# # - '[0-9]+'
# # check that each sentence starts with a capital letter
# capital: false
#
# godox:
# # report any comments starting with keywords, this is useful for TODO or FIXME comments that
# # might be left in the code accidentally and should be resolved before merging
# keywords: # default keywords are TODO, BUG, and FIXME, these can be overwritten by this setting
# - NOTE
# - OPTIMIZE # marks code that should be optimized before merging
# - HACK # marks hack-arounds that should be removed before merging
gofmt:
# simplify code: gofmt with `-s` option, true by default
simplify: true
# gofumpt:
# # Select the Go version to target. The default is `1.15`.
# lang-version: "1.15"
#
# # Choose whether or not to use the extra rules that are disabled
# # by default
# extra-rules: false
#
# goheader:
# values:
# const:
# # define here const type values in format k:v, for example:
# # COMPANY: MY COMPANY
# regexp:
# # define here regexp type values, for example
# # AUTHOR: .*@mycompany\.com
# template: # |-
# # put here copyright header template for source code files, for example:
# # Note: {{ YEAR }} is a builtin value that returns the year relative to the current machine time.
# #
# # {{ AUTHOR }} {{ COMPANY }} {{ YEAR }}
# # SPDX-License-Identifier: Apache-2.0
#
# # Licensed under the Apache License, Version 2.0 (the "License");
# # you may not use this file except in compliance with the License.
# # You may obtain a copy of the License at:
#
# # http://www.apache.org/licenses/LICENSE-2.0
#
# # Unless required by applicable law or agreed to in writing, software
# # distributed under the License is distributed on an "AS IS" BASIS,
# # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# # See the License for the specific language governing permissions and
# # limitations under the License.
# template-path:
# # also as alternative of directive 'template' you may put the path to file with the template source
goimports:
# put imports beginning with prefix after 3rd-party packages;
# it's a comma-separated list of prefixes
local-prefixes: github.com/c2fo/
# golint:
# # minimal confidence for issues, default is 0.8
# min-confidence: 0.8
# gomnd:
# settings:
# mnd:
# # the list of enabled checks, see https://github.com/tommy-muehle/go-mnd/#checks for description.
# #checks: argument,case,condition,operation,return,assign
# checks: argument,case,condition,return
# # ignored-numbers: 1000
# # ignored-files: magic_.*.go
# # ignored-functions: math.*
#
# gomoddirectives:
# # Allow local `replace` directives. Default is false.
# replace-local: false
# # List of allowed `replace` directives. Default is empty.
# replace-allow-list:
# - launchpad.net/gocheck
# # Allow to not explain why the version has been retracted in the `retract` directives. Default is false.
# retract-allow-no-explanation: false
# # Forbid the use of the `exclude` directives. Default is false.
# exclude-forbidden: false
#
# gomodguard:
# allowed:
# modules: # List of allowed modules
# # - gopkg.in/yaml.v2
# domains: # List of allowed module domains
# # - golang.org
# blocked:
# modules: # List of blocked modules
# # - github.com/uudashr/go-module: # Blocked module
# # recommendations: # Recommended modules that should be used instead (Optional)
# # - golang.org/x/mod
# # reason: "`mod` is the official go.mod parser library." # Reason why the recommended module should be used (Optional)
# versions: # List of blocked module version constraints
# # - github.com/mitchellh/go-homedir: # Blocked module with version constraint
# # version: "< 1.1.0" # Version constraint, see https://github.com/Masterminds/semver#basic-comparisons
# # reason: "testing if blocked version constraint works." # Reason why the version constraint exists. (Optional)
# local_replace_directives: false
# gosec:
# # To select a subset of rules to run.
# # Available rules: https://github.com/securego/gosec#available-rules
# includes:
# - G401
# - G306
# - G101
# # To specify a set of rules to explicitly exclude.
# # Available rules: https://github.com/securego/gosec#available-rules
# excludes:
# - G204
# # To specify the configuration of rules.
# # The configuration of rules is not fully documented by gosec:
# # https://github.com/securego/gosec#configuration
# # https://github.com/securego/gosec/blob/569328eade2ccbad4ce2d0f21ee158ab5356a5cf/rules/rulelist.go#L60-L102
# config:
# G306: "0600"
# G101:
# pattern: "(?i)example"
# ignore_entropy: false
# entropy_threshold: "80.0"
# per_char_threshold: "3.0"
# truncate: "32"
gosec:
excludes:
# Flags for potentially-unsafe casting of ints, similar problem to globally-disabled G103
- G115
gosimple:
# Select the Go version to target. The default is '1.13'.
go: "1.21"
# https://staticcheck.io/docs/options#checks
checks: [ "all", "-ST1003" ]
# 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
#
# # enable or disable analyzers by name
# # run `go tool vet help` to see all analyzers
# enable:
# - atomicalign
# enable-all: false
# disable:
# - shadow
# disable-all: false
#
# ifshort:
# # Maximum length of variable declaration measured in number of lines, after which linter won't suggest using short syntax.
# # Has higher priority than max-decl-chars.
# max-decl-lines: 1
# # Maximum length of variable declaration measured in number of characters, after which linter won't suggest using short syntax.
# max-decl-chars: 30
#
# importas:
# # if set to `true`, force to use alias.
# no-unaliased: true
# # List of aliases
# alias:
# # using `servingv1` alias for `knative.dev/serving/pkg/apis/serving/v1` package
# - pkg: knative.dev/serving/pkg/apis/serving/v1
# alias: servingv1
# # using `autoscalingv1alpha1` alias for `knative.dev/serving/pkg/apis/autoscaling/v1alpha1` package
# - pkg: knative.dev/serving/pkg/apis/autoscaling/v1alpha1
# alias: autoscalingv1alpha1
# # You can specify the package path by regular expression,
# # and alias by regular expression expansion syntax like below.
# # see https://github.com/julz/importas#use-regular-expression for details
# - pkg: knative.dev/serving/pkg/apis/(\w+)/(v[\w\d]+)
# alias: $1$2
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: 140
# tab width in spaces. Default to 1.
tab-width: 1
# makezero:
# # Allow only slices initialized with a length of zero. Default is false.
# always: false
maligned:
# print struct with more effective memory layout or not, false by default
suggest-new: true
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
# 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
#
# promlinter:
# # Promlinter cannot infer all metrics name in static analysis.
# # Enable strict mode will also include the errors caused by failing to parse the args.
# strict: false
# # Please refer to https://github.com/yeya24/promlinter#usage for detailed usage.
# disabled-linters:
# # - "Help"
# # - "MetricUnits"
# # - "Counter"
# # - "HistogramSummaryReserved"
# # - "MetricTypeInName"
# # - "ReservedChars"
# # - "CamelCase"
# # - "lintUnitAbbreviations"
#
# predeclared:
# # comma-separated list of predeclared identifiers to not report on
# ignore: ""
# # include method names and field names (i.e., qualified names) in checks
# q: false
nolintlint:
# Enable to ensure that nolint directives are all used. Default is true.
allow-unused: false
# Disable to ensure that nolint directives don't have a leading space. Default is true.
allow-leading-space: true
# Exclude following linters from requiring an explanation. Default is [].
allow-no-explanation: []
# Enable to require an explanation of nonzero length after each nolint directive. Default is false.
require-explanation: false
# Enable to require nolint directives to mention the specific linter being suppressed. Default is false.
require-specific: false
revive:
# see https://github.com/mgechev/revive#available-rules for details.
ignore-generated-header: true
severity: warning
# rules:
# - name: indent-error-flow
# severity: warning
# - name: add-constant
# severity: warning
# arguments:
# - maxLitCount: "3"
# allowStrs: '""'
# allowInts: "0,1,2"
# allowFloats: "0.0,0.,1.0,1.,2.0,2."
staticcheck:
# Select the Go version to target. The default is '1.13'.
go: "1.21"
# https://staticcheck.io/docs/options#checks
checks: [ "all", "-ST1003" ]
stylecheck:
# Select the Go version to target. The default is '1.13'.
go: "1.21"
# https://staticcheck.io/docs/options#checks
checks: [ "all", "-ST1000", "-ST1003", "-ST1016", "-ST1020", "-ST1021", "-ST1022" ]
# # https://staticcheck.io/docs/options#dot_import_whitelist
# dot-import-whitelist:
# - fmt
# # https://staticcheck.io/docs/options#initialisms
# initialisms: [ "ACL", "API", "ASCII", "CPU", "CSS", "DNS", "EOF", "GUID", "HTML", "HTTP", "HTTPS", "ID", "IP", "JSON", "QPS", "RAM", "RPC", "SLA", "SMTP", "SQL", "SSH", "TCP", "TLS", "TTL", "UDP", "UI", "GID", "UID", "UUID", "URI", "URL", "UTF8", "VM", "XML", "XMPP", "XSRF", "XSS" ]
# # https://staticcheck.io/docs/options#http_status_code_whitelist
# http-status-code-whitelist: [ "200", "400", "404", "500" ]
# tagliatelle:
# # check the struck tag name case
# case:
# # use the struct field name to check the name of the struct tag
# use-field-name: true
# rules:
# # any struct tag type can be used.
# # support string case: `camel`, `pascal`, `kebab`, `snake`, `goCamel`, `goPascal`, `goKebab`, `goSnake`, `upper`, `lower`
# json: camel
# yaml: camel
# xml: camel
# bson: camel
# avro: snake
# mapstructure: kebab
#
# testpackage:
# # regexp pattern to skip files
# skip-regexp: (export|internal)_test\.go
#
# thelper:
# # The following configurations enable all checks. It can be omitted because all checks are enabled by default.
# # You can enable only required checks deleting unnecessary checks.
# test:
# first: true
# name: true
# begin: true
# benchmark:
# first: true
# name: true
# begin: true
# tb:
# first: true
# name: true
# begin: true
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
unused:
# Select the Go version to target. The default is '1.13'.
go: "1.21"
# whitespace:
# multi-if: false # Enforces newlines (or comments) after every multi-line if statement
# multi-func: false # Enforces newlines (or comments) after every multi-line function signature
#
# wrapcheck:
# # An array of strings that specify substrings of signatures to ignore.
# # If this set, it will override the default set of ignored signatures.
# # See https://github.com/tomarrell/wrapcheck#configuration for more information.
# ignoreSigs:
# - .Errorf(
# - errors.New(
# - errors.Unwrap(
# - .Wrap(
# - .Wrapf(
# - .WithMessage(
#
# wsl:
# # See https://github.com/bombsimon/wsl/blob/master/doc/configuration.md for
# # documentation of available settings. These are the defaults for
# # `golangci-lint`.
# allow-assign-and-anything: false
# allow-assign-and-call: true
# allow-cuddle-declarations: false
# allow-multiline-assign: true
# allow-separated-leading-comment: false
# allow-trailing-comment: false
# force-case-trailing-whitespace: 0
# force-err-cuddling: false
# force-short-decl-cuddling: false
# strict-append: true
#
# # The custom section can be used to define linter plugins to be loaded at runtime.
# # See README doc for more info.
# custom:
# # Each custom linter should have a unique name.
# example:
# # The path to the plugin *.so. Can be absolute or local. Required for each custom linter
# path: /path/to/example.so
# # The description of the linter. Optional, just for documentation purposes.
# description: This is an example usage of a plugin linter.
# # Intended to point to the repo location of the linter. Optional, just for documentation purposes.
# original-url: github.com/golangci/example-linter
linters:
# please, do not use `enable-all`: it's deprecated and will be removed soon.
# inverted configuration with `enable-all` and `disable` is not scalable during updates of golangci-lint
disable-all: true
enable:
- bodyclose
# - deadcode
# - depguard
# - dogsled
# - dupl **
- errcheck
# - exportloopref
# - exhaustive
# - funlen **
# - gochecknoinits
# - goconst
- gocritic
- gocyclo
- gofmt
- goimports
# - golint
# - gomnd **
# - goprintffuncname
- gosec
- gosimple
- govet
- ineffassign
- lll
# - maligned
- misspell
# - nakedret
# - noctx
- nolintlint
# - rowserrcheck
- revive
- staticcheck
# - structcheck
- stylecheck
# - typecheck
- unconvert
- unparam
- unused
# - varcheck
# - whitespace
# don't enable:
# - asciicheck
# - scopelint
# - gochecknoglobals **
# - gocognit
# - godot
# - godox **
# - goerr113 *
# - nestif
# - prealloc
# - testpackage
# - wsl
issues:
# Excluding configuration per-path, per-linter, per-text and per-source
exclude-rules:
- path: _test\.go
linters:
- gomnd
# 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
# The default value is false. If set to true exclude and exclude-rules
# regular expressions become case sensitive.
exclude-case-sensitive: false
# Which dirs to exclude: issues from them won't be reported.
# Can use regexp here: `generated.*`, regexp is applied on full path,
# including the path prefix if one is set.
# Default dirs are skipped independently of this option's value (see exclude-dirs-use-default).
# "/" will be replaced by current OS file path separator to properly work on Windows.
# Default: []
exclude-dirs:
- docs
- mocks
# The list of ids of default excludes to include or disable. By default it's empty.
# include:
# - EXC0002 # disable excluding of issues about comments from golint
# Maximum issues count per one linter. Set to 0 to disable. Default is 50.
max-issues-per-linter: 50
# Maximum count of issues with the same text. Set to 0 to disable. Default is 3.
max-same-issues: 3
# 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: false
# 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
# Fix found issues (if it's supported by the linter)
#fix: true
severity:
# Default value is empty string.
# Set the default severity for issues. If severity rules are defined and the issues
# do not match or no severity is provided to the rule this will be the default
# severity applied. Severities should match the supported severity names of the
# selected out format.
# - Code climate: https://docs.codeclimate.com/docs/issues#issue-severity
# - Checkstyle: https://checkstyle.sourceforge.io/property_types.html#severity
# - Github: https://help.github.com/en/actions/reference/workflow-commands-for-github-actions#setting-an-error-message
#default-severity: error
# The default value is false.
# If set to true severity-rules regular expressions become case sensitive.
case-sensitive: false
# Default value is empty list.
# When a list of severity rules are provided, severity information will be added to lint
# issues. Severity rules have the same filtering capability as exclude rules except you
# are allowed to specify one matcher per severity rule.
# Only affects out formats that support setting severity information.
# rules:
# - linters:
# - dupl
# severity: info