Documentation
¶
Overview ¶
Package report renders scan results for terminals and machines.
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func JSON ¶
JSON writes results as one JSON document. Credential values are redacted unless ShowSecrets is set.
func Refs ¶
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; limit 0 means all of them.
func StatusLine ¶
StatusLine renders the one-line outcome for a target as it completes.
Types ¶
type Options ¶
type Options struct {
Color bool
ShowSecrets bool
// AllRefs lists every ref a commit is on instead of the first few.
AllRefs bool
// Providers answers where a credential of each kind is revoked. It is
// required for Text: the caller assembles it, so this package need not
// know any provider. A nil registry is a programming error and panics.
Providers *detect.Registry
}
Options control text rendering.
type Step ¶ added in v0.2.0
Step is one line of advice under a finding.
func Remediation ¶ added in v0.2.0
Remediation says what to do about a credential: what it unlocks in the scanned repositories when its provider can tell, how to revoke it, where it is still configured on this machine, and what its history needs. A credential its provider already rejects needs nothing.