report

Documentation

Index

• func Render(w io.Writer, r *schema.Report, format Format, opts Options) error
• type Format
• type Options

Functions

func Render

func Render(w io.Writer, r *schema.Report, format Format, opts Options) error

Types

type Format

type Format string

const (
	FormatMarkdown Format = "md"
	FormatHTML     Format = "html"
	FormatJSON     Format = "json"
)

type Options

type Options struct {
	// Public strips internal details (package list, project paths, vuln install
	// paths) — suitable for committing to a public repo.
	Public bool
	// KeyFindings, if non-nil, appends a secrets section to the report.
	KeyFindings []keyscanner.Finding
}