report

package

v0.1.2 Latest Latest Go to latest Published: Sep 12, 2026 License: MIT Imports: 8 Imported by: 0

Details

Package report renders scan results for terminals and machines.

This section is empty.

This section is empty.

func JSON(w io.Writer, results []scan.Result, o Options) error

JSON writes results as one JSON document. Token values are redacted unless ShowSecrets is set.

func Refs(refs []string, limit int) string

Refs renders ref names compactly: branches by name (default branches first), tags as "tag v1", pull request refs as "PR #12", at most limit entries.

func StatusLine(r scan.Result, o Options) string

StatusLine renders the one-line outcome for a target as it completes.

func Text(w io.Writer, results []scan.Result, o Options)

Text writes the final report: every distinct token with all the places it was found, followed by a summary line.

type Options struct {
	Color       bool
	ShowSecrets bool
}

Options control text rendering.

type Output struct {
	Summary summary       `json:"summary"`
	Results []scan.Result `json:"results"`
}

Output is the JSON document written by JSON.