obol-stack/.golangci.yml at main · ObolNetwork/obol-stack · 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"
run:
  go: "1.25"
linters:
  default: all
  disable:
    - containedctx
    - contextcheck
    - cyclop
    - depguard
    - err113
    - exhaustruct
    - forbidigo       # CLI uses fmt.Print* for user output
    - forcetypeassert
    - funlen
    - funcorder
    - gochecknoglobals
    - gocognit
    - gocyclo
    - godoclint       # don't require doc comments on all exports
    - godot
    - godox
    - gomoddirectives
    - inamedparam
    - interfacebloat
    - intrange
    - ireturn
    - lll
    - maintidx
    - mnd
    - musttag
    - nestif
    - nlreturn        # stylistic, too noisy
    - noctx           # too much to retrofit; revisit later
    - noinlineerr
    - nonamedreturns
    - paralleltest
    - prealloc
    - recvcheck
    - tagliatelle
    - testpackage     # internal test packages are fine here
    - varnamelen
    - wrapcheck       # obol-stack has no app/errors wrapper package
    - wsl
    # TODO: re-enable incrementally as issues are fixed
    # All linters re-enabled
  settings:
    dupl:
      threshold: 400
    exhaustive:
      default-signifies-exhaustive: true
    gocritic:
      disabled-checks:
        - ifElseChain
    gosec:
      excludes:
        - G115
        - G204  # CLI tool intentionally runs subprocesses (k3d, helm, kubectl)
        - G101  # false positives from variable names containing "key", "token", "secret"
    govet:
      disable:
        - fieldalignment
        - shadow
      enable-all: true
    revive:
      severity: warning
      enable-all-rules: true
      rules:
        - name: add-constant
          disabled: true
        - name: argument-limit
          disabled: true
        - name: banned-characters
          disabled: true
        - name: cognitive-complexity
          disabled: true
        - name: comment-spacings
          disabled: true
        - name: cyclomatic
          disabled: true
        - name: file-header
          disabled: true
        - name: function-length
          disabled: true
        - name: function-result-limit
          disabled: true
        - name: line-length-limit
          disabled: true
        - name: max-public-structs
          disabled: true
        - name: range-val-address
          disabled: true
        - name: unhandled-error
          disabled: true
        - name: unused-parameter
          disabled: true
        - name: unused-receiver
          disabled: true
        - name: use-fmt-print
          disabled: true
        - name: unnecessary-format
          disabled: true
        - name: enforce-switch-style
          disabled: true
        - name: unsecure-url-scheme
          disabled: true
        - name: deep-exit
          disabled: true
        # TODO: re-enable as issues are fixed
        - name: confusing-results
          disabled: true
        - name: early-return
          disabled: true
        - name: exported
          disabled: true
        - name: identical-branches
          disabled: true
        - name: identical-switch-branches
          disabled: true
        - name: if-return
          disabled: true
        - name: import-alias-naming
          disabled: true
        - name: superfluous-else
          disabled: true
        - name: unchecked-type-assertion
          disabled: true
        - name: unexported-return
          disabled: true
        - name: use-slices-sort
          disabled: true
        - name: var-naming
          disabled: true
    staticcheck:
      checks:
        - -SA1019
        - all
  exclusions:
    generated: lax
    presets:
      - comments
      - common-false-positives
      - legacy
      - std-error-handling
    rules:
      - linters:
          - bodyclose
          - errcheck
          - errchkjson
          - gosec
          - revive
          - unparam
          - goconst
        path: (.+)_test\.go
      - linters:
          - gosec
        path: internal/testutil/
      - path: (.+)\.go$
        text: error returned from interface method should be wrapped
      - path: (.+)\.go$
        text: "defer: prefer not to defer chains of function calls"
      - path: (.+)\.go$
        text: avoid control coupling
      - path: (.+)\.go$
        text: shadows an import name
      - path: (.+)\.go$
        text: confusing-naming
      - path: (.+)\.go$
        text: nested-structs
      - path: (.+)\.go$
        text: 'shadow: declaration of "err" shadows declaration'
      - linters:
          - cyclop
        path: (.+)_test\.go
issues:
  max-issues-per-linter: 0
  max-same-issues: 0
  fix: false
formatters:
  enable:
    - gofmt
    - gofumpt
    - goimports
  settings:
    gci:
      sections:
        - prefix(github.com/ObolNetwork/obol-stack)
  exclusions:
    generated: lax