report

package

v2.14.0 Latest Latest Go to latest Published: Nov 21, 2023 License: Apache-2.0 Imports: 11 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

This section is empty.

View Source

var Now = time.Now

Now returns the current time

func PrettyJSON(jsonBytes []byte) ([]byte, error)

PrettyJSON will indent JSON to be pretty

func WriteReports(format string, output io.Writer, reports reports, outputTemplate string) error

WriteReports writes the result to output, format as passed in argument

type JSONWriter struct {
	Output io.Writer
}

JSONWriter implements result Writer

func (jw JSONWriter) Write(reports reports) error

Write writes the reports in JSON format

type TemplateWriter struct {
	Output   io.Writer
	Template *template.Template
}

TemplateWriter write result in custom format defined by user's template

func NewTemplateWriter(output io.Writer, outputTemplate string) (*TemplateWriter, error)

NewTemplateWriter is the factory method to return TemplateWriter object

func (tw TemplateWriter) Write(reports reports) error

Write writes result

type Writer interface {
	Write(reports) error
}

Writer defines the result write operation