ignore.go RawHistoryFolder

1package analyzer
2
3import (
4	"go/ast"
5	"go/token"
6	"strings"
7
8	"github.com/bnema/hexcheck/config"
9	"golang.org/x/tools/go/analysis"
10)
11
12// DirectiveCategory is the diagnostic category used for malformed
13// //hexcheck:ignore directives.
14const DirectiveCategory = "invalid-ignore-directive"
15
16const ignoreDirective = "//hexcheck:ignore"
17
18type ignoreKey struct {
19	file string
20	line int
21	rule string
22}
23
24// ignoreIndex records which rules are suppressed on which lines.
25type ignoreIndex map[ignoreKey]bool
26
27// collectIgnores indexes `//hexcheck:ignore rule[,rule] reason` directives.
28// A directive suppresses matching diagnostics on its own line and on the
29// following line. A reason is required, like config allow entries.
30func (r runner) collectIgnores(file *ast.File) {
31	known := config.DefaultRuleSeverities()
32	for _, group := range file.Comments {
33		for _, comment := range group.List {
34			rest, ok := strings.CutPrefix(comment.Text, ignoreDirective)
35			if !ok || (rest != "" && rest[0] != ' ' && rest[0] != '\t') {
36				continue
37			}
38			fields := strings.Fields(rest)
39			if len(fields) < 2 {
40				r.reportDirective(comment.Pos(), "hexcheck:ignore needs a rule list and a reason")
41				continue
42			}
43			pos := r.pass.Fset.Position(comment.Pos())
44			for rule := range strings.SplitSeq(fields[0], ",") {
45				if _, ok := known[rule]; !ok {
46					r.reportDirective(comment.Pos(), "hexcheck:ignore names unknown rule "+rule)
47					continue
48				}
49				r.ignores[ignoreKey{file: pos.Filename, line: pos.Line, rule: rule}] = true
50				r.ignores[ignoreKey{file: pos.Filename, line: pos.Line + 1, rule: rule}] = true
51			}
52		}
53	}
54}
55
56func (r runner) isIgnoredInline(pos token.Pos, rule string) bool {
57	if r.ignores == nil {
58		return false
59	}
60	p := r.pass.Fset.Position(pos)
61	return r.ignores[ignoreKey{file: p.Filename, line: p.Line, rule: rule}]
62}
63
64func (r runner) reportDirective(pos token.Pos, msg string) {
65	r.pass.Report(analysis.Diagnostic{Pos: pos, Category: DirectiveCategory, Message: "[error] " + DirectiveCategory + ": " + msg})
66}