1d768f8983
Go maintainers started to unconditionally update the minimum go version for golang.org/x/ dependencies to go1.23, which means that we'll no longer be able to support any version below that when updating those dependencies; > all: upgrade go directive to at least 1.23.0 [generated] > > By now Go 1.24.0 has been released, and Go 1.22 is no longer supported > per the Go Release Policy (https://go.dev/doc/devel/release#policy). > > For golang/go#69095. This updates our minimum version to go1.23, as we won't be able to maintain compatibility with older versions because of the above. Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
132 lines
3.4 KiB
Go
132 lines
3.4 KiB
Go
// FIXME(thaJeztah): remove once we are a module; the go:build directive prevents go from downgrading language version to go1.16:
|
|
//go:build go1.23
|
|
|
|
package formatter
|
|
|
|
import (
|
|
"bytes"
|
|
"io"
|
|
"strings"
|
|
"text/template"
|
|
|
|
"github.com/docker/cli/cli/command/formatter/tabwriter"
|
|
"github.com/docker/cli/templates"
|
|
"github.com/pkg/errors"
|
|
)
|
|
|
|
// Format keys used to specify certain kinds of output formats
|
|
const (
|
|
TableFormatKey = "table"
|
|
RawFormatKey = "raw"
|
|
PrettyFormatKey = "pretty"
|
|
JSONFormatKey = "json"
|
|
|
|
DefaultQuietFormat = "{{.ID}}"
|
|
JSONFormat = "{{json .}}"
|
|
)
|
|
|
|
// Format is the format string rendered using the Context
|
|
type Format string
|
|
|
|
// IsTable returns true if the format is a table-type format
|
|
func (f Format) IsTable() bool {
|
|
return strings.HasPrefix(string(f), TableFormatKey)
|
|
}
|
|
|
|
// IsJSON returns true if the format is the json format
|
|
func (f Format) IsJSON() bool {
|
|
return string(f) == JSONFormatKey
|
|
}
|
|
|
|
// Contains returns true if the format contains the substring
|
|
func (f Format) Contains(sub string) bool {
|
|
return strings.Contains(string(f), sub)
|
|
}
|
|
|
|
// Context contains information required by the formatter to print the output as desired.
|
|
type Context struct {
|
|
// Output is the output stream to which the formatted string is written.
|
|
Output io.Writer
|
|
// Format is used to choose raw, table or custom format for the output.
|
|
Format Format
|
|
// Trunc when set to true will truncate the output of certain fields such as Container ID.
|
|
Trunc bool
|
|
|
|
// internal element
|
|
finalFormat string
|
|
header any
|
|
buffer *bytes.Buffer
|
|
}
|
|
|
|
func (c *Context) preFormat() {
|
|
c.finalFormat = string(c.Format)
|
|
// TODO: handle this in the Format type
|
|
switch {
|
|
case c.Format.IsTable():
|
|
c.finalFormat = c.finalFormat[len(TableFormatKey):]
|
|
case c.Format.IsJSON():
|
|
c.finalFormat = JSONFormat
|
|
}
|
|
|
|
c.finalFormat = strings.Trim(c.finalFormat, " ")
|
|
r := strings.NewReplacer(`\t`, "\t", `\n`, "\n")
|
|
c.finalFormat = r.Replace(c.finalFormat)
|
|
}
|
|
|
|
func (c *Context) parseFormat() (*template.Template, error) {
|
|
tmpl, err := templates.Parse(c.finalFormat)
|
|
if err != nil {
|
|
return nil, errors.Wrap(err, "template parsing error")
|
|
}
|
|
return tmpl, nil
|
|
}
|
|
|
|
func (c *Context) postFormat(tmpl *template.Template, subContext SubContext) {
|
|
if c.Format.IsTable() {
|
|
t := tabwriter.NewWriter(c.Output, 10, 1, 3, ' ', 0)
|
|
buffer := bytes.NewBufferString("")
|
|
tmpl.Funcs(templates.HeaderFunctions).Execute(buffer, subContext.FullHeader())
|
|
buffer.WriteTo(t)
|
|
t.Write([]byte("\n"))
|
|
c.buffer.WriteTo(t)
|
|
t.Flush()
|
|
} else {
|
|
c.buffer.WriteTo(c.Output)
|
|
}
|
|
}
|
|
|
|
func (c *Context) contextFormat(tmpl *template.Template, subContext SubContext) error {
|
|
if err := tmpl.Execute(c.buffer, subContext); err != nil {
|
|
return errors.Wrap(err, "template parsing error")
|
|
}
|
|
if c.Format.IsTable() && c.header != nil {
|
|
c.header = subContext.FullHeader()
|
|
}
|
|
c.buffer.WriteString("\n")
|
|
return nil
|
|
}
|
|
|
|
// SubFormat is a function type accepted by Write()
|
|
type SubFormat func(func(SubContext) error) error
|
|
|
|
// Write the template to the buffer using this Context
|
|
func (c *Context) Write(sub SubContext, f SubFormat) error {
|
|
c.buffer = bytes.NewBufferString("")
|
|
c.preFormat()
|
|
|
|
tmpl, err := c.parseFormat()
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
subFormat := func(subContext SubContext) error {
|
|
return c.contextFormat(tmpl, subContext)
|
|
}
|
|
if err := f(subFormat); err != nil {
|
|
return err
|
|
}
|
|
|
|
c.postFormat(tmpl, sub)
|
|
return nil
|
|
}
|