report

package

v0.51.0 Latest Latest Go to latest Published: May 3, 2024 License: Apache-2.0 Imports: 28 Imported by: 23

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

View Source

const (
	SchemaVersion = 2
)

View Source

var CustomTemplateFuncMap = make(map[string]interface{})

CustomTemplateFuncMap is used to overwrite existing functions for testing.

func ToPathUri(input string, resultClass types.ResultClass) string

func Write(ctx context.Context, report types.Report, option flag.Options) (err error)

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

type JSONWriter struct {
	Output io.Writer
}

JSONWriter implements result Writer

func (jw JSONWriter) Write(ctx context.Context, report types.Report) error

Write writes the results in JSON format

type SarifWriter struct {
	Output  io.Writer
	Version string

	Target string
	// contains filtered or unexported fields
}

SarifWriter implements result Writer

func (sw *SarifWriter) Write(ctx context.Context, report types.Report) error

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, appVersion string) (*TemplateWriter, error)

NewTemplateWriter is the factory method to return TemplateWriter object

func (tw TemplateWriter) Write(ctx context.Context, report types.Report) error

Write writes result

type Writer interface {
	Write(context.Context, types.Report) error
}

Writer defines the result write operation