formatted

Documentation

Index

• Variables
• func Age(t *metav1.Time, c clockwork.Clock) string
• func AutoStepName(stepName string) string
• func BaseCompletion(target string, args []string) ([]string, cobra.ShellCompDirective)
• func CheckParamDefaultValue(param string, paramSpec []v1.ParamSpec) string
• func ColorStatus(status string) string
• func Condition(c v1.Conditions) string
• func DecorateAttr(attrString, message string) string
• func Duration(t1, t2 *metav1.Time) string
• func FindVersion(version map[string]string) string
• func FormatAddress(addressURL string) string
• func FormatDesc(desc string) string
• func GetObjectsWithKubectl(obj string) []string
• func GetTaskRefName(task *v1.PipelineTask) string
• func Param(params []v1.Param, paramSpec []v1.ParamSpec) string
• func ParentCompletion(cmd *cobra.Command, args []string, toComplete string) ([]string, cobra.ShellCompDirective)
• func PipelineRefExists(spec v1.PipelineRunSpec) string
• func RemoveLastAppliedConfig(annotations map[string]string) map[string]string
• func Result(value v1.ParamValue) string
• func TaskRefExists(spec v1.TaskRunSpec) string
• func Timeout(t *metav1.Duration) string
• func Workspace(ws v1.WorkspaceBinding) string
• type Color
  • func NewColor() *Color
  • func (c *Color) Error(w io.Writer, format string, args ...interface{})
  • func (c *Color) PrintRed(w io.Writer, format string, args ...interface{})

Variables

var ConditionColor = map[string]color.Attribute{
	"Failed":    color.FgHiRed,
	"Succeeded": color.FgHiGreen,
	"Running":   color.FgHiBlue,
	"Cancelled": color.FgHiYellow,
	"Completed": color.FgHiMagenta,
	"Pending":   color.FgHiBlue,
	"Started":   color.FgHiCyan,
}

Functions

func Age

func Age(t *metav1.Time, c clockwork.Clock) string

func AutoStepName

func AutoStepName(stepName string) string

AutoStepName when our stepName is empty return a generated name as generated on pipeLine

func BaseCompletion

func BaseCompletion(target string, args []string) ([]string, cobra.ShellCompDirective)

BaseCompletion return a completion for a kubernetes object using Kubectl

func CheckParamDefaultValue

func CheckParamDefaultValue(param string, paramSpec []v1.ParamSpec) string

CheckParamDefaultValue returns param's value if defined, if not then checks for default value If default value is not defined then returns param's type

func ColorStatus

func ColorStatus(status string) string

ColorStatus Get a status coloured

func Condition

func Condition(c v1.Conditions) string

Condition returns a human readable text based on the status of the Condition

func DecorateAttr

func DecorateAttr(attrString, message string) string

DecorateAttr decorate strings with a color or an emoji, respecting the user preference if no colour needed.

func Duration

func Duration(t1, t2 *metav1.Time) string

func FindVersion

func FindVersion(version map[string]string) string

func FormatAddress

func FormatAddress(addressURL string) string

func FormatDesc

func FormatDesc(desc string) string

If description is longer than 20 char then it will return initial 20 chars suffixed by ...

func GetObjectsWithKubectl

func GetObjectsWithKubectl(obj string) []string

GetObjectsWithKubectl return completions with kubectl, we are doing this with kubectl since we have caching and without it completion is way too slow

func GetTaskRefName

func GetTaskRefName(task *v1.PipelineTask) string

func Param

func Param(params []v1.Param, paramSpec []v1.ParamSpec) string

Param returns params with their values. If user value is not defined then returns default value, if default value is not defined then returns param's type

func ParentCompletion

func ParentCompletion(cmd *cobra.Command, args []string, toComplete string) ([]string, cobra.ShellCompDirective)

ParentCompletion do completion of command to the Parent

func PipelineRefExists

func PipelineRefExists(spec v1.PipelineRunSpec) string

Check if PipelineRef exists on a PipelineRunSpec. Returns empty string if not present.

func RemoveLastAppliedConfig

func RemoveLastAppliedConfig(annotations map[string]string) map[string]string

func Result

func Result(value v1.ParamValue) string

Result will format a given result value

func TaskRefExists

func TaskRefExists(spec v1.TaskRunSpec) string

Check if TaskRef exists on a TaskRunSpec. Returns empty string if not present.

func Timeout

func Timeout(t *metav1.Duration) string

func Workspace

func Workspace(ws v1.WorkspaceBinding) string

Types

type Color

type Color struct {
	Rainbow *rainbow
	// contains filtered or unexported fields
}

Color formatter to print the colored output on streams

func NewColor

func NewColor() *Color

NewColor returns a new instance color formatter

func (*Color) Error

func (c *Color) Error(w io.Writer, format string, args ...interface{})

Error prints the formatted content to given destination in red color

func (*Color) PrintRed

func (c *Color) PrintRed(w io.Writer, format string, args ...interface{})

PrintRed prints the formatted content to given destination in red color