e067eacd81
This commit completely removes the iostreams.NewColorScheme() initializer function in favor of exporting the type fields for greater clarity in its use. The result being code specifying only the fields that matter to test cases.
102 lines
2.7 KiB
Go
102 lines
2.7 KiB
Go
package tableprinter
|
|
|
|
import (
|
|
"io"
|
|
"strings"
|
|
"time"
|
|
|
|
"github.com/cli/cli/v2/internal/text"
|
|
"github.com/cli/cli/v2/pkg/iostreams"
|
|
"github.com/cli/go-gh/v2/pkg/tableprinter"
|
|
)
|
|
|
|
type TablePrinter struct {
|
|
tableprinter.TablePrinter
|
|
isTTY bool
|
|
cs *iostreams.ColorScheme
|
|
}
|
|
|
|
// IsTTY gets whether the TablePrinter will render to a terminal.
|
|
func (t *TablePrinter) IsTTY() bool {
|
|
return t.isTTY
|
|
}
|
|
|
|
// AddTimeField in TTY mode displays the fuzzy time difference between now and t.
|
|
// In non-TTY mode it just displays t with the time.RFC3339 format.
|
|
func (tp *TablePrinter) AddTimeField(now, t time.Time, c func(string) string) {
|
|
var tf string
|
|
if tp.isTTY {
|
|
tf = text.FuzzyAgo(now, t)
|
|
} else {
|
|
tf = t.Format(time.RFC3339)
|
|
}
|
|
tp.AddField(tf, WithColor(c))
|
|
}
|
|
|
|
var (
|
|
WithColor = tableprinter.WithColor
|
|
WithPadding = tableprinter.WithPadding
|
|
WithTruncate = tableprinter.WithTruncate
|
|
)
|
|
|
|
type headerOption struct {
|
|
columns []string
|
|
}
|
|
|
|
// New creates a TablePrinter from an IOStreams.
|
|
func New(ios *iostreams.IOStreams, headers headerOption) *TablePrinter {
|
|
maxWidth := 80
|
|
isTTY := ios.IsStdoutTTY()
|
|
if isTTY {
|
|
maxWidth = ios.TerminalWidth()
|
|
}
|
|
|
|
return NewWithWriter(ios.Out, isTTY, maxWidth, ios.ColorScheme(), headers)
|
|
}
|
|
|
|
// NewWithWriter creates a TablePrinter from a Writer, whether the output is a terminal, the terminal width, and more.
|
|
func NewWithWriter(w io.Writer, isTTY bool, maxWidth int, cs *iostreams.ColorScheme, headers headerOption) *TablePrinter {
|
|
tp := &TablePrinter{
|
|
TablePrinter: tableprinter.New(w, isTTY, maxWidth),
|
|
isTTY: isTTY,
|
|
cs: cs,
|
|
}
|
|
|
|
if isTTY && len(headers.columns) > 0 {
|
|
// Make sure all headers are uppercase, taking a copy of the headers to avoid modifying the original slice.
|
|
upperCasedHeaders := make([]string, len(headers.columns))
|
|
for i := range headers.columns {
|
|
upperCasedHeaders[i] = strings.ToUpper(headers.columns[i])
|
|
}
|
|
|
|
// Make sure all header columns are padded - even the last one. Previously, the last header column
|
|
// was not padded. In tests cs.Enabled() is false which allows us to avoid having to fix up
|
|
// numerous tests that verify header padding.
|
|
var paddingFunc func(int, string) string
|
|
if cs.Enabled {
|
|
paddingFunc = text.PadRight
|
|
}
|
|
|
|
tp.AddHeader(
|
|
upperCasedHeaders,
|
|
WithPadding(paddingFunc),
|
|
WithColor(cs.TableHeader),
|
|
)
|
|
}
|
|
|
|
return tp
|
|
}
|
|
|
|
// WithHeader defines the column names for a table.
|
|
// Panics if columns is nil or empty.
|
|
func WithHeader(columns ...string) headerOption {
|
|
if len(columns) == 0 {
|
|
panic("must define header columns")
|
|
}
|
|
return headerOption{columns}
|
|
}
|
|
|
|
// NoHeader disable printing or checking for a table header.
|
|
//
|
|
// Deprecated: use WithHeader unless required otherwise.
|
|
var NoHeader = headerOption{}
|