color

package module

v0.1.1 Latest Latest Go to latest Published: Jan 25, 2025 License: MIT Imports: 4 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/gabefiori/color

Links

Open Source Insights

README ¶

Color

A lightweight package that provides utilities for colorizing terminal output using ANSI escape codes.

Installation

To install color, you can use go get:

go get github.com/gabefiori/color

Import the gabefiori/color package:

package your

import (
    "fmt"
    "github.com/gabefiori/color"
)

func main() {
    b := color.Blue("blue text!")
    fmt.Println(b)
}

Examples

b1 := color.Blue("returns string with blue text")

// Background colors are also available.
b2 := color.BlueBg("returns a string with blue background")

fmt.Println(b1, b2)

// Colorization can be disabled.
// By default, it will be disabled if the "NO_COLOR" environment variable is set.
color.NoColor = true
fmt.Println(color.Blue("no color..."))

color.NoColor = false

// Any type is accepted, but some types, like string, []byte, or any kind of number (e.g., int, int8, uint32...)
// are optimized.
_ = color.Red(100)
_ = color.Red(uint(100))
_ = color.Red([]byte("hey"))

// Only 16 styles are available, but you can create your own.
brightRed := "\x1b[91m"
redOnWhite := "\x1b[31;47m"
rgb := "\x1b[38;2;50;200;100m"

_ = color.Wrap(brightRed, "hello")
_ = color.Wrap(redOnWhite, "hello")
_ = color.Wrap(rgb, "hello")

Tests

To run the tests, you can run:

go test ./...

Benchmarks

To run the benchmarks, you can run:

go test ./... -bench=. -benchmem

Documentation ¶

Rendered for

Overview ¶

Package color provides utilities for colorizing terminal output using ANSI escape codes.

Constants ¶

View Source

const (
	Reset     = "\x1b[0m"
	FgBlack   = "\x1b[30m"
	FgRed     = "\x1b[31m"
	FgGreen   = "\x1b[32m"
	FgYellow  = "\x1b[33m"
	FgBlue    = "\x1b[34m"
	FgMagenta = "\x1b[35m"
	FgCyan    = "\x1b[36m"
	FgWhite   = "\x1b[37m"

	BgBlack   = "\x1b[40m"
	BgRed     = "\x1b[41m"
	BgGreen   = "\x1b[42m"
	BgYellow  = "\x1b[43m"
	BgBlue    = "\x1b[44m"
	BgMagenta = "\x1b[45m"
	BgCyan    = "\x1b[46m"
	BgWhite   = "\x1b[47m"
)