认识下 ANIS,写个简版 chalk

20211117-095455@2x.png

背景:对于终端 terminal 的使用,相信我们都不陌生,而且你可能还会拍着胸脯说,终端那不是天天都用,程序员必备呀,而且我还会把它打扮的花里胡哨的,就算使用一些默认的终端命令也是非常的好看,比如 Git、Vim、bash 等等,没错,我们今天说的就是终端的颜色。

比如我们常见的通过终端打开 Git 它的分支高亮提示:

当代码编译错误,我们会在终端收到高亮的错误提示,让我们非常直观且快速的定位到错误:

还有一些无关痛痒的警告也是可以通过终端来告诉我们的,比如 npm install 的警告:

以上是我们常看到的几个案例,不止看到过,甚至,你可能还写过它们,比如你写系统生成的日志,为了更直观的观察结果,定位问题,你会使用 chalkcolor 等这样的第三方库来标记重点信息,就像我们上面看到的几个例子那样。

当你看到或用到终端输出彩色字体的时候,不知道你心中有没有闪过一丝的好奇,这到底是怎么实现的,不过要想学明白它,可有点不容易,需要你会点编码的知识,尤其是 ANSI 的知识。

ASCII 你肯定听说过,ANSI 是什么东东来,别急,这就是我们接下来要带你学习的。

如果你对 ANSI 比较了解,可直接跳转到 「简版 chalk」章节。

目录

  • 目录
  • 什么是 ANSI 转义序列
  • ANSI 的语法
    • 颜色
      • 三位色
      • 四位色
      • 八位色
      • 二十四位色
    • 其他装饰
      • 斜体
      • 下划线
      • 字体闪烁
      • 隐藏
      • 删除线
      • 选择图形再现参数
    • 光标
  • 简版 chalk
    • 终端是否支持颜色
    • 封装 format 函数
    • 封装颜色函数
    • 使用
    • 输出结果
  • 应用在其他语言上
  • 概述
  • 参考

什么是 ANSI 转义序列

计算机最底层的机制是二进制,它不认识 a、b、c、1、2、3 等等,我们人能识别的字符,那怎么办来,简单,一个字节等于 8 位,一个字符等于一个字节,我们维护一个表,等过变动 0 或 1 的位置,让固定的二进制编码去对应我们人能识别的字符就好了,比如二进制 0100 0001 就对应我们的大写字母 A。

但是这样也是有问题的,因为 2**8=256 我们只能表示二百五十六个字符,汉字都成千上万,所以以后又出现了 Unicode、UTF-8、UTF-16(字符用两个字节或四个字节表示)和 UTF-32(字符用四个字节表示),它们之间的关系,你还可以去看阮老师的文字 字符编码笔记:ASCII,Unicode 和 UTF-8 加深印象。

到此,我们的计算机完成了,字符的展示,可是我们人类并不满足预测,为啥文字不能支持丰富的颜色、我想突出重点,文字为啥不能高亮,于是为了支持这种富文本的需求出现了 ANSI 编码。

维基百科对它的定义是:

ANSI escape sequences are a standard for in-band signaling to control cursor location, color, font styling, and other options on video text terminals and terminal emulators. Certain sequences of bytes, most starting with an ASCII escape character and a bracket character, are embedded into text. The terminal interprets these sequences as commands, rather than text to display verbatim.'

翻译下就是:
ANSI 转义序列带内信号的标准,用于控制视频文本终端终端仿真器上的光标位置、颜色、字体样式和其他选项。某些字节序列(大多数以ASCII 转义字符和括号字符开头)被嵌入到文本中。终端将这些序列解释为命令,而不是逐字显示的文本。

看完有点懵是吧,你可把它的定位简单理解为这样:

ANSI 转义序列是用于控制台/终端光标位置、更改和设置颜色和字体以及执行其他操作的指令。

这时你仔细想想,其实 ANSI 就是 ASCII 的扩展,只不过提供了额外的命令,我们可以用来改变终端的输出而已。

ANSI 的语法

大部分以ESC转义字符[ 字符开始 m 结束,中间为 code 码,以分号进行分割。比如:ESC[31m(31 表示字体红色)。但 ESC 是个字符串,不转义是不能使用的,通过 ASCII 表知道 ESC 对应的十进制值为 27,就选这个十进制作为转义的基准。

现在把二十七给转换成八进制和十进制:

const octal = Number(27).toString(8);
const hex = Number(27).toString(16);

console.log(octal, hex); // 33 1b
  1. 八进制表示为 \033
  2. 十六进制表示为 \x1B
  3. \u001B 十六进制 Unicode 编码。

上面三种方式都是可以的,下面通过三种方式打印出红色字体的文字:

// 1. default.js
console.log("Esc[31mhello!"); // Esc[31mhello!

// 2. hex.js
console.log("\x1b[31m我是红色!");

// 3. octal.js
console.log("\033[31m我是红色!");

// 4. unicode.js  \u001B === \u001b
console.log("\u001B[31m我是红色!");

使用 Node 运行会看到下面结果:

除了第一个不是红色的文字外,其他三个案例都正常打印出红色的文字,这里推荐使用 Unicode 编码的形式的,兼容性更好。

颜色

第一个我们就学习如何输出颜色相关的知识。

三位色

三位色表示二的三次方等于八,一共八种色,这八种色也是基本色,并且有各自的名称,黑色、红色、绿色、黄色、蓝色、品红、青色、白色。

颜色一般作用在前景色和背景色上,前景色就是文字的颜色,而背景色就是文字的背景颜色了。

从数字 30 ~ 37 表示前景色的颜色,从数字 40 ~ 47 表示背景色的颜色,

颜色 FG FG ANSI 写法 BG BG ANSI 写法
黑色 30 \u001b[30m 40 \u001b[40m
红色 31 \u001b[31m 41 \u001b[41m
绿色 32 \u001b[32m 42 \u001b[42m
黄色 33 \u001b[33m 43 \u001b[43m
蓝色 34 \u001b[34m 44 \u001b[44m
品红 35 \u001b[35m 45 \u001b[45m
青色 36 \u001b[36m 46 \u001b[46m
白色 37 \u001b[37m 47 \u001b[47m
默认前/背景色 39 \u001b[39m 49 \u001b[49m

这个有个小知识点,看代码:

console.log("\u001b[31m 我是 ");
console.log(" 红色! ");
console.log(" 1 + 1 = 2 ");

执行结果:

发现问题没有,没错所有的字体都变成了红色,包括没有使用 ANSI 命令的代码,ANSI 的使用有点像 HTML 的双闭合标签,上面代码我们给了开始没给结束。

那简单了,我们添加一个结束就行了,有一个比较暴力的办法,当 code 为 0 的 \u001b[0m 会重置我们设置的所有属性,这个太猛了,我们现在只需要重置字体颜色,所以使用 39 就行了,即 \u001b[39m 恢复默认前景色,其实就是重置字体颜色,代码如下。

console.log("\u001b[31m 我是 \u001b[39m");

结果:

OK,现在来一个小案例把八个字体颜色全部使用下,一一打印出 A ~ H 对应的八种颜色:

const colorText = (text, code, groundCode) => `\u001b[${code}m ${text} \u001b[${groundCode}m`;

const result = `
  ${colorText("A", 30, 39)} ${colorText("B", 31, 39)} ${colorText("C", 32, 39)} ${colorText("D", 33, 39)} 
  ${colorText("E", 34, 39)} ${colorText("F", 35, 39)} ${colorText("G", 36, 39)} ${colorText("H", 37, 39)}
  ${colorText("A", 40, 49)} ${colorText("B", 41, 49)} ${colorText("C", 42, 49)} ${colorText("D", 43, 49)} 
  ${colorText("E", 44, 49)} ${colorText("F", 45, 49)} ${colorText("G", 46, 49)} ${colorText("H", 47, 49)} 
`
console.log(result);

结果:

上面我们案例,前景色和背景色都是分开使用的能不能组合在一起来,答案是可以的,不然文章开头的 npm ERR 和 WARN 如何实现的?对伐!

现在我们就来实现 黑底红字的 ERROR 和 黄底黑字的 WARN:

// 诀窍:多个颜色 分号 分割
console.log(`
  \n
  npm \u001b[31;40m ERROR \u001b[39;49m
  \n
  npm \u001b[30;43m WARN \u001b[39;49m
  \n
`);

当当当,非常完美的实现

四位色

四位色即二的四次方等于十六,一共十六种色。

就像文字有粗体一样,颜色也有明亮,基于八种颜色分别明亮下,颜色就翻倍了达到了十二种,明亮后的颜色它们有自己的编码,分别是 90 ~ 97 前景明亮,100 ~ 107 背景明亮。

现在以蓝色和亮蓝色为例:

console.log(`
  \n
  字体蓝色:\u001b[34m ERROR \u001b[39m 字体亮蓝色:\u001b[94m ERROR \u001b[39m
  \n
  背景:\u001b[44m WARN \u001b[49m 背景亮蓝色:\u001b[104m WARN \u001b[49m
`);

控制台运行如下:

wiki 有一份颜色表充分描述了各平台对十六种颜色的支持。

要想达到明亮的效果,除了新的 code,还可以使用基本颜色编码配合编码 1 来实现同样的效果,编码 1 表示粗体或增加强度,使用的时候用分号和其他 code 分隔:

console.log(`
  \n
  字体蓝色:\u001b[34m ERROR \u001b[39m 字体亮蓝色:\u001b[94m ERROR \u001b[39m 字体加粗亮蓝色: \u001b[1;34m ERROR \u001b[22;39m
`);

结果如下:

既然可以加强,那么就可以弱化(降低强度),弱化的编码为 2,look 下代码:

console.log(`
  \n
  字体蓝色:\u001b[34m ERROR \u001b[39m 字体亮蓝色:\u001b[94m ERROR \u001b[39m
  字体加粗亮蓝色: \u001b[1;34m ERROR \u001b[22;39m 字体强度弱化: \u001b[2;34m ERROR \u001b[22;39m 
`);

运行结果,弱化不像强化,只对颜色有影响而对字体粗细没有影响:

编码 1 和 2 出现的效果,我们可以通过 22 进行重置到正常颜色或强度。

上面探讨的弱化和强化针对的都是前景色,那么对背景色的影响呢,通过代码来观察下:

console.log(`
  \n
  背景色蓝色:\u001b[44m BACKGROUND \u001b[49m 背景色亮蓝色:\u001b[104m BACKGROUND \u001b[49m
  背景色加粗亮蓝色: \u001b[1;44m BACKGROUND \u001b[22;49m 背景色强度弱化: \u001b[2;44m BACKGROUND \u001b[22;49m 
`);

运行结果:

四个颜色,背景亮蓝色的色值为: #3b8eea,剩下三个都为:#2472c8也就是说强化和弱化对背景色没有效果。

强化和弱化虽然没有效果,但是却可以通过编码 7 来反显把前景色与背景色交换。

console.log(`
  \n
  背景色蓝色:\u001b[44m BACKGROUND \u001b[49m 
  蓝色反向:\u001b[7;44m BACKGROUND \u001b[27;49m
`);

这时我就想到,前景色先弱化在反显不就实现了背景色弱化,实践发现并没有生效。

八位色

八位色即二的八次方等于二百五十六,一共 256 种色,它的语法是下面这样。

ESC[ … 38;5;<n> … m选择前景色
ESC[ … 48;5;<n> … m选择背景色

0-  7:标准颜色(同ESC [ 30–37 m)
8- 15:高强度颜色(同ESC [ 90–97 m)
16-231:6 × 6 × 6 立方(216色): 16 + 36 × r + 6 × g + b (0 ≤ r, g, b ≤ 5)
232-255:从黑到白的24阶灰度色

比如前景色黑色:

// m 前面的数字 0,这个位的数值可从 0 ~ 255 正好对应 256 中颜色
console.log("\u001b[38;5;0m 黑色 \u001b[39m");

0 ~ 255 对应的颜色色阶:

我们通过代码把所有的颜色打印出来:

const rangeArr = (len) => Array.from({ length: len }, (_, i) => i);
const color256 = (bg = "foreground") => rangeArr(2 ** 8).reduce((row, colorCode, colorIndex) => {
  const bgCode = bg === "foreground" ? 3 : 4;
  const lright = String(colorCode).padStart(3, 0);
  const text = `\u001b[${bgCode}8;5;${colorCode}m${lright} \u001b[${bgCode}9m`;
  if (colorIndex % 16 === 0) {
    row += `\n ${text}`;
  } else {
    row += text;
  }
  return row;
}, "");

如果我们想要 256 种前景色,直接调用 color256 函数即可:

console.log(color256());

运行结果:

如果我们想要 256 种背景色,需要给 color256 函数传入参数 background 即可:

console.log(color256("background"));

运行结果:

二十四位色

二十四位色即二的二十四次方等于 16777216,一共 16777216 种色。

语法类似八位色,只不过中间的 5 改成了 2,n 改成了 RGB:

   ESC[ … 38;2;<r>;<g>;<b> … m选择RGB前景色
   ESC[ … 48;2;<r>;<g>;<b> … m选择RGB背景色

如果我们需要一个前景色品红,就应该这样写:

console.log("\u001b[38;2;255;0;255m 品红 \u001b[39m");

运行结果:

这个颜色的结果就不显示了,颜色过多,控制台也承载不下,但是我们可以写出全部展示的伪代码。

const rangeArr = (len) => Array.from({ length: len }, (_, i) => i);
const bit24 = 2 ** 24;

for (r of rangeArr(bit24)) {
  for (g of rangeArr(bit24)){
    for(b of rangeArr(bit24)) {
      const code = String(r * bit24 * bit24 + g * bit24 + b);
      console.log(`\u001b[38;2;${r};${g};${b}m${code.padStart(3, 0)} \u001b[39m`)
    }
  }
}

若你感兴趣,还可以试试 RGB 对应的八个基准色:

甚至是十六色

其他装饰

斜体

未广泛支持:

console.log("\u001b[3m 斜体 \u001b[23m");

下划线

console.log("\u001b[4m 下划线 \u001b[24m");

效果如下:

字体闪烁

闪烁分为两种:快闪(编码 6)和慢闪(编码 5),但是快闪不是所有终端都支持的,目前我的终端只支持慢闪 5,而且调试代码的时候不能在 VSCode 的终端,必须通过全局打开的 terminal。

console.log("\u001b[94;5m 缓慢闪烁 \u001b[39;25m");

运行结果:

ezgif.com-gif-maker.gif

隐藏

未广泛支持:

console.log("前面有字 \u001b[8m 隐藏 \u001b[28m 后面有字");

运行结果:

删除线

未广泛支持:

console.log("\u001b[9m 删除 delete \u001b[29m");

运行结果:

选择图形再现参数

我们上面学习的编码都是比较常用的,Wiki 上维护了一个比较全的编码,如下图,基本上常用的都讲到了。

光标

ANSI 转义序列 还有另一个更有用的模块即,终端窗口的光标操作,让你可以移动,或擦除终端部分内容。例如,让你在输入命令上左右移动光标以响应箭头键,或者制作进度条如下图这种。

ezgif.com-gif-maker.gif

这个内容我们留下次再展开讲。

简版 chalk

终端是否支持颜色

第一步肯定要判断下我们的终端是否支持颜色功能,NodeJS 可以使用内置的 TTY 来判断:

const tty = require("node:tty");
// 支持 TRUE,否则 FALSE
const hasColors = tty.WriteStream.prototype.hasColors();

封装 format 函数

根据第一步检测的结构,封装 format 函数,变色采用的 ANSI 编码,前景色即字体颜色的格式为:\u001B[31m需要变色的字符串\u001B[39m,31 表示红色,39 表示关闭当前色,避免影响后面的内容。

所以 format 需要开始 startCode 和结束 endCode。

然后,如果终端不支持颜色功能,正确打印出传入的字符就行了,如果支持,那么就根据拼装 ANSI 语法打印出变色字体。

const format = (startCode, endCode) => hasColors ? string => '\u001B[' + startCode + 'm' + string + '\u001B[' + endCode + 'm' : string => string;

封装颜色函数

比如说前景色红色,对应的 code 为 31,重置 code 为 39:

const red = format(31, 39);

使用

传入需要变色的字符串:

console.log(red("变红!"));

输出结果

运行代码输出结果:

应用在其他语言上

上文的演示案例,虽然全部都是使用 JS 的方法实现的,但只要你掌握了 ANSI 的知识,在任何语言都能使用,我们举个 Python 的例子:

print("\033[31mHello\033[39m \033[33mPython3!\033[39m");

打印出红色的 Hello 黄色的 Python3!

概述

总结时刻,今天我们学习了 ANSI 转义序列,它主要包含颜色和光标两大类,颜色功能可以用来美化终端输出,光标功能可以用来制作 progress 或 loading,来增加代码友好的编译提示。

顺便我们实践了一把简版的chalk,光标功能实践 progress,我们只给出了案例,留待下篇文章再谈。

参考

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 203,271评论 5 476
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 85,275评论 2 380
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 150,151评论 0 336
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,550评论 1 273
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,553评论 5 365
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,559评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,924评论 3 395
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,580评论 0 257
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,826评论 1 297
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,578评论 2 320
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,661评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,363评论 4 318
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,940评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,926评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,156评论 1 259
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 42,872评论 2 349
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,391评论 2 342

推荐阅读更多精彩内容