cliformat

Documentation

Overview

Package cliformat provides a shared --format flag and output writer for Go CLI tools. Supported formats: name, yaml, json.

Usage:

cliformat.AddFlag(cmd, "name")         // register --format on a cobra command
format := cliformat.GetFormat(cmd)     // read the resolved value
cliformat.WriteList(w, format, items, func(d *MyType) string { return d.Name })

Index

• Variables
• func AddFlag(cmd *cobra.Command, defaultFormat string)
• func GetFormat(cmd *cobra.Command) string
• func WriteList[T any](w io.Writer, format string, items []T, nameOf func(T) string) error

Variables

var ValidFormats = []string{"name", "yaml", "json"}

ValidFormats is the set of formats supported by WriteList.

Functions

func AddFlag

func AddFlag(cmd *cobra.Command, defaultFormat string)

AddFlag registers a --format flag on cmd with the given default value. The flag description lists all ValidFormats.

func GetFormat

func GetFormat(cmd *cobra.Command) string

GetFormat returns the resolved --format flag value from cmd (lower-cased). Returns an empty string if the flag was not registered.

func WriteList

func WriteList[T any](w io.Writer, format string, items []T, nameOf func(T) string) error

WriteList renders items to w in the requested format.

• "name" (or ""): one name per line, using nameOf to extract each name.
• "yaml": YAML document stream, one --- block per item.
• "json": JSON array.

T may be any type — struct, map, pointer, etc.