colorhash

README

• Take in arbitrary input and return a deterministic color

• Color chosen can be limited in several ways:

  • only visually / noticibly distinct colors to choose from
  • Color exclusions
    • dynamic color exclusions (optional terminal context)
  • colors within different terminal support classes (i.e. term-256)

• Offer to return Hex codes (6 digits or 3)

• Offer to return ascii escape codes

• If the input is text, offer to wrap the input text and return the output as a string

1. take input as bytes
2. hash the input
3. use modulo against the sum to choose the color to return from the subset of colors selected.

Documentation

Index

• Constants
• Variables
• func ColorString(colorString string) func(...interface{}) string
• func HashBytes(r io.Reader) int
• func HashString(s string) int
• type Color
  • func CreateColor(x int) Color
  • func FromHex(h string) (c Color, err error)
  • func RGB(r, g, b int) Color
  • func RGBA(r, g, b, a int) (c Color, err error)
  • func (c Color) GetBlue() int
  • func (c Color) GetGreen() int
  • func (c Color) GetRed() int
  • func (c Color) RGBA() (r, g, b, a uint32)
  • func (c Color) ToHex() string
  • func (c Color) ToShortHex() string

Constants

const (
	MaxUint = ^uint(0)
	MaxInt  = int(MaxUint >> 1)
)

const (
	TotalHexColorspace = 16777216
)

Variables

var (
	Info  = Teal
	Warn  = Yellow
	Fatal = Red
)

var (
	Black   = ColorString("\033[1;30m%s\033[0m")
	Red     = ColorString("\033[1;31m%s\033[0m")
	Green   = ColorString("\033[1;32m%s\033[0m")
	Yellow  = ColorString("\033[1;33m%s\033[0m")
	Purple  = ColorString("\033[1;34m%s\033[0m")
	Magenta = ColorString("\033[1;35m%s\033[0m")
	Teal    = ColorString("\033[0;97m%s\033[0m")
	White   = ColorString("\033[1;37m%s\033[0m")
	//  Bold
	BBlack  = ColorString("\033[1;30m%s\033[0m")
	BRed    = ColorString("\033[1;31m%s\033[0m")
	BGreen  = ColorString("\033[1;32m%s\033[0m")
	BYellow = ColorString("\033[1;33m%s\033[0m")
	BBlue   = ColorString("\033[1;34m%s\033[0m")
	BPurple = ColorString("\033[1;35m%s\033[0m")
	BCyan   = ColorString("\033[1;36m%s\033[0m")
	BWhite  = ColorString("\033[1;37m%s\033[0m")

	//  Underline
	UBlack  = ColorString("\033[4;30m%s\033[0m")
	URed    = ColorString("\033[4;31m%s\033[0m")
	UGreen  = ColorString("\033[4;32m%s\033[0m")
	UYellow = ColorString("\033[4;33m%s\033[0m")
	UBlue   = ColorString("\033[4;34m%s\033[0m")
	UPurple = ColorString("\033[4;35m%s\033[0m")
	UCyan   = ColorString("\033[4;36m%s\033[0m")
	UWhite  = ColorString("\033[4;37m%s\033[0m")

	//  Background
	OnBlack  = ColorString("\033[40m%s\033[0m")
	OnRed    = ColorString("\033[41m%s\033[0m")
	OnGreen  = ColorString("\033[42m%s\033[0m")
	OnYellow = ColorString("\033[43m%s\033[0m")
	OnBlue   = ColorString("\033[44m%s\033[0m")
	OnPurple = ColorString("\033[45m%s\033[0m")
	OnCyan   = ColorString("\033[46m%s\033[0m")
	OnWhite  = ColorString("\033[47m%s\033[0m")

	//  High Intensty
	IBlack  = ColorString("\033[0;90m%s\033[0m")
	IRed    = ColorString("\033[0;91m%s\033[0m")
	IGreen  = ColorString("\033[0;92m%s\033[0m")
	IYellow = ColorString("\033[0;93m%s\033[0m")
	IBlue   = ColorString("\033[0;94m%s\033[0m")
	IPurple = ColorString("\033[0;95m%s\033[0m")
	ICyan   = ColorString("\033[0;96m%s\033[0m")
	IWhite  = ColorString("\033[0;97m%s\033[0m")

	//  Bold High Intensty
	BIBlack  = ColorString("\033[1;90m%s\033[0m")
	BIRed    = ColorString("\033[1;91m%s\033[0m")
	BIGreen  = ColorString("\033[1;92m%s\033[0m")
	BIYellow = ColorString("\033[1;93m%s\033[0m")
	BIBlue   = ColorString("\033[1;94m%s\033[0m")
	BIPurple = ColorString("\033[1;95m%s\033[0m")
	BICyan   = ColorString("\033[1;96m%s\033[0m")
	BIWhite  = ColorString("\033[1;97m%s\033[0m")

	//  High Intensty backgrounds
	OnIBlack  = ColorString("\033[0;100m%s\033[0m")
	OnIRed    = ColorString("\033[0;101m%s\033[0m")
	OnIGreen  = ColorString("\033[0;102m%s\033[0m")
	OnIYellow = ColorString("\033[0;103m%s\033[0m")
	OnIBlue   = ColorString("\033[0;104m%s\033[0m")
	OnIPurple = ColorString("\033[10;95m%s\033[0m")
	OnICyan   = ColorString("\033[0;106m%s\033[0m")
	OnIWhite  = ColorString("\033[0;107m%s\033[0m")
)

Functions

func ColorString

func ColorString(colorString string) func(...interface{}) string

func HashBytes

func HashBytes(r io.Reader) int

func HashString

func HashString(s string) int

Types

type Color

type Color struct {
	Hue   int
	Alpha int
}

func CreateColor

func CreateColor(x int) Color

func FromHex

func FromHex(h string) (c Color, err error)

func RGB

func RGB(r, g, b int) Color

func RGBA

func RGBA(r, g, b, a int) (c Color, err error)

func (Color) GetBlue

func (c Color) GetBlue() int

func (Color) GetGreen

func (c Color) GetGreen() int

func (Color) GetRed

func (c Color) GetRed() int

func (Color) RGBA

func (c Color) RGBA() (r, g, b, a uint32)

func (Color) ToHex

func (c Color) ToHex() string

func (Color) ToShortHex

func (c Color) ToShortHex() string