Documentation
¶
Index ¶
Constants ¶
const ( DefaultIcon = "weights" DefaultColor = "blue" )
Variables ¶
var ( // IconValues lists the icon names HEY accepts for habits. IconValues = iconNames() // ColorValues lists the color names HEY accepts for habits. ColorValues = strings.Join(Colors, ", ") )
var Colors = []string{"blue", "red", "gold", "green", "teal", "purple", "pink", "brown"}
Colors are the habit colors HEY accepts, in the order its own enum declares them.
var EveryDay = []int32{0, 1, 2, 3, 4, 5, 6}
var Icons = []Icon{
{"weights", "💪"}, {"art", "🎨"}, {"baseball", "⚾"}, {"basketball", "🏀"},
{"bed", "😴"}, {"bicycle", "🚲"}, {"brain", "🧠"}, {"camera", "📷"},
{"cat", "🐱"}, {"church", "⛪"}, {"clean", "🧹"}, {"cook", "🍳"},
{"dog", "🐶"}, {"football", "🏈"}, {"fruit", "🍎"}, {"game", "🎮"},
{"garden", "🌻"}, {"guitar", "🎸"}, {"heart", "💗"}, {"hydrate", "💧"},
{"meditate", "🧘"}, {"money", "💰"}, {"music", "🎵"}, {"piano", "🎹"},
{"pill", "💊"}, {"plant", "🌱"}, {"read", "📖"}, {"run", "🏃"},
{"smoke", "🚬"}, {"soccer", "⚽"}, {"study", "📚"}, {"swim", "🌊"},
{"tea", "🍵"}, {"toothbrush", "🪥"}, {"tree", "🌳"}, {"tv", "📺"},
{"vegetable", "🥕"}, {"walk", "🚶"}, {"water", "🚰"}, {"write", "📝"},
{"yoga", "🤸"}, {"heat", "🔥"}, {"ice", "🧊"}, {"lotus", "🌸"},
{"breathe", "💨"}, {"drink", "🥤"}, {"star", "⭐"},
}
Icons are the habit icons HEY accepts, in the order its own enum declares them.
Functions ¶
func EmojiFor ¶
EmojiFor answers the emoji standing in for an icon, and nothing for a name HEY does not know, so a habit carrying an icon this build has not heard of still lists.
func FormatDays ¶
FormatDays returns weekdays in the numeric form accepted by HEY.
func ParseDays ¶
ParseDays accepts comma-separated weekday names or numbers from Sunday (0) through Saturday (6).
func ValidateColor ¶
ValidateColor accepts a color name supported by HEY habits.
func ValidateIcon ¶
ValidateIcon accepts an icon name supported by HEY habits.
Types ¶
type Icon ¶
Icon is one of the icons HEY draws a habit with. HEY serves an SVG per icon, which a terminal cannot draw, so each carries the emoji that stands in for it. The emoji are all two cells wide — see TestEveryHabitEmojiIsTwoCellsWide — because a habit's icon sits in lists whose width is measured.
Source Files