Hilighter

What is this?

This go package provides color methods for strings. It also provides a method for wrapping strings that accounts for color escape codes.

How to install

Open a terminal and run the following:

$ go get -u gitlab.com/mjwhitta/hilighter/cmd/hl

Usage

In a terminal you can do things like the following:

$ cat some_file | hl green on_blue
$ cat some_file | hl rainbow on_white dim
$ cat some_file | hl rainbow on_rainbow
$ hl rainbow on_rainbow <some_file
$ echo "Hex color codes!" | hl ffffff on_ff0000
$ cat some_file | hl wrap
$ cat some_file | hl wrap_64

In Golang you can do things like the following:

package main

import (
    "fmt"

    hl "gitlab.com/mjwhitta/hilighter"
)

func main() {
    // Example 1 (single color)
    var greenStr = hl.Green("1. Hello, %s!\n", "world")
    fmt.Print(greenStr)

    // or

    hl.PrintGreen("1. Hello, %s!\n", "world")

    // or

    hl.PrintlnGreen("1. Hello, world!")

    // Example 2 (multiple colors)
    var multiColored = hl.Hilights(
        []string{"white", "on_green"},
        "2. Hello, %s!\n",
        "world",
    )
    fmt.Print(multiColored)

    // or

    multiColored = hl.Hilights(
        []string{"white", "on_green"},
        "2. Hello, world!",
    )
    fmt.Println(multiColored)

    // or

    hl.PrintHilights(
        []string{"white", "on_green"},
        "2. Hello, %s!\n",
        "world",
    )

    // or

    hl.PrintlnHilights(
        []string{"white", "on_green"},
        "2. Hello, world!",
    )

    // Example 3 (8-bit)
    var eightBit = hl.Color002("3. 8-bit color codes!")
    fmt.Println(eightBit)

    // or

    hl.PrintColor002("3. 8-bit color codes!\n")

    // or

    hl.PrintlnColor002("3. 8-bit color codes!")

    // Example 4 (hex)

    var hex = hl.Hex("5f8700", "4. Hex color codes!")
    fmt.Println(hex)

    // or

    hl.PrintHex("5f8700", "4. Hex color codes!\n")

    // or

    hl.PrintlnHex("5f8700", "4. Hex color codes!")

    // Example 5 (text wrapping)
    var long_var = "5."
    var word = "hilight"
    for i := 0; i < 32; i++ {
        long_var += " " + word
    }

    fmt.Println(hl.Wrap(80, hl.Hilight("green", long_var)))

    // or

    hl.PrintWrap(80, hl.Green("%s\n", long_var))

    // or

    hl.PrintlnWrap(80, hl.Green(long_var))

    // Example 6 (rainbow)
    long_var = "6."
    for i := 0; i < 8; i++ {
        long_var += " " + word
    }

    fmt.Println(hl.Rainbow(long_var))

    // or

    hl.PrintRainbow("%s\n", long_var)

    // or

    hl.PrintlnRainbow(long_var)

    // or

    hl.PrintlnOnRainbow(hl.White(long_var))

    // or

    hl.PrintlnRainbow(hl.OnRainbow(long_var))
}

The following colors are supported:

The following modes are supported:

Links

• Source
• ANSI escape codes

TODO

• Better README