show

README

Format message

contains section, panel, padding, helpPanel, table, tree, title, list, multiList

• title

• table

• panel

• section

• padding

• list

• multi list

• alert(block)

• markdown

• json

Related

• https://github.com/InVisionApp/tabular
• https://github.com/gosuri/uitable

Documentation

Overview

Package show provides some formatter tools for display data.

Index

• Constants
• func AList(title string, data interface{}, fn func(opts *ListOption))
• func Error(format string, v ...interface{}) int
• func JSON(v interface{}, settings ...string) int
• func MList(listMap map[string]interface{}, fn func(opts *ListOption))
• func Success(format string, v ...interface{}) int
• func TabWriter(outTo io.Writer, rows []string) *tabwriter.Writer
• type Base
  • func (b *Base) Format() string
  • func (b *Base) Print()
  • func (b *Base) Println()
  • func (b *Base) SetOutput(output io.Writer)
• type FormatterFace
• type Item
• type Items
  • func NewItems(data interface{}) *Items
  • func (its *Items) Each(fn func(item *Item))
  • func (its *Items) ItemType() string
  • func (its *Items) KeyMaxWidth(userSetting int) int
• type List
  • func NewList(title string, data interface{}) *List
  • func (l *List) Flush()
  • func (l *List) Format() string
  • func (l *List) Print()
  • func (l *List) Println()
  • func (l *List) SetBuffer(buffer *bytes.Buffer)
  • func (l *List) String() string
  • func (l *List) WithOptions(fn func(opts *ListOption)) *List
• type ListOption
• type Lists
  • func NewLists(listMap map[string]interface{}) *Lists
  • func (ls *Lists) Flush()
  • func (ls *Lists) Format() string
  • func (ls *Lists) Print()
  • func (ls *Lists) Println()
  • func (ls *Lists) String() string
  • func (ls *Lists) WithOptions(fn func(opts *ListOption)) *Lists
• type ShownFace
• type Table
  • func NewTable(title string) *Table
  • func (t *Table) Format() string
• type Title
  • func NewTitle(title string) *Title
• type Writer
  • func NewWriter(output io.Writer) *Writer
  • func (w *Writer) Flush() error
  • func (w *Writer) Print()
  • func (w *Writer) Write(buf []byte) (n int, err error)

Constants

const (
	// OK success exit code
	OK = 0
	// ERR error exit code
	ERR = 2
)

const (
	// ItemMap parsed from map, struct
	ItemMap = "map"
	// ItemList parsed from array, slice
	ItemList = "list"
)

const (
	// position
	Left = iota
	Middle
	Right
)

some constants

Functions

func AList

func AList(title string, data interface{}, fn func(opts *ListOption))

AList create a List instance and print. Usage:

show.AList("some info", map[string]string{"name": "tom"}, nil)

func Error

func Error(format string, v ...interface{}) int

Error tips message print

func JSON

func JSON(v interface{}, settings ...string) int

JSON print pretty JSON data

func MList

func MList(listMap map[string]interface{}, fn func(opts *ListOption))

MList show multi list data. Usage:

show.MList(data, nil)
show.MList(data, func(opts *ListOption) {
	opts.LeftIndent = "    "
})

func Success

func Success(format string, v ...interface{}) int

Success tips message print

func TabWriter

func TabWriter(outTo io.Writer, rows []string) *tabwriter.Writer

TabWriter create. more please see: package text/tabwriter/example_test.go Usage:

w := TabWriter(os.Stdout, []string{
	"a\tb\tc\td\t.",
	"123\t12345\t1234567\t123456789\t."
})
w.Flush()

Types

type Base

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

Base formatter

func (*Base) Format

func (b *Base) Format() string

Format given data to string

func (*Base) Print

func (b *Base) Print()

Print formatted message

func (*Base) Println

func (b *Base) Println()

Println formatted message and print newline

func (*Base) SetOutput

func (b *Base) SetOutput(output io.Writer)

SetOutput for print message

type FormatterFace

type FormatterFace interface {
	Format() string
}

FormatterFace interface

type Item

type Item struct {
	Key string
	Val string
	// contains filtered or unexported fields
}

Item definition

type Items

type Items struct {
	List []*Item
	// contains filtered or unexported fields
}

Items definition

func NewItems

func NewItems(data interface{}) *Items

NewItems create a Items for data.

func (*Items) Each

func (its *Items) Each(fn func(item *Item))

Each handle item in the items.List

func (*Items) ItemType

func (its *Items) ItemType() string

ItemType get

func (*Items) KeyMaxWidth

func (its *Items) KeyMaxWidth(userSetting int) int

KeyMaxWidth get

type List

type List struct {
	Base // use for internal
	// options
	Opts *ListOption
	// contains filtered or unexported fields
}

List definition

String len:

len("你好"), len("hello"), len("hello你好") -> 6 5 11

func NewList

func NewList(title string, data interface{}) *List

NewList instance

func (*List) Flush

func (l *List) Flush()

Flush formatted message to console

func (*List) Format

func (l *List) Format() string

Format as string

func (*List) Print

func (l *List) Print()

Print formatted message

func (*List) Println

func (l *List) Println()

Println formatted message with newline

func (*List) SetBuffer

func (l *List) SetBuffer(buffer *bytes.Buffer)

SetBuffer field

func (*List) String

func (l *List) String() string

String returns formatted string

func (*List) WithOptions

func (l *List) WithOptions(fn func(opts *ListOption)) *List

WithOptions with options func

type ListOption

type ListOption struct {
	// IgnoreEmpty ignore empty value item
	IgnoreEmpty bool
	// UpperFirst upper first char for the item.value
	UpperFirst  bool
	SepChar     string // split key value
	LeftIndent  string
	KeyWidth    int // if not set, will auto detect.
	KeyMinWidth int
	KeyStyle    string
	ValueStyle  string
	TitleStyle  string
}

ListOption definition

type Lists

type Lists struct {
	Base // use for internal
	// options
	Opts *ListOption
	// contains filtered or unexported fields
}

Lists definition

func NewLists

func NewLists(listMap map[string]interface{}) *Lists

NewLists create lists

func (*Lists) Flush

func (ls *Lists) Flush()

Flush formatted message to console

func (*Lists) Format

func (ls *Lists) Format() string

Format as string

func (*Lists) Print

func (ls *Lists) Print()

Print formatted message

func (*Lists) Println

func (ls *Lists) Println()

Println formatted message with newline

func (*Lists) String

func (ls *Lists) String() string

String returns formatted string

func (*Lists) WithOptions

func (ls *Lists) WithOptions(fn func(opts *ListOption)) *Lists

WithOptions with options func

type ShownFace

type ShownFace interface {
	// data to string
	String() string
	// print current message
	Print()
	// print current message
	Println()
}

ShownFace shown interface

type Table

type Table struct {
	Base // use for internal
	// Title for the table
	Title string
	// Cols the table head col data
	Cols []string
	// Rows table data rows
	Rows []interface{}
	// options ...
	// HasBorder show border line
	HasBorder bool
	// RowBorder show row border
	RowBorder bool
	// HeadBorder show head border
	HeadBorder bool
	// WrapBorder wrap border for table
	WrapBorder bool
}

Table a cli Table show

func NewTable

func NewTable(title string) *Table

NewTable create table

func (*Table) Format

func (t *Table) Format() string

Format as string

type Title

type Title struct {
	Title     string
	Style     string
	Formatter func(t *Title) string
	// Formatter IFormatter
	Char       rune
	Width      int
	Indent     int
	Position   int
	ShowBorder bool
}

Title definition

func NewTitle

func NewTitle(title string) *Title

NewTitle instance

type Writer

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

Writer definition

func NewWriter

func NewWriter(output io.Writer) *Writer

NewWriter create a new writer

func (*Writer) Flush

func (w *Writer) Flush() error

Flush data to io.Writer

func (*Writer) Print

func (w *Writer) Print()

Print data to io.Writer

func (*Writer) Write

func (w *Writer) Write(buf []byte) (n int, err error)

Write