mirror of
https://github.com/docker/cli.git
synced 2026-11-06 13:10:41 -04:00
Nicolas Beck
de8f4032ad
Allow plugins to return informational messages without the next-steps heading or indentation. Invoke each hook once and render generic messages before the shared next-steps block. Centralize grouping and formatting in PrintMessages, with a callback for template evaluation and error handling. This avoids the need for an intermediate EvaluatedMessage type and simplifies hook collection to return the original responses. Skip messages containing only whitespace while preserving empty lines within non-empty messages. Keep PrintNextSteps as a deprecated wrapper to preserve existing callers and output. Update the printer tests and remove the obsolete appendMessages helper and its tests. Co-authored-by: Nicolas Beck <nicolas.beck@docker.com> Signed-off-by: Nicolas Beck <nicolas.beck@docker.com> Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
49 lines
1.4 KiB
Go
49 lines
1.4 KiB
Go
package hooks
|
|
|
|
import "io"
|
|
|
|
const (
|
|
whatsNext = "\n\033[1mWhat's next:\033[0m\n"
|
|
indent = " "
|
|
)
|
|
|
|
// PrintMessages groups messages by type and writes them to out. Generic messages
|
|
// appear first, without a header or indentation, followed by next steps under a
|
|
// shared "What's next:" header. Order within each type is preserved.
|
|
// Messages with no lines or an unknown type produce no output.
|
|
func PrintMessages(out io.Writer, messages []Response, evaluate func(Response) []string) {
|
|
grouped := make(map[ResponseType][]string)
|
|
for _, message := range messages {
|
|
lines := evaluate(message)
|
|
grouped[message.Type] = append(grouped[message.Type], lines...)
|
|
}
|
|
for _, responseType := range []ResponseType{GenericMessage, NextSteps} {
|
|
lines := grouped[responseType]
|
|
if len(lines) == 0 {
|
|
continue
|
|
}
|
|
|
|
header, prefix := "\n", ""
|
|
if responseType == NextSteps {
|
|
header, prefix = whatsNext, indent
|
|
}
|
|
|
|
_, _ = io.WriteString(out, header)
|
|
for _, line := range lines {
|
|
_, _ = io.WriteString(out, prefix)
|
|
_, _ = io.WriteString(out, line)
|
|
_, _ = io.WriteString(out, "\n")
|
|
}
|
|
}
|
|
}
|
|
|
|
// PrintNextSteps renders list of [NextSteps] messages and writes them
|
|
// to out. It is a no-op if messages is empty.
|
|
//
|
|
// Deprecated: use [PrintMessages] instead.
|
|
func PrintNextSteps(out io.Writer, messages []string) {
|
|
PrintMessages(out, []Response{{Type: NextSteps}}, func(Response) []string {
|
|
return messages
|
|
})
|
|
}
|