report

package
v0.19.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jul 17, 2026 License: Apache-2.0 Imports: 10 Imported by: 0

Documentation

Overview

Package report renders a scan result in a chosen format. Each format is a Reporter over a common Data value, so the CLI (and, later, the branch diff) can emit console/markdown/HTML for humans and JSON/SARIF for machines through one interface.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func Formats

func Formats() []string

Formats lists the available format names, sorted.

Types

type Data

type Data struct {
	Release     saga.Release
	Run         engine.Result
	Verdict     norn.Result
	MinPriority string
}

Data is everything a reporter needs to render a scan.

type Reporter

type Reporter interface {
	Format() string
	Render(w io.Writer, d Data) error
}

Reporter renders Data in one format.

func For

func For(format string) (Reporter, error)

For returns the reporter for a format name.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL