README
¶
format
import "github.com/brittonhayes/pillager/pkg/format"
Package format contains the renderer and available output formats
Index
- type Custom
- type HTML
- type HTMLTable
- type JSON
- type Markdown
- type Reporter
- type Simple
- type TOML
- type Table
- type YAML
type Custom
type Custom struct {
// contains filtered or unexported fields
}
func (Custom) Report
func (c Custom) Report(w io.Writer, findings []report.Finding) error
func (*Custom) WithTemplate
func (c *Custom) WithTemplate(t string)
type HTML
type HTML struct{}
func (HTML) Report
func (h HTML) Report(w io.Writer, findings []report.Finding) error
type HTMLTable
type HTMLTable struct{}
func (HTMLTable) Report
func (h HTMLTable) Report(w io.Writer, findings []report.Finding) error
type JSON
type JSON struct{}
func (JSON) Report
func (j JSON) Report(w io.Writer, findings []report.Finding) error
type Markdown
type Markdown struct{}
func (Markdown) Report
func (m Markdown) Report(w io.Writer, findings []report.Finding) error
type Reporter
Reporter is the interface that each of the canonical output formats implement.
type Reporter interface {
Report(io.Writer, []report.Finding) error
}
func StringToReporter
func StringToReporter(s string) Reporter
StringToReporter takes in a string representation of the preferred reporter.
type Simple
type Simple struct{}
func (Simple) Report
func (s Simple) Report(w io.Writer, findings []report.Finding) error
type TOML
type TOML struct{}
func (TOML) Report
func (t TOML) Report(w io.Writer, findings []report.Finding) error
type Table
type Table struct{}
func (Table) Report
func (t Table) Report(w io.Writer, findings []report.Finding) error
type YAML
type YAML struct{}
func (YAML) Report
func (y YAML) Report(w io.Writer, findings []report.Finding) error
Generated by gomarkdoc
Documentation
¶
Overview ¶
Package format contains the renderer and available output formats
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Custom ¶ added in v0.7.0
type Custom struct {
// contains filtered or unexported fields
}
func (*Custom) WithTemplate ¶ added in v0.7.0
type Reporter ¶ added in v0.7.0
Reporter is the interface that each of the canonical output formats implement.
func StringToReporter ¶ added in v0.7.0
StringToReporter takes in a string representation of the preferred reporter.
Source Files
Click to show internal directories.
Click to hide internal directories.