report

Documentation

Index

• Constants
• func ColorEnabled(w io.Writer) bool
• func JSON(w io.Writer, r ports.Report) error
• func SARIF(w io.Writer, r ports.Report, toolVersion string) error
• func Table(w io.Writer, r ports.Report) error
• func Write(w io.Writer, format string, r ports.Report, version string) error
• func WriteFinding(w io.Writer, f domain.Finding, color bool, lastFile string) string
• func YAML(w io.Writer, r ports.Report) error

Constants

const Disclaimer = "" /* 157-byte string literal not displayed */

Functions

func ColorEnabled

func ColorEnabled(w io.Writer) bool

ColorEnabled reports whether w is a color TTY.

func JSON

func JSON(w io.Writer, r ports.Report) error

JSON writes a machine-readable report.

func SARIF

func SARIF(w io.Writer, r ports.Report, toolVersion string) error

SARIF writes SARIF 2.1.0 for CI.

func Table

func Table(w io.Writer, r ports.Report) error

Table writes a human-readable report grouped by file.

func Write

func Write(w io.Writer, format string, r ports.Report, version string) error

Write dispatches a format name.

func WriteFinding

func WriteFinding(w io.Writer, f domain.Finding, color bool, lastFile string) string

WriteFinding displays a single finding. lastFile is the preceding file header; the result is value should be passed back on the next call.

func YAML

func YAML(w io.Writer, r ports.Report) error

YAML writes the same report as YAML.