analysis

Documentation

Index

• type Analyzer
• type Diagnostic
• type Pass
  • func (p *Pass) ReportResult(analysisName string, rule *Rule, message string, detail string)
• type Rule
• type Severity
• type TestReporter
  • func (r *TestReporter) Report(d Diagnostic)

Types

type Analyzer

type Analyzer struct {
	Name     string
	Requires []*Analyzer
	Run      func(pass *Pass) (interface{}, error)
	Rules    []*Rule
}

type Diagnostic

type Diagnostic struct {
	Severity Severity
	Title    string
	Detail   string
	Context  string `json:"Context,omitempty"`
	Name     string
}

type Pass

type Pass struct {
	AnalyzerName  string
	RootDir       string
	SourceCodeDir string
	ResultOf      map[*Analyzer]interface{}
	Report        func(string, Diagnostic)
}

func (*Pass) ReportResult

func (p *Pass) ReportResult(analysisName string, rule *Rule, message string, detail string)

type Rule

type Rule struct {
	Name      string
	Disabled  bool
	Severity  Severity
	ReportAll bool
}

type Severity

type Severity string

var (
	Error   Severity = "error"
	Warning Severity = "warning"
	OK      Severity = "ok"
)

type TestReporter

type TestReporter struct {
	ReportFunc func(d Diagnostic)
	Invoked    bool
}

func (*TestReporter) Report

func (r *TestReporter) Report(d Diagnostic)