wpsecadv/.golangci.yml at main · typisttech/wpsecadv · 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
version: "2"

run:
  build-tags:
    - e2econtainer
    - e2escripts

linters:
  enable:
    # Default
    - errcheck
    - govet
    - ineffassign
    - staticcheck
    - unused
    # Custom
    - asasalint
    - asciicheck
    - bidichk
    - bodyclose
    - containedctx
    - contextcheck
    - copyloopvar
    - cyclop
    - depguard
    - dogsled
    - dupl
    - dupword
    - durationcheck
    - embeddedstructfieldcheck
    - errchkjson
    - errname
    - errorlint
    - exhaustive
    - exptostd
    - fatcontext
    - forcetypeassert
    - gocheckcompilerdirectives
    - gochecknoglobals
    - gochecknoinits
    - gocritic
    - godoclint
    - godot
    - gosec
    - misspell
    - nolintlint
    - nonamedreturns
    - revive
    - sloglint
    - unparam
    - usestdlibvars
    - wrapcheck

  settings:
    # Default
    errcheck:
      exclude-functions:
        - fmt.Fprintln(os.Stdout)
        - (net/http.ResponseWriter).Write

    govet:
      enable-all: true
      disable:
        - fieldalignment

    staticcheck:
      checks:
        - all
        - -ST1000 # at least one file in a package should have a package comment

    # Custom
    depguard:
      rules:
        all:
          files:
            - $all
          deny:
            - pkg: encoding/json$
              desc: Use 'encoding/json/v2' or 'encoding/json/jsontext'
            - pkg: github.com/stretchr/testify
              desc: Use standard library or 'github.com/google/go-cmp/cmp'
        production:
          files:
            - "**/cmd/serve/*.go"
            - "**/internal/server/*.go"
            - "**/internal/data/*.go"
            - "**/internal/packagist/*.go"
            - "!$test"
          allow:
            - $gostd
            - "github.com/typisttech/wpsecadv/internal/data$"
            - "github.com/typisttech/wpsecadv/internal/server$"
            - "github.com/typisttech/wpsecadv/internal/packagist$"
          deny:
            - pkg: encoding/json
              desc: Do not perform JSON encoding/decoding in production server

    exhaustive:
      default-signifies-exhaustive: true

    gocritic:
      enabled-checks:
        - emptyStringTest
        - httpNoBody
        - preferStringWriter

    godoclint:
      enable:
        - max-len
        - no-unused-link
        - require-stdlib-doclink

    godot:
      scope: toplevel
      capital: true

    gosec:
      excludes:
        - G104 # Handled by errcheck

    nolintlint:
      require-specific: true

    revive:
      rules:
        - name: exported
          disabled: true

    wrapcheck:
      extra-ignore-sigs:
        - encoding/json/v2.Marshal(
        - encoding/json/v2.Unmarshal(

  exclusions:
    generated: disable
    warn-unused: true
    rules:
      - source: "^\\s*defer\\s+"
        linters:
          - errcheck

      - source: "^\\s*fmt\\.Fprint(f|ln)\\(stderr,\\s+"
        linters:
          - errcheck

      - text: "^\\s*shadow: declaration of \"err\" shadows declaration at\\s+"
        linters:
          - govet

      - path: (main|store|_gen)\.go
        linters:
          - cyclop

      - path: internal/packagist/core_gen.go
        text: singleCaseSwitch
        linters:
          - gocritic

      - path: (_gen|_gen_test)\.go
        linters:
          - misspell

      - path: cmd/serve/(.+).go
        linters:
          - wrapcheck

      - path: internal/data/gen/(.+).go
        linters:
          - wrapcheck

formatters:
  enable:
    - gci
    - gofmt
    - gofumpt
    - goimports

  settings:
    gofumpt:
      extra-rules: true