Emerald
A basic color library for use in my Go projects, built on top of mgutz/ansi.
Package ansi is a small, fast library to create ANSI colored strings and codes.
Install
Get it
go get -u github.com/jcwillox/emerald
Example
import "github.com/jcwillox/emerald"
// colorize a string, SLOW
msg := emerald.Color("foo", "red+b:white")
// create a FAST closure function to avoid computation of ANSI code
phosphorize := emerald.ColorFunc("green+h:black")
msg = phosphorize("Bring back the 80s!")
msg2 := phospohorize("Look, I'm a CRT!")
// cache escape codes and build strings manually
lime := emerald.ColorCode("green+h:black")
reset := emerald.ColorCode("reset")
fmt.Println(lime, "Bring back the 80s!", reset)
Other examples
Color(s, "red") // red
Color(s, "red+d") // red dim
Color(s, "red+b") // red bold
Color(s, "red+B") // red blinking
Color(s, "red+u") // red underline
Color(s, "red+bh") // red bold bright
Color(s, "red:white") // red on white
Color(s, "red+b:white+h") // red bold on white bright
Color(s, "red+B:white+h") // red blink on white bright
Color(s, "off") // turn off ansi codes
To view color combinations, from project directory in terminal.
go test
Style format
"foregroundColor+attributes:backgroundColor+attributes"
Colors
- black
- red
- green
- yellow
- blue
- magenta
- cyan
- white
- 0...255 (256 colors)
- #FFFFFF (hex color codes)
Foreground Attributes
- B = Blink
- b = bold
- h = high intensity (bright)
- d = dim
- i = inverse
- s = strikethrough
- u = underline
Background Attributes
- h = high intensity (bright)
Constants
- emerald.Reset
- emerald.DefaultBG
- emerald.DefaultFG
- emerald.Black
- emerald.Red
- emerald.Green
- emerald.Yellow
- emerald.Blue
- emerald.Magenta
- emerald.Cyan
- emerald.White
- emerald.LightBlack
- emerald.LightRed
- emerald.LightGreen
- emerald.LightYellow
- emerald.LightBlue
- emerald.LightMagenta
- emerald.LightCyan
- emerald.LightWhite
Windows Support
Emerald has full support for Windows and has print functions that wrap mattn/go-colorable to handle ANSI support on older windows systems.
import (
"github.com/jcwillox/emerald"
)
emerald.Print(emerald.Blue)
emerald.Printf("%s%s", emerald.Blue, "Hello World")
emerald.Println(emerald.Blue, "Hello World", Reset)
References
Wikipedia ANSI escape codes Colors
General tips and formatting
0 Oct 22, 2021
21 Nov 20, 2022
1.2k Dec 29, 2022
10 Nov 25, 2022
4 Nov 1, 2021
4 Dec 13, 2022
134 Jan 4, 2023
0 Jan 18, 2022
52 Dec 9, 2022
0 Feb 5, 2022
6 Oct 4, 2022
2 Feb 1, 2022
3 Nov 13, 2021
2 May 30, 2022
17 Oct 23, 2022
4 Aug 11, 2022
1.3k Jan 9, 2023
376 Jan 5, 2023