# @ansi-tools/parser 中文文档

规范地址：https://npmcn.com/package/%40ansi-tools/parser/

版本：1\.1\.0
npm 元数据更新时间：2026-09-12T09:59:59.492Z
中文译文更新时间：2026-11-06T05:51:23.026Z
软件包许可：ISC

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

原始 npm 页面：https://www.npmjs.com/package/%40ansi-tools/parser
原文对照：https://npmcn.com/package/%40ansi-tools/parser/?lang=original
项目主页：https://github.com/webpro/ANSI.tools/tree/main/packages/parser
源码仓库：https://github.com/webpro/ANSI.tools

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

- 包体积（解压后）：27.8 kB，8 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：0 个
- 首次发布：2025-07-14T06:22:22.736Z
- 最新版本发布：2026-09-12T09:59:59.305Z
- 近 30 天下载量：18385（2026-10-06 至 2026-11-04，npm 官方下载统计）
- 已发布版本数：22（近 12 个月 6 个）

## 中文简介

ANSI出逃代码解析器和活化器. 从字符串解析终端控制序列(CSI,SGR,OSC,DCS). 零从属.

## 安装

```sh
npm install @ansi-tools/parser
```

也可以使用：`pnpm add @ansi-tools/parser`、`yarn add @ansi-tools/parser`、`bun add @ansi-tools/parser`

## README

# @ansi-tools/parser (英语)

解析器为ANSI出逃序列.

## 特征

-   支持CSI,OSC,DCS,ESC,APC,SOS,PM等.
-   QQ 处理 7- 位 (`\x1b` 或者说 `\u001b`)和8位数(`\u009b`(a) 介绍者
-   处理八进制`\033`)和简称 `\e` 介绍者( 只逃脱)
-   QQ 多个字符串终止符(`\x1b\\`, (中文(简体) ), `\x07`(中文(简体) )
-   零依赖关系
-   QQ 为原始输入和逃出输入单独优化模块

用于 [类工具](https://ansi.tools/)。 。 。 .

## 安装

```bash
npm install @ansi-tools/parser
```

## 使用量

```ts
import { parse } from "@ansi-tools/parser";

const input = "\x1b[31mHello\x1b[0m World";

for (const code of parse(input)) {
  console.log(code);
}
```

逃出和未逃出输入有区别. 只有逃出来 输入字符串 原始输入和位置可以在符号和 控制密码 默认和 `/escaped` 导入.

默认和未脱逃的标志化速度大约为~30%. 使用这个,如果你 只需要控制密码.

## 实例

### 默认( raw/ unscaped)

```ts
import { parse } from "@ansi-tools/parser";

parse(`\x1b[31mHello\x1b[0m`);

// result:
[
  {
    type: "CSI",
    pos: 0,
    raw: "\u001b[31m",
    command: "m",
    params: ["31"],
  },
  {
    type: "TEXT",
    pos: 5,
    raw: "Hello",
  },
  {
    type: "CSI",
    pos: 10,
    raw: "\u001b[0m",
    command: "m",
    params: ["0"],
  },
];
```

### 逃脱

```ts
import { parse } from "@ansi-tools/parser/escaped";

parse(String.raw`\x1b[31mHello\x1b[0m`);

// result:
[
  {
    type: "CSI",
    pos: 0,
    raw: "\\x1b[31m",
    command: "m",
    params: ["31"],
  },
  {
    type: "TEXT",
    pos: 8,
    raw: "Hello",
  },
  {
    type: "CSI",
    pos: 13,
    raw: "\\x1b[0m",
    command: "m",
    params: ["0"],
  },
];
```

## 调试器生成器( E)

默认和默认的发件机和发件机也可用 `/escaped` 各个版本.

### 符号化

```ts
import { tokenize } from "@ansi-tools/parser";

const input = "\x1b[31m";

for (const token of tokenize(input)) {
  console.log(token);
}
```

### 发电机

```ts
import { tokenizer, parser } from "@ansi-tools/parser";

const input = "\x1b[31mHello\x1b[0m";

const tokens = tokenizer(input);

const codes = parser(tokens);

for (const code of codes) {
  console.log(code);
}
```

## 类型定义

```ts
function tokenize(input: string): TOKEN[];
function parse(input: string): CODE[];

function* tokenizer(input: string): Generator<TOKEN>;
function* parser(tokens: Generator<TOKEN>): Generator<CODE>;

type TOKEN = {
  type: "INTRODUCER" | "DATA" | "FINAL" | "TEXT";
  pos: number;
  raw: string;
  code?: string;
  intermediate?: string;
};

type CONTROL_CODE = {
  type: "CSI" | "DCS" | "DEC" | "ESC" | "OSC" | "SGR" | "STRING" | "PRIVATE";
  command: string;
  raw: string;
  params: string[];
  parameterGroups?: string[][];
  pos: number;
};

type TEXT = {
  type: "TEXT";
  raw: string;
  pos: number;
};

type CODE = CONTROL_CODE | TEXT;
```

## 许可证

公务员制度委员会

## 常见问题

### @ansi-tools/parser 是什么？

ANSI出逃代码解析器和活化器\. 从字符串解析终端控制序列\(CSI,SGR,OSC,DCS\)\. 零从属\.

### 如何安装 @ansi-tools/parser？

在项目目录运行 npm install @ansi-tools/parser，或使用 pnpm add / yarn add / bun add。

### @ansi-tools/parser 支持 TypeScript 吗？

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

### @ansi-tools/parser 支持 ESM 还是 CommonJS？

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

### @ansi-tools/parser 可以商用吗？

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

### @ansi-tools/parser 的下载量有多少？

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

### @ansi-tools/parser 还在维护吗？

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