rule

package

v0.0.1 Latest Latest Go to latest Published: Aug 21, 2020 License: MIT Imports: 7 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/caitlinelfring/woke

Links

Open Source Insights

Documentation ¶

Index ¶

Variables
type Result
- func (r *Result) Reason() string
- func (r *Result) String() string
type Results
type Rule
- func (r *Rule) String() string
- func (r *Rule) UnmarshalYAML(unmarshal func(interface{}) error) error
type Severity
- func NewSeverity(s string) Severity
- func (s Severity) String() string

Constants ¶

This section is empty.

Variables ¶

View Source

var BlacklistRule = Rule{
	Name:         "blacklist",
	Regexp:       regexp.MustCompile(`\b(black-?list)\b`),
	Alternatives: "denylist,blocklist",
}

View Source

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

View Source

var WhitelistRule = Rule{
	Name:         "whitelist",
	Regexp:       regexp.MustCompile(`\b(white-?list)\b`),
	Alternatives: "allowlist",
}

Functions ¶

This section is empty.

Types ¶

type Result ¶

type Result struct {
	Rule     *Rule
	Match    string
	Position *token.Position
}

func (*Result) Reason ¶

func (r *Result) Reason() string

Reason outputs the suggested alternatives for this rule

func (*Result) String ¶

func (r *Result) String() string

type Results ¶

type Results struct {
	Results []Result
}

func (*Results) Add ¶

func (rs *Results) Add(r *Result)

Add adds a single Result object onto the Results stack

func (*Results) Output ¶

func (rs *Results) Output()

func (*Results) Push ¶

func (rs *Results) Push(r ...Result)

Push pushes a list of Result objects onto the Results stack

func (*Results) String ¶

func (rs *Results) String() string

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) String ¶

func (r *Rule) String() string

func (*Rule) UnmarshalYAML ¶

func (r *Rule) UnmarshalYAML(unmarshal func(interface{}) error) error

UnmarshalYAML to enforce regexp at the unmarshal level

type Severity ¶

type Severity int

const (
	SevInfo Severity = iota
	SevWarn
	SevError
)

func NewSeverity ¶

func NewSeverity(s string) Severity

func (Severity) String ¶

func (s Severity) String() string

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL