djschleen / go-color

A lightweight, simple and cross-platform package to colorize text in terminals

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

go-color

A lightweight, simple and cross-platform package to colorize text in terminals.

Usage

Variables only

You can either directly use the variables like so:

package main

import "github.com/TwinProduction/go-color"

func main() {
    println(color.Red + "Something something something" + color.Reset)
}

NOTE: If you're going to use this approach, don't forget to prepend your string with color.Reset, otherwise everything else in your terminal will be that color until the color is reset or overridden.

Function and variable

You can use the Colorize(color, message)/Ize(color, message) function in conjunction with a variable:

package main

import "github.com/TwinProduction/go-color"

func main() {
    println(color.Ize(color.Red, "Something something something"))
    // Or if you prefer the longer version
    println(color.Colorize(color.Red, "Something something something"))
}

Unlike the method above, using this function will automatically prepend color.Reset at the end of your message.

Because I felt reading color.Ize() to be more visually pleasant than color.Colorize(), I included Ize() as an alias for Colorize().

I'm not usually a big fan of having two methods doing the same thing, but since this package doesn't have much room for growth (its only purpose is to colorize terminal outputs, after all, and there isn't hundreds of ways to go about it), I believe it's acceptable to have both.

Installation

go get github.com/TwinProduction/go-color

About

A lightweight, simple and cross-platform package to colorize text in terminals

License:Apache License 2.0


Languages

Language:Go 100.0%