report

package
v0.1.0 Latest Latest
Warning

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

 Go to latest Published: Aug 5, 2026 License: MIT Imports: 5 Imported by: 0

Documentation

Overview

Package report renders an engine.Report into human- and machine-readable formats. Formatters are the output-side adapters of the tool; they are the same regardless of whether the run came from the CLI, the HTTP API, or a connector.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func Formats 

func Formats() []string

Formats lists the supported format names.

Types

type Formatter 

type Formatter interface {
	Format(w io.Writer, r *engine.Report) error
}

Formatter renders a report to a writer.

func Get 

func Get(name string) (Formatter, error)

Get returns the formatter for a name. An empty name defaults to "table".

type JSON 

type JSON struct{}

JSON renders the full report as indented JSON.

func (JSON) Format 

func (JSON) Format(w io.Writer, r *engine.Report) error

type SARIF 

type SARIF struct{}

SARIF renders findings as a minimal SARIF 2.1.0 document, consumable by GitHub code scanning and other SARIF viewers.

func (SARIF) Format 

func (SARIF) Format(w io.Writer, r *engine.Report) error

type Table 

type Table struct{}

Table renders a compact human-readable summary and finding list.

func (Table) Format 

func (Table) Format(w io.Writer, r *engine.Report) error

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.