reporter

Documentation

Index

• type CsvReportingConfig
• type MarkdownReportingConfig
• type Reporter
  • func NewConsoleReporter() (Reporter, error)
  • func NewCsvReporter(config CsvReportingConfig) (Reporter, error)
  • func NewMarkdownReportGenerator(config MarkdownReportingConfig) (Reporter, error)
  • func NewSummaryReporter() (Reporter, error)

Types

type CsvReportingConfig

type CsvReportingConfig struct {
	Path string
}

type MarkdownReportingConfig

type MarkdownReportingConfig struct {
	Path string
}

type Reporter

type Reporter interface {
	Name() string

	// Feed collected data to reporting module
	AddManifest(manifest *models.PackageManifest)
	AddAnalyzerEvent(event *analyzer.AnalyzerEvent)
	AddPolicyEvent(event *policy.PolicyEvent)

	// Inform reporting module to finalise (e.g. write report to file)
	Finish() error
}

func NewConsoleReporter

func NewConsoleReporter() (Reporter, error)

func NewCsvReporter

func NewCsvReporter(config CsvReportingConfig) (Reporter, error)

func NewMarkdownReportGenerator

func NewMarkdownReportGenerator(config MarkdownReportingConfig) (Reporter, error)

func NewSummaryReporter

func NewSummaryReporter() (Reporter, error)