report

package
v0.3.6 Latest Latest
Warning

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

 Go to latest Published: Oct 15, 2026 License: Apache-2.0 Imports: 11 Imported by: 0

Documentation

Index

Constants

View Source 
const (
	OutputMarkdown     = "markdown"
	DefaultMaxBytes    = 60000
	MinPositiveMaxByte = 1024
)

Variables

This section is empty.

Functions

func RawUnifiedDiff 

func RawUnifiedDiff(results []diff.Result) string

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 DiffStyle added in v0.3.6 

type DiffStyle string

DiffStyle selects how each Application's changes are written inside its markdown <details> block. Summary counts, byte budgets, and the raw and HTML side outputs always use the unified diff. 

const (
	// DiffStyleUnified embeds the unified diff in a “`diff fence.
	DiffStyleUnified DiffStyle = "unified"
	// DiffStyleDyff embeds dyff's GitHub-style structural report in a “`diff
	// fence.
	DiffStyleDyff DiffStyle = "dyff"
)

func ParseDiffStyle added in v0.3.6 

func ParseDiffStyle(value string) (DiffStyle, error)

func (DiffStyle) Normalize added in v0.3.6 

func (style DiffStyle) Normalize() DiffStyle

func (DiffStyle) Validate added in v0.3.6 

func (style DiffStyle) Validate() error

type MarkdownOptions 

type MarkdownOptions struct {
	MaxBytes        int
	DiagnosticLimit int
	Title           string
	Diagnostics     DiagnosticsMode
	DiffStyle       DiffStyle
	// ForceOpenDetails opens every application diff block. When false, a
	// single application is open and several applications stay collapsed.
	ForceOpenDetails bool
}

type MarkdownResult 

type MarkdownResult struct {
	Bytes       int
	Truncated   bool
	ShownApps   int
	OmittedApps int
}

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

View all Source files

Directories

Path Synopsis
Package dyffreport renders manifest diff results with the dyff library (https://github.com/homeport/dyff).
 Package dyffreport renders manifest diff results with the dyff library (https://github.com/homeport/dyff).

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.