printer

package

v1.13.0 Latest Latest Go to latest Published: May 17, 2026 License: AGPL-3.0 Imports: 21 Imported by: 0

Details

Rendered for

View Source

const (
	FormatText = "text"
	FormatJSON = "json"
	FormatHTML = "html"
	FormatSVG  = "svg"
)

View Source

var ErrTemplateInvalid = errors.New("template invalid")

View Source

var SupportedFormats = []string{FormatText, FormatJSON, FormatHTML, FormatSVG}

SupportedFormats lists every format accepted by the printer package, in the canonical order used by help text and test matrices.

func HTML(r *result.Result, writer io.Writer) error

func IsSupportedFormat(name string) bool

IsSupportedFormat reports whether name is one of SupportedFormats.

func JSON(r any, writer io.Writer, options *JSONOption) error

func Svg(r *result.Result, writer io.Writer, options *SvgOption) error

func Text(r *result.Result, writer io.Writer, options *CommonOption) error

type CommonOption struct {
	HideSections bool
	HideMain     bool
	HideStd      bool
}

type JSONOption struct {
	Indent     *int
	HideDetail bool
}

type SvgOption struct {
	CommonOption
	Width       int
	Height      int
	MarginBox   int
	PaddingBox  int
	PaddingRoot int
}

Path	Synopsis
wasm