report

Documentation

Index

• Constants
• Variables
• func ToPathUri(input string, resultClass types.ResultClass) string
• func Write(ctx context.Context, report types.Report, option flag.Options) (err error)
• type JSONWriter
  • func (jw JSONWriter) Write(_ context.Context, report types.Report) error
• type SarifWriter
  • func (sw *SarifWriter) Write(ctx context.Context, report types.Report) error
• type TemplateWriter
  • func NewTemplateWriter(output io.Writer, outputTemplate, appVersion string) (*TemplateWriter, error)
  • func (tw TemplateWriter) Write(ctx context.Context, report types.Report) error
• type Writer

Constants

const (
	SchemaVersion = 2
)

Variables

var CustomTemplateFuncMap = make(map[string]any)

CustomTemplateFuncMap is used to overwrite existing functions for testing.

Functions

func ToPathUri

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

func Write

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

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

Types

type JSONWriter

type JSONWriter struct {
	Output         io.Writer
	ListAllPkgs    bool
	ShowSuppressed bool
}

JSONWriter implements result Writer

func (JSONWriter) Write

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

Write writes the results in JSON format

type SarifWriter

type SarifWriter struct {
	Output  io.Writer
	Version string

	Target string
	// contains filtered or unexported fields
}

SarifWriter implements result Writer

func (*SarifWriter) Write

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

type TemplateWriter

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

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

func NewTemplateWriter

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

NewTemplateWriter is the factory method to return TemplateWriter object

func (TemplateWriter) Write

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

Write writes result

type Writer

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

Writer defines the result write operation