format

package
v0.3.0 Latest Latest
Warning

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

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

Documentation

Index

Constants

View Source 
const (
	ReportSchemaURL  = "https://schemas.cerberauth.com/reportx/v0.3.0/report.schema.json"
	FindingSchemaURL = "https://schemas.cerberauth.com/reportx/v0.3.0/finding.schema.json"
)

ReportSchemaURL and FindingSchemaURL point at the JSON Schemas published for reportx's JSON and JSONL output on schemas.cerberauth.com.

Variables

View Source 
var FormatNames = []FormatName{
	FormatJSON,
	FormatYAML,
	FormatJSONL,
	FormatSARIF,
	FormatMarkdown,
	FormatHTML,
	FormatTerminal,
}

Functions

This section is empty.

Types

type CLIFlags 

type CLIFlags struct {
	Format  string
	Output  string
	NoColor bool
}

func RegisterFlags 

func RegisterFlags(fs *flag.FlagSet) *CLIFlags

func (*CLIFlags) Formatter 

func (f *CLIFlags) Formatter() (Formatter, error)

func (*CLIFlags) Writer 

func (f *CLIFlags) Writer() (io.Writer, func(), error)

type FormatName 

type FormatName string
const (
	FormatJSON     FormatName = "json"
	FormatYAML     FormatName = "yaml"
	FormatJSONL    FormatName = "jsonl"
	FormatSARIF    FormatName = "sarif"
	FormatMarkdown FormatName = "markdown"
	FormatHTML     FormatName = "html"
	FormatTerminal FormatName = "terminal"
)

type Formatter 

type Formatter interface {
	Format(r *reportx.Report) ([]byte, error)
	MediaType() string
	FileExtension() string
}

func NewFormatter 

func NewFormatter(name string) (Formatter, error)

type HTMLFormatter 

type HTMLFormatter struct {
	// ReferrerTag, when set, is appended as a "ref" query param to each
	// finding's URL so clicks from the report can be attributed back.
	ReferrerTag string
}

func NewHTMLFormatter 

func NewHTMLFormatter() *HTMLFormatter

func NewHTMLFormatterWithReferrerTag added in v0.1.2 

func NewHTMLFormatterWithReferrerTag(tag string) *HTMLFormatter

NewHTMLFormatterWithReferrerTag returns an HTMLFormatter that tags finding URLs with the given referrer tag (see ReferrerTag).

func (*HTMLFormatter) FileExtension 

func (f *HTMLFormatter) FileExtension() string

func (*HTMLFormatter) Format 

func (f *HTMLFormatter) Format(r *reportx.Report) ([]byte, error)

func (*HTMLFormatter) MediaType 

func (f *HTMLFormatter) MediaType() string

type JSONFormatter 

type JSONFormatter struct{}

func NewJSONFormatter 

func NewJSONFormatter() *JSONFormatter

func (*JSONFormatter) FileExtension 

func (f *JSONFormatter) FileExtension() string

func (*JSONFormatter) Format 

func (f *JSONFormatter) Format(r *reportx.Report) ([]byte, error)

func (*JSONFormatter) MediaType 

func (f *JSONFormatter) MediaType() string

type JSONLFormatter 

type JSONLFormatter struct{}

func NewJSONLFormatter 

func NewJSONLFormatter() *JSONLFormatter

func (*JSONLFormatter) FileExtension 

func (f *JSONLFormatter) FileExtension() string

func (*JSONLFormatter) Format 

func (f *JSONLFormatter) Format(r *reportx.Report) ([]byte, error)

func (*JSONLFormatter) MediaType 

func (f *JSONLFormatter) MediaType() string

type MarkdownFormatter 

type MarkdownFormatter struct {
	// ReferrerTag, when set, is appended as a "ref" query param to each
	// finding's URL so clicks from the report can be attributed back.
	ReferrerTag string
}

func NewMarkdownFormatter 

func NewMarkdownFormatter() *MarkdownFormatter

func NewMarkdownFormatterWithReferrerTag added in v0.1.2 

func NewMarkdownFormatterWithReferrerTag(tag string) *MarkdownFormatter

NewMarkdownFormatterWithReferrerTag returns a MarkdownFormatter that tags finding URLs with the given referrer tag (see ReferrerTag).

func (*MarkdownFormatter) FileExtension 

func (f *MarkdownFormatter) FileExtension() string

func (*MarkdownFormatter) Format 

func (f *MarkdownFormatter) Format(r *reportx.Report) ([]byte, error)

func (*MarkdownFormatter) MediaType 

func (f *MarkdownFormatter) MediaType() string

type SARIFFormatter 

type SARIFFormatter struct{}

func NewSARIFFormatter 

func NewSARIFFormatter() *SARIFFormatter

func (*SARIFFormatter) FileExtension 

func (f *SARIFFormatter) FileExtension() string

func (*SARIFFormatter) Format 

func (f *SARIFFormatter) Format(r *reportx.Report) ([]byte, error)

func (*SARIFFormatter) MediaType 

func (f *SARIFFormatter) MediaType() string

type TerminalFormatter 

type TerminalFormatter struct {
	NoColor bool
	// ReferrerTag, when set, is appended as a "ref" query param to each
	// finding's URL so clicks from the report can be attributed back.
	ReferrerTag string
}

func NewTerminalFormatter 

func NewTerminalFormatter() *TerminalFormatter

func NewTerminalFormatterNoColor 

func NewTerminalFormatterNoColor() *TerminalFormatter

func NewTerminalFormatterWithReferrerTag added in v0.1.2 

func NewTerminalFormatterWithReferrerTag(tag string) *TerminalFormatter

NewTerminalFormatterWithReferrerTag returns a TerminalFormatter that tags finding URLs with the given referrer tag (see ReferrerTag).

func (*TerminalFormatter) FileExtension 

func (f *TerminalFormatter) FileExtension() string

func (*TerminalFormatter) Format 

func (f *TerminalFormatter) Format(r *reportx.Report) ([]byte, error)

func (*TerminalFormatter) MediaType 

func (f *TerminalFormatter) MediaType() string

type YAMLFormatter added in v0.2.0 

type YAMLFormatter struct{}

func NewYAMLFormatter added in v0.2.0 

func NewYAMLFormatter() *YAMLFormatter

func (*YAMLFormatter) FileExtension added in v0.2.0 

func (f *YAMLFormatter) FileExtension() string

func (*YAMLFormatter) Format added in v0.2.0 

func (f *YAMLFormatter) Format(r *reportx.Report) ([]byte, error)

func (*YAMLFormatter) MediaType added in v0.2.0 

func (f *YAMLFormatter) MediaType() string

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.