style

Documentation

Index

• Constants
• Variables
• func LowPrefix(s Options) string
• type Enum
• type Options

Constants

const SpinnerCharacter = 9

SpinnerCharacter is which of the spinner.CharSets to use

Variables

var (
	// LowBullet is a bullet-point prefix for Low-fi mode
	LowBullet = "* "
	// LowIndent is an indented prefix for Low-fi mode
	LowIndent = "  "
	// LowIndentBullet is an indented bullet-point prefix for Low-fi mode
	LowIndentBullet = "  - "
	// LowWarning is a warning prefix for Low-fi mode
	LowWarning = "! "
	// LowError is an error prefix for Low-fi mode
	LowError = "X "
	// Indented is how far to indent unstyled text
	Indented = "    "
)

var Config = map[Enum]Options{
	Celebration:        {Prefix: "🎉  "},
	Check:              {Prefix: "✅  "},
	Command:            {Prefix: "    ▪ ", LowPrefix: LowIndentBullet},
	Confused:           {Prefix: "😕  "},
	Deleted:            {Prefix: "💀  "},
	Documentation:      {Prefix: "📘  "},
	Empty:              {Prefix: "", LowPrefix: ""},
	Happy:              {Prefix: "😄  "},
	Issue:              {Prefix: "    ▪ ", LowPrefix: LowIndentBullet},
	Indent:             {Prefix: "    ", LowPrefix: LowIndent},
	Issues:             {Prefix: "🍿  "},
	Launch:             {Prefix: "🚀  "},
	LogEntry:           {Prefix: "    "},
	New:                {Prefix: "🆕  "},
	Notice:             {Prefix: "📌  "},
	Option:             {Prefix: "    ▪ ", LowPrefix: LowIndentBullet},
	Pause:              {Prefix: "⏸️  "},
	Provisioning:       {Prefix: "🌱  "},
	Ready:              {Prefix: "🏄  "},
	Restarting:         {Prefix: "🔄  "},
	Running:            {Prefix: "🏃  "},
	Sparkle:            {Prefix: "✨  "},
	Stopped:            {Prefix: "🛑  "},
	Stopping:           {Prefix: "✋  "},
	Success:            {Prefix: "✅  "},
	ThumbsDown:         {Prefix: "👎  "},
	ThumbsUp:           {Prefix: "👍  "},
	Unpause:            {Prefix: "⏯️  "},
	URL:                {Prefix: "👉  ", LowPrefix: LowIndent},
	Usage:              {Prefix: "💡  "},
	Waiting:            {Prefix: "⌛  "},
	WaitingWithSpinner: {Prefix: "⌛  ", OmitNewline: true, Spinner: true},
	Unsupported:        {Prefix: "🚡  "},
	Workaround:         {Prefix: "👉  ", LowPrefix: LowIndent},

	Conflict:         {Prefix: "💢  ", LowPrefix: LowWarning},
	Failure:          {Prefix: "❌  ", LowPrefix: LowError},
	Fatal:            {Prefix: "💣  ", LowPrefix: LowError},
	Warning:          {Prefix: "❗  ", LowPrefix: LowWarning},
	KnownIssue:       {Prefix: "🧯  ", LowPrefix: LowError},
	UnmetRequirement: {Prefix: "⛔  ", LowPrefix: LowError},
	NotAllowed:       {Prefix: "🚫  ", LowPrefix: LowError},
	Embarrassed:      {Prefix: "🤦  ", LowPrefix: LowWarning},
	Sad:              {Prefix: "😿  "},
	Shrug:            {Prefix: "🤷  "},
	Improvement:      {Prefix: "💨  ", LowPrefix: LowWarning},
	SeeNoEvil:        {Prefix: "🙈  ", LowPrefix: LowError},

	AddonDisable:     {Prefix: "🌑  "},
	AddonEnable:      {Prefix: "🌟  "},
	Caching:          {Prefix: "🤹  "},
	Celebrate:        {Prefix: "🎉  "},
	Connectivity:     {Prefix: "📶  "},
	Containerd:       {Prefix: "📦  "},
	ContainerRuntime: {Prefix: "🎁  "},
	Copying:          {Prefix: "✨  "},
	CRIO:             {Prefix: "🎁  "},
	DeletingHost:     {Prefix: "🔥  "},
	Docker:           {Prefix: "🐳  ", OmitNewline: true, Spinner: true},
	DryRun:           {Prefix: "🌵  "},
	Enabling:         {Prefix: "🔌  "},
	FileDownload:     {Prefix: "💾  "},
	Fileserver:       {Prefix: "🚀  ", OmitNewline: true},
	HealthCheck:      {Prefix: "🔎  "},
	Internet:         {Prefix: "🌐  "},
	ISODownload:      {Prefix: "💿  "},
	Kubectl:          {Prefix: "💗  "},
	Meh:              {Prefix: "🙄  ", LowPrefix: LowWarning},
	Mounting:         {Prefix: "📁  "},
	MountOptions:     {Prefix: "💾  "},
	Permissions:      {Prefix: "🔑  "},
	Provisioner:      {Prefix: "ℹ️  "},
	Pulling:          {Prefix: "🚜  "},
	Resetting:        {Prefix: "🔄  "},
	Shutdown:         {Prefix: "🛑  "},
	StartingNone:     {Prefix: "🤹  "},
	StartingSSH:      {Prefix: "🔗  "},
	StartingVM:       {Prefix: "🔥  ", OmitNewline: true, Spinner: true},
	SubStep:          {Prefix: "    ▪ ", LowPrefix: LowIndentBullet, OmitNewline: true, Spinner: true},
	Tip:              {Prefix: "💡  "},
	Unmount:          {Prefix: "🔥  "},
	VerifyingNoLine:  {Prefix: "🤔  ", OmitNewline: true},
	Verifying:        {Prefix: "🤔  "},
	CNI:              {Prefix: "🔗  "},
	Toolkit:          {Prefix: "🛠️   "},
}

Config is a map of style name to style struct For consistency, ensure that emojis added render with the same width across platforms.

Functions

func LowPrefix

func LowPrefix(s Options) string

LowPrefix returns a 7-bit compatible prefix for a style

Types

type Enum

type Enum int

Enum is an enumeration of Style

const (
	None Enum = iota
	AddonDisable
	AddonEnable
	Caching
	Celebrate
	Celebration
	Check
	Command
	Conflict
	Confused
	Connectivity
	Containerd
	ContainerRuntime
	Copying
	CRIO
	Deleted
	DeletingHost
	Docker
	Documentation
	DryRun
	Embarrassed
	Empty
	Enabling
	Failure
	Fatal
	FileDownload
	Fileserver
	Happy
	HealthCheck
	Improvement
	Indent
	Internet
	ISODownload
	Issue
	Issues
	Kubectl
	KnownIssue
	Launch
	LogEntry
	Meh
	Mounting
	MountOptions
	New
	Notice
	NotAllowed
	Option
	Pause
	Permissions
	Provisioner
	Provisioning
	Pulling
	Ready
	Resetting
	Restarting
	Running
	Sad
	SeeNoEvil
	Shrug
	Shutdown
	Sparkle
	StartingNone
	StartingSSH
	StartingVM
	Stopped
	Stopping
	SubStep
	Success
	ThumbsDown
	ThumbsUp
	Tip
	Unmount
	Unpause
	UnmetRequirement
	Unsupported
	URL
	Usage
	Verifying
	VerifyingNoLine
	Waiting
	WaitingWithSpinner
	WaitingPods
	Warning
	Workaround
	CNI
	Toolkit
)

All the Style constants available

type Options

type Options struct {
	// Prefix is a string to place in the beginning of a message
	Prefix string
	// LowPrefix is the 7-bit compatible prefix we fallback to for less-awesome terminals
	LowPrefix string
	// OmitNewline omits a newline at the end of a message.
	OmitNewline bool
	// Spinner is a character to place at ending of message
	Spinner bool
}

Options describes how to stylize a message.