README
¶
cli color
Command line color library, written using golang
Features
- Easy to use
- supports rich color output
- supports html tab-style color rendering
- compatible with Windows
Install
- use dep
dep ensure -add gopkg.in/gookit/color.v1 // is recommended
// OR
dep ensure -add github.com/gookit/color
- go get
go get gopkg.in/gookit/color.v1 // is recommended
// OR
go get -u github.com/gookit/color
- git clone
git clone https://github.com/gookit/color
Godoc
Quick start
import "gopkg.in/gookit/color.v1" // is recommended
// or
import "github.com/gookit/color"
package main
import (
"github.com/gookit/color"
)
func main() {
// simple usage
color.FgCyan.Printf("Simple to use %s\n", "color")
// custom color
color.New(color.FgWhite, color.BgBlack).Println("custom color style")
// can also:
color.Style{color.FgCyan, color.OpBold}.Println("custom color style")
// use style tag
color.Print("<suc>he</><comment>llo</>, <cyan>wel</><red>come</>\n")
// set a style tag
color.Tag("info").Println("info style text")
// use info style tips
color.Tips("info").Print("tips style text")
// use info style blocked tips
color.LiteTips("info").Print("blocked tips style text")
}
Color output display
More usage
Basic color functions
support on windows
cmd.exe
color.Bold(args ...interface{})color.Black(args ...interface{})color.White(args ...interface{})color.Gray(args ...interface{})color.Red(args ...interface{})color.Green(args ...interface{})color.Yellow(args ...interface{})color.Blue(args ...interface{})color.Magenta(args ...interface{})color.Cyan(args ...interface{})
color.Bold("bold message")
color.Yellow("yellow message")
Extra style functions
support on windows
cmd.exe
color.Info()color.Note()color.Light()color.Error()color.Danger()color.Notice()color.Success()color.Comment()color.Primary()color.Warning()color.Question()color.Secondary()
color.Info("Info message")
color.Success("Success message")
Use like html tag
not support on windows
cmd.exe
// use style tag
color.Print("<suc>he</><comment>llo</>, <cyan>wel</><red>come</>")
color.Println("<suc>hello</>")
color.Println("<error>hello</>")
color.Println("<warning>hello</>")
// custom color attributes
color.Print("<fg=yellow;bg=black;op=underscore;>hello, welcome</>\n")
color.Tag
// set a style tag
color.Tag("info").Print("info style text")
color.Tag("info").Printf("%s style text", "info")
color.Tag("info").Println("info style text")
Internal color tags
// Some internal defined style tags
// usage: <tag>content text</>
// basic tags
- red
- blue
- cyan
- black
- green
- brown
- white
- default // no color
- normal// no color
- yellow
- magenta
// alert tags like bootstrap's alert
- suc // same "green" and "bold"
- success
- info // same "green"
- comment // same "brown"
- note
- notice
- warn
- warning
- primary
- danger // same "red"
- err
- error
// more tags
- lightRed
- light_red
- lightGreen
- light_green
- lightBlue
- light_blue
- lightCyan
- light_cyan
- lightDray
- light_gray
- gray
- darkGray
- dark_gray
- lightYellow
- light_yellow
- lightMagenta
- light_magenta
// extra
- lightRedEx
- light_red_ex
- lightGreenEx
- light_green_ex
- lightBlueEx
- light_blue_ex
- lightCyanEx
- light_cyan_ex
- whiteEx
- white_ex
// option
- bold
- underscore
- reverse
Ref
issue9/termhttps://github.com/issue9/termbeego/beehttps://github.com/beego/beeinhere/consolehttps://github/inhere/php-console- ANSI escape code
License
MIT
Documentation
¶
Index ¶
- Constants
- Variables
- func AddStyle(name string, s Style)
- func Apply(str string, colors ...Color) string
- func ApplyTag(tag string, args ...interface{}) string
- func Black(args ...interface{})
- func Blackln(args ...interface{})
- func Blue(args ...interface{})
- func Blueln(args ...interface{})
- func Bold(args ...interface{})
- func Boldln(args ...interface{})
- func Byte24Color(str string)
- func Byte8Color(str string, val Bt8Color)
- func ClearCode(str string) string
- func ClearTag(str string) string
- func Comment(args ...interface{})
- func Commentln(args ...interface{})
- func Cyan(args ...interface{})
- func Cyanln(args ...interface{})
- func Danger(args ...interface{})
- func Dangerln(args ...interface{})
- func Disable()
- func Err(args ...interface{})
- func Errln(args ...interface{})
- func Error(args ...interface{})
- func Errorln(args ...interface{})
- func Fprint(w io.Writer, args ...interface{}) (int, error)
- func Fprintf(w io.Writer, format string, args ...interface{}) (int, error)
- func Fprintln(w io.Writer, args ...interface{}) (int, error)
- func GetColorTags() map[string]string
- func GetStyleCode(name string) string
- func GetStyleName(name string) string
- func Gray(args ...interface{})
- func Grayln(args ...interface{})
- func Green(args ...interface{})
- func Greenln(args ...interface{})
- func Info(args ...interface{})
- func Infoln(args ...interface{})
- func IsBgColor(name string) bool
- func IsDefinedTag(name string) bool
- func IsDisabled() bool
- func IsFgColor(name string) bool
- func IsOption(name string) bool
- func Light(args ...interface{})
- func Lightln(args ...interface{})
- func Magenta(args ...interface{})
- func Magentaln(args ...interface{})
- func Note(args ...interface{})
- func Noteln(args ...interface{})
- func Notice(args ...interface{})
- func Noticeln(args ...interface{})
- func ParseCodeFromAttr(attr string) (code string)
- func Primary(args ...interface{})
- func Primaryln(args ...interface{})
- func Print(args ...interface{}) (int, error)
- func Printf(format string, args ...interface{}) (int, error)
- func Println(args ...interface{}) (int, error)
- func Question(args ...interface{})
- func Questionln(args ...interface{})
- func Red(args ...interface{})
- func Redln(args ...interface{})
- func Render(args ...interface{}) string
- func RenderCodes(code string, str string) string
- func RenderStr(str string) string
- func ReplaceTag(str string, dumpIt ...bool) string
- func Reset() (int, error)
- func Secondary(args ...interface{})
- func Secondaryln(args ...interface{})
- func Set(colors ...Color) (int, error)
- func Suc(args ...interface{})
- func Success(args ...interface{})
- func Successln(args ...interface{})
- func Sucln(args ...interface{})
- func TrueColor(str string, rgb RgbColor)
- func Warn(args ...interface{})
- func Warning(args ...interface{})
- func Warningln(args ...interface{})
- func Warnln(args ...interface{})
- func White(args ...interface{})
- func Whiteln(args ...interface{})
- func WrapTag(str string, tag string) string
- func Yellow(args ...interface{})
- func Yellowln(args ...interface{})
- type Bt8Color
- type Bt8Style
- type Color
- func (c Color) IsValid() bool
- func (c Color) Print(args ...interface{}) (int, error)
- func (c Color) Printf(format string, args ...interface{}) (int, error)
- func (c Color) Println(args ...interface{}) (int, error)
- func (c Color) Render(args ...interface{}) string
- func (c Color) Renderf(format string, args ...interface{}) string
- func (c Color) String() string
- type LiteTips
- type Logger
- type RgbColor
- type RgbStyle
- type Style
- func (s Style) Apply(args ...interface{}) string
- func (s Style) Print(args ...interface{}) (int, error)
- func (s Style) Printf(format string, args ...interface{}) (int, error)
- func (s Style) Println(args ...interface{}) (int, error)
- func (s Style) Render(args ...interface{}) string
- func (s Style) Save(name string)
- type Tag
- type Tips
Constants ¶
View Source
const ( // Regex to match color tags // golang 不支持反向引用. 即不支持使用 \1 引用第一个匹配 ([a-z=;]+) // TagExpr = `<([a-z=;]+)>(.*?)<\/\1>` // 所以调整一下 统一使用 `</>` 来结束标签，例如 "<info>some text</>" // 支持自定义颜色属性的tag "<fg=white;bg=blue;op=bold>content</>" // (?s:...) s - 让 "." 匹配换行 TagExpr = `<([a-zA-Z_=,;]+)>(?s:(.*?))<\/>` // Regex to match color attributes AttrExpr = `(fg|bg|op)=([a-z,]+);?` // Regex used for removing color tags // StripExpr = `<[\/]?[a-zA-Z=;]+>` // 随着上面的做一些调整 StripExpr = `<[\/]?[a-zA-Z_=,;]*>` )
output colored text like use html tag. (not support windows cmd)
View Source
const CodeExpr = `\033\[[\d;?]+m`
Regex to clear color codes eg "\033[1;36mText\x1b[0m"
View Source
const FullColorTpl = "\x1b[%sm%s\x1b[0m"
View Source
const ResetCode = "\x1b[0m"
ESC 操作的表示 "\033"(Octal 8进制) = "\x1b"(Hexadecimal 16进制) = 27 (10进制)
View Source
const SetRgbBg = "\x1b[48;2;%d;%d;%dm"
View Source
const SetRgbFg = "\x1b[38;2;%d;%d;%dm"
24 byte RGB color RGB:
R 0-255 G 0-255 B 0-255 R 00-FF G 00-FF B 00-FF (16进制)
format:
ESC[ … 38;2;<r>;<g>;<b> … m // 选择RGB前景色 ESC[ … 48;2;<r>;<g>;<b> … m // 选择RGB背景色
links:
https://zh.wikipedia.org/wiki/ANSI转义序列#24位
View Source
const SettingTpl = "\x1b[%sm"
CLI color template
View Source
const SingleColorTpl = "\x1b[%dm%s\x1b[0m"
View Source
const Tpl256Bg = "48;5;%d"
View Source
const Tpl256Fg = "38;5;%d"
8 byte 256 color(`2^8`) format:
ESC[ … 38;5;<n> … m // 选择前景色 ESC[ … 48;5;<n> … m // 选择背景色
example:
fg "\x1b[38;5;242m" bg "\x1b[48;5;208m" both "\x1b[38;5;242;48;5;208m"
links:
https://zh.wikipedia.org/wiki/ANSI转义序列#8位
Variables ¶
View Source
var BgColors = map[string]Color{ "black": BgBlack, "red": BgRed, "green": BgGreen, "yellow": BgYellow, "blue": BgBlue, "magenta": BgMagenta, "cyan": BgCyan, "white": BgWhite, "default": BgDefault, }
Background colors map
View Source
var BuiltinStyles = map[string]Style{ "info": {OpReset, FgGreen}, "note": {OpBold, FgLightCyan}, "light": {FgLightWhite}, "error": {FgLightWhite, BgRed}, "danger": {OpBold, FgRed}, "notice": {OpBold, FgCyan}, "success": {OpBold, FgGreen}, "comment": {OpReset, FgYellow}, "primary": {OpReset, FgBlue}, "warning": {OpBold, FgYellow}, "question": {OpReset, FgMagenta}, "secondary": {FgDarkGray}, }
Some defined styles, like bootstrap styles
View Source
var Enable = true
switch color display
View Source
var FgColors = map[string]Color{ "black": FgBlack, "red": FgRed, "green": FgGreen, "yellow": FgYellow, "blue": FgBlue, "magenta": FgMagenta, "cyan": FgCyan, "white": FgWhite, "default": FgDefault, }
Foreground colors map
View Source
var LogLevel2tag = map[string]string{
"info": "info",
"warn": "warning",
"warning": "warning",
"debug": "cyan",
"notice": "notice",
"error": "error",
}
log level to cli color style
View Source
var Options = map[string]Color{ "reset": OpReset, "bold": OpBold, "fuzzy": OpFuzzy, "italic": OpItalic, "underscore": OpUnderscore, "blink": OpBlink, "reverse": OpReverse, "concealed": OpConcealed, }
color options map
Functions ¶
func Apply ¶
Apply apply custom colors usage:
// (string, fg-color,bg-color, options...)
color.Apply("text", color.FgGreen)
color.Apply("text", color.FgGreen, color.BgBlack, color.OpBold)
func Commentln ¶ added in v1.0.1
func Commentln(args ...interface{})
Comment add comment style for message
func Dangerln ¶ added in v1.0.1
func Dangerln(args ...interface{})
Danger add danger style for message
func Magentaln ¶ added in v1.0.1
func Magentaln(args ...interface{})
Magentaln add magenta for message
func Noticeln ¶ added in v1.0.1
func Noticeln(args ...interface{})
Notice add notice style for message
func ParseCodeFromAttr ¶
ParseCodeFromAttr parse color attributes attr like: "fg=VALUE;bg=VALUE;op=VALUE", VALUE please see var: FgColors, BgColors, Options eg: "fg=yellow" "bg=red" "op=bold,underscore" option is allow multi value "fg=white;bg=blue;op=bold" "fg=white;op=bold,underscore"
func Primaryln ¶ added in v1.0.1
func Primaryln(args ...interface{})
Primary add primary style for message
func Questionln ¶ added in v1.0.1
func Questionln(args ...interface{})
Question add question style for message
func ReplaceTag ¶
ReplaceTag parse string, replace tag and return rendered string
func Secondaryln ¶ added in v1.0.1
func Secondaryln(args ...interface{})
Secondary add secondary style for message
func Successln ¶ added in v1.0.1
func Successln(args ...interface{})
Success add success style for message
func Warningln ¶ added in v1.0.1
func Warningln(args ...interface{})
Warning add warning style for message
Types ¶
type Bt8Color ¶
type Bt8Color uint8
uint8 at 0 - 255 10进制和16进制都可 0x98 = 152 use 8 byte, 0 - 255 color
type Color ¶
type Color uint8
Color represents a text color.
const ( // basic Foreground colors 30 - 37 FgBlack Color = iota + 30 FgRed FgGreen FgYellow FgBlue FgMagenta // 品红 FgCyan // 青色 FgWhite // revert default FG FgDefault Color = 39 // extra Foreground color 90 - 97(非标准) FgDarkGray Color = iota + 90 // 亮黑（灰） FgLightRed FgLightGreen FgLightYellow FgLightBlue FgLightMagenta FgLightCyan FgLightWhite )
Foreground colors.
const ( // basic Background colors 40 - 47 BgBlack Color = iota + 40 BgRed BgGreen BgYellow // BgBrown like yellow BgBlue BgMagenta BgCyan BgWhite // revert default BG BgDefault Color = 49 // extra Background color 100 - 107(非标准) BgDarkGray Color = iota + 100 BgLightRed BgLightGreen BgLightYellow BgLightBlue BgLightMagenta BgLightCyan BgLightWhite )
Background colors.
const ( OpReset Color = iota // 0 重置所有设置 OpBold // 1 加粗 OpFuzzy // 2 模糊(不是所有的终端仿真器都支持) OpItalic // 3 斜体(不是所有的终端仿真器都支持) OpUnderscore // 4 下划线 OpBlink // 5 闪烁 OpFastBlink // 5 快速闪烁(未广泛支持) OpReverse // 7 颠倒的 交换背景色与前景色 OpConcealed // 8 隐匿的 OpStrikethrough // 9 删除的，删除线(未广泛支持) )
Option settings
type LiteTips ¶
type LiteTips string
LiteTips will only add color for tag name value is a defined style name
type Logger ¶
type Logger struct {
// contains filtered or unexported fields
}
Logger console logger
type Style ¶
type Style []Color
Style a colored style can add: fg color, bg color, color options quick use:
color.Style(color.FgGreen).
Source Files
¶
Directories
Click to show internal directories.
Click to hide internal directories.