# @hashicorp/ansi\_up 中文文档

规范地址：https://npmcn.com/package/%40hashicorp/ansi_up/

版本：6\.0\.8
npm 元数据更新时间：2026-10-15T01:13:14.425Z
中文译文更新时间：2026-11-17T11:02:33.592Z
软件包许可：MIT

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40hashicorp/ansi_up
原文对照：https://npmcn.com/package/%40hashicorp/ansi_up/?lang=original
项目主页：https://github.com/drudru/ansi_up#readme
源码仓库：https://github.com/drudru/ansi_up

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：321 kB，23 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- Node.js 要求：\*
- 运行依赖：0 个
- 首次发布：2026-05-06T20:21:53.433Z
- 最新版本发布：2026-05-06T21:09:12.012Z
- 近 30 天下载量：46675（2026-10-18 至 2026-11-16，npm 官方下载统计）
- 已发布版本数：2（近 12 个月 2 个）

## 中文简介

将字符串中的ansi序列转换为多彩的 HTML

## 安装

```sh
npm install @hashicorp/ansi_up
```

也可以使用：`pnpm add @hashicorp/ansi_up`、`yarn add @hashicorp/ansi_up`、`bun add @hashicorp/ansi_up`

## README

# ansi-up.js (英语)

**上进** 是一个易于使用的工具库,用于转换包含 [ANSI 颜色逃生代码](http://en.wikipedia.org/wiki/ANSI_escape_code#Colors) 输入 HTML.

这个模块是一个单一的ES6 Javascript文件,没有依赖性. 这是"异形"的Javascript。 这仅仅是另一种说法 ansi up.js 文件将同时在浏览器或节点.js中工作. Js库由TypeScript及其类型描述船与国家预防机制汇编而成. 此代码自2011年起被用入生产,并积极维护.

例如, 打开此终端输出 :

```
ESC[1;Foreground
[1;30m 30  [1;30m 30  [1;30m 30  [1;30m 30  [1;30m 30  [1;30m 30  [1;30m 30  [1;30m 30  [0m
[1;31m 31  [1;31m 31  [1;31m 31  [1;31m 31  [1;31m 31  [1;31m 31  [1;31m 31  [1;31m 31  [0m
[1;32m 32  [1;32m 32  [1;32m 32  [1;32m 32  [1;32m 32  [1;32m 32  [1;32m 32  [1;32m 32  [0m
...
```

... 输入浏览器输出 :

![](https://raw.github.com/drudru/ansi_up/master/sample.png)

## 浏览器示例

```HTML

    <script type="module" type="text/javascript">

    var txt  = "\n\n\033[1;33;40m 33;40  \033[1;33;41m 33;41  \033[1;33;42m 33;42  \033[1;33;43m 33;43  \033[1;33;44m 33;44  \033[1;33;45m 33;45  \033[1;33;46m 33;46  \033[1m\033[0\n\n\033[1;33;42m >> Tests OK\n\n"

    import { AnsiUp } from './ansi_up.js'
    var ansi_up = new AnsiUp();

    var html = ansi_up.ansi_to_html(txt);

    var cdiv = document.getElementById("console");

    cdiv.innerHTML = html;

    </script>
```

## 节点示例

```JavaScript
    import { AnsiUp } from './ansi_up.js'
    var ansi_up = new AnsiUp();

    var txt  = "\n\n\033[1;33;40m 33;40  \033[1;33;41m 33;41  \033[1;33;42m 33;42  \033[1;33;43m 33;43  \033[1;33;44m 33;44  \033[1;33;45m 33;45  \033[1;33;46m 33;46  \033[1m\033[0\n\n\033[1;33;42m >> Tests OK\n\n"

    var html = ansi_up.ansi_to_html(txt);
```

更多实例出现在repo中的"例"目录中.

## 字体示例

```TypeScript
    import { AnsiUp } from './ansi_up.js'
    const ansi_up = new AnsiUp();

    const txt  = "\n\n\x1B[1;33;40m 33;40  \x1B[1;33;41m 33;41  \x1B[1;33;42m 33;42  \x1B[1;33;43m 33;43  \x1B[1;33;44m 33;44  \x1B[1;33;45m 33;45  \x1B[1;33;46m 33;46  \x1B[1m\x1B[0\n\n\x1B[1;33;42m >> Tests OK\n\n"

    let html = ansi_up.ansi_to_html(txt);
```

## 安装

```
$ npm install ansi_up
```

## 版本数

-   6.0版本 - 切换到ES6模块. 添加昏暗的样式 。 样式 cs 可配置 .
-   5.1版本 - 添加斜体和下划线样式 (@ DaoDaoNoCode)
-   5.0版本 - OSC URL的安全修正
-   4.0版本 - 支持的再存档码 [终端 URL 代码](https://gist.github.com/egmontkob/eb114294efbcd5adb1944c9f3cb5feda)。 。 。 .
-   3.0版本 - 现在将 ANSI 粗体序列作为 CSS 字体重: 粗体
-   2.0版本 - 移动到状态的流媒体版本 API
-   1.3版本 - 是最老的被贬损的API.

## 快速启动

1.  使用任意模块系统导入 _上进_ 模块.
2.  证取所取相.
3.  对于每一块安西逃脱的文本字符串,呼叫 **ansi to html (简体中文)**。 。 。 .
4.  将已发射的 HTML 添加到先前已发射的 HTML 中 .
5.  完成时间

## API 方法和推荐设置

您只需要 ansi to html 方法 。 以下列出的其他属性允许您 超越一些逃脱行为 你可能不需要改变这些 从它们的默认值.

建议持有横幅标记的 HTML 容器采用单一空间字体来命名. 预告牌可以做这个. 还建议HTML容器采用黑色背景样式. 更多CSS主题请参见实例.

#### ansi to html (txt) (韩语)

这把ANSI终端的逃生代码/序列转换为SPAN标签来包装和样式内容.

这种方法只解释 ANSI SGR( 选择图形格式) 代码或逃脱 URL 代码 . 例如,光标移动代码被忽略并被隐藏在输出中.

这种方法也安全地逃脱了任何不安全的HTML字符.

默认样式使用非常接近规定标准的颜色. 标准假设文本会有黑色背景. 这些颜色被设定为SPAN标签上的内含样式. 另一个选项是设置“ use class” 属性为真 . 这将在跨度上设置类, 这样颜色就可以通过 CSS 设定 . 所使用的类名为格式 `ansi-*-fg/bg` 财务报告和审定财务报表 `ansi-bright-*-fg/bg` 其中 \* 是颜色名称,即:黑色/红色/绿色/黄色/蓝色/mageta/cyan/白色. Xterm 256颜色,索引 16.255 `ansi-xterm-<index>-fg/bg` 课程. 当使用真彩色( 38; 2 / 48; 2)时 `use_classes = true`, ansi up 将 RGB 值映射到最近的xterm 索引并发出相应的类. 参见这些类完整的 CSS 主题的实例目录.

## 属性

#### 逃脱 html

(默认:真实)

默认情况下, HTML 保留字符 `& < > " '` 替换为 [HTML 实体](https://www.w3schools.com/html/html_entities.asp) 使其在您的应用程序中显示为字面字符,而不是被解释为 HTML 结构。 如果您更喜欢让 HTML 保留字符不受影响, 您可以设置为虚假 .

#### 使用类( c)

(默认:虚假)

这导致 SPAN 标签使用类来样式 SPAN 标签 指定 RGB 值.

类模式细节 :

-   x 任期指数 0. 15 对现有 `ansi-*` 编号 : `ansi-bright-*` 课程.
-   任期指数 16.255 `ansi-xterm-<index>-fg/bg` 课程.
-   truecolor (38; 2 / 48; 2) 解析到最近的x term 类时 `use_classes` 这是真的.
-   真彩仍然内含 `rgb(...)` 样式 `use_classes` 是虚假的.

#### url allowlist 列表

(默认: {'http': 1,'https': 1})

此映射是一个“ ALL” 的URI 方案列表, 可以让 HTML 锁定标记 .

#### 粗体结构

(默认 : “ 重量: 粗体 ” )

#### 微弱样式

(默认 : '不透明: 0. 7')

#### 斜体结构

(默认 : “ font- style: italic ” )

#### 下划线

(默认: “ 文本- 装饰: 下行 ” )

## 缓冲

一般情况下, ansi to html _应_ 以非空字符串引用时, 发出 HTML 输出 . 唯一的例外是ESC序列不完整或OSC URL序列不完整. 对于这些案例,库会缓冲(不会输出出输出),直到收到完成这些序列的输入.

### 使用实例

我用这个图书馆来"尾"一个文件.

在远程机器上,我有一个程序生成日志文件. 我有一个网络服务器运行在同一台机器上. 服务器托管了一个简单的HTML页面,使用AJAX通过范围查询对对象进行投票. 具体来说,我用一个HTTP/1.1 与 RFC 7233 范围查询请求. 第一个范围查询将在 0 开始,但随后将逐步推进 收到了新的数据.

对于收到的每一个新数据,我都会将数据转换为 _上进_,并附上新的 横跨到 PRE 标记的内侧HTML.

### UTF8 注释

最后一点, _上进_ 以 Javascript 字符串的形式输入. 这些字符串是UTF8. 当你接受一些程序的输出并发送到 Javascript,会有缓冲。 请确定您不会发送不完整的 UTF8 序列 . Javascript 转换为一时会忽略或丢弃流中的序列 绳子.

## 大楼

为了构建,一个简单的 Makefile 处理这一切.

```shell
    $ make
```

## 正在测试

进行测试 _上进_运行 `npm install` 以安装 dev 依赖。 然后说:

```shell
    $ make test
```

## 常见问题

### @hashicorp/ansi\_up 是什么？

将字符串中的ansi序列转换为多彩的 HTML

### 如何安装 @hashicorp/ansi\_up？

在项目目录运行 npm install @hashicorp/ansi\_up，或使用 pnpm add / yarn add / bun add。

### @hashicorp/ansi\_up 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @hashicorp/ansi\_up 支持 ESM 还是 CommonJS？

以 ES Module 形式发布，推荐使用 import 引入。在 CommonJS 项目中，Node\.js 20\.19\+ / 22\.12\+ 可以直接 require\(\) 不含顶层 await 的 ES Module，更早的版本需要改用动态 import\(\)。

### @hashicorp/ansi\_up 需要什么版本的 Node\.js？

package\.json 的 engines 字段要求 Node\.js \*。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。

### @hashicorp/ansi\_up 可以商用吗？

@hashicorp/ansi\_up 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @hashicorp/ansi\_up 的下载量有多少？

根据 npm 官方下载统计，@hashicorp/ansi\_up 在 2026/10/18 – 2026/11/16 这 30 天内被下载 46,675 次，日均约 1,556 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @hashicorp/ansi\_up 还在维护吗？

最新版本 6\.0\.8 发布于 2026/05/07（6 个月前）；至今共发布 2 个版本，其中过去 12 个月发布了 2 个；首次发布于 2026/05/07。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。

