Documentation
¶
Overview ¶
Package formatters provides output formatting for diff results.
Package formatters provides output formatting for diff results.
Package formatters provides output formatting for diff results.
Index ¶
Constants ¶
const ( FormatTerminal = "terminal" FormatMarkdown = "markdown" FormatJSON = "json" FormatHTML = "html" )
Format name constants.
const ( ModeUnified = "unified" ModeSideBySide = "side-by-side" )
Display mode constants.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Formatter ¶ added in v1.2.2
Formatter defines the interface for diff result output formatters.
type HTMLFormatter ¶ added in v1.2.2
type HTMLFormatter struct {
// contains filtered or unexported fields
}
HTMLFormatter formats diff results as a self-contained HTML report by rendering markdown through goldmark.
func NewHTMLFormatter ¶ added in v1.2.2
func NewHTMLFormatter(writer io.Writer) *HTMLFormatter
NewHTMLFormatter creates a new HTML formatter.
type JSONFormatter ¶
type JSONFormatter struct {
// contains filtered or unexported fields
}
JSONFormatter formats diff results as JSON.
func NewJSONFormatter ¶
func NewJSONFormatter(writer io.Writer) *JSONFormatter
NewJSONFormatter creates a new JSON formatter.
func NewJSONFormatterCompact ¶
func NewJSONFormatterCompact(writer io.Writer) *JSONFormatter
NewJSONFormatterCompact creates a new JSON formatter with compact output.
func (*JSONFormatter) Format ¶
func (f *JSONFormatter) Format(result *diff.Result) error
Format formats the diff result as JSON.
func (*JSONFormatter) SetPretty ¶
func (f *JSONFormatter) SetPretty(pretty bool)
SetPretty sets whether to output formatted JSON.
type MarkdownFormatter ¶
type MarkdownFormatter struct {
// contains filtered or unexported fields
}
MarkdownFormatter formats diff results as markdown.
func NewMarkdownFormatter ¶
func NewMarkdownFormatter(writer io.Writer) *MarkdownFormatter
NewMarkdownFormatter creates a new markdown formatter.
type SideBySideFormatter ¶ added in v1.2.2
type SideBySideFormatter struct {
// contains filtered or unexported fields
}
SideBySideFormatter formats diff results in a two-column terminal layout.
func NewSideBySideFormatter ¶ added in v1.2.2
func NewSideBySideFormatter(writer io.Writer) *SideBySideFormatter
NewSideBySideFormatter creates a new side-by-side terminal formatter.
type TerminalFormatter ¶
type TerminalFormatter struct {
// contains filtered or unexported fields
}
TerminalFormatter formats diff results for terminal output.
func NewTerminalFormatter ¶
func NewTerminalFormatter(writer io.Writer) *TerminalFormatter
NewTerminalFormatter creates a new terminal formatter.
Source Files