report

package

v0.4.1 Latest Latest Go to latest Published: Jun 17, 2026 License: MIT Imports: 9 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/DevShedLabs/devscan

Links

Open Source Insights

Documentation ¶

Index ¶

func Render(w io.Writer, r *schema.Report, format Format, opts Options) error
func RenderOSVAdvisories(w io.Writer, advisories []advisory.OSVAdvisory, format Format, detail bool) error
type Format
type Options

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func Render ¶

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

func RenderOSVAdvisories ¶ added in v0.3.5

func RenderOSVAdvisories(w io.Writer, advisories []advisory.OSVAdvisory, format Format, detail bool) error

RenderOSVAdvisories writes OSV search results in the requested format. detail controls whether full advisory text and references are included.

Types ¶

type Format ¶

type Format string

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

type Options ¶ added in v0.1.5

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
}

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL