tbl

README

tbl

tbl is a simple way to print text tables.

Installing

go get -u github.com/alligator/tbl

Example

package main

import (
	"fmt"

	"github.com/alligator/tbl"
)

type row struct {
	id   int
	name string
}

func main() {
	rows := []row{
		{1, "gate"},
		{2, "boop"},
	}

	t := tbl.NewTable()

	for _, row := range rows {
		t.NewRow()

		t.NewCol("Id")
		t.Printf("%d", row.id)

		t.NewCol("Name")
		t.Print(row.name)
	}

	fmt.Print(t.String())
}

This will print this table:

| Id | Name |
| -- | ---- |
| 1  | gate |
| 2  | boop |

There is also a minimal style, with no column and row separators. Use it like so:

t := tbl.NewTable()
t.Style = tbl.StyleMinimal

Minimal tables looks like this:

ID  NAME
1   gate
2   boop

Documentation

Overview

Package tbl implements a simple way to print tables

Index

• type Table
  • func NewTable() *Table
  • func (t *Table) NewCol(name string)
  • func (t *Table) NewRow()
  • func (t *Table) Print(s string)
  • func (t *Table) Printf(format string, a ...any)
  • func (t *Table) String() string
• type TableStyle

Types

type Table

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

func NewTable

func NewTable() *Table

func (*Table) NewCol

func (t *Table) NewCol(name string)

NewCol adds a column with the given name to the current row

func (*Table) NewRow

func (t *Table) NewRow()

NewRow adds a row to the end of table

func (*Table) Print

func (t *Table) Print(s string)

Print s to the current column

func (*Table) Printf

func (t *Table) Printf(format string, a ...any)

Printf is shorthand for

tbl.Print(fmt.Sprintf(format, a))

func (*Table) String

func (t *Table) String() string

String returns the formatted table

type TableStyle

type TableStyle uint8

const (
	StyleDefault TableStyle = iota
	StyleMinimal
)