Easy column formatted output for golang
Clone or download
ryanuber Merge pull request #16 from ryanuber/b-nil-config
Handle nil configs during merge
Latest commit abc9093 Jul 3, 2017
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.travis.yml remove goveralls for now Apr 19, 2014
LICENSE Updating license copy Sep 15, 2016
README.md Allow disabling of automatic trimming Jun 30, 2017
columnize.go Merge pull request #16 from ryanuber/b-nil-config Jul 3, 2017
columnize_test.go Merge pull request #16 from ryanuber/b-nil-config Jul 3, 2017

README.md

Columnize

Easy column-formatted output for golang

Build Status GoDoc

Columnize is a really small Go package that makes building CLI's a little bit easier. In some CLI designs, you want to output a number similar items in a human-readable way with nicely aligned columns. However, figuring out how wide to make each column is a boring problem to solve and eats your valuable time.

Here is an example:

package main

import (
    "fmt"
    "github.com/ryanuber/columnize"
)

func main() {
    output := []string{
        "Name | Gender | Age",
        "Bob | Male | 38",
        "Sally | Female | 26",
    }
    result := columnize.SimpleFormat(output)
    fmt.Println(result)
}

As you can see, you just pass in a list of strings. And the result:

Name   Gender  Age
Bob    Male    38
Sally  Female  26

Columnize is tolerant of missing or empty fields, or even empty lines, so passing in extra lines for spacing should show up as you would expect.

Configuration

Columnize is configured using a Config, which can be obtained by calling the DefaultConfig() method. You can then tweak the settings in the resulting Config:

config := columnize.DefaultConfig()
config.Delim = "|"
config.Glue = "  "
config.Prefix = ""
config.Empty = ""
config.NoTrim = false
  • Delim is the string by which columns of input are delimited
  • Glue is the string by which columns of output are delimited
  • Prefix is a string by which each line of output is prefixed
  • Empty is a string used to replace blank values found in output
  • NoTrim is a boolean used to disable the automatic trimming of input values

You can then pass the Config in using the Format method (signature below) to have text formatted to your liking.

See the godoc page for usage.