mirror of
https://github.com/coder/coder.git
synced 2025-07-03 16:13:58 +00:00
dd97fe2bce
This change will improve over CLI performance and "snappiness" as well as substantially reduce our test times. Preliminary benchmarks show `coder server --help` times cut from 300ms to 120ms on my dogfood instance. The inefficiency of lipgloss disproportionately impacts our system, as all help text for every command is generated whenever any command is invoked. The `pretty` API could clean up a lot of the code (e.g., by replacing complex string concatenations with Printf), but this commit is too expansive as is so that work will be done in a follow up.
77 lines
1.8 KiB
Go
77 lines
1.8 KiB
Go
package cliui
|
|
|
|
import (
|
|
"fmt"
|
|
"io"
|
|
"strings"
|
|
|
|
"github.com/coder/pretty"
|
|
)
|
|
|
|
// cliMessage provides a human-readable message for CLI errors and messages.
|
|
type cliMessage struct {
|
|
Style pretty.Style
|
|
Header string
|
|
Prefix string
|
|
Lines []string
|
|
}
|
|
|
|
// String formats the CLI message for consumption by a human.
|
|
func (m cliMessage) String() string {
|
|
var str strings.Builder
|
|
|
|
if m.Prefix != "" {
|
|
_, _ = str.WriteString(Bold(m.Prefix))
|
|
}
|
|
|
|
pretty.Fprint(&str, m.Style, m.Header)
|
|
_, _ = str.WriteString("\r\n")
|
|
for _, line := range m.Lines {
|
|
_, _ = fmt.Fprintf(&str, " %s %s\r\n", pretty.Sprint(m.Style, "|"), line)
|
|
}
|
|
return str.String()
|
|
}
|
|
|
|
// Warn writes a log to the writer provided.
|
|
func Warn(wtr io.Writer, header string, lines ...string) {
|
|
_, _ = fmt.Fprint(wtr, cliMessage{
|
|
Style: DefaultStyles.Warn,
|
|
Prefix: "WARN: ",
|
|
Header: header,
|
|
Lines: lines,
|
|
}.String())
|
|
}
|
|
|
|
// Warn writes a formatted log to the writer provided.
|
|
func Warnf(wtr io.Writer, fmtStr string, args ...interface{}) {
|
|
Warn(wtr, fmt.Sprintf(fmtStr, args...))
|
|
}
|
|
|
|
// Info writes a log to the writer provided.
|
|
func Info(wtr io.Writer, header string, lines ...string) {
|
|
_, _ = fmt.Fprint(wtr, cliMessage{
|
|
Header: header,
|
|
Lines: lines,
|
|
}.String())
|
|
}
|
|
|
|
// Infof writes a formatted log to the writer provided.
|
|
func Infof(wtr io.Writer, fmtStr string, args ...interface{}) {
|
|
Info(wtr, fmt.Sprintf(fmtStr, args...))
|
|
}
|
|
|
|
// Error writes a log to the writer provided.
|
|
func Error(wtr io.Writer, header string, lines ...string) {
|
|
_, _ = fmt.Fprint(wtr, cliMessage{
|
|
Style: DefaultStyles.Error,
|
|
Prefix: "ERROR: ",
|
|
Header: header,
|
|
Lines: lines,
|
|
}.String())
|
|
}
|
|
|
|
// Errorf writes a formatted log to the writer provided.
|
|
func Errorf(wtr io.Writer, fmtStr string, args ...interface{}) {
|
|
Error(wtr, fmt.Sprintf(fmtStr, args...))
|
|
}
|