Documentation
¶
Index ¶
- Constants
- func RawUnifiedDiff(results []diff.Result) string
- type DiagnosticsMode
- type MarkdownOptions
- type MarkdownResult
- func DiffMarkdown(result app.DiffResult, options MarkdownOptions) ([]byte, MarkdownResult, error)
- func ImageDiffMarkdown(result app.ImageDiffResult, options MarkdownOptions) ([]byte, MarkdownResult, error)
- func WriteDiffMarkdown(w io.Writer, result app.DiffResult, options MarkdownOptions) (MarkdownResult, error)
- func WriteImageDiffMarkdown(w io.Writer, result app.ImageDiffResult, options MarkdownOptions) (MarkdownResult, error)
Constants ¶
View Source
const ( OutputMarkdown = "markdown" DefaultMaxBytes = 60000 MinPositiveMaxByte = 1024 )
Variables ¶
This section is empty.
Functions ¶
func RawUnifiedDiff ¶
Types ¶
type DiagnosticsMode ¶ added in v0.2.8
type DiagnosticsMode string
DiagnosticsMode controls how much of the diagnostics list the markdown report embeds. Summary warning/error counts are always kept.
const ( // DiagnosticsModeAll lists errors openly and collapses warnings inside a // <details> block. DiagnosticsModeAll DiagnosticsMode = "all" // DiagnosticsModeErrors lists errors openly and omits warnings entirely. DiagnosticsModeErrors DiagnosticsMode = "errors" // DiagnosticsModeNone omits the diagnostics section entirely. DiagnosticsModeNone DiagnosticsMode = "none" )
func ParseDiagnosticsMode ¶ added in v0.2.8
func ParseDiagnosticsMode(value string) (DiagnosticsMode, error)
func (DiagnosticsMode) Normalize ¶ added in v0.2.8
func (mode DiagnosticsMode) Normalize() DiagnosticsMode
func (DiagnosticsMode) Validate ¶ added in v0.2.8
func (mode DiagnosticsMode) Validate() error
type MarkdownOptions ¶
type MarkdownOptions struct {
MaxBytes int
DiagnosticLimit int
Title string
Diagnostics DiagnosticsMode
}
type MarkdownResult ¶
func DiffMarkdown ¶
func DiffMarkdown(result app.DiffResult, options MarkdownOptions) ([]byte, MarkdownResult, error)
func ImageDiffMarkdown ¶
func ImageDiffMarkdown(result app.ImageDiffResult, options MarkdownOptions) ([]byte, MarkdownResult, error)
func WriteDiffMarkdown ¶
func WriteDiffMarkdown(w io.Writer, result app.DiffResult, options MarkdownOptions) (MarkdownResult, error)
func WriteImageDiffMarkdown ¶
func WriteImageDiffMarkdown(w io.Writer, result app.ImageDiffResult, options MarkdownOptions) (MarkdownResult, error)
Source Files
Directories
Click to show internal directories.
Click to hide internal directories.