mirror of https://github.com/fatedier/frp
62 lines
2.3 KiB
Markdown
62 lines
2.3 KiB
Markdown
# table <br/> [](https://godoc.org/github.com/rodaine/table) [](https://travis-ci.org/rodaine/table)
|
|
|
|
|
|
|
|
Package table provides a convenient way to generate tabular output of any data, primarily useful for CLI tools.
|
|
|
|
## Features
|
|
|
|
- Accepts all data types (`string`, `int`, `interface{}`, everything!) and will use the `String() string` method of a type if available.
|
|
- Can specify custom formatting for the header and first column cells for better readability.
|
|
- Columns are left-aligned and sized to fit the data, with customizable padding.
|
|
- The printed output can be sent to any `io.Writer`, defaulting to `os.Stdout`.
|
|
- Built to an interface, so you can roll your own `Table` implementation.
|
|
- Works well with ANSI colors ([fatih/color](https://github.com/fatih/color) in the example)!
|
|
- Can provide a custom `WidthFunc` to accomodate multi- and zero-width characters (such as [runewidth](https://github.com/mattn/go-runewidth))
|
|
|
|
## Usage
|
|
|
|
**Download the package:**
|
|
|
|
```sh
|
|
go get -u github.com/rodaine/table
|
|
```
|
|
|
|
**Example:**
|
|
|
|
```go
|
|
package main
|
|
|
|
import (
|
|
"fmt"
|
|
"strings"
|
|
|
|
"github.com/fatih/color"
|
|
"github.com/rodaine/table"
|
|
)
|
|
|
|
func main() {
|
|
headerFmt := color.New(color.FgGreen, color.Underline).SprintfFunc()
|
|
columnFmt := color.New(color.FgYellow).SprintfFunc()
|
|
|
|
tbl := table.New("ID", "Name", "Score", "Added")
|
|
tbl.WithHeaderFormatter(headerFmt).WithFirstColumnFormatter(columnFmt)
|
|
|
|
for _, widget := range getWidgets() {
|
|
tbl.AddRow(widget.ID, widget.Name, widget.Cost, widget.Added)
|
|
}
|
|
|
|
tbl.Print()
|
|
}
|
|
```
|
|
|
|
_Consult the [documentation](https://godoc.org/github.com/rodaine/table) for further examples and usage information_
|
|
|
|
## Contributing
|
|
|
|
Please feel free to submit an [issue](https://github.com/rodaine/table/issues) or [PR](https://github.com/rodaine/table/pulls) to this repository for features or bugs. All submitted code must pass the scripts specified within [.travis.yml](https://github.com/rodaine/table/blob/master/.travis.yml) and should include tests to back up the changes.
|
|
|
|
## License
|
|
|
|
table is released under the MIT License (Expat). See the [full license](https://github.com/rodaine/table/blob/master/license).
|