ansi_up.js 技术文档

ansi_up.js 技术文档

ansi_up A javascript library that converts text with ANSI terminal codes into colorful HTML Zero dependencies. 项目地址: https://gitcode.com/gh_mirrors/an/ansi_up

欢迎来到 ansi_up.js 的详细指南。本库提供一种简单易用的方式，将包含ANSI颜色转义码的文本转换成HTML格式，使您能够轻松地在网页上展示终端风格的输出。以下是该库的全面使用指南。

安装指南

对于Node.js环境，使用npm来安装是最简便的方法：

$ npm install ansi_up

若要在浏览器环境中使用，您需要通过ES6模块导入或将其脚本直接包含在您的HTML文件中。

项目的使用说明

基础使用

浏览器端示例

在HTML文件中，您可以这样使用ansi_up.js：

<script type="module">
import { AnsiUp } from './path/to/ansi_up.js';
var ansi_up = new AnsiUp();
var txt = "\n...\n"; // 包含ANSI颜色代码的文本
var html = ansi_up.ansi_to_html(txt);
document.getElementById("outputDiv").innerHTML = html;
</script>

Node.js 示例

对于Node环境，使用方法相似：

import { AnsiUp } from 'ansi_up';
let ansi_up = new AnsiUp();
let txt = "\n...\n";
let html = ansi_up.ansi_to_html(txt);
console.log(html);

类型Script支持

如果您使用TypeScript，则可以这样引入：

import { AnsiUp } from './path/to/ansi_up.js';
const ansi_up = new AnsiUp();
const txt = "\n...\n";
let html = ansi_up.ansi_to_html(txt);

项目API使用文档

核心API非常直观，主要关注ansi_to_html方法：

• ansi_to_html(txt: string): string
  • 参数: txt - 包含ANSI转义序列的字符串。
  • 返回: 转换后的HTML字符串。
  • 功能: 将文本中的ANSI颜色转义码转换为对应的HTML样式标签。

此外，您可以调整以下属性以改变默认行为：

• escape_html: 控制是否转义HTML字符，默认为true。
• use_classes: 若设为true，将使用CSS类代替内联样式，便于自定义主题。

项目版本与更新

• v6.0+ 支持ES6模块，添加淡入效果，允许配置样式CSS。
• 更早版本提供了对旧API的支持以及各种特性增强，如安全修复和URL处理。

编译与测试

• 对于开发人员，利用Makefile进行编译 (make) 和运行测试 (make test)。

注意事项

确保处理UTF8编码的数据时避免发送不完整的字节序列，以免JavaScript忽略或错误解析数据。

ansi_up.js 是一个成熟的解决方案，适用于需要把命令行输出转换到Web界面的情景，如日志查看工具或者实时系统监控界面。记住设置适当的容器样式（推荐使用monospace字体和黑色背景）以保持原生终端的视觉体验。

感谢Dru Nelson和其他贡献者的辛勤工作，使得这个库成为可能并持续得到维护。希望这份文档能帮助您充分利用 ansi_up.js！

ansi_up A javascript library that converts text with ANSI terminal codes into colorful HTML Zero dependencies. 项目地址: https://gitcode.com/gh_mirrors/an/ansi_up