reports

Documentation

Index

• type ConsoleReport
  • func (cr *ConsoleReport) Generate(report *Report)
• type Generator
• type Report
  • func New(generator Generator) *Report
  • func (r *Report) AddAnalyzers(analyzers []analyzers.Analyzer)
  • func (r *Report) AddIssues(issues []*analyzers.Issue)
  • func (r *Report) AddSources(sources []*sources.Source)
  • func (r *Report) AnalyzersRun() string
  • func (r *Report) Generate()

Types

type ConsoleReport

type ConsoleReport struct{}

ConsoleReport is a type of text-based report that writes to stdout.

func (*ConsoleReport) Generate

func (cr *ConsoleReport) Generate(report *Report)

Generate generates a text-based report.

type Generator

type Generator interface {
	Generate(*Report)
}

Generator is a type that can generate reports.

type Report

type Report struct {
	GeneratedAt time.Time
	Analyzers   []analyzers.Analyzer
	Sources     []*sources.Source
	Issues      []*analyzers.Issue
	// contains filtered or unexported fields
}

Report represents a report of issues found.

func New

func New(generator Generator) *Report

New returns a new instance of Report.

func (*Report) AddAnalyzers

func (r *Report) AddAnalyzers(analyzers []analyzers.Analyzer)

AddAnalyzers adds a list of analyzers to the report.

func (*Report) AddIssues

func (r *Report) AddIssues(issues []*analyzers.Issue)

AddIssues adds a list of issues to a report.

func (*Report) AddSources

func (r *Report) AddSources(sources []*sources.Source)

AddSources adds a list of sources to the report.

func (*Report) AnalyzersRun

func (r *Report) AnalyzersRun() string

AnalyzersRun returns a list of IDs associated with the analyzers that were run.

func (*Report) Generate

func (r *Report) Generate()

Generate generates a report.