formatter

package

v0.1.26 Latest Latest Go to latest Published: Jan 7, 2026 License: MIT Imports: 7 Imported by: 0

Details

Package formatter provides functions to format data structures into different output formats such as YAML, JSON, and text.

This section is empty.

This section is empty.

func Format(writer io.Writer, target any, t FormatType) error

Format formats the target as a YAML, JSON, or text representation. It's a convenience function that wraps the specific format functions.

func FormatJSON(writer io.Writer, target any) error

FormatJSON formats the target as a JSON representation.

func FormatShort(w io.Writer, data any) error

FormatShort formats the target struct to a short text representation. If the field has a "short" tag, it uses the value of that tag as the key.

func FormatText(w io.Writer, data any) error

FormatText formats the target as a text representation. It uses the field name as the key and the field value as the value.

func FormatYAML(writer io.Writer, target any) error

FormatYAML formats the target as a YAML representation.

type FormatType string

FormatType represents the type of format to be used for output.

const (
	YAML  FormatType = "yaml"
	JSON  FormatType = "json"
	TEXT  FormatType = "text"
	SHORT FormatType = "short"
)

Format types.