output

package

v0.2.1 Latest Latest Go to latest Published: Mar 1, 2026 License: Apache-2.0 Imports: 6 Imported by: 0

Details

This section is empty.

This section is empty.

func ColorizeJSON(raw []byte) []byte

ColorizeJSON adds ANSI colors to severity values for terminal display.

func FixHint(ruleID string) (string, bool)

FixHint returns a deterministic remediation hint for a rule code.

func FormatJSON(payload any, pretty bool) ([]byte, error)

FormatJSON renders the payload as JSON, optionally pretty printed.

func RenderJSONError(specFile string, exitCode int, message string, debug *Debug) (any, jsonSummary, error)

RenderJSONError builds a JSON error response when findings cannot be produced.

func RenderJSONReport(specFile string, report validate.Report, exitCode int, debug *Debug) (any, jsonSummary, error)

RenderJSONReport renders a report to JSON with the required schema.

func RenderReport(r validate.Report) string

RenderReport is kept for compatibility with existing callers.

type CheckResult struct {
	Target   string
	Report   validate.Report
	ExitCode int
}

CheckResult holds all data required by human renderers.

type ClassicRenderer struct{}

ClassicRenderer preserves the original human-readable output format.

func (ClassicRenderer) Render(result CheckResult, _ RenderOptions) string

Render renders a report in classic mode.

type Debug struct {
	InternalError string `json:"internal_error"`
	Stacktrace    string `json:"stacktrace"`
}

type HumanRenderer interface {
	Render(result CheckResult, opts RenderOptions) string
}

HumanRenderer renders human-readable output.

type RenderOptions struct {
	Width int
}

RenderOptions controls human output formatting.

type ReportRenderer struct{}

ReportRenderer renders the structured interactive report format.

func (ReportRenderer) Render(result CheckResult, opts RenderOptions) string

Render renders a report in structured report mode.

type Verdict string