Golang终端ANSI彩色输出格式化插件库Aurora的使用

Aurora是一个为Golang提供终极ANSI颜色的库，支持Printf/Sprintf等格式化输出。

安装

版本1.x

使用gopkg.in安装：

go get -u gopkg.in/logrusorgru/aurora.v1

版本2.x

go get -u github.com/logrusorgru/aurora

Go模块支持(v3+)

go get -u github.com/logrusorgru/aurora/v3

最新版本(v4+)

go get -u github.com/logrusorgru/aurora/v4

使用示例

简单使用

package main

import (
	"fmt"
	"github.com/logrusorgru/aurora/v4"
)

func main() {
	fmt.Println("Hello,", aurora.Magenta("Aurora"))
	fmt.Println(aurora.Bold(aurora.Cyan("Cya!")))
}

Printf格式化

package main

import (
	"fmt"
	"github.com/logrusorgru/aurora/v4"
)

func main() {
	fmt.Printf("Got it %d times\n", aurora.Green(1240))
	fmt.Printf("PI is %+1.2e\n", aurora.Cyan(3.14))
}

aurora.Sprintf

package main

import (
	"fmt"
	"github.com/logrusorgru/aurora/v4"
)

func main() {
	fmt.Println(aurora.Sprintf(aurora.Magenta("Got it %d times"), aurora.Green(1240)))
}

启用/禁用颜色

package main

import (
	"fmt"
	"flag"

	"github.com/logrusorgru/aurora/v4"
)

// 颜色器
var au *aurora.Aurora

var colors = flag.Bool("colors", false, "enable or disable colors")

func init() {
	flag.Parse()
	au = aurora.New(WithColors(*colors))
}

func main() {
	// 使用颜色器
	fmt.Println(au.Green("Hello"))
}

超链接、默认颜色器和配置

package main

import (
	"flag"
	"fmt"

	"github.com/logrusorgru/aurora/v4"
)

func main() {
	var conf = aurora.NewConfig()
	conf.AddFlags(flag.CommandLine, "prefix.")
	flag.Parse()

	aurora.DefaultColorizer = aurora.New(conf.Options()...) // 设置全局

	fmt.Println(aurora.Red("Example").Hyperlink("http://example.com/"))
}

链式调用

以下两种方式是等价的：

x := aurora.BgMagenta(aurora.Bold(aurora.Red("x")))

x := aurora.Red("x").Bold().BgMagenta()

第二种方式更易读。

Colorize函数

func getColors() Color {
	// 返回适当的颜色和格式
}

func main() {
	fmt.Println(aurora.Colorize("Greeting", getColors()))
}

更简单的例子：

x := aurora.Colorize("Greeting", GreenFg|GrayBg|BoldFm)

灰度颜色

fmt.Println("  ",
	aurora.Gray(1-1, " 00-23 ").BgGray(24-1),
	aurora.Gray(4-1, " 03-19 ").BgGray(20-1),
	aurora.Gray(8-1, " 07-15 ").BgGray(16-1),
	aurora.Gray(12-1, " 11-11 ").BgGray(12-1),
	aurora.Gray(16-1, " 15-07 ").BgGray(8-1),
	aurora.Gray(20-1, " 19-03 ").BgGray(4-1),
	aurora.Gray(24-1, " 23-00 ").BgGray(1-1),
)

8位颜色

package main

import (
	"fmt"
	"github.com/logrusorgru/aurora"
)

func main() {
	for i := uint8(16); i <= 231; i++ {
		fmt.Println(i, aurora.Index(i, "pew-pew"), aurora.BgIndex(i, "pew-pew"))
	}
}

支持的颜色和格式

格式

• 粗体 (1)
• 淡色 (2)
• 双下划线 (21)
• 哥特体 (20)
• 斜体 (3)
• 下划线 (4)
• 慢闪烁 (5)
• 快闪烁 (6)
• 反色 (7)
• 隐藏 (8)
• 删除线 (9)
• 加框 (51)
• 加圈 (52)
• 上划线 (53)

颜色

• 前景色和背景色，包括亮色
  • 黑色
  • 红色
  • 绿色
  • 黄色(棕色)
  • 蓝色
  • 洋红色
  • 青色
  • 白色
  • 24级灰度
  • 216种8位颜色

限制

Windows

Aurora只提供ANSI颜色，不支持Windows。但有解决方案可用：

• 使用go-colorable
• 在Windows 10中使用注册表修改

TTY

Aurora没有内置TTY检测器。如果需要只为终端启用颜色，而为文件禁用颜色，可以参考相关解决方案。

许可

Copyright © 2016-2022 The Aurora Authors. 本作品是免费的。 它在适用法律允许的范围内不提供任何担保。您可以根据Unlicense的条款重新分发和/或修改它。