outfmt

package

v0.1.5 Latest Latest Go to latest Published: Dec 29, 2025 License: MIT Imports: 7 Imported by: 0

Documentation ¶

Index ¶

Constants
func Colorize(text, color string, enabled bool) string
func GetColor(ctx context.Context) string
func GetFormat(ctx context.Context) string
func GetQuery(ctx context.Context) string
func Output(ctx context.Context, data any, textFn func(io.Writer)) error
func OutputWithQuery(format, query string, data any, textFn func(io.Writer)) error
func ShouldColorize(mode string) bool
func WithColor(ctx context.Context, mode string) context.Context
func WithFormat(ctx context.Context, format string) context.Context
func WithQuery(ctx context.Context, query string) context.Context
func WriteJSON(w io.Writer, data any) error
func WriteJSONPretty(w io.Writer, data any) error
func WriteJSONWithQuery(w io.Writer, data any, queryStr string) error
type ColorMode
type TableWriter
- func NewTableWriter(w io.Writer) *TableWriter

Constants ¶

const (
	Reset   = "\033[0m"
	Bold    = "\033[1m"
	Red     = "\033[31m"
	Green   = "\033[32m"
	Yellow  = "\033[33m"
	Blue    = "\033[34m"
	Magenta = "\033[35m"
	Cyan    = "\033[36m"
	Gray    = "\033[90m"
)

ANSI color codes

Variables ¶

This section is empty.

Functions ¶

func Colorize ¶

func Colorize(text, color string, enabled bool) string

Colorize wraps text in ANSI color codes if colors are enabled

func GetColor ¶

func GetColor(ctx context.Context) string

func GetFormat ¶

func GetFormat(ctx context.Context) string

func GetQuery ¶

func GetQuery(ctx context.Context) string

func Output ¶

func Output(ctx context.Context, data any, textFn func(io.Writer)) error

func OutputWithQuery ¶

func OutputWithQuery(format, query string, data any, textFn func(io.Writer)) error

func ShouldColorize ¶

func ShouldColorize(mode string) bool

ShouldColorize returns true if output should be colorized

func WithColor ¶

func WithColor(ctx context.Context, mode string) context.Context

func WithFormat ¶

func WithFormat(ctx context.Context, format string) context.Context

func WithQuery ¶

func WithQuery(ctx context.Context, query string) context.Context

func WriteJSON ¶

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

func WriteJSONPretty ¶

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

func WriteJSONWithQuery ¶

func WriteJSONWithQuery(w io.Writer, data any, queryStr string) error

Types ¶

type ColorMode ¶

type ColorMode string

ColorMode represents color output setting

const (
	ColorAuto   ColorMode = "auto"
	ColorAlways ColorMode = "always"
	ColorNever  ColorMode = "never"
)

type TableWriter ¶

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

func NewTableWriter ¶

func NewTableWriter(w io.Writer) *TableWriter

func (*TableWriter) Append ¶

func (t *TableWriter) Append(row []string)

func (*TableWriter) Render ¶

func (t *TableWriter) Render()

func (*TableWriter) SetHeader ¶

func (t *TableWriter) SetHeader(headers []string)

Source Files ¶

View all Source files

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