juno/.golangci.yaml at main · NethermindEth/juno · 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
version: "2"
linters:
  default: none
  enable:
    - bodyclose
    - copyloopvar
    - depguard
    - dogsled
    - dupl
    - errcheck
    - exhaustruct
    - funlen
    - gochecknoinits
    - goconst
    - gocritic
    - gocyclo
    - goprintffuncname
    - gosec
    - govet
    - ineffassign
    - intrange
    - lll
    - makezero
    - misspell
    - mnd
    - nakedret
    - nilerr
    - nilnesserr
    - noctx
    - nolintlint
    - prealloc
    - staticcheck
    - tparallel
    - unconvert
    - unparam
    - unused
    - usestdlibvars
    - usetesting
    - whitespace
  settings:
    depguard:
      rules:
        logger:
          deny:
            - pkg: github.com/sirupsen/logrus
              desc: use github.com/NethermindEth/juno/utils for logging
    dupl:
      threshold: 100
    funlen:
      lines: 120
      statements: 50
    goconst:
      min-len: 2
      min-occurrences: 3
    gocritic:
      disabled-checks:
        - sloppyReassign
        - dupImport # https://github.com/go-critic/go-critic/issues/845
        - ifElseChain
        - octalLiteral
        - whyNoLint
        - unnamedResult
        # note(rdr): when lib is called x and then you do x = x.New(). Widely used in the repo.
        #            Should we change it?
        - importShadow
      enabled-tags:
        - diagnostic
        - experimental
        - opinionated
        - performance
        - style
    gocyclo:
      min-complexity: 15
    gosec:
      excludes:
        - G115 #TODO: remove after fixing https://github.com/securego/gosec/issues/1212
    govet:
      enable:
        - nilness
    lll:
      line-length: 140 # todo(rdr): change this to 100
    mnd:
      checks:
        - argument
        - case
        - condition
        - return
      ignored-numbers:
        - "0"
        - "1"
        - "2"
        - "3"
        - "4"
        - "8"
        - "16"
        - "24"
        - "32"
    nolintlint:
      # permissive here and strict in .golangci_diff.yaml to avoid conflicts
      allow-unused: true
      require-explanation: false # todo(rdr): this should be switched to true for non test files
      require-specific: true
    prealloc:
      simple: true
      range-loops: false
      for-loops: false
    staticcheck:
      checks:
        - "all"
        # note(rdr): change if `type` to `switch type`. I would agree in general but it also applies
        #            it even if there is only one `if` and it is not possible to relax it
        - "-QF1003"
        # note(rdr): doesn't allow the use of optional embedded fields in structs. . I am not sure
        #            if it is beneficial
        - "-QF1008"
        # note: this disables deprecation warning because it is active for .golangci_diff.yaml
        - "-SA1019"
  exclusions:
    generated: lax
    presets:
      - comments
      - common-false-positives
      - legacy
      - std-error-handling
    rules:
      - linters:
          - exhaustruct
          - funlen
          - gosec
          - goconst
          - lll
          - mnd
        path: _test\.go
      - linters:
          - exhaustruct
        path-except: adapters/.+\.go
      - linters:
          - lll
        source: '^//go:generate |https?://'
      - linters:
          - staticcheck
        path: vm/state.go
        text: "ST1003.*_cgo"
formatters:
  enable:
    - gci
    - gofumpt
  exclusions:
    generated: lax
run:
  timeout: 10m