tyk/.golangci.dev.yml at master · TykTechnologies/tyk · 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
version: "2"

# Options for analysis running.
run:
  # 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.
  #
  # Allowed values: readonly|vendor|mod
  # By default, it isn't set.
  modules-download-mode: readonly
  tests: true
  # Allow multiple parallel golangci-lint instances running.
  # If false (default) - golangci-lint acquires file lock on start.
  allow-parallel-runners: false
linters:
  enable:
    - dupl
    - errcheck
    - errorlint
    - forbidigo
    - gochecknoinits
    - govet
    - misspell
    - nilerr
    - noctx
    - revive
    - thelper
    - whitespace
  disable:
    - ireturn
    - paralleltest
    - tagliatelle
    - testpackage
    - varnamelen
  settings:
    errcheck:
      check-type-assertions: true
      check-blank: true
      exclude-functions:
        - (*github.com/TykTechnologies/tyk/gateway.Test).Run
        - time.Parse
        - strconv.ParseBool
        - strconv.ParseInt
    forbidigo:
      forbid:
        - pattern: ^fmt\.Print.*$
          msg: Do not commit print statements, use t.Log or Logrus.
        - pattern: ^net\/http\.(Get|Head|Post|Form).*$
          msg: Do not use top level http package functions, NewRequestWithContext is encouraged.
      exclude-godoc-examples: false
      analyze-types: true
    govet:
      disable:
        - fieldalignment
        - shadow
      enable-all: true
    misspell:
      ignore-rules:
        - tempset # temporary set, not "tempest"
    revive:
      severity: error
      enable-all-rules: false
      rules:
        - name: unused-parameter
          arguments:
            - allowRegex: ^_
          disabled: false
        - name: import-shadowing
          disabled: false
        - name: exported
          disabled: false
    whitespace:
      multi-if: true # Enforces newlines (or comments) after every multi-line if statement
      multi-func: true # Enforces newlines (or comments) after every multi-line function signature
  exclusions:
    presets:
      - comments
      - common-false-positives
      - legacy
      - std-error-handling
    rules:
      # cli package uses fmt.Print by design
      - linters:
          - forbidigo
        path: ^cli/
      # we don't want to silence test, but we want to silence
      # some known issues in them which rank lower than product.
      # generally no test code impacts the quality of product
      # code, if the test is deleted. Whatever test metrics we
      # measure are to our benefit.
      - linters:
          - errcheck
        path: (^test/|^tests/|/testutil.go|_test\.go)
        text: error return value of `[^`]+` is not checked # unsafe typecasts are common
      - linters:
          - errcheck
        path: (^test/|^tests/|/testutil.go|_test\.go)
        text: Error return value is not checked
      - linters:
          - dupl # many functions looks like dupes
          - gocyclo # many functions can be very long
          - funlen # many functions can be very long
          - gosec # tests don't have CVEs
        path: _test\.go
      - path: (.+)\.go$
        text: G404 # Use of weak random number generator (math/rand instead of crypto/rand)
      - path: (.+)\.go$
        text: SA9004 # only the first constant in this group has an explicit type
      - path: (.+)\.go$
        text: SA1019 # Warning on deprecated imports (stdlib ioutil, grpc import)
      - path: (.+)\.go$
        text: SA1029 # should not use built-in type string as key for value; define your own type to avoid collision
    paths:
      - .*\.pb\.go$
      - .*/mock/.+\.go$
      - .*/bindata.go$
      - ci
      - bin
      - webclient
      - portal
      - third_party$
      - builtin$
      - examples$
issues:
  max-issues-per-linter: 0
  max-same-issues: 0
formatters:
  enable:
    - gci # using for import formatting instead of goimports
    - gofmt # standard Go formatting
  settings:
    gci:
      sections:
        - standard  # std packages
        - default   # third-party packages
        - prefix(github.com/TykTechnologies)  # same org, different repos
        - prefix(github.com/TykTechnologies/tyk)  # same repo
        - blank     # blank imports
        - dot       # dot imports
  exclusions:
    paths:
      - third_party$
      - builtin$
      - examples$