format

Documentation

Overview

Package format provides output formatters for task data.

Index

• type Formatter
  • func NewFormatter(f string, columns []string) (Formatter, error)
  • func NewFormatterFromCmd(cmd *cobra.Command) (Formatter, error)

Types

type Formatter

type Formatter interface {
	Task(w io.Writer, task *taskkit.Task) error
	Tasks(w io.Writer, tasks []*taskkit.Task) error
	ProjectSummaries(w io.Writer, summaries []*taskkit.ProjectSummary) error
	UrgencyBreakdown(w io.Writer, task *taskkit.Task) error
}

Formatter writes task output to a writer.

func NewFormatter

func NewFormatter(f string, columns []string) (Formatter, error)

NewFormatter returns the Formatter for the given format string and optional column list (used by the pretty formatter; ignored by json).

func NewFormatterFromCmd

func NewFormatterFromCmd(cmd *cobra.Command) (Formatter, error)

NewFormatterFromCmd returns the Formatter based on the --output flag value. If --columns is registered on the command, its value is forwarded to the formatter.