colorable

README

go-colorable

Colorable writer for windows.

For example, most of logger packages doesn't show colors on windows. (I know we can do it with ansicon. But I don't want.) This package is possible to handle escape sequence for ansi color on windows.

Too Bad!

So Good!

Usage

logrus.SetFormatter(&logrus.TextFormatter{ForceColors: true})
logrus.SetOutput(colorable.NewColorableStdout())

logrus.Info("succeeded")
logrus.Warn("not correct")
logrus.Error("something error")
logrus.Fatal("panic")

You can compile above code on non-windows OSs.

Installation

$ go get github.com/mattn/go-colorable

License

MIT

Author

Yasuhiro Matsumoto (a.k.a mattn)

Documentation

Index

• func EnableColorsStdout(enabled *bool) func()
• func NewColorable(file *os.File) io.Writer
• func NewColorableStderr() io.Writer
• func NewColorableStdout() io.Writer
• func NewNonColorable(w io.Writer) io.Writer
• type NonColorable
  • func (w *NonColorable) Write(data []byte) (n int, err error)

Functions

func EnableColorsStdout

func EnableColorsStdout(enabled *bool) func()

EnableColorsStdout enable colors if possible.

func NewColorable

func NewColorable(file *os.File) io.Writer

NewColorable returns new instance of Writer which handles escape sequence.

func NewColorableStderr

func NewColorableStderr() io.Writer

NewColorableStderr returns new instance of Writer which handles escape sequence for stderr.

func NewColorableStdout

func NewColorableStdout() io.Writer

NewColorableStdout returns new instance of Writer which handles escape sequence for stdout.

func NewNonColorable

func NewNonColorable(w io.Writer) io.Writer

NewNonColorable returns new instance of Writer which removes escape sequence from Writer.

Types

type NonColorable

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

NonColorable holds writer but removes escape sequence.

func (*NonColorable) Write

func (w *NonColorable) Write(data []byte) (n int, err error)

Write writes data on console