clitable

= CLITable

Pretty print Data as tables on the command line.

== CLI tool

The csvtable cli tool allows printing CSV data as a table:

  go install github.com/DavidGamba/dgtools/clitable/cmd/csvtable@v0.3.0

To parse TSV data use the `--tsv` flag.

== Library

image:https://pkg.go.dev/badge/github.com/DavidGamba/dgtools/clitable.svg[Go Reference, link="https://pkg.go.dev/github.com/DavidGamba/dgtools/clitable"]

[source, go]
----
import "github.com/DavidGamba/dgtools/clitable"
----

For simple tables of type `[][]string`:

[source, go]
----
simpleData := [][]string{{"Hello", "1"}, {"World", "2"}}
clitable.NewTablePrinter().Print(clitable.SimpleTable{simpleData})
----

----
┌───────┬───┐
│ Hello │ 1 │
├───────┼───┤
│ World │ 2 │
└───────┴───┘
----

For CSV from an `io.Reader`:

[source, go]
----
r := strings.NewReader("Hello,1\nWorld,2\n")
clitable.NewTablePrinter().FprintCSVReader(os.Stdout, r)
----

For TSV from an `io.Reader`:

[source, go]
----
r := strings.NewReader("Hello	1\nWorld	2\n")
clitable.NewTablePrinter().Separator('\t').FprintCSVReader(os.Stdout, r)
----

----
┌───────┬───┐
│ Hello │ 1 │
├───────┼───┤
│ World │ 2 │
└───────┴───┘
----

For iterating over structs you need to implement the table interface by adding a `RowIterator` function:

[source, go]
----
type Data struct {
	Info []struct {
		Name string
		ID   int
	}
}

func (d *Data) RowIterator() <-chan clitable.Row {
	c := make(chan clitable.Row)
	go func() {
		c <- clitable.Row{Fields: []string{"", "Name", "ID"}}
		for i, row := range d.Info {
			c <- clitable.Row{Fields: []string{strconv.Itoa(i + 1), row.Name, strconv.Itoa(row.ID)}}
		}
		close(c)
	}()
	return c
}
----

Then print:

[source, go]
----
data := &Data{[]struct {
  Name string
  ID   int
}{{"Hello", 1}, {"World", 2}}}

clitable.NewTablePrinter().Fprint(os.Stdout, data)
----

----
┌───┬───────┬────┐
│   │ Name  │ ID │
╞═══╪═══════╪════╡
│ 1 │ Hello │ 1  │
├───┼───────┼────┤
│ 2 │ World │ 2  │
└───┴───────┴────┘
----

Controlling style:

[source, go]
----
clitable.NewTablePrinter().SetStyle(clitable.Full).Print(data)

┌───┬───────┬────┐
│   │ Name  │ ID │
╞═══╪═══════╪════╡
│ 1 │ Hello │ 1  │
├───┼───────┼────┤
│ 2 │ World │ 2  │
└───┴───────┴────┘

clitable.NewTablePrinter().SetStyle(clitable.Full).HasHeader(false).Print(data)

┌───┬───────┬────┐
│   │ Name  │ ID │
├───┼───────┼────┤
│ 1 │ Hello │ 1  │
├───┼───────┼────┤
│ 2 │ World │ 2  │
└───┴───────┴────┘

clitable.NewTablePrinter().SetStyle(clitable.Compact).Print(data)

───┬───────┬────
   │ Name  │ ID 
═══╪═══════╪════
 1 │ Hello │ 1  
 2 │ World │ 2  
───┴───────┴────

clitable.NewTablePrinter().SetStyle(clitable.Ascii).Print(data)

+---+-------+----+
|   | Name  | ID |
+===+=======+====+
| 1 | Hello | 1  |
+---+-------+----+
| 2 | World | 2  |
+---+-------+----+

clitable.NewTablePrinter().SetStyle(clitable.Space).Print(data)

     Name    ID 
 1   Hello   1  
 2   World   2  

clitable.NewTablePrinter().SetStyle(clitable.CSV).Print(data)

,Name,ID
1,Hello,1
2,World,2
----