codealert

Documentation

Index

• type CodeAlert
• type CodeAlertAnalyzer
  • func (a CodeAlertAnalyzer) Analyze(ctx *ctxpb.ShipshapeContext) ([]*notepb.Note, error)
  • func (CodeAlertAnalyzer) Category() string
  • func (a CodeAlertAnalyzer) FindMatches(content string) []*notepb.Note

Types

type CodeAlert

type CodeAlert struct {
	Name        string
	File        string
	Description string
	Regexp      *regexp.Regexp
}

A CodeAlert represents a regexp being matched on files included for the alert.

type CodeAlertAnalyzer

type CodeAlertAnalyzer struct {
}

func (CodeAlertAnalyzer) Analyze

func (a CodeAlertAnalyzer) Analyze(ctx *ctxpb.ShipshapeContext) ([]*notepb.Note, error)

TODO(emso): Use file filter in code alert

func (CodeAlertAnalyzer) Category

func (CodeAlertAnalyzer) Category() string

func (CodeAlertAnalyzer) FindMatches

func (a CodeAlertAnalyzer) FindMatches(content string) []*notepb.Note

FindMatches returns an array of notes for each match in content.