formatter

package
v5.0.1 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Dec 18, 2025 License: Apache-2.0 Imports: 29 Imported by: 0

Documentation

Index

Constants

View Source 
const (
	BOLD      = "1"
	FAINT     = "2"
	ITALIC    = "3"
	UNDERLINE = "4"
)
View Source 
const (
	RESET = "0"
	CYAN  = "36"
)
View Source 
const (
	// Never use ANSI codes
	Never = "never"

	// Always use ANSI codes
	Always = "always"

	// Auto detect terminal is a tty and can use ANSI codes
	Auto = "auto"
)
View Source 
const (
	// JSON Print in JSON format
	JSON = "json"
	// TemplateLegacyJSON the legacy json formatting value using go template
	TemplateLegacyJSON = "{{json.}}"
	// PRETTY is the constant for default formats on list commands
	//
	// Deprecated: use TABLE
	PRETTY = "pretty"
	// TABLE Print output in table format with column headers (default)
	TABLE = "table"
)
View Source 
const DISPLAY_ERROR_TIME = 10

Variables

This section is empty.

Functions

func ContainerWrite 

func ContainerWrite(ctx formatter.Context, containers []api.ContainerSummary) error

ContainerWrite renders the context for a list of containers

func NewContainerFormat 

func NewContainerFormat(source string, quiet bool, size bool) formatter.Format

NewContainerFormat returns a Format for rendering using a Context

func NewLogConsumer 

func NewLogConsumer(ctx context.Context, stdout, stderr io.Writer, color, prefix, timestamp bool) api.LogConsumer

NewLogConsumer creates a new LogConsumer

func Print 

func Print(toJSON any, format string, outWriter io.Writer, writerFn func(w io.Writer), headers ...string) error

Print prints formatted lists in different formats

func PrintPrettySection 

func PrintPrettySection(out io.Writer, printer func(writer io.Writer), headers ...string) error

PrintPrettySection prints a tabbed section on the writer parameter

func SetANSIMode 

func SetANSIMode(streams command.Streams, ansi string)

SetANSIMode configure formatter for colored output on ANSI-compliant console

func ToJSON 

func ToJSON(i any, prefix string, indentation string) (string, error)

ToJSON return a string with the JSON representation of the interface{}

func ToStandardJSON 

func ToStandardJSON(i any) (string, error)

ToStandardJSON return a string with the JSON representation of the interface{}

Types

type ContainerContext 

type ContainerContext struct {
	formatter.HeaderContext

	// FieldsUsed is used in the pre-processing step to detect which fields are
	// used in the template. It's currently only used to detect use of the .Size
	// field which (if used) automatically sets the '--size' option when making
	// the API call.
	FieldsUsed map[string]any
	// contains filtered or unexported fields
}

ContainerContext is a struct used for rendering a list of containers in a Go template.

func NewContainerContext 

func NewContainerContext() *ContainerContext

NewContainerContext creates a new context for rendering containers

func (*ContainerContext) Command 

func (c *ContainerContext) Command() string

func (*ContainerContext) CreatedAt 

func (c *ContainerContext) CreatedAt() string

func (*ContainerContext) ExitCode 

func (c *ContainerContext) ExitCode() int

func (*ContainerContext) Health 

func (c *ContainerContext) Health() string

func (*ContainerContext) ID 

func (c *ContainerContext) ID() string

ID returns the container's ID as a string. Depending on the `--no-trunc` option being set, the full or truncated ID is returned.

func (*ContainerContext) Image 

func (c *ContainerContext) Image() string

func (*ContainerContext) Label 

func (c *ContainerContext) Label(name string) string

Label returns the value of the label with the given name or an empty string if the given label does not exist.

func (*ContainerContext) Labels 

func (c *ContainerContext) Labels() string

Labels returns a comma-separated string of labels present on the container.

func (*ContainerContext) LocalVolumes 

func (c *ContainerContext) LocalVolumes() string

LocalVolumes returns the number of volumes using the "local" volume driver.

func (*ContainerContext) MarshalJSON 

func (c *ContainerContext) MarshalJSON() ([]byte, error)

MarshalJSON makes ContainerContext implement json.Marshaler

func (*ContainerContext) Mounts 

func (c *ContainerContext) Mounts() string

Mounts returns a comma-separated string of mount names present on the container. If the trunc option is set, names can be truncated (ellipsized).

func (*ContainerContext) Name 

func (c *ContainerContext) Name() string

func (*ContainerContext) Names 

func (c *ContainerContext) Names() string

Names returns a comma-separated string of the container's names, with their slash (/) prefix stripped. Additional names for the container (related to the legacy `--link` feature) are omitted.

func (*ContainerContext) Networks 

func (c *ContainerContext) Networks() string

Networks returns a comma-separated string of networks that the container is attached to.

func (*ContainerContext) Ports 

func (c *ContainerContext) Ports() string

func (*ContainerContext) Project 

func (c *ContainerContext) Project() string

func (*ContainerContext) Publishers 

func (c *ContainerContext) Publishers() api.PortPublishers

func (*ContainerContext) RunningFor 

func (c *ContainerContext) RunningFor() string

func (*ContainerContext) Service 

func (c *ContainerContext) Service() string

func (*ContainerContext) Size 

func (c *ContainerContext) Size() string

Size returns the container's size and virtual size (e.g. "2B (virtual 21.5MB)")

func (*ContainerContext) State 

func (c *ContainerContext) State() string

func (*ContainerContext) Status 

func (c *ContainerContext) Status() string

type Feature 

type Feature interface {
	Start(context.Context) error
	Stop() error
}

Feature is an compose feature that can be started/stopped by a menu command

type KEYBOARD_LOG_LEVEL 

type KEYBOARD_LOG_LEVEL int
const (
	NONE  KEYBOARD_LOG_LEVEL = 0
	INFO  KEYBOARD_LOG_LEVEL = 1
	DEBUG KEYBOARD_LOG_LEVEL = 2
)

type KeyboardError 

type KeyboardError struct {
	// contains filtered or unexported fields
}

type KeyboardWatch 

type KeyboardWatch struct {
	Watching bool
	Watcher  Feature
}

type LogKeyboard 

type LogKeyboard struct {
	Watch                 *KeyboardWatch
	Detach                func()
	IsDockerDesktopActive bool
	// contains filtered or unexported fields
}

func NewKeyboardManager 

func NewKeyboardManager(isDockerDesktopActive bool, sc chan<- os.Signal) *LogKeyboard

func (*LogKeyboard) Decorate 

func (lk *LogKeyboard) Decorate(l api.LogConsumer) api.LogConsumer

func (*LogKeyboard) EnableDetach 

func (lk *LogKeyboard) EnableDetach(detach func())

func (*LogKeyboard) EnableWatch 

func (lk *LogKeyboard) EnableWatch(enabled bool, watcher Feature)

func (*LogKeyboard) HandleKeyEvents 

func (lk *LogKeyboard) HandleKeyEvents(ctx context.Context, event keyboard.KeyEvent, project *types.Project, options api.UpOptions)

func (*LogKeyboard) PrintKeyboardInfo 

func (lk *LogKeyboard) PrintKeyboardInfo()

func (*LogKeyboard) ToggleWatch 

func (lk *LogKeyboard) ToggleWatch(ctx context.Context, options api.UpOptions)

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.