Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
- API
  
  Reference documentation for the pkg.go.dev API
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

format

package

Go to main page

Versions in this module

v0

v0.3.0

Aug 22, 2026

Changes in this version

+ const FindingSchemaURL

+ const ReportSchemaURL

v0.2.0

Aug 16, 2026

Changes in this version

type FormatName

+ const FormatYAML

+ type YAMLFormatter struct

+ func NewYAMLFormatter() *YAMLFormatter

+ func (f *YAMLFormatter) FileExtension() string

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

+ func (f *YAMLFormatter) MediaType() string

v0.1.2

Jul 7, 2026

Changes in this version

type HTMLFormatter

+ ReferrerTag string

+ func NewHTMLFormatterWithReferrerTag(tag string) *HTMLFormatter

type MarkdownFormatter

+ ReferrerTag string

+ func NewMarkdownFormatterWithReferrerTag(tag string) *MarkdownFormatter

type TerminalFormatter

+ ReferrerTag string

+ func NewTerminalFormatterWithReferrerTag(tag string) *TerminalFormatter

v0.1.1

Jun 15, 2026

v0.1.0

Jun 13, 2026

Changes in this version

+ var FormatNames = []FormatName

+ type CLIFlags struct

+ Format string

+ NoColor bool

+ Output string

+ func RegisterFlags(fs *flag.FlagSet) *CLIFlags

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

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

+ type FormatName string

+ const FormatHTML

+ const FormatJSON

+ const FormatJSONL

+ const FormatMarkdown

+ const FormatSARIF

+ const FormatTerminal

+ type Formatter interface

+ FileExtension func() string

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

+ MediaType func() string

+ func NewFormatter(name string) (Formatter, error)

+ type HTMLFormatter struct

+ func NewHTMLFormatter() *HTMLFormatter

+ func (f *HTMLFormatter) FileExtension() string

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

+ func (f *HTMLFormatter) MediaType() string

+ type JSONFormatter struct

+ func NewJSONFormatter() *JSONFormatter

+ func (f *JSONFormatter) FileExtension() string

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

+ func (f *JSONFormatter) MediaType() string

+ type JSONLFormatter struct

+ func NewJSONLFormatter() *JSONLFormatter

+ func (f *JSONLFormatter) FileExtension() string

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

+ func (f *JSONLFormatter) MediaType() string

+ type MarkdownFormatter struct

+ func NewMarkdownFormatter() *MarkdownFormatter

+ func (f *MarkdownFormatter) FileExtension() string

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

+ func (f *MarkdownFormatter) MediaType() string

+ type SARIFFormatter struct

+ func NewSARIFFormatter() *SARIFFormatter

+ func (f *SARIFFormatter) FileExtension() string

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

+ func (f *SARIFFormatter) MediaType() string

+ type TerminalFormatter struct

+ NoColor bool

+ func NewTerminalFormatter() *TerminalFormatter

+ func NewTerminalFormatterNoColor() *TerminalFormatter

+ func (f *TerminalFormatter) FileExtension() string

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

+ func (f *TerminalFormatter) MediaType() string