cli-color 项目技术文档

1. 安装指南

1.1 安装环境要求

• Node.js 环境
• npm 包管理器

1.2 安装步骤

1. 打开终端或命令行工具。
2. 运行以下命令安装 cli-color 包：

   npm install cli-color
   

2. 项目使用说明

2.1 基本用法

cli-color 是一个用于在控制台中输出彩色和格式化文本的工具。它提供了多种颜色和样式选项，可以轻松地为控制台输出添加视觉效果。

2.1.1 引入模块

首先，需要在项目中引入 cli-color 模块：

var clc = require("cli-color");

2.1.2 输出彩色文本

可以使用 clc 对象的方法来输出彩色文本。例如，输出红色文本：

console.log(clc.red("Text in red"));

2.1.3 混合样式

可以混合使用不同的样式，例如红色背景、白色前景和下划线：

console.log(clc.red.bgWhite.underline("Underlined red text on white background."));

2.1.4 混合样式与普通文本

可以将样式化的文本与普通文本混合使用：

console.log(clc.red("red") + " plain " + clc.blue("blue"));

2.1.5 嵌套样式

样式化的文本可以嵌套使用：

console.log(clc.red("red " + clc.blue("blue") + " red"));

2.1.6 预定义样式

为了方便使用，可以预定义常用的样式：

var error = clc.red.bold;
var warn = clc.yellow;
var notice = clc.blue;

console.log(error("Error!"));
console.log(warn("Warning"));
console.log(notice("Notice"));

2.2 环境变量

如果设置了 NO_COLOR 环境变量，cli-color 将不会输出任何颜色或样式。

3. 项目API使用文档

3.1 支持的样式

cli-color 支持以下样式：

• bold：加粗
• italic：斜体
• underline：下划线
• blink：闪烁
• inverse：反转颜色
• strike：删除线

3.2 支持的颜色

cli-color 支持以下颜色：

• 前景色：black, red, green, yellow, blue, magenta, cyan, white
• 背景色：bgBlack, bgRed, bgGreen, bgYellow, bgBlue, bgMagenta, bgCyan, bgWhite

3.2.1 亮色变体

• 前景色：blackBright, redBright, greenBright, yellowBright, blueBright, magentaBright, cyanBright, whiteBright
• 背景色：bgBlackBright, bgRedBright, bgGreenBright, bgYellowBright, bgBlueBright, bgMagentaBright, bgCyanBright, bgWhiteBright

3.2.2 xTerm 颜色

cli-color 还支持 xTerm 颜色（256 色），但某些终端和 Windows 系统可能不支持。

var msg = clc.xterm(202).bgXterm(236);
console.log(msg("Orange text on dark gray background"));

3.3 重置终端

可以使用 clc.reset 重置终端：

process.stdout.write(clc.reset);

3.4 清除屏幕

cli-color 提供了多种清除屏幕的功能：

• clc.erase.screen：清除整个屏幕
• clc.erase.screenLeft：清除屏幕左侧部分
• clc.erase.screenRight：清除屏幕右侧部分
• clc.erase.line：清除当前行
• clc.erase.lineRight：清除当前行右侧部分
• clc.erase.lineLeft：清除当前行左侧部分

3.5 光标移动

cli-color 提供了多种光标移动的功能：

• clc.move(x, y)：相对移动光标
• clc.move.to(x, y)：绝对移动光标
• clc.move.up(n)：向上移动光标
• clc.move.down(n)：向下移动光标
• clc.move.right(n)：向右移动光标
• clc.move.left(n)：向左移动光标
• clc.move.lines(n)：向前或向后移动 n 行
• clc.move.top：移动光标到屏幕顶部
• clc.move.bottom：移动光标到屏幕底部
• clc.move.lineBegin：移动光标到行首
• clc.move.lineEnd：移动光标到行尾

3.6 终端特性

• clc.windowSize.width：获取终端宽度
• clc.windowSize.height：获取终端高度

3.7 其他功能

• clc.slice(str[, begin[, end]])：对带有 ANSI 格式化的字符串进行切片
• clc.strip(formatedText)：去除 ANSI 格式化，返回纯文本
• clc.getStrippedLength(str)：获取 ANSI 格式化字符串的实际长度
• clc.art(text, styleConf)：创建文本图形艺术
• clc.columns(data[, options])：输出对齐的表格

4. 项目安装方式

4.1 使用 npm 安装

npm install cli-color

4.2 引入项目

在项目中引入 cli-color 模块：

var clc = require("cli-color");

通过以上步骤，您可以成功安装并使用 cli-color 项目，为控制台输出添加丰富的颜色和样式。