Documentation
¶
Overview ¶
Package report writes scan reports in the CLI output formats.
Index ¶
- Constants
- Variables
- func Repository(ref string) string
- func SARIF(w io.Writer, reps []*scan.Report, inv Invocation) error
- func Status(f scan.Finding) string
- func Table(w io.Writer, r *scan.Report) error
- func Write(w io.Writer, format string, reps []*scan.Report, inv Invocation) error
- type Failure
- type Invocation
Constants ¶
View Source
const InformationURI = "https://github.com/movray/meles"
InformationURI is the project page named in SARIF output.
Variables ¶
View Source
var Formats = []string{"table", "json", "sarif"}
Formats lists the supported output formats.
Functions ¶
func Repository ¶
Repository returns the repository of a reference, e.g. "index.docker.io/library/alpine" for "alpine:3.20".
func SARIF ¶
SARIF writes the reports as one SARIF 2.1.0 run. Findings are errors, skipped files warnings (the scan is incomplete); entries an ignore rule takes out of the verdict are suppressed, not left out. Failed scans make the invocation unsuccessful, so that an empty result list never reads as clean.
Types ¶
type Invocation ¶
type Invocation struct {
// Version of meles.
Version string
// Failed lists the scans that ended with an error.
Failed []Failure
}
Invocation describes the run of meles, for formats that record it.
Click to show internal directories.
Click to hide internal directories.