commit e5d4c4e942f0131b01a43069d0e4d24132b99ad4 · treybastian.com/colourize

+71

colourize.go

···

       1
       1
       +
       // Package colourize implements simple ANSI colour codes to style termianl output text.

     

       2
       2
       +
       package colourize

     

       3
       3
       +
       

     

       4
       4
       +
       import (

     

       5
       5
       +
       	"bytes"

     

       6
       6
       +
       	"fmt"

     

       7
       7
       +
       	"strconv"

     

       8
       8
       +
       )

     

       9
       9
       +
       

     

       10
       10
       +
       // Colour Styles

     

       11
       11
       +
       const (

     

       12
       12
       +
       	// Text Colour

     

       13
       13
       +
       	Black   = 30

     

       14
       14
       +
       	Red     = 31

     

       15
       15
       +
       	Green   = 32

     

       16
       16
       +
       	Yellow  = 33

     

       17
       17
       +
       	Blue    = 34

     

       18
       18
       +
       	Magenta = 35

     

       19
       19
       +
       	Cyan    = 36

     

       20
       20
       +
       	White   = 37

     

       21
       21
       +
       	Grey    = 90

     

       22
       22
       +
       

     

       23
       23
       +
       	// Background Colour

     

       24
       24
       +
       	Blackbg   = 40

     

       25
       25
       +
       	Redbg     = 41

     

       26
       26
       +
       	Greenbg   = 42

     

       27
       27
       +
       	Yellowbg  = 43

     

       28
       28
       +
       	Bluebg    = 44

     

       29
       29
       +
       	Magentabg = 45

     

       30
       30
       +
       	Cyanbg    = 46

     

       31
       31
       +
       	Whitebg   = 47

     

       32
       32
       +
       

     

       33
       33
       +
       	// Style

     

       34
       34
       +
       	Bold      = 1

     

       35
       35
       +
       	Dim       = 2

     

       36
       36
       +
       	Italic    = 3

     

       37
       37
       +
       	Underline = 4

     

       38
       38
       +
       	Blinkslow = 5

     

       39
       39
       +
       	Blinkfast = 6

     

       40
       40
       +
       	Inverse   = 7

     

       41
       41
       +
       	Hidden    = 8

     

       42
       42
       +
       	Strikeout = 9

     

       43
       43
       +
       )

     

       44
       44
       +
       

     

       45
       45
       +
       /* Colourize is the function that provides colours for values passed to it.

     

       46
       46
       +
       package main

     

       47
       47
       +
       

     

       48
       48
       +
       import(

     

       49
       49
       +
       	c "github.com/TreyBastian/colourize"

     

       50
       50
       +
       	"fmt"

     

       51
       51
       +
       )

     

       52
       52
       +
       

     

       53
       53
       +
       func main() {

     

       54
       54
       +
       	fmt.Println(c.Colourize("Hello", c.Cyan))

     

       55
       55
       +
       }

     

       56
       56
       +
       */

     

       57
       57
       +
       

     

       58
       58
       +
       func Colourize(s interface{}, style ...int) string {

     

       59
       59
       +
       	b := new(bytes.Buffer)

     

       60
       60
       +
       	b.WriteString("\x1b[")

     

       61
       61
       +
       	l := len(style)

     

       62
       62
       +
       	for k, c := range style {

     

       63
       63
       +
       		b.WriteString(strconv.Itoa(c))

     

       64
       64
       +
       		if l > 1 && k < l-1 {

     

       65
       65
       +
       			b.WriteString(";")

     

       66
       66
       +
       		}

     

       67
       67
       +
       	}

     

       68
       68
       +
       	b.WriteString("m")

     

       69
       69
       +
       

     

       70
       70
       +
       	return fmt.Sprintf("%s%v\x1b[0m", b.String(), s)

     

       71
       71
       +
       }

+55

colourize_test.go

···

       1
       1
       +
       package colourize

     

       2
       2
       +
       

     

       3
       3
       +
       import (

     

       4
       4
       +
       	"fmt"

     

       5
       5
       +
       	"testing"

     

       6
       6
       +
       )

     

       7
       7
       +
       

     

       8
       8
       +
       func TestText(t *testing.T) {

     

       9
       9
       +
       	fmt.Println("~~~* Testing Text Colour *~~~")

     

       10
       10
       +
       	fmt.Println(Colourize("Black Text", Black))

     

       11
       11
       +
       	fmt.Println(Colourize("Red Text", Red))

     

       12
       12
       +
       	fmt.Println(Colourize("Green Text", Green))

     

       13
       13
       +
       	fmt.Println(Colourize("Yellow Text", Yellow))

     

       14
       14
       +
       	fmt.Println(Colourize("Blue Text", Blue))

     

       15
       15
       +
       	fmt.Println(Colourize("Magenta Text", Magenta))

     

       16
       16
       +
       	fmt.Println(Colourize("Cyan Text", Cyan))

     

       17
       17
       +
       	fmt.Println(Colourize("White Text", White))

     

       18
       18
       +
       	fmt.Println(Colourize("Grey Text", Grey))

     

       19
       19
       +
       }

     

       20
       20
       +
       

     

       21
       21
       +
       func TestBackground(t *testing.T) {

     

       22
       22
       +
       	fmt.Println("~~~* Testing Background Colour *~~~")

     

       23
       23
       +
       	fmt.Println(Colourize("Black Background", Blackbg))

     

       24
       24
       +
       	fmt.Println(Colourize("Red Background", Redbg))

     

       25
       25
       +
       	fmt.Println(Colourize("Green Background", Greenbg))

     

       26
       26
       +
       	fmt.Println(Colourize("Yellow Background", Yellowbg))

     

       27
       27
       +
       	fmt.Println(Colourize("Blue Background", Bluebg))

     

       28
       28
       +
       	fmt.Println(Colourize("Magenta Background", Magentabg))

     

       29
       29
       +
       	fmt.Println(Colourize("Cyan Background", Cyanbg))

     

       30
       30
       +
       	fmt.Println(Colourize("White Background", Whitebg))

     

       31
       31
       +
       }

     

       32
       32
       +
       

     

       33
       33
       +
       func TestStyle(t *testing.T) {

     

       34
       34
       +
       	fmt.Println("~~~* Testing Style *~~~")

     

       35
       35
       +
       	fmt.Println(Colourize("Bold Test", Bold))

     

       36
       36
       +
       	fmt.Println(Colourize("Dim Test", Dim))

     

       37
       37
       +
       	fmt.Println(Colourize("Italic Test", Italic))

     

       38
       38
       +
       	fmt.Println(Colourize("Underline Test", Underline))

     

       39
       39
       +
       	fmt.Println(Colourize("Blinkslow Test", Blinkslow))

     

       40
       40
       +
       	fmt.Println(Colourize("Blinkfast Test", Blinkfast))

     

       41
       41
       +
       	fmt.Println(Colourize("Inverse Test", Inverse))

     

       42
       42
       +
       	fmt.Println(Colourize("Hidden Test", Hidden))

     

       43
       43
       +
       	fmt.Println(Colourize("Strikeout Test", Strikeout))

     

       44
       44
       +
       }

     

       45
       45
       +
       

     

       46
       46
       +
       func TestFunctional(t *testing.T) {

     

       47
       47
       +
       	fmt.Println("~~~* Testing Functional Uses *~~~")

     

       48
       48
       +
       	fmt.Println(Colourize("Bold White and Green Background", Bold, White, Greenbg))

     

       49
       49
       +
       	fmt.Println(Colourize("Dim White with Cyan Background and ", White, Cyanbg, Dim), "Testing Automatic Style Reset")

     

       50
       50
       +
       	fmt.Println(Colourize("White background with Blue Text and", Whitebg, Blue), Colourize("Green Background and Yellow Text", Greenbg, Yellow))

     

       51
       51
       +
       	testString := "with a Printf test"

     

       52
       52
       +
       	fmt.Printf(Colourize("Blue Background and White Text %s", Bluebg, White), testString)

     

       53
       53
       +
       	fmt.Printf("\n")

     

       54
       54
       +
       	fmt.Println(Colourize(1234, Green), "Testing with Integer Input")

     

       55
       55
       +
       }