report

Documentation

Index

• type HTMLFormatter
  • func (f *HTMLFormatter) Format(report types.AuditReport) ([]byte, error)
• type JSONFormatter
  • func (f *JSONFormatter) Format(report types.AuditReport) ([]byte, error)
• type ReportFormatter
  • func GetFormatter(format string, prettyPrint bool) (ReportFormatter, error)
• type YAMLFormatter
  • func (f *YAMLFormatter) Format(report types.AuditReport) ([]byte, error)

Types

type HTMLFormatter

type HTMLFormatter struct {
	Template string
}

HTMLFormatter formats reports as HTML

func (*HTMLFormatter) Format

func (f *HTMLFormatter) Format(report types.AuditReport) ([]byte, error)

type JSONFormatter

type JSONFormatter struct {
	PrettyPrint bool
}

JSONFormatter formats reports as JSON

func (*JSONFormatter) Format

func (f *JSONFormatter) Format(report types.AuditReport) ([]byte, error)

type ReportFormatter

type ReportFormatter interface {
	Format(report types.AuditReport) ([]byte, error)
}

ReportFormatter handles report formatting

func GetFormatter

func GetFormatter(format string, prettyPrint bool) (ReportFormatter, error)

GetFormatter returns the appropriate formatter based on format string

type YAMLFormatter

type YAMLFormatter struct{}

YAMLFormatter formats reports as YAML

func (*YAMLFormatter) Format

func (f *YAMLFormatter) Format(report types.AuditReport) ([]byte, error)