color

The color module provides functions to colorize text in the terminal.

The core functionality is provided by github.com/fatih/color (opens in a new tab).

Configuring colors and other text attributes is done using the various constants described below. Multiple constants can be passed to functions in this module to combine attributes.

Module

color(options ...int) color.color

The color module object itself is callable, which is a shorthand for color.color().

>>> color(color.fg_green).printf("hello!\n")
// colorized output

Functions

color

color(options ...int) color.color

Creates a new color object with the specified options.

>>> c := color.color(color.fg_red, color.bold)

set

set(options ...int)

Sets the terminal color to the specified options.

>>> color.set(color.fg_green, color.bold)

unset

unset()

Resets the terminal color to the default.

>>> color.unset()

Types

color

Defines a custom color object.

Methods

sprintf

sprintf(format string, a ...object) string

Formats the string with the color object.

>>> c := color.color(color.fg_red, color.bold)
>>> c.sprintf("Hello, %s!", "world")
"\x1b[31;1mHello, world!\x1b[0;22m"
>>> print(c.sprintf("Hello, %s!", "world"))
// colorized output

fprintf

fprintf(w io.writer, format string, a ...object)

Writes the colorized, formatted string to the given writer.

>>> b := buffer()
>>> c.fprintf(b, "Hello, %s!\n", "world")
>>> b
buffer("\x1b[31;1mHello, world!\n\x1b[0m")

printf

printf(format string, a ...object)

Writes the colorized, formatted string to the standard output. Note you may need to include a trailing newline to flush the output.

>>> c.printf("Hello, %s!\n", "world")
// colorized output

Constants