output

package module

Go to main page

Versions in this module

v0

v0.30.4

Jul 11, 2026

v0.30.3

Jul 11, 2026

v0.30.2

Jul 11, 2026

v0.30.1

Jul 6, 2026

v0.30.0

Jul 6, 2026

Changes in this version

+ func RegisterTableMarshaler(format Format, renderer TableMarshaler)

+ func RegisterUnknownRenderer(format Format, renderer UnknownRenderer)

+ func RenderTable(data *Table, format Format, opts RenderOptions) error

+ func RenderUnknown(data any, format Format, opts RenderOptions) error

type Format

+ func RegisteredTableMarshalFormats() []Format

+ func RegisteredUnknownFormats() []Format

+ type Graph struct

+ func TableToGraph(data *Table, opts ...TableToGraphOption) Graph

+ func (g Graph) Edges() []GraphEdge

+ func (g Graph) Nodes() []GraphNode

+ type GraphBuilder struct

+ func NewGraphBuilder() GraphBuilder

+ func (m *GraphBuilder) AddEdge(edge GraphEdge)

+ func (m *GraphBuilder) AddNode(node GraphNode)

+ func (m *GraphBuilder) AddRowEdges(data *Table)

+ func (m *GraphBuilder) Build() Graph

+ func (m *GraphBuilder) DedupEdges()

+ func (m *GraphBuilder) Edges() []GraphEdge

+ func (m *GraphBuilder) Nodes() []GraphNode

+ func (m *GraphBuilder) SetEdges(edges []GraphEdge)

+ func (m *GraphBuilder) SetNodes(nodes []GraphNode)

+ func (m *GraphBuilder) SetNodesFromTable(data *Table, modifyNode func(i int, n *GraphNode))

type GraphNode

+ func NodesFromTable(data *Table, labelFn GraphNodeLabelFunc) []GraphNode

+ type NodeStyle struct

+ Fill string

+ FontColor string

+ FontSize int

+ Stroke string

type StreamingRenderer

+ func RendererAsWriter(r Renderer) StreamingRenderer

+ type Table struct

+ Footer []string

+ Headers []string

+ Rows [][]string

+ func GraphToTable(g Graph) *Table

+ func NewTable(headers []string) *Table

+ func (d *Table) AddRow(row []string)

+ func (d *Table) AddRowChecked(row []string) error

+ func (d *Table) ColCount() int

+ func (d *Table) CreateRowEdges() []RowEdge

+ func (d *Table) GetFooter() []string

+ func (d *Table) GetHeaders() []string

+ func (d *Table) GetRows() [][]string

+ func (d *Table) HasFooter() bool

+ func (d *Table) RowCount() int

+ func (d *Table) SetFooter(footer []string)

+ func (d *Table) ToMapSlice() []map[string]string

+ func (d *Table) Validate() error

+ type TableBuilder struct

+ func NewTableBuilder() *TableBuilder

+ func (b *TableBuilder) AddRow(row ...string) *TableBuilder

+ func (b *TableBuilder) AddRows(rows ...[]string) *TableBuilder

+ func (b *TableBuilder) Build() *Table

+ func (b *TableBuilder) SetFooter(footer ...string) *TableBuilder

+ func (b *TableBuilder) SetHeaders(headers ...string) *TableBuilder

+ type TableMarshaler func(w io.Writer, data *Table, opts RenderOptions) error

+ type TableStore struct

+ func (b *TableStore) AddRow(row []string)

+ func (b *TableStore) Data() *Table

+ func (b *TableStore) HasFooter() bool

+ func (b *TableStore) SetData(data *Table)

+ func (b *TableStore) SetFooter(footer []string)

+ func (b *TableStore) SetHeaders(headers []string)

+ type TableToGraphOption func(*tableToGraphConfig)

+ func WithGraphNodeLabelFunc(fn GraphNodeLabelFunc) TableToGraphOption

+ type TreeBuilder struct

+ func NewTreeBuilder() *TreeBuilder

+ func (b *TreeBuilder) AddChild(parentID, id, label string) *TreeBuilder

+ func (b *TreeBuilder) AddChildren(parentID string, children ...[2]string) *TreeBuilder

+ func (b *TreeBuilder) Build() *TreeNode

+ func (b *TreeBuilder) SetRoot(id, label string) *TreeBuilder

type TreeNode

+ func GraphToTree(g Graph) *TreeNode

+ type TreeRenderer interface

+ SetRoot func(node *TreeNode)

+ type UnknownRenderer func(w io.Writer, data any, opts RenderOptions) error

v0.23.3

Jul 3, 2026

v0.23.2

Jul 3, 2026

v0.23.1

Jul 2, 2026

v0.23.0

Jul 2, 2026

v0.22.0

Jul 1, 2026

v0.21.0

Jul 1, 2026

v0.20.0

Jul 1, 2026

v0.19.0

Jun 24, 2026

Changes in this version

+ func TreeToRenderer[R, ID any](newRenderer func() R, addNodes func(R, *TreeNode, ID), root *TreeNode) R

v0.18.0

Jun 24, 2026

Changes in this version

+ var AllDirections = []Direction

+ var AllLineStyles = []LineStyle

+ var CIEnvVars = []string

+ func ContainsEnum[T comparable](values []T, v T) bool

+ func EnumAllowedStrings[T any](values []T, toString func(T) string) []string

+ func EnumAllowedValues[T StringEnum](values []T) []string

+ func IsCI() bool

+ func IsNoColor() bool

+ func ParseEnum[T comparable](values []T, s string, toString func(T) string) (T, error)

type Direction

+ func (d Direction) IsValid() bool

+ type InvalidLineStyleError struct

+ Allowed []LineStyle

+ Value string

+ func (e *InvalidLineStyleError) Error() string

type InvalidShapeError

+ Allowed []Shape

type LineStyle

+ func ParseLineStyle(s string) (LineStyle, error)

+ func (l LineStyle) AllowedValues() []string

+ type ParseError struct

+ Value string

+ Values []string

+ func (e *ParseError) Error() string

+ type StringEnum interface

+ String func() string

v0.17.2

Jun 22, 2026

v0.17.1

Jun 22, 2026

v0.17.0

Jun 20, 2026

v0.16.0

Jun 20, 2026

v0.15.0

Jun 20, 2026

v0.14.0

Jun 20, 2026

v0.13.0

Jun 19, 2026

Changes in this version

+ func RegisterAnyDataRenderer(format Format, renderer AnyDataRenderer)

+ func RegisterTableDataRenderer(format Format, renderer TableDataRenderer)

+ type AnyDataRenderer func(w io.Writer, data any, opts RenderOptions) error

+ type Direction string

+ const DirectionDown

+ const DirectionLeft

+ const DirectionRight

+ const DirectionUp

+ func (d Direction) ToD2Direction() string

+ func (d Direction) ToRankDir() string

type EdgeStyle

+ Line LineStyle

type GraphStyle

+ Fill string

+ Stroke string

+ type InvalidNodeShapeError struct

+ Value string

+ func (e *InvalidNodeShapeError) Error() string

+ type LineStyle string

+ const LineStyleDashed

+ const LineStyleDotted

+ const LineStyleSolid

+ func (l LineStyle) IsValid() bool

+ func (l LineStyle) String() string

+ type NodeShape string

+ const NodeShapeBox

+ const NodeShapeCircle

+ const NodeShapeCylinder

+ const NodeShapeDiamond

+ const NodeShapeEllipse

+ const NodeShapeHexagon

+ const NodeShapeParallelogram

+ const NodeShapeRect

+ func ParseNodeShape(s string) (NodeShape, error)

+ func (s NodeShape) AllowedValues() []string

+ func (s NodeShape) IsValid() bool

+ func (s NodeShape) String() string

+ type TableDataRenderer func(w io.Writer, data *TableData, opts RenderOptions) error

v0.12.0

Jun 17, 2026

Changes in this version

type GraphRendererState

+ func (m *GraphRendererState) DedupEdges()

v0.11.0

Jun 17, 2026

v0.10.1

Jun 13, 2026

v0.10.0

Jun 12, 2026

v0.9.0

Jun 12, 2026

Changes in this version

+ func RegisterAnyDataMarshaler(format Format, marshaler AnyDataMarshaler)

+ func RenderAnyData(data any, format Format, opts RenderOptions) error

+ type AnyDataMarshaler func(w io.Writer, data any, opts RenderOptions) error

type Format

+ func RegisteredAnyDataFormats() []Format

+ func RegisteredTableDataFormats() []Format

type TableData

+ func (d *TableData) AddRowChecked(row []string) error

v0.8.0

Jun 10, 2026

v0.7.9

Jun 10, 2026

v0.7.8

Jun 10, 2026

v0.7.7

Jun 10, 2026

v0.7.6

Jun 10, 2026

v0.7.5

Jun 10, 2026

v0.7.4

Jun 10, 2026

v0.7.3

Jun 10, 2026

v0.7.2

Jun 9, 2026

v0.7.1

Jun 9, 2026

v0.7.0

Jun 9, 2026

Changes in this version

+ func RegisterFormatShapes(format Format, shapes ...Shape)

+ type GraphRendererState struct

+ func NewGraphRendererState() GraphRendererState

+ func (m *GraphRendererState) AddEdge(edge GraphEdge)

+ func (m *GraphRendererState) AddNode(node GraphNode)

+ func (m *GraphRendererState) AddRowEdges(data *TableData)

+ func (m *GraphRendererState) Edges() []GraphEdge

+ func (m *GraphRendererState) Nodes() []GraphNode

+ func (m *GraphRendererState) SetEdges(edges []GraphEdge)

+ func (m *GraphRendererState) SetNodes(nodes []GraphNode)

+ func (m *GraphRendererState) SetNodesFromTableData(data *TableData, modifyNode func(i int, n *GraphNode))

+ type NodeEdgeAppender interface

+ AddEdge func(edge GraphEdge)

+ AddNode func(node GraphNode)

+ type TableDataStore struct

+ func (b *TableDataStore) AddRow(row []string)

+ func (b *TableDataStore) Data() *TableData

+ func (b *TableDataStore) HasFooter() bool

+ func (b *TableDataStore) SetData(data *TableData)

+ func (b *TableDataStore) SetFooter(footer []string)

+ func (b *TableDataStore) SetHeaders(headers []string)

v0.6.3

Jun 3, 2026

v0.6.2

Jun 1, 2026

v0.6.1

May 30, 2026

Changes in this version

type MarkdownTable

+ func (m *MarkdownTable) AsTableRenderer() TableRenderer

+ func (m *MarkdownTable) SetFooter(footer []string) *MarkdownTable

type TableData

+ Footer []string

+ func (d *TableData) GetFooter() []string

+ func (d *TableData) HasFooter() bool

+ func (d *TableData) SetFooter(footer []string)

+ func (d *TableData) Validate() error

type TableDataBase

+ func (b *TableDataBase) HasFooter() bool

+ func (b *TableDataBase) SetFooter(footer []string)

v0.6.0

May 25, 2026

Changes in this version

+ func MarshalFormat(format string, marshalFn func(any) ([]byte, error), v any) ([]byte, error)

+ func RegisterTableDataMarshaler(format Format, marshaler TableDataMarshaler)

+ func UnmarshalFormat(format string, unmarshalFn func([]byte, any) error, data []byte, v any) error

type ASCIITreeRenderer

+ func (r *ASCIITreeRenderer) SetColorMode(mode ColorMode)

type Format

+ const FormatAsciiDoc

+ const FormatJSONL

+ const FormatPlantUML

+ const FormatTOML

type MarkdownTable

+ func (m *MarkdownTable) SetColorMode(mode ColorMode) *MarkdownTable

type RenderOptions

+ ColorMode ColorMode

+ type TableDataBase struct

+ func (b *TableDataBase) AddRow(row []string)

+ func (b *TableDataBase) Data() *TableData

+ func (b *TableDataBase) SetData(data *TableData)

+ func (b *TableDataBase) SetHeaders(headers []string)

+ type TableDataMarshaler func(w io.Writer, data *TableData, opts RenderOptions) error

v0.5.0

May 24, 2026

Changes in this version

+ var AllShapes = []Shape

+ func MarshalCSVFromTableData(data *TableData) ([]byte, error)

+ func MarshalTSVFromTableData(data *TableData) ([]byte, error)

+ func RenderTableData(data *TableData, format Format, opts ...RenderOptions) error

type Format

+ func FormatsForShape(s Shape) []Format

+ func (f Format) Shapes() []Shape

+ func (f Format) Supports(s Shape) bool

type GraphRendererMixin

+ func (m *GraphRendererMixin) Edges() []GraphEdge

+ func (m *GraphRendererMixin) EdgesPtr() *[]GraphEdge

+ func (m *GraphRendererMixin) Nodes() []GraphNode

+ func (m *GraphRendererMixin) NodesPtr() *[]GraphNode

+ type InvalidColorModeError struct

+ Value string

+ func (e *InvalidColorModeError) Error() string

+ type InvalidGraphShapeError struct

+ Value string

+ func (e *InvalidGraphShapeError) Error() string

+ type InvalidShapeError struct

+ Value string

+ func (e *InvalidShapeError) Error() string

+ type InvalidSortByError struct

+ Value string

+ func (e *InvalidSortByError) Error() string

+ type JSONGraphRenderer struct

+ func NewJSONGraphRenderer() *JSONGraphRenderer

+ func (r *JSONGraphRenderer) Render() (string, error)

+ type JSONTableRenderer struct

+ func NewJSONTableRenderer() *JSONTableRenderer

+ func (b *JSONTableRenderer) AddRow(row []string)

+ func (b *JSONTableRenderer) SetData(data *TableData)

+ func (b *JSONTableRenderer) SetHeaders(headers []string)

+ func (r *JSONTableRenderer) Render() (string, error)

+ type JSONTreeRenderer struct

+ func NewJSONTreeRenderer() *JSONTreeRenderer

+ func (r *JSONTreeRenderer) Render() (string, error)

+ func (r *JSONTreeRenderer) SetRoot(node *TreeNode)

+ type RenderOptions struct

+ GraphID string

+ Title string

+ Writer io.Writer

+ type Shape string

+ const ShapeGraph

+ const ShapeTable

+ const ShapeTree

+ func ParseShape(s string) (Shape, error)

+ func (s Shape) AllowedValues() []string

+ func (s Shape) IsValid() bool

+ func (s Shape) String() string

type TableData

+ func (d *TableData) ToMapSlice() []map[string]string

+ type UnsupportedFormatError struct

+ Format Format

+ func (e *UnsupportedFormatError) Error() string

+ func (e *UnsupportedFormatError) Unwrap() error

+ type YAMLGraphRenderer struct

+ func NewYAMLGraphRenderer() *YAMLGraphRenderer

+ func (r *YAMLGraphRenderer) Render() (string, error)

+ type YAMLTableRenderer struct

+ func NewYAMLTableRenderer() *YAMLTableRenderer

+ func (b *YAMLTableRenderer) AddRow(row []string)

+ func (b *YAMLTableRenderer) SetData(data *TableData)

+ func (b *YAMLTableRenderer) SetHeaders(headers []string)

+ func (r *YAMLTableRenderer) Render() (string, error)

+ type YAMLTreeRenderer struct

+ func NewYAMLTreeRenderer() *YAMLTreeRenderer

+ func (r *YAMLTreeRenderer) Render() (string, error)

+ func (r *YAMLTreeRenderer) SetRoot(node *TreeNode)

v0.4.0

May 16, 2026

Changes in this version

+ const OutputFormatCSV

+ const OutputFormatD2

+ const OutputFormatDOT

+ const OutputFormatHTML

+ const OutputFormatJSON

+ const OutputFormatMarkdown

+ const OutputFormatMermaid

+ const OutputFormatTSV

+ const OutputFormatTable

+ const OutputFormatTree

+ const OutputFormatXML

+ const OutputFormatYAML

+ var AllFormats = []Format

+ var ErrFormatAlreadyRegistered = errors.New("format already registered")

+ var ErrInvalidColorMode = errors.New("invalid color mode")

+ var ErrInvalidD2ArrowType = errors.New("invalid D2 arrow type")

+ var ErrInvalidD2Constraint = errors.New("invalid D2 constraint")

+ var ErrInvalidD2Direction = errors.New("invalid D2 direction")

+ var ErrInvalidD2NodeShape = errors.New("invalid D2 node shape")

+ var ErrInvalidGraphShape = errors.New("invalid graph shape")

+ var ErrInvalidSortBy = errors.New("invalid sort by")

+ var ErrNoRendererRegistered = errors.New("no renderer registered for format")

+ var ErrUnsupportedType = errors.New("unsupported type")

+ func AddTreeNodes(nodes *[]GraphNode, edges *[]GraphEdge, node *TreeNode, parentID string, ...)

+ func AssertTreeNodeDepth(t *testing.T, root, child, grandchild *TreeNode)

+ func DefaultGraphNodeLabel(header, cell string) string

+ func FilledStrings(n int, value string) []string

+ func IsRegistered(format Format) bool

+ func MarshalJSON(v any) ([]byte, error)

+ func MarshalJSONIndent(v any, prefix, indent string) ([]byte, error)

+ func MarshalTSV(data any) ([]byte, error)

+ func MarshalXML(v any) ([]byte, error)

+ func MarshalXMLFromTableData(data *TableData) ([]byte, error)

+ func MarshalXMLIndent(v any, prefix, indent string) (result []byte, err error)

+ func MarshalYAML(v any) ([]byte, error)

+ func MustRender(r Renderer) string

+ func NewBrandedID[Brand any](value string) id.ID[Brand, string]

+ func Register(format Format, factory RendererFactory) error

+ func UnmarshalJSON(data []byte, v any) error

+ func UnmarshalYAML(data []byte, v any) error

+ func Unregister(format Format)

+ type ASCIITreeRenderer struct

+ func NewASCIITreeRenderer() *ASCIITreeRenderer

+ func TreeRendererFromTableData(data *TableData) *ASCIITreeRenderer

+ func (r *ASCIITreeRenderer) Render() (string, error)

+ func (r *ASCIITreeRenderer) SetRoot(node *TreeNode)

+ type Alignment int

+ const AlignCenter

+ const AlignLeft

+ const AlignRight

+ const AlignmentCenter

+ const AlignmentLeft

+ const AlignmentRight

+ type BrandedID = id.ID[Brand, string]

+ type CSVWriter struct

+ func NewCSVWriter(w io.Writer) *CSVWriter

+ func (c *CSVWriter) Error() error

+ func (c *CSVWriter) Flush()

+ func (c *CSVWriter) WriteHeader(cols []string) error

+ func (c *CSVWriter) WriteRow(values []string) error

+ func (c *CSVWriter) WriteRows(values [][]string) error

+ type ColorMode string

+ const ColorModeAlways

+ const ColorModeAuto

+ const ColorModeNever

+ func ParseColorMode(s string) (ColorMode, error)

+ func (c ColorMode) AllowedValues() []string

+ func (c ColorMode) IsValid() bool

+ func (c ColorMode) ShouldColor() bool

+ func (c ColorMode) String() string

+ type D2ArrowType string

+ const D2ArrowArrow

+ const D2ArrowBox

+ const D2ArrowCFMany

+ const D2ArrowCFManyRequired

+ const D2ArrowCFOne

+ const D2ArrowCFOneRequired

+ const D2ArrowCircle

+ const D2ArrowCross

+ const D2ArrowDiamond

+ const D2ArrowFilled

+ const D2ArrowNone

+ const D2ArrowTriangle

+ func ParseD2ArrowType(s string) (D2ArrowType, error)

+ func (a D2ArrowType) AllowedValues() []string

+ func (a D2ArrowType) IsValid() bool

+ func (a D2ArrowType) String() string

+ type D2Column struct

+ Constraint D2Constraint

+ Name string

+ Type string

+ type D2Constraint string

+ const D2ConstraintForeign

+ const D2ConstraintPrimary

+ const D2ConstraintUnique

+ func AllD2Constraints() []D2Constraint

+ func ParseD2Constraint(s string) (D2Constraint, error)

+ func (c D2Constraint) AllowedValues() []string

+ func (c D2Constraint) IsValid() bool

+ func (c D2Constraint) String() string

+ type D2Diagram struct

+ func D2FromTableData(data *TableData) *D2Diagram

+ func D2FromTree(root *TreeNode) *D2Diagram

+ func NewD2Diagram() *D2Diagram

+ func (d *D2Diagram) AddClass(name string, style D2NodeStyle) *D2Diagram

+ func (d *D2Diagram) AddEdge(edge D2Edge) *D2Diagram

+ func (d *D2Diagram) AddEdgeSimple(from, to string) *D2Diagram

+ func (d *D2Diagram) AddLabeledEdge(from, to, label string) *D2Diagram

+ func (d *D2Diagram) AddNode(node D2Node) *D2Diagram

+ func (d *D2Diagram) AddNodeSimple(id, label string) *D2Diagram

+ func (d *D2Diagram) AddNodeWithShape(id, label string, shape D2NodeShape) *D2Diagram

+ func (d *D2Diagram) AddTable(name string, columns []D2Column) *D2Diagram

+ func (d *D2Diagram) Render() (string, error)

+ func (d *D2Diagram) SetDirection(dir D2Direction) *D2Diagram

+ func (d *D2Diagram) SetEdges(edges []GraphEdge)

+ func (d *D2Diagram) SetLayout(engine string) *D2Diagram

+ func (d *D2Diagram) SetNodes(nodes []GraphNode)

+ func (d *D2Diagram) SetTitle(title string) *D2Diagram

+ type D2Direction string

+ const D2DirDown

+ const D2DirLeft

+ const D2DirRight

+ const D2DirUp

+ func ParseD2Direction(s string) (D2Direction, error)

+ func (d D2Direction) AllowedValues() []string

+ func (d D2Direction) IsValid() bool

+ func (d D2Direction) String() string

+ type D2Edge struct

+ From D2NodeID

+ Label D2NodeLabel

+ SourceArrow D2ArrowType

+ Style D2EdgeStyle

+ TargetArrow D2ArrowType

+ To D2NodeID

+ type D2EdgeStyle struct

+ Animated bool

+ FontColor string

+ FontSize int

+ Stroke string

+ StrokeDash int

+ StrokeWidth int

+ type D2Node struct

+ Class string

+ GridColumns int

+ GridGap int

+ GridRows int

+ Height int

+ ID D2NodeID

+ Icon string

+ Label D2NodeLabel

+ Link string

+ Near string

+ Nested string

+ Shape D2NodeShape

+ Style D2NodeStyle

+ Tooltip string

+ Width int

+ type D2NodeID = id.ID[D2NodeIDBrand, string]

+ type D2NodeIDBrand struct

+ type D2NodeLabel = id.ID[D2NodeLabelBrand, string]

+ type D2NodeLabelBrand struct

+ type D2NodeShape string

+ const D2ShapeCircle

+ const D2ShapeClass

+ const D2ShapeCloud

+ const D2ShapeCode

+ const D2ShapeCylinder

+ const D2ShapeDiamond

+ const D2ShapeHexagon

+ const D2ShapeImage

+ const D2ShapeOval

+ const D2ShapePage

+ const D2ShapeParallelogram

+ const D2ShapePerson

+ const D2ShapeQueue

+ const D2ShapeRectangle

+ const D2ShapeSQLTable

+ const D2ShapeSquare

+ const D2ShapeStep

+ const D2ShapeStoredData

+ const D2ShapeText

+ const D2ShapeTriangle

+ func ParseD2NodeShape(s string) (D2NodeShape, error)

+ func (s D2NodeShape) AllowedValues() []string

+ func (s D2NodeShape) IsValid() bool

+ func (s D2NodeShape) String() string

+ type D2NodeStyle struct

+ BorderRadius int

+ Fill string

+ FontColor string

+ FontSize int

+ Opacity float64

+ Shadow bool

+ Stroke string

+ StrokeDash int

+ StrokeWidth int

+ TextTransform string

+ type D2Table struct

+ Columns []D2Column

+ Name string

+ type DOTRenderer struct

+ func DOTFromTableData(data *TableData) *DOTRenderer

+ func DOTFromTree(root *TreeNode) *DOTRenderer

+ func NewDOTRenderer() *DOTRenderer

+ func NewUndirectedDOTRenderer() *DOTRenderer

+ func (r *DOTRenderer) Render() (string, error)

+ func (r *DOTRenderer) SetGraphID(id string)

+ type DelimitedWriter struct

+ func NewDelimitedWriter(w io.Writer, delimiter rune, name string) *DelimitedWriter

+ func (d *DelimitedWriter) Error() error

+ func (d *DelimitedWriter) Flush()

+ func (d *DelimitedWriter) WriteRow(cols []string, description string) error

+ func (d *DelimitedWriter) WriteRows(values [][]string, description string) error

+ type EdgeStyle struct

+ ArrowHead string

+ ArrowTail string

+ Color string

+ Style string

+ type ExpectedOutput = gentest.ExpectedOutput

+ type Format string

+ const FormatCSV

+ const FormatD2

+ const FormatDOT

+ const FormatHTML

+ const FormatJSON

+ const FormatMarkdown

+ const FormatMermaid

+ const FormatTSV

+ const FormatTable

+ const FormatTree

+ const FormatXML

+ const FormatYAML

+ func ParseFormat(s string) (Format, error)

+ func ParseOutputFormat(s string) (Format, error)

+ func RegisteredFormats() []Format

+ func (f Format) AllowedValues() []string

+ func (f Format) Category() FormatCategory

+ func (f Format) IsGraphFormat() bool

+ func (f Format) IsTableFormat() bool

+ func (f Format) IsTreeFormat() bool

+ func (f Format) IsValid() bool

+ func (f Format) String() string

+ type FormatCategory int

+ const CategoryGraph

+ const CategoryTable

+ const CategoryTree

+ func (c FormatCategory) String() string

+ type GraphEdge struct

+ From GraphNodeID

+ Label GraphNodeLabel

+ Style EdgeStyle

+ To GraphNodeID

+ func NewGraphEdge(from, to string) *GraphEdge

+ type GraphNode struct

+ ID GraphNodeID

+ Label GraphNodeLabel

+ Metadata map[string]string

+ Shape GraphShape

+ Style GraphStyle

+ func NewGraphNode(id, label string) *GraphNode

+ func NodesFromTableData(data *TableData, labelFn GraphNodeLabelFunc) []GraphNode

+ type GraphNodeID = id.ID[GraphNodeIDBrand, string]

+ type GraphNodeIDBrand struct

+ type GraphNodeLabel = id.ID[GraphNodeLabelBrand, string]

+ type GraphNodeLabelBrand struct

+ type GraphNodeLabelFunc func(header, cell string) string

+ type GraphRenderer interface

+ SetEdges func(edges []GraphEdge)

+ SetNodes func(nodes []GraphNode)

+ type GraphRendererMixin struct

+ func NewGraphRendererMixin() GraphRendererMixin

+ func (m *GraphRendererMixin) AddRowEdges(data *TableData)

+ func (m *GraphRendererMixin) SetEdges(edges []GraphEdge)

+ func (m *GraphRendererMixin) SetNodes(nodes []GraphNode)

+ func (m *GraphRendererMixin) SetNodesFromTableData(data *TableData, modifyNode func(i int, n *GraphNode))

+ type GraphShape string

+ const ShapeBox

+ const ShapeCircle

+ const ShapeCylinder

+ const ShapeDiamond

+ const ShapeEllipse

+ const ShapeHexagon

+ const ShapeParallelogram

+ const ShapeRect

+ func ParseGraphShape(s string) (GraphShape, error)

+ func (s GraphShape) AllowedValues() []string

+ func (s GraphShape) IsValid() bool

+ func (s GraphShape) String() string

+ type GraphStyle struct

+ FillColor string

+ FontColor string

+ FontSize int

+ StrokeColor string

+ type HTMLRenderer struct

+ func NewHTMLRenderer() *HTMLRenderer

+ func (b *HTMLRenderer) AddRow(row []string)

+ func (b *HTMLRenderer) SetData(data *TableData)

+ func (b *HTMLRenderer) SetHeaders(headers []string)

+ func (r *HTMLRenderer) Render() (string, error)

+ func (r *HTMLRenderer) RenderFullHTML(title string) (string, error)

+ type HTMLTreeRenderer struct

+ func NewHTMLTreeRenderer() *HTMLTreeRenderer

+ func (r *HTMLTreeRenderer) Render() (string, error)

+ func (r *HTMLTreeRenderer) RenderFullHTML(title string) (string, error)

+ func (r *HTMLTreeRenderer) SetRoot(node *TreeNode)

+ type InvalidFormatError struct

+ Allowed []Format

+ Value string

+ func (e *InvalidFormatError) Error() string

+ type JSONWriter struct

+ Writer io.Writer

+ func NewJSONWriter(w io.Writer) *JSONWriter

+ func (j *JSONWriter) Encode(v any) error

+ type MarkdownTable struct

+ func NewMarkdownTable() *MarkdownTable

+ func NewMarkdownTableFromData(data *TableData) *MarkdownTable

+ func (m *MarkdownTable) AddRow(row []string) *MarkdownTable

+ func (m *MarkdownTable) Render() (string, error)

+ func (m *MarkdownTable) SetAlign(col int, alignment Alignment) *MarkdownTable

+ func (m *MarkdownTable) SetHeaders(headers []string) *MarkdownTable

+ type MermaidRenderer struct

+ func MermaidFlowchartRenderer(data *TableData) *MermaidRenderer

+ func MermaidTreeRenderer(root *TreeNode) *MermaidRenderer

+ func NewMermaidRenderer() *MermaidRenderer

+ func (r *MermaidRenderer) Render() (string, error)

+ type OutputFormat = Format

+ type Renderer interface

+ Render func() (string, error)

+ func Create(format Format) (Renderer, error)

+ type RendererFactory func() Renderer

+ type RowEdge struct

+ From string

+ To string

+ type SortBy string

+ const SortByComplexity

+ const SortByCreatedAt

+ const SortByHealth

+ const SortByImportance

+ const SortByName

+ const SortByUpdatedAt

+ func ParseSortBy(s string) (SortBy, error)

+ func (s SortBy) AllowedValues() []string

+ func (s SortBy) IsValid() bool

+ func (s SortBy) String() string

+ type StreamingHTMLRenderer struct

+ func NewStreamingHTMLRenderer() *StreamingHTMLRenderer

+ func (b *StreamingHTMLRenderer) AddRow(row []string)

+ func (b *StreamingHTMLRenderer) SetData(data *TableData)

+ func (b *StreamingHTMLRenderer) SetHeaders(headers []string)

+ func (r *StreamingHTMLRenderer) Render() (string, error)

+ func (r *StreamingHTMLRenderer) Stream(w io.Writer) error

+ type StreamingRenderer interface

+ Stream func(w io.Writer) error

+ func StreamingRendererFromRenderer(r Renderer) StreamingRenderer

+ type TSVWriter struct

+ func NewTSVWriter(w io.Writer) *TSVWriter

+ func (t *TSVWriter) Error() error

+ func (t *TSVWriter) Flush()

+ func (t *TSVWriter) WriteHeader(cols []string) error

+ func (t *TSVWriter) WriteRow(values []string) error

+ func (t *TSVWriter) WriteRows(values [][]string) error

+ type TableData struct

+ Headers []string

+ Rows [][]string

+ func NewTableData(headers []string) *TableData

+ func (d *TableData) AddRow(row []string)

+ func (d *TableData) ColCount() int

+ func (d *TableData) CreateRowEdges() []RowEdge

+ func (d *TableData) GetHeaders() []string

+ func (d *TableData) GetRows() [][]string

+ func (d *TableData) RowCount() int

+ type TableRenderer interface

+ AddRow func(row []string)

+ SetHeaders func(headers []string)

+ type TreeNode struct

+ Children []*TreeNode

+ ID TreeNodeID

+ Label TreeNodeLabel

+ Metadata map[string]string

+ func NewTreeNode(id, label string) *TreeNode

+ func (n *TreeNode) AddChild(child *TreeNode)

+ func (n *TreeNode) Depth() int

+ func (n *TreeNode) Parent() *TreeNode

+ type TreeNodeID = id.ID[TreeNodeIDBrand, string]

+ type TreeNodeIDBrand struct

+ type TreeNodeIDFunc func(*TreeNode) string

+ type TreeNodeLabel = id.ID[TreeNodeLabelBrand, string]

+ type TreeNodeLabelBrand struct

+ type TreeOutputRenderer interface

+ SetRoot func(node *TreeNode)

+ type XMLWriter struct

+ Writer io.Writer

+ func NewXMLWriter(w io.Writer) *XMLWriter

+ func (x *XMLWriter) WriteFooter() error

+ func (x *XMLWriter) WriteHeader(cols []string) error

+ func (x *XMLWriter) WriteRow(values []string) error

+ func (x *XMLWriter) WriteRows(values [][]string) error

v0.3.0

May 13, 2026

v0.2.0

Apr 30, 2026

v0.1.0

Apr 30, 2026

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