co

README

co

The library for terminal output formatting with ANSI colors

Install

$ go get -u github.com/Binbiubiubiu/co

Example

package main

import (
	. "github.com/Binbiubiubiu/co"
)

func main() {
	println(GreenBright("Hello"), BgCyanBright(RedBright("Binbiubiubiu")))
}

Bench

$ go test -bench=.  
goos: darwin
goarch: amd64
pkg: github.com/Binbiubiubiu/co
cpu: Intel(R) Core(TM) i7-7820HQ CPU @ 2.90GHz
Benchmark_co-8                   2007859               594.8 ns/op
Benchmark_fatih_color-8           504742              2027 ns/op
Benchmark_gookit_color-8         1488526               801.0 ns/op
PASS
ok      github.com/Binbiubiubiu/co      6.489s

Thanks

colorette 🌈Easily set your terminal text color & styles.

Documentation

Index

• Constants
• Variables
• type ColorFunc
• type Colors
  • func CreateColors() Colors
  • func UseColors(useColor bool) Colors

Constants

const IS_WINDOWS = runtime.GOOS == "windows"

Variables

var BgBlack = colors.BgBlack

var BgBlackBright = colors.BgBlackBright

var BgBlue = colors.BgBlue

var BgBlueBright = colors.BgBlueBright

var BgCyan = colors.BgCyan

var BgCyanBright = colors.BgCyanBright

var BgGreen = colors.BgGreen

var BgGreenBright = colors.BgGreenBright

var BgMagenta = colors.BgMagenta

var BgMagentaBright = colors.BgMagentaBright

var BgRed = colors.BgRed

var BgRedBright = colors.BgRedBright

var BgWhite = colors.BgWhite

var BgWhiteBright = colors.BgWhiteBright

var BgYellow = colors.BgYellow

var BgYellowBright = colors.BgYellowBright

var Black = colors.Black

var BlackBright = colors.BlackBright

var Blue = colors.Blue

var BlueBright = colors.BlueBright

var Bold = colors.Bold

var Cyan = colors.Cyan

var CyanBright = colors.CyanBright

var Dim = colors.Dim

var Gray = colors.Gray

var Green = colors.Green

var GreenBright = colors.GreenBright

var Hidden = colors.Hidden

var Inverse = colors.Inverse

var (
	IsColorSupported = !isDisabled &&
		(isForced || (IS_WINDOWS && !isDumbTerminal) || isCompatibleTerminal || isCI)
)

var Italic = colors.Italic

var Magenta = colors.Magenta

var MagentaBright = colors.MagentaBright

var Red = colors.Red

var RedBright = colors.RedBright

var Reset = colors.Reset

var Strikethrough = colors.Strikethrough

var Underline = colors.Underline

var White = colors.White

var WhiteBright = colors.WhiteBright

var Yellow = colors.Yellow

var YellowBright = colors.YellowBright

Types

type ColorFunc

type ColorFunc func(string) string

Color formatting functions

type Colors

type Colors struct {
	Reset           ColorFunc
	Bold            ColorFunc
	Dim             ColorFunc
	Italic          ColorFunc
	Underline       ColorFunc
	Inverse         ColorFunc
	Hidden          ColorFunc
	Strikethrough   ColorFunc
	Black           ColorFunc
	Red             ColorFunc
	Green           ColorFunc
	Yellow          ColorFunc
	Blue            ColorFunc
	Magenta         ColorFunc
	Cyan            ColorFunc
	White           ColorFunc
	Gray            ColorFunc
	BgBlack         ColorFunc
	BgRed           ColorFunc
	BgGreen         ColorFunc
	BgYellow        ColorFunc
	BgBlue          ColorFunc
	BgMagenta       ColorFunc
	BgCyan          ColorFunc
	BgWhite         ColorFunc
	BlackBright     ColorFunc
	RedBright       ColorFunc
	GreenBright     ColorFunc
	YellowBright    ColorFunc
	BlueBright      ColorFunc
	MagentaBright   ColorFunc
	CyanBright      ColorFunc
	WhiteBright     ColorFunc
	BgBlackBright   ColorFunc
	BgRedBright     ColorFunc
	BgGreenBright   ColorFunc
	BgYellowBright  ColorFunc
	BgBlueBright    ColorFunc
	BgMagentaBright ColorFunc
	BgCyanBright    ColorFunc
	BgWhiteBright   ColorFunc
}

func CreateColors

func CreateColors() Colors

Create a color tool function

func UseColors

func UseColors(useColor bool) Colors

Create a color utility function with a useColor property