tablecli

README

tablecli

Packages provide a convenient way to generate tabular output of any data, useful primarily for CLI tools.

Example of use:

package main

import (
    table "github.com/MaxwelMazur/tablecli"
    "github.com/fatih/color"
    "strings"
)


type list struct {
    ID string 
    Name string
}

func main() {
    tbl := table.New("ID", "NAME")
    headerFmt := color.New(color.FgBlue, color.Underline).SprintfFunc()
    columnFmt := color.New(color.FgGreen).SprintfFunc()
    tbl.WithHeaderFormatter(headerFmt).WithFirstColumnFormatter(columnFmt)

    var list = []list{
        { "123123", "Jonh"},
        { "123121", "Jeff"},
    }

    for _, i := range list {
	tbl.AddRow(i.ID, i.Name)
    }

    format := strings.Repeat("%s", len(tbl.GetHeader())) + "\n"
    tbl.CalculateWidths([]string{})

    tbl.PrintHeader(format)
	for _, r := range tbl.GetRows() {
	    tbl.PrintRow(format, r)
    }
}

Output:

ID      NAME  
123123  Jonh  
123121  Jeff 

Documentation

Index

• Variables
• type Formatter
• type Table
  • func New(columnHeaders ...interface{}) Table
• type WidthFunc

Variables

var (
	DefaultPadding                        = 2
	DefaultWriter               io.Writer = os.Stdout
	DefaultHeaderFormatter      Formatter
	DefaultFirstColumnFormatter Formatter
	DefaultWidthFunc            WidthFunc = utf8.RuneCountInString
	WidthPersist                []int
)

Types

type Formatter

type Formatter func(string, ...interface{}) string

type Table

type Table interface {
	WithHeaderFormatter(f Formatter) Table
	WithFirstColumnFormatter(f Formatter) Table
	WithPadding(p int) Table
	WithWriter(w io.Writer) Table
	WithWidthFunc(f WidthFunc) Table
	AddRow(vals ...interface{}) Table
	SetRows(Rows [][]string) Table
	Print()
	GetByteFormat() []byte
	CalculateWidths([]string)
	GetHeader() []string
	GetRows() [][]string
	GetWriter() io.Writer
	PrintHeader(format string)
	PrintRow(format string, row []string)
}

func New

func New(columnHeaders ...interface{}) Table

type WidthFunc

type WidthFunc func(string) int