color

Documentation

Index

• Variables
• func Black(format string, a ...interface{})
• func BlackString(format string, a ...interface{}) string
• func Blue(format string, a ...interface{})
• func BlueString(format string, a ...interface{}) string
• func Cyan(format string, a ...interface{})
• func CyanString(format string, a ...interface{}) string
• func Green(format string, a ...interface{})
• func GreenString(format string, a ...interface{}) string
• func Magenta(format string, a ...interface{})
• func MagentaString(format string, a ...interface{}) string
• func Red(format string, a ...interface{})
• func RedString(format string, a ...interface{}) string
• func Unset()
• func White(format string, a ...interface{})
• func WhiteString(format string, a ...interface{}) string
• func Yellow(format string, a ...interface{})
• func YellowString(format string, a ...interface{}) string
• type Attribute
• type Color
  • func New(value ...Attribute) *Color
  • func Set(p ...Attribute) *Color
  • func (c *Color) Add(value ...Attribute) *Color
  • func (c *Color) DisableColor()
  • func (c *Color) EnableColor()
  • func (c *Color) Equals(c2 *Color) bool
  • func (c *Color) Fprint(w io.Writer, a ...interface{}) (n int, err error)
  • func (c *Color) FprintFunc() func(w io.Writer, a ...interface{})
  • func (c *Color) Fprintf(w io.Writer, format string, a ...interface{}) (n int, err error)
  • func (c *Color) FprintfFunc() func(w io.Writer, format string, a ...interface{})
  • func (c *Color) Fprintln(w io.Writer, a ...interface{}) (n int, err error)
  • func (c *Color) FprintlnFunc() func(w io.Writer, a ...interface{})
  • func (c *Color) Print(a ...interface{}) (n int, err error)
  • func (c *Color) PrintFunc() func(a ...interface{})
  • func (c *Color) Printf(format string, a ...interface{}) (n int, err error)
  • func (c *Color) PrintfFunc() func(format string, a ...interface{})
  • func (c *Color) Println(a ...interface{}) (n int, err error)
  • func (c *Color) PrintlnFunc() func(a ...interface{})
  • func (c *Color) Set() *Color
  • func (c *Color) SprintFunc() func(a ...interface{}) string
  • func (c *Color) SprintfFunc() func(format string, a ...interface{}) string
  • func (c *Color) SprintlnFunc() func(a ...interface{}) string

Variables

var (
	// NoColor defines if the output is colorized or not. It's dynamically set to
	// false or true based on the stdout's file descriptor referring to a terminal
	// or not. This is a global option and affects all colors. For more control
	// over each color block use the methods DisableColor() individually.
	NoColor = !isatty.IsTerminal(os.Stdout.Fd()) || os.Getenv("TERM") == "dumb"

	// Output defines the standard output of the print functions. By default
	// os.Stdout is used.
	Output = colorable.NewColorableStdout()
)

Functions

func Black

func Black(format string, a ...interface{})

Black is an convenient helper function to print with black foreground. A newline is appended to format by default.

func BlackString

func BlackString(format string, a ...interface{}) string

BlackString is an convenient helper function to return a string with black foreground.

func Blue

func Blue(format string, a ...interface{})

Blue is an convenient helper function to print with blue foreground. A newline is appended to format by default.

func BlueString

func BlueString(format string, a ...interface{}) string

BlueString is an convenient helper function to return a string with blue foreground.

func Cyan

func Cyan(format string, a ...interface{})

Cyan is an convenient helper function to print with cyan foreground. A newline is appended to format by default.

func CyanString

func CyanString(format string, a ...interface{}) string

CyanString is an convenient helper function to return a string with cyan foreground.

func Green

func Green(format string, a ...interface{})

Green is an convenient helper function to print with green foreground. A newline is appended to format by default.

func GreenString

func GreenString(format string, a ...interface{}) string

GreenString is an convenient helper function to return a string with green foreground.

func Magenta

func Magenta(format string, a ...interface{})

Magenta is an convenient helper function to print with magenta foreground. A newline is appended to format by default.

func MagentaString

func MagentaString(format string, a ...interface{}) string

MagentaString is an convenient helper function to return a string with magenta foreground.

func Red

func Red(format string, a ...interface{})

Red is an convenient helper function to print with red foreground. A newline is appended to format by default.

func RedString

func RedString(format string, a ...interface{}) string

RedString is an convenient helper function to return a string with red foreground.

func Unset

func Unset()

Unset resets all escape attributes and clears the output. Usually should be called after Set().

func White

func White(format string, a ...interface{})

White is an convenient helper function to print with white foreground. A newline is appended to format by default.

func WhiteString

func WhiteString(format string, a ...interface{}) string

WhiteString is an convenient helper function to return a string with white foreground.

func Yellow

func Yellow(format string, a ...interface{})

Yellow is an convenient helper function to print with yellow foreground. A newline is appended to format by default.

func YellowString

func YellowString(format string, a ...interface{}) string

YellowString is an convenient helper function to return a string with yellow foreground.

Types

type Attribute

type Attribute int

Attribute defines a single SGR Code

const (
	Reset Attribute = iota
	Bold
	Faint
	Italic
	Underline
	BlinkSlow
	BlinkRapid
	ReverseVideo
	Concealed
	CrossedOut
)

Base attributes

const (
	FgBlack Attribute = iota + 30
	FgRed
	FgGreen
	FgYellow
	FgBlue
	FgMagenta
	FgCyan
	FgWhite
)

Foreground text colors

const (
	FgHiBlack Attribute = iota + 90
	FgHiRed
	FgHiGreen
	FgHiYellow
	FgHiBlue
	FgHiMagenta
	FgHiCyan
	FgHiWhite
)

Foreground Hi-Intensity text colors

const (
	BgBlack Attribute = iota + 40
	BgRed
	BgGreen
	BgYellow
	BgBlue
	BgMagenta
	BgCyan
	BgWhite
)

Background text colors

const (
	BgHiBlack Attribute = iota + 100
	BgHiRed
	BgHiGreen
	BgHiYellow
	BgHiBlue
	BgHiMagenta
	BgHiCyan
	BgHiWhite
)

Background Hi-Intensity text colors

type Color

type Color struct {
	// contains filtered or unexported fields
}

Color defines a custom color object which is defined by SGR parameters.

func New

func New(value ...Attribute) *Color

New returns a newly created color object.

func Set

func Set(p ...Attribute) *Color

Set sets the given parameters immediately. It will change the color of output with the given SGR parameters until color.Unset() is called.

func (*Color) Add

func (c *Color) Add(value ...Attribute) *Color

Add is used to chain SGR parameters. Use as many as parameters to combine and create custom color objects. Example: Add(color.FgRed, color.Underline).

func (*Color) DisableColor

func (c *Color) DisableColor()

DisableColor disables the color output. Useful to not change any existing code and still being able to output. Can be used for flags like "--no-color". To enable back use EnableColor() method.

func (*Color) EnableColor

func (c *Color) EnableColor()

EnableColor enables the color output. Use it in conjunction with DisableColor(). Otherwise this method has no side effects.

func (*Color) Equals

func (c *Color) Equals(c2 *Color) bool

Equals returns a boolean value indicating whether two colors are equal.

func (*Color) Fprint

func (c *Color) Fprint(w io.Writer, a ...interface{}) (n int, err error)

Fprint formats using the default formats for its operands and writes to w. Spaces are added between operands when neither is a string. It returns the number of bytes written and any write error encountered. On Windows, users should wrap w with colorable.NewColorable() if w is of type *os.File.

func (*Color) FprintFunc

func (c *Color) FprintFunc() func(w io.Writer, a ...interface{})

FprintFunc returns a new function that prints the passed arguments as colorized with color.Fprint().

func (*Color) Fprintf

func (c *Color) Fprintf(w io.Writer, format string, a ...interface{}) (n int, err error)

Fprintf formats according to a format specifier and writes to w. It returns the number of bytes written and any write error encountered. On Windows, users should wrap w with colorable.NewColorable() if w is of type *os.File.

func (*Color) FprintfFunc

func (c *Color) FprintfFunc() func(w io.Writer, format string, a ...interface{})

FprintfFunc returns a new function that prints the passed arguments as colorized with color.Fprintf().

func (*Color) Fprintln

func (c *Color) Fprintln(w io.Writer, a ...interface{}) (n int, err error)

Fprintln formats using the default formats for its operands and writes to w. Spaces are always added between operands and a newline is appended. On Windows, users should wrap w with colorable.NewColorable() if w is of type *os.File.

func (*Color) FprintlnFunc

func (c *Color) FprintlnFunc() func(w io.Writer, a ...interface{})

FprintlnFunc returns a new function that prints the passed arguments as colorized with color.Fprintln().

func (*Color) Print

func (c *Color) Print(a ...interface{}) (n int, err error)

Print formats using the default formats for its operands and writes to standard output. Spaces are added between operands when neither is a string. It returns the number of bytes written and any write error encountered. This is the standard fmt.Print() method wrapped with the given color.

func (*Color) PrintFunc

func (c *Color) PrintFunc() func(a ...interface{})

PrintFunc returns a new function that prints the passed arguments as colorized with color.Print().

func (*Color) Printf

func (c *Color) Printf(format string, a ...interface{}) (n int, err error)

Printf formats according to a format specifier and writes to standard output. It returns the number of bytes written and any write error encountered. This is the standard fmt.Printf() method wrapped with the given color.

func (*Color) PrintfFunc

func (c *Color) PrintfFunc() func(format string, a ...interface{})

PrintfFunc returns a new function that prints the passed arguments as colorized with color.Printf().

func (*Color) Println

func (c *Color) Println(a ...interface{}) (n int, err error)

Println formats using the default formats for its operands and writes to standard output. Spaces are always added between operands and a newline is appended. It returns the number of bytes written and any write error encountered. This is the standard fmt.Print() method wrapped with the given color.

func (*Color) PrintlnFunc

func (c *Color) PrintlnFunc() func(a ...interface{})

PrintlnFunc returns a new function that prints the passed arguments as colorized with color.Println().

func (*Color) Set

func (c *Color) Set() *Color

Set sets the SGR sequence.

func (*Color) SprintFunc

func (c *Color) SprintFunc() func(a ...interface{}) string

SprintFunc returns a new function that returns colorized strings for the given arguments with fmt.Sprint(). Useful to put into or mix into other string. Windows users should use this in conjunction with color.Output, example:

put := New(FgYellow).SprintFunc()
fmt.Fprintf(color.Output, "This is a %s", put("warning"))

func (*Color) SprintfFunc

func (c *Color) SprintfFunc() func(format string, a ...interface{}) string

SprintfFunc returns a new function that returns colorized strings for the given arguments with fmt.Sprintf(). Useful to put into or mix into other string. Windows users should use this in conjunction with color.Output.

func (*Color) SprintlnFunc

func (c *Color) SprintlnFunc() func(a ...interface{}) string

SprintlnFunc returns a new function that returns colorized strings for the given arguments with fmt.Sprintln(). Useful to put into or mix into other string. Windows users should use this in conjunction with color.Output.