render

package

v0.0.0-...-ab5910b Latest Latest Go to latest Published: Mar 17, 2026 License: MIT Imports: 5 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/basecamp/fizzy-cli

Links

Open Source Insights

Documentation ¶

Overview ¶

Package render provides styled and markdown output rendering for the Fizzy CLI. The shared output.Writer falls back to JSON for FormatStyled/FormatMarkdown; this package supplies the app-specific rendering.

Index ¶

func MarkdownDetail(data map[string]any, summary string) string
func MarkdownList(data []map[string]any, cols Columns, summary string) string
func MarkdownSummary(data map[string]any, summary string) string
func StyledDetail(data map[string]any, summary string) string
func StyledList(data []map[string]any, cols Columns, summary string) string
func StyledSummary(data map[string]any, summary string) string
type Column
type Columns

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func MarkdownDetail ¶

func MarkdownDetail(data map[string]any, summary string) string

MarkdownDetail renders a single map as bold-label: value pairs.

func MarkdownList ¶

func MarkdownList(data []map[string]any, cols Columns, summary string) string

MarkdownList renders a slice of maps as a GFM table.

func MarkdownSummary ¶

func MarkdownSummary(data map[string]any, summary string) string

MarkdownSummary renders a single-line summary message for mutations.

func StyledDetail ¶

func StyledDetail(data map[string]any, summary string) string

StyledDetail renders a single map as styled key-value pairs.

func StyledList ¶

func StyledList(data []map[string]any, cols Columns, summary string) string

StyledList renders a slice of maps as a styled terminal table.

func StyledSummary ¶

func StyledSummary(data map[string]any, summary string) string

StyledSummary renders a single-line summary message for mutations.

Types ¶

type Column ¶

type Column struct {
	Header string
	Field  string
}

Column maps a display header to a JSON field name.

type Columns ¶

type Columns []Column

Columns is a slice of Column specs for table rendering.

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL