Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
View Source
var BlacklistRule = Rule{ Name: "blacklist", Regexp: regexp.MustCompile(`\b(black-?list)\b`), Alternatives: "denylist,blocklist", }
BlacklistRule is the default rule for whitelist
View Source
var DefaultRules = []*Rule{ &WhitelistRule, &BlacklistRule, }
DefaultRules are the default rules in case a config file with rules is not provided
View Source
var WhitelistRule = Rule{ Name: "whitelist", Regexp: regexp.MustCompile(`\b(white-?list)\b`), Alternatives: "allowlist", }
WhitelistRule is the default rule for whitelist
Functions ¶
This section is empty.
Types ¶
type Result ¶
Result contains data about the result of a broken rule
type Results ¶
type Results struct {
Results []Result
}
Results contains a list of Result
type Rule ¶
type Rule struct {
Name string // `yaml:"name"`
Regexp *regexp.Regexp // `yaml:"regexp"`
Alternatives string // `yaml:"alternatives"`
Severity Severity
}
Rule is a linter rule
func (*Rule) UnmarshalYAML ¶
UnmarshalYAML to enforce regexp at the unmarshal level
Source Files
Click to show internal directories.
Click to hide internal directories.