Documentation
¶
Overview ¶
Package report formats brief detection results for output.
Index ¶
- Variables
- func ArtifactHuman(w io.Writer, a *brief.Artifact)
- func ArtifactJSON(w io.Writer, a *brief.Artifact) error
- func Human(w io.Writer, r *brief.Report, verbose bool)
- func JSON(w io.Writer, r *brief.Report) error
- func Markdown(w io.Writer, r *brief.Report, verbose bool)
- func MissingHuman(w io.Writer, r *brief.MissingReport)
- func MissingJSON(w io.Writer, r *brief.MissingReport) error
- func MissingMarkdown(w io.Writer, r *brief.MissingReport)
- func SinksHuman(w io.Writer, r *brief.SinkReport)
- func SinksJSON(w io.Writer, r *brief.SinkReport) error
- func SinksMarkdown(w io.Writer, r *brief.SinkReport)
- func ThreatHuman(w io.Writer, r *brief.ThreatReport)
- func ThreatJSON(w io.Writer, r *brief.ThreatReport) error
- func ThreatMarkdown(w io.Writer, r *brief.ThreatReport)
Constants ¶
This section is empty.
Variables ¶
var CategoryLabels = map[string]string{ "test": "Test", "lint": "Lint", "format": "Format", "typecheck": "Typecheck", "docs": "Docs", "build": "Build", "native_extension": "Native Ext", "library": "Library", "codegen": "Codegen", "database": "Database", "security": "Security", "ci": "CI", "container": "Container", "infrastructure": "Infra", "monorepo": "Monorepo", "environment": "Environment", "release": "Release", "coverage": "Coverage", "dependency_bot": "Dep Updates", // contains filtered or unexported fields }
CategoryLabels maps category keys to human-readable labels.
var CategoryOrder = []string{"test", "lint", "format", "typecheck", "docs", "build", "native_extension", "library", "codegen", "database", "security", "ci", "container", "infrastructure", "monorepo", "environment", categoryI18n, "release", "coverage", "dependency_bot"}
CategoryOrder defines the stable display order for tool categories.
Functions ¶
func ArtifactHuman ¶ added in v0.11.0
ArtifactHuman writes the artifact report in human-readable format.
func ArtifactJSON ¶ added in v0.11.0
ArtifactJSON writes the artifact report as JSON.
func MissingHuman ¶ added in v0.4.0
func MissingHuman(w io.Writer, r *brief.MissingReport)
MissingHuman writes the missing report in human-readable format.
func MissingJSON ¶ added in v0.4.0
func MissingJSON(w io.Writer, r *brief.MissingReport) error
MissingJSON writes the missing report as JSON.
func MissingMarkdown ¶ added in v0.4.1
func MissingMarkdown(w io.Writer, r *brief.MissingReport)
MissingMarkdown writes the missing report in markdown format.
func SinksHuman ¶ added in v0.5.0
func SinksHuman(w io.Writer, r *brief.SinkReport)
SinksHuman writes the sink report in human-readable format, grouped by tool.
func SinksJSON ¶ added in v0.5.0
func SinksJSON(w io.Writer, r *brief.SinkReport) error
SinksJSON writes the sink report as JSON.
func SinksMarkdown ¶ added in v0.5.0
func SinksMarkdown(w io.Writer, r *brief.SinkReport)
SinksMarkdown writes the sink report in markdown format.
func ThreatHuman ¶ added in v0.5.0
func ThreatHuman(w io.Writer, r *brief.ThreatReport)
ThreatHuman writes the threat report in human-readable format.
func ThreatJSON ¶ added in v0.5.0
func ThreatJSON(w io.Writer, r *brief.ThreatReport) error
ThreatJSON writes the threat report as JSON.
func ThreatMarkdown ¶ added in v0.5.0
func ThreatMarkdown(w io.Writer, r *brief.ThreatReport)
ThreatMarkdown writes the threat report in markdown format.
Types ¶
This section is empty.
Source Files