Skip to content

dev: simplify severity processor #4451

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Mar 4, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 5 additions & 16 deletions pkg/lint/runner.go
Original file line number Diff line number Diff line change
Expand Up @@ -328,22 +328,11 @@ func getSeverityRulesProcessor(cfg *config.Severity, log logutils.Log, files *fs
})
}

var severityRulesProcessor processors.Processor
if cfg.CaseSensitive {
severityRulesProcessor = processors.NewSeverityRulesCaseSensitive(
cfg.Default,
severityRules,
files,
log.Child(logutils.DebugKeySeverityRules),
)
} else {
severityRulesProcessor = processors.NewSeverityRules(
cfg.Default,
severityRules,
files,
log.Child(logutils.DebugKeySeverityRules),
)
severityOpts := processors.SeverityOptions{
Default: cfg.Default,
Rules: severityRules,
CaseSensitive: cfg.CaseSensitive,
}

return severityRulesProcessor
return processors.NewSeverity(log.Child(logutils.DebugKeySeverityRules), files, severityOpts)
}
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@ import (
"github.com/golangci/golangci-lint/pkg/result"
)

var _ Processor = &Severity{}

type severityRule struct {
baseRule
severity string
Expand All @@ -18,53 +20,47 @@ type SeverityRule struct {
Severity string
}

type SeverityRules struct {
type SeverityOptions struct {
Default string
Rules []SeverityRule
CaseSensitive bool
}

type Severity struct {
name string

log logutils.Log

files *fsutils.Files

defaultSeverity string
rules []severityRule
files *fsutils.Files
log logutils.Log
}

func NewSeverityRules(defaultSeverity string, rules []SeverityRule, files *fsutils.Files, log logutils.Log) *SeverityRules {
r := &SeverityRules{
func NewSeverity(log logutils.Log, files *fsutils.Files, opts SeverityOptions) *Severity {
p := &Severity{
name: "severity-rules",
files: files,
log: log,
defaultSeverity: defaultSeverity,
defaultSeverity: opts.Default,
}
r.rules = createSeverityRules(rules, "(?i)")

return r
}

func createSeverityRules(rules []SeverityRule, prefix string) []severityRule {
parsedRules := make([]severityRule, 0, len(rules))
for _, rule := range rules {
parsedRule := severityRule{}
parsedRule.linters = rule.Linters
parsedRule.severity = rule.Severity
if rule.Text != "" {
parsedRule.text = regexp.MustCompile(prefix + rule.Text)
}
if rule.Source != "" {
parsedRule.source = regexp.MustCompile(prefix + rule.Source)
}
if rule.Path != "" {
path := fsutils.NormalizePathInRegex(rule.Path)
parsedRule.path = regexp.MustCompile(path)
}
if rule.PathExcept != "" {
pathExcept := fsutils.NormalizePathInRegex(rule.PathExcept)
parsedRule.pathExcept = regexp.MustCompile(pathExcept)
}
parsedRules = append(parsedRules, parsedRule)
prefix := "(?i)"
if opts.CaseSensitive {
prefix = ""
p.name = "severity-rules-case-sensitive"
}
return parsedRules

p.rules = createSeverityRules(opts.Rules, prefix)

return p
}

func (p SeverityRules) Process(issues []result.Issue) ([]result.Issue, error) {
func (p *Severity) Process(issues []result.Issue) ([]result.Issue, error) {
if len(p.rules) == 0 && p.defaultSeverity == "" {
return issues, nil
}

return transformIssues(issues, func(i *result.Issue) *result.Issue {
for _, rule := range p.rules {
rule := rule
Expand All @@ -79,30 +75,45 @@ func (p SeverityRules) Process(issues []result.Issue) ([]result.Issue, error) {
return i
}
}

i.Severity = p.defaultSeverity

return i
}), nil
}

func (SeverityRules) Name() string { return "severity-rules" }
func (SeverityRules) Finish() {}
func (p *Severity) Name() string { return p.name }

var _ Processor = SeverityRules{}
func (*Severity) Finish() {}

type SeverityRulesCaseSensitive struct {
*SeverityRules
}
func createSeverityRules(rules []SeverityRule, prefix string) []severityRule {
parsedRules := make([]severityRule, 0, len(rules))

func NewSeverityRulesCaseSensitive(defaultSeverity string, rules []SeverityRule,
files *fsutils.Files, log logutils.Log) *SeverityRulesCaseSensitive {
r := &SeverityRules{
files: files,
log: log,
defaultSeverity: defaultSeverity,
for _, rule := range rules {
parsedRule := severityRule{}
parsedRule.linters = rule.Linters
parsedRule.severity = rule.Severity

if rule.Text != "" {
parsedRule.text = regexp.MustCompile(prefix + rule.Text)
}

if rule.Source != "" {
parsedRule.source = regexp.MustCompile(prefix + rule.Source)
}

if rule.Path != "" {
path := fsutils.NormalizePathInRegex(rule.Path)
parsedRule.path = regexp.MustCompile(path)
}

if rule.PathExcept != "" {
pathExcept := fsutils.NormalizePathInRegex(rule.PathExcept)
parsedRule.pathExcept = regexp.MustCompile(pathExcept)
}

parsedRules = append(parsedRules, parsedRule)
}
r.rules = createSeverityRules(rules, "")

return &SeverityRulesCaseSensitive{r}
return parsedRules
}

func (SeverityRulesCaseSensitive) Name() string { return "severity-rules-case-sensitive" }
Loading