chalk_test.go

package chalk

import (
	"fmt"
	"testing"
)

func init() {
	// Force tests to print escape sequence regardless of terminal capabilities.
	HasColors = true
}

var codes = []struct {
	p    Parameter
	code int
	name string
}{
	{FGBlack, 30, "black"},
	{FGRed, 31, "red"},
	{FGGreen, 32, "green"},
	{FGYellow, 33, "yellow"},
	{FGBlue, 34, "blue"},
	{FGMagenta, 35, "magenta"},
	{FGCyan, 36, "cyan"},
	{FGWhite, 37, "white"},

	{FGGray, 90, "gray"},
	{FGBrightBlack, 90, "brightblack"},
	{FGBrightRed, 91, "brightred"},
	{FGBrightGreen, 92, "brightgreen"},
	{FGBrightYellow, 93, "brightyellow"},
	{FGBrightBlue, 94, "brightblue"},
	{FGBrightMagenta, 95, "brightmagenta"},
	{FGBrightCyan, 96, "brightcyan"},
	{FGBrightWhite, 97, "brightwhite"},
}

func TestAddColors(t *testing.T) {
	for i := range codes {
		chalk := NewChalk()
		// Foreground colors on the same chalk should override each other.
		for j := 0; j <= i; j++ {
			chalk.Add(codes[j].p)
		}
		want := fmt.Sprintf("\x1b[%dm%s\x1b[0m", codes[i].code, codes[i].name)
		if s := chalk.Sprint(codes[i].name); s != want {
			t.Errorf("got:%q\nwant:%q", s, want)
		}
	}
}

func TestChalk_Sprint(t *testing.T) {
	for _, test := range codes {
		chalk := NewChalk()
		chalk.Add(test.p)
		want := fmt.Sprintf("\x1b[%dm%s\x1b[0m", test.code, test.name)
		if s := chalk.Sprint(test.name); s != want {
			t.Errorf("Sprint(%s) = %q, want %q", test.name, s, want)
		}
	}
}

func TestChalk_Sprintf(t *testing.T) {
	for _, test := range codes {
		chalk := NewChalk()
		chalk.Add(test.p)
		want := fmt.Sprintf("\x1b[%dmhello, %s!\x1b[0m", test.code, test.name)
		if s := chalk.Sprintf("hello, %s!", test.name); s != want {
			t.Errorf("Sprint(%s) = %q, want %q", test.name, s, want)
		}
	}
}

func TestChalk_Sprintln(t *testing.T) {
	for _, test := range codes {
		chalk := NewChalk()
		chalk.Add(test.p)
		want := fmt.Sprintf("\x1b[%dm%s\n\x1b[0m", test.code, test.name)
		if s := chalk.Sprintln(test.name); s != want {
			t.Errorf("Sprintln(%s) = %q, want %q", test.name, s, want)
		}
	}
}

func ExampleChalk_Print() {
	// TODO: Explore ways of capturing stdout
	for _, test := range codes[:8] {
		chalk := NewChalk()
		chalk.Add(test.p)
		chalk.Println(test.name)
	}
	// Output:
	// black
	// red
	// green
	// yellow
	// blue
	// magenta
	// cyan
	// white
	// 
}

func ExampleChalk_Printf() {
	for _, test := range codes[:8] {
		chalk := NewChalk()
		chalk.Add(test.p)
		chalk.Printf("hello, %s!", test.name)
		fmt.Println()
	}
	// Output:
	// hello, black!
	// hello, red!
	// hello, green!
	// hello, yellow!
	// hello, blue!
	// hello, magenta!
	// hello, cyan!
	// hello, white!
}

func ExampleRed() {
	Red("red")
	fmt.Println()
	Red("hello, %s!", "red")
	// Output:
	// red
	// hello, red!
}

func ExampleGreen() {
	Green("green")
	fmt.Println()
	Green("hello, %s!", "green")
	// Output:
	// green
	// hello, green!
}

func BenchmarkChalk_Print(b *testing.B) {
	for i := 0; i < b.N; i++ {
		c := NewChalk()
		c.Add(FGRed)
		_ = c.Sprint("hello")
	}
}