reporter

Documentation

Index

• Constants
• type Lang
• type ReportLevel
• type Reporter
  • func NewReporter(format, output string, level ReportLevel) *Reporter
  • func NewReporterWithLang(format, output string, level ReportLevel, lang Lang) *Reporter
  • func (r *Reporter) Generate(report *optimizer.Report) error
  • func (r *Reporter) GenerateHTML(report *optimizer.Report) (string, error)
  • func (r *Reporter) GenerateMD(report *optimizer.Report) (string, error)
  • func (r *Reporter) GenerateTXT(report *optimizer.Report) (string, error)

Constants

const Version = "1.9.0"

Version information

Types

type Lang

type Lang string

Lang represents a supported language

const (
	LangZH Lang = "zh" // Chinese (default)
	LangEN Lang = "en" // English
)

type ReportLevel

type ReportLevel int

ReportLevel represents the verbosity level of the report

const (
	ReportLevelSummary ReportLevel = iota // Show only optimization overview
	ReportLevelChanged                    // Show overview + changed structs
	ReportLevelFull                       // Show all structs
)

type Reporter

type Reporter struct {
	// contains filtered or unexported fields
}

Reporter is the report generator

func NewReporter

func NewReporter(format, output string, level ReportLevel) *Reporter

NewReporter creates a report generator

func NewReporterWithLang

func NewReporterWithLang(format, output string, level ReportLevel, lang Lang) *Reporter

NewReporterWithLang creates a report generator (with language support)

func (*Reporter) Generate

func (r *Reporter) Generate(report *optimizer.Report) error

Generate generates the report

func (*Reporter) GenerateHTML

func (r *Reporter) GenerateHTML(report *optimizer.Report) (string, error)

GenerateHTML generates an HTML format report

func (*Reporter) GenerateMD

func (r *Reporter) GenerateMD(report *optimizer.Report) (string, error)

GenerateMD generates a Markdown format report

func (*Reporter) GenerateTXT

func (r *Reporter) GenerateTXT(report *optimizer.Report) (string, error)

GenerateTXT generates a TXT format report