reporter

Documentation

Index

• type HTMLReporter
  • func (h *HTMLReporter) Write(result docked.AnalysisResult) error
• type Reporter
• type TextReporter
  • func (t *TextReporter) Write(result docked.AnalysisResult) (err error)

Types

type HTMLReporter

type HTMLReporter struct {
	// The path to the Dockerfile
	DockerfilePath string
	// The target output directory
	OutDirectory string
}

HTMLReporter writes formatted output to an HTML file with accompanying files to OutDirectory.

func (*HTMLReporter) Write

func (h *HTMLReporter) Write(result docked.AnalysisResult) error

type Reporter

type Reporter interface {
	// Write handler for analysis results
	Write(result docked.AnalysisResult) error
}

Reporter defines necessary members for all reporter implementations

type TextReporter

type TextReporter struct {
	DisableColors bool      // Disable colors in supported terminals
	Out           io.Writer // The output stream
}

TextReporter writes formatted output in textual column format to Out. Optionally, control whether colors are output in supported terminals with DisableColors

func (*TextReporter) Write

func (t *TextReporter) Write(result docked.AnalysisResult) (err error)