output

package

v0.2.1 Latest Latest Go to latest Published: Jun 18, 2026 License: MIT Imports: 7 Imported by: 0

Details

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

Repository

github.com/hadron-memory/hadron-cli

Links

Open Source Insights

Documentation ¶

Overview ¶

Package output renders command results as human-readable text or JSON. Commands build explicit DTOs for their output — never genqlient-generated structs — so the --json contract stays stable across schema regenerations.

Index ¶

func Write(s *IOStreams, asJSON bool, v any, table func(w io.Writer) error) error
func WriteJSON(w io.Writer, v any) error
type IOStreams
- func System() *IOStreams
- func Test() (*IOStreams, *bytes.Buffer, *bytes.Buffer)
- func (s *IOStreams) IsInputTerminal() bool
- func (s *IOStreams) IsTerminal() bool
type Table
- func NewTable(w io.Writer, headers ...string) *Table
- func (t *Table) Flush() error
- func (t *Table) Row(cells ...string)

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func Write ¶

func Write(s *IOStreams, asJSON bool, v any, table func(w io.Writer) error) error

Write renders v as indented JSON when asJSON is set, otherwise calls table to render the human view.

func WriteJSON ¶

func WriteJSON(w io.Writer, v any) error

WriteJSON marshals v as indented JSON followed by a newline.

Types ¶

type IOStreams ¶

type IOStreams struct {
	In     io.Reader
	Out    io.Writer
	ErrOut io.Writer
	// contains filtered or unexported fields
}

IOStreams bundles the CLI's input/output handles so commands never touch os.Stdin/Stdout directly, keeping them testable.

func System ¶

func System() *IOStreams

System returns IOStreams wired to the real process streams.

func Test ¶

func Test() (*IOStreams, *bytes.Buffer, *bytes.Buffer)

Test returns IOStreams backed by buffers, plus the stdout and stderr buffers for assertions.

func (*IOStreams) IsInputTerminal ¶

func (s *IOStreams) IsInputTerminal() bool

IsInputTerminal reports whether stdin is a TTY (i.e. a prompt can actually be answered).

func (*IOStreams) IsTerminal ¶

func (s *IOStreams) IsTerminal() bool

IsTerminal reports whether stdout is a TTY.

type Table ¶

type Table struct {
	// contains filtered or unexported fields
}

Table is a thin tabwriter wrapper for aligned columnar output.

func NewTable ¶

func NewTable(w io.Writer, headers ...string) *Table

func (*Table) Flush ¶

func (t *Table) Flush() error

func (*Table) Row ¶

func (t *Table) Row(cells ...string)

Source Files ¶

View all Source files

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