mirror of https://github.com/ericchiang/pup
You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
155 lines
4.0 KiB
155 lines
4.0 KiB
# Color [](http://godoc.org/github.com/fatih/color) [](https://travis-ci.org/fatih/color)
|
|
|
|
|
|
|
|
Color lets you use colorized outputs in terms of [ANSI Escape
|
|
Codes](http://en.wikipedia.org/wiki/ANSI_escape_code#Colors) in Go (Golang). It
|
|
has support for Windows too! The API can be used in several ways, pick one that
|
|
suits you.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
## Install
|
|
|
|
```bash
|
|
go get github.com/fatih/color
|
|
```
|
|
|
|
## Examples
|
|
|
|
### Standard colors
|
|
|
|
```go
|
|
// Print with default helper functions
|
|
color.Cyan("Prints text in cyan.")
|
|
|
|
// A newline will be appended automatically
|
|
color.Blue("Prints %s in blue.", "text")
|
|
|
|
// These are using the default foreground colors
|
|
color.Red("We have red")
|
|
color.Magenta("And many others ..")
|
|
|
|
```
|
|
|
|
### Mix and reuse colors
|
|
|
|
```go
|
|
// Create a new color object
|
|
c := color.New(color.FgCyan).Add(color.Underline)
|
|
c.Println("Prints cyan text with an underline.")
|
|
|
|
// Or just add them to New()
|
|
d := color.New(color.FgCyan, color.Bold)
|
|
d.Printf("This prints bold cyan %s\n", "too!.")
|
|
|
|
// Mix up foreground and background colors, create new mixes!
|
|
red := color.New(color.FgRed)
|
|
|
|
boldRed := red.Add(color.Bold)
|
|
boldRed.Println("This will print text in bold red.")
|
|
|
|
whiteBackground := red.Add(color.BgWhite)
|
|
whiteBackground.Println("Red text with white background.")
|
|
```
|
|
|
|
### Custom print functions (PrintFunc)
|
|
|
|
```go
|
|
// Create a custom print function for convenience
|
|
red := color.New(color.FgRed).PrintfFunc()
|
|
red("Warning")
|
|
red("Error: %s", err)
|
|
|
|
// Mix up multiple attributes
|
|
notice := color.New(color.Bold, color.FgGreen).PrintlnFunc()
|
|
notice("Don't forget this...")
|
|
```
|
|
|
|
### Insert into noncolor strings (SprintFunc)
|
|
|
|
```go
|
|
// Create SprintXxx functions to mix strings with other non-colorized strings:
|
|
yellow := color.New(color.FgYellow).SprintFunc()
|
|
red := color.New(color.FgRed).SprintFunc()
|
|
fmt.Printf("This is a %s and this is %s.\n", yellow("warning"), red("error"))
|
|
|
|
info := color.New(color.FgWhite, color.BgGreen).SprintFunc()
|
|
fmt.Printf("This %s rocks!\n", info("package"))
|
|
|
|
// Use helper functions
|
|
fmt.Printf("This", color.RedString("warning"), "should be not neglected.")
|
|
fmt.Printf(color.GreenString("Info:"), "an important message." )
|
|
|
|
// Windows supported too! Just don't forget to change the output to color.Output
|
|
fmt.Fprintf(color.Output, "Windows support: %s", color.GreenString("PASS"))
|
|
```
|
|
|
|
### Plug into existing code
|
|
|
|
```go
|
|
// Use handy standard colors
|
|
color.Set(color.FgYellow)
|
|
|
|
fmt.Println("Existing text will now be in yellow")
|
|
fmt.Printf("This one %s\n", "too")
|
|
|
|
color.Unset() // Don't forget to unset
|
|
|
|
// You can mix up parameters
|
|
color.Set(color.FgMagenta, color.Bold)
|
|
defer color.Unset() // Use it in your function
|
|
|
|
fmt.Println("All text will now be bold magenta.")
|
|
```
|
|
|
|
### Disable color
|
|
|
|
There might be a case where you want to disable color output (for example to
|
|
pipe the standard output of your app to somewhere else). `Color` has support to
|
|
disable colors both globally and for single color definition. For example
|
|
suppose you have a CLI app and a `--no-color` bool flag. You can easily disable
|
|
the color output with:
|
|
|
|
```go
|
|
|
|
var flagNoColor = flag.Bool("no-color", false, "Disable color output")
|
|
|
|
if *flagNoColor {
|
|
color.NoColor = true // disables colorized output
|
|
}
|
|
```
|
|
|
|
It also has support for single color definitions (local). You can
|
|
disable/enable color output on the fly:
|
|
|
|
```go
|
|
c := color.New(color.FgCyan)
|
|
c.Println("Prints cyan text")
|
|
|
|
c.DisableColor()
|
|
c.Println("This is printed without any color")
|
|
|
|
c.EnableColor()
|
|
c.Println("This prints again cyan...")
|
|
```
|
|
|
|
## Todo
|
|
|
|
* Save/Return previous values
|
|
* Evaluate fmt.Formatter interface
|
|
|
|
|
|
## Credits
|
|
|
|
* [Fatih Arslan](https://github.com/fatih)
|
|
* Windows support via @mattn: [colorable](https://github.com/mattn/go-colorable)
|
|
|
|
## License
|
|
|
|
The MIT License (MIT) - see [`LICENSE.md`](https://github.com/fatih/color/blob/master/LICENSE.md) for more details
|
|
|