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

run:
  timeout: 5m
  issues-exit-code: 1

linters:
  enable:
    - errcheck      # check error returns
    - govet         # suspicious constructs
    - staticcheck   # advanced static analysis (absorbs gosimple in v2)
    - unused        # unused code
    - ineffassign   # useless assignments
    - misspell      # spelling mistakes
    - gocritic      # opinionated lints
    - revive        # replacement for golint
    - unconvert     # unnecessary type conversions
    - bodyclose     # http response body not closed
    - noctx         # http requests without context
    - gosec         # security issues
    - errorlint     # error wrapping and comparison
    - nilnil        # return nil, nil
    - wastedassign  # assignments to variables never read
    - usetesting    # os.Setenv in tests instead of t.Setenv, etc.

  settings:
    govet:
      enable-all: true
      disable:
        # too many structs to reorder, risks breaking serialization
        - fieldalignment
        - shadow          # common Go pattern, too noisy
        - unusedwrite     # false positives on test data structs
    errcheck:
      check-blank: false
      exclude-functions:
        # log writes are best-effort
        - github.com/dropalldatabases/sif/internal/logger.Write
        # Close on io.Closer is idiomatic best-effort
        - (io.Closer).Close
        - (*os.File).Close
        - (*net/http.Response).Body.Close
        # fmt.Fprint* returns are rarely actionable
        - fmt.Fprint
        - fmt.Fprintf
        - fmt.Fprintln
    staticcheck:
      # QF1003/QF1012 are v2 quickfix suggestions, not bugs.
      # ST1000/ST1003 were the stylecheck linter in v1
      # (not previously enabled); skipping to match prior parity.
      checks:
        - all
        - -QF1003
        - -QF1012
        - -ST1000
        - -ST1003
    revive:
      rules:
        # stuttering names (scan.ScanResult) need breaking API changes
        - name: exported
          disabled: true
    gocritic:
      enabled-tags:
        - diagnostic
        - style
        - performance
      disabled-checks:
        - commentedOutCode   # too opinionated for a project with TODOs
        - paramTypeCombine   # style-only, not worth churn
        - unnamedResult      # style-only
        - unnecessaryDefer   # common pattern in tests
        # inverting conditions in scan logic hurts readability
        - nestingReduce
        - importShadow       # nuclei output pkg alias conflict, intentional
        - rangeValCopy       # nuclei module iterates value types, fine here
    gosec:
      excludes:
        - G104  # errcheck covers this
        - G107  # pentesting tool -- variable URLs are the whole point
        - G110  # nuclei template decompression, acceptable context
        - G301  # log/template dirs need 0755 for common tooling
        - G302  # log files intentionally world-readable for tailing
        - G304  # sif reads user-supplied wordlist paths -- intentional

  exclusions:
    rules:
      # test files get some slack
      - path: _test\.go
        linters:
          - errcheck
          - noctx
      # net.* calls predate context plumbing; refactor tracked separately
      - path: internal/scan/(ports|shodan|subdomaintakeover)\.go
        linters:
          - noctx
      # Close on concrete types errcheck can't match to (io.Closer).Close
      - path: internal/nuclei/templates/templates\.go
        text: "tarball.Close"
        linters:
          - errcheck
      - path: internal/scan/ports\.go
        text: "tcp.Close"
        linters:
          - errcheck
      - path: sif\.go
        text: "logger.Close"
        linters:
          - errcheck

issues:
  max-issues-per-linter: 50
  max-same-issues: 50