README
¶
colorstring 
colorstring is a Go library for outputting colored strings to a console using a simple inline syntax in your string to specify the color to print as.
For example, the string [blue]hello [red]world would output the text
"hello world" in two colors. The API of colorstring allows for easily disabling
colors, adding aliases, etc.
Installation
Standard go get:
$ go get github.com/mitchellh/colorstring
Usage & Example
For usage and examples see the Godoc.
Usage is easy enough:
colorstring.Println("[blue]Hello [red]World!")
Additionally, the Colorize struct can be used to set options such as
custom colors, color disabling, etc.
Documentation
¶
Overview ¶
colorstring provides functions for colorizing strings for terminal output.
Index ¶
- Variables
- func Color(v string) string
- func ColorPrefix(v string) string
- func Fprint(w io.Writer, a string) (n int, err error)
- func Fprintf(w io.Writer, format string, a ...interface{}) (n int, err error)
- func Fprintln(w io.Writer, a string) (n int, err error)
- func Print(a string) (n int, err error)
- func Printf(format string, a ...interface{}) (n int, err error)
- func Println(a string) (n int, err error)
- type Colorize
Constants ¶
This section is empty.
Variables ¶
var DefaultColors map[string]string
DefaultColors are the default colors used when colorizing.
If the color is surrounded in underscores, such as "_blue_", then that color will be used for the background color.
Functions ¶
func Color ¶
Color colorizes your strings using the default settings.
Strings given to Color should use the syntax `[color]` to specify the color for text following. For example: `[blue]Hello` will return "Hello" in blue. See DefaultColors for all the supported colors and attributes.
If an unrecognized color is given, it is ignored and assumed to be part of the string. For example: `[hi]world` will result in "[hi]world".
A color reset is appended to the end of every string. This will reset the color of following strings when you output this text to the same terminal session.
If you want to customize any of this behavior, use the Colorize struct.
func ColorPrefix ¶
ColorPrefix returns the color sequence that prefixes the given text.
This is useful when wrapping text if you want to inherit the color of the wrapped text. For example, "[green]foo" will return "[green]". If there is no color sequence, then this will return "".
func Fprint ¶
Fprint is a convenience wrapper for fmt.Fprint with support for color codes.
Fprint formats using the default formats for its operands and writes to w with support for color codes. Spaces are added between operands when neither is a string. It returns the number of bytes written and any write error encountered.
func Fprintf ¶
Fprintf is a convenience wrapper for fmt.Fprintf with support for color codes.
Fprintf formats according to a format specifier and writes to w with support for color codes. It returns the number of bytes written and any write error encountered.
func Fprintln ¶
Fprintln is a convenience wrapper for fmt.Fprintln with support for color codes.
Fprintln formats using the default formats for its operands and writes to w with support for color codes. Spaces are always added between operands and a newline is appended. It returns the number of bytes written and any write error encountered.
func Print ¶
Print is a convenience wrapper for fmt.Print with support for color codes.
Print formats using the default formats for its operands and writes to standard output with support for color codes. Spaces are added between operands when neither is a string. It returns the number of bytes written and any write error encountered.
func Printf ¶
Printf is a convenience wrapper for fmt.Printf with support for color codes.
Printf formats according to a format specifier and writes to standard output with support for color codes. It returns the number of bytes written and any write error encountered.
func Println ¶
Println is a convenience wrapper for fmt.Println with support for color codes.
Println formats using the default formats for its operands and writes to standard output with support for color codes. Spaces are always added between operands and a newline is appended. It returns the number of bytes written and any write error encountered.
Types ¶
type Colorize ¶
type Colorize struct {
// Colors maps a color string to the code for that color. The code
// is a string so that you can use more complex colors to set foreground,
// background, attributes, etc. For example, "boldblue" might be
// "1;34"
Colors map[string]string
// If true, color attributes will be ignored. This is useful if you're
// outputting to a location that doesn't support colors and you just
// want the strings returned.
Disable bool
// Reset, if true, will reset the color after each colorization by
// adding a reset code at the end.
Reset bool
}
Colorize colorizes your strings, giving you the ability to customize some of the colorization process.
The options in Colorize can be set to customize colorization. If you're only interested in the defaults, just use the top Color function directly, which creates a default Colorize.
func (*Colorize) Color ¶
Color colorizes a string according to the settings setup in the struct.
For more details on the syntax, see the top-level Color function.
func (*Colorize) ColorPrefix ¶
ColorPrefix returns the first color sequence that exists in this string.
For example: "[green]foo" would return "[green]". If no color sequence exists, then "" is returned. This is especially useful when wrapping colored texts to inherit the color of the wrapped text.
Source Files