rule

Documentation

Index

• Variables
• type Rule
  • func (r *Rule) FindAllStringIndex(text string) [][]int
  • func (r *Rule) Reason(violation string) string
  • func (r *Rule) ReasonWithNote(violation string) string
  • func (r *Rule) String() string
• type Severity
  • func NewSeverity(s string) Severity
  • func (s *Severity) Colorize() string
  • func (s Severity) String() string
  • func (s *Severity) UnmarshalYAML(unmarshal func(interface{}) error) error

Variables

var BlacklistRule = Rule{
	Name:         "blacklist",
	Terms:        []string{"blacklist", "black-list"},
	Alternatives: []string{"blocklist"},
	Severity:     SevWarn,
}

BlacklistRule is the default rule for blacklist

var DefaultRules = []*Rule{
	&WhitelistRule,
	&BlacklistRule,
}

DefaultRules are the default rules always used

var WhitelistRule = Rule{
	Name:         "whitelist",
	Terms:        []string{"whitelist", "white-list"},
	Alternatives: []string{"allowlist"},
	Severity:     SevWarn,
}

WhitelistRule is the default rule for whitelist

Types

type Rule

type Rule struct {
	Name         string   `yaml:"name"`
	Terms        []string `yaml:"terms"`
	Alternatives []string `yaml:"alternatives"`
	Note         string   `yaml:"note"`
	Severity     Severity `yaml:"severity"`
	// contains filtered or unexported fields
}

Rule is a linter rule

func (*Rule) FindAllStringIndex

func (r *Rule) FindAllStringIndex(text string) [][]int

func (*Rule) Reason

func (r *Rule) Reason(violation string) string

Reason returns a human-readable reason for the rule violation

func (*Rule) ReasonWithNote

func (r *Rule) ReasonWithNote(violation string) string

Reason returns a human-readable reason for the rule violation with an additional note, if defined.

func (*Rule) String

func (r *Rule) String() string

type Severity

type Severity int

Severity is a log severity

const (
	// SevError translates to Error
	// This will be the default severity
	SevError Severity = iota
	// SevWarn translates to Warn
	SevWarn
	// SevInfo translates to Info
	SevInfo
)

func NewSeverity

func NewSeverity(s string) Severity

NewSeverity turns a string into a Severity

func (*Severity) Colorize

func (s *Severity) Colorize() string

func (Severity) String

func (s Severity) String() string

func (*Severity) UnmarshalYAML

func (s *Severity) UnmarshalYAML(unmarshal func(interface{}) error) error

UnmarshalYAML to unmarshal severity string