# @effect/printer-ansi 中文文档

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

版本：0\.51\.0
npm 元数据更新时间：2026-09-18T21:17:48.019Z
中文译文更新时间：2026-11-13T08:24:18.944Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40effect/printer-ansi
原文对照：https://npmcn.com/package/%40effect/printer-ansi/?lang=original
项目主页：https://effect.website/
源码仓库：https://github.com/Effect-TS/effect

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

- 包体积（解压后）：272 kB，71 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：1 个
- peer 依赖：effect ^3\.22\.1，@effect/typeclass ^0\.41\.0
- 首次发布：2022-05-27T09:07:33.799Z
- 最新版本发布：2026-07-30T04:29:10.263Z
- 近 30 天下载量：996636（2026-10-13 至 2026-11-11，npm 官方下载统计）
- 已发布版本数：307（近 12 个月 4 个）

## 中文简介

一个易于使用、可扩展的为终端提供文件的打印器

## 安装

```sh
npm install @effect/printer-ansi
```

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

## README

# ANSI 效果- TS 终端漂亮打印机

-   [ANSI 效果- TS 终端漂亮打印机](https://npmcn.com/package/%40effect/printer-ansi/#readme-ansi-terminal-pretty-printer-for-effect-ts)
    -   [安装](https://npmcn.com/package/%40effect/printer-ansi/#readme-installation)
        -   [`@effect/printer-ansi`](https://npmcn.com/package/%40effect/printer-ansi/#readme-effectprinter-ansi)
    -   [概览](https://npmcn.com/package/%40effect/printer-ansi/#readme-overview)
    -   [终端输出和不信任文本](https://npmcn.com/package/%40effect/printer-ansi/#readme-terminal-output-and-untrusted-text)
    -   [鸣谢](https://npmcn.com/package/%40effect/printer-ansi/#readme-acknowledgements)

## 安装

### `@effect/printer-ansi`

```bash
npm install @effect/printer-ansi
```

```bash
pnpm install @effect/printer-ansi
```

```bash
yarn add @effect/printer-ansi
```

## 概览

此软件包定义了由 : `@effect/printer` 软件包,适合在与ANSI兼容的终端上显示,包括颜色、粗体、下划线和斜体等.

欲了解更多信息 `@effect/printer` 在一般情况下,参见主要 [`@effect/printer` 软件包文档](https://npmcn.com/package/%40effect/printer/README.md)。 。 。 .

## 终端输出和不信任文本

文字叶片是逐字记录,包括控制字符。 渲染返回字符串,不会使终端的不可信文本安全。 应用 `AnsiDoc.sanitize` 给攻击者控制的子树,然后将结果写入终端。 保持信任,故意的终端序列 外的分树.

## 鸣谢

此软件包为 [https://github.com/quchen/prettyprinter (中文(简体) )](https://github.com/quchen/prettyprinter)

## 常见问题

### @effect/printer-ansi 是什么？

一个易于使用、可扩展的为终端提供文件的打印器

### 如何安装 @effect/printer-ansi？

在项目目录运行 npm install @effect/printer-ansi，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：effect（^3\.22\.1）、@effect/typeclass（^0\.41\.0）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @effect/printer-ansi 支持 TypeScript 吗？

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

### @effect/printer-ansi 支持 ESM 还是 CommonJS？

同时提供 ES Module 与 CommonJS 入口，import 和 require\(\) 都可以使用，打包工具会自动选择合适的版本。

### @effect/printer-ansi 可以商用吗？

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

### @effect/printer-ansi 的下载量有多少？

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

### @effect/printer-ansi 还在维护吗？

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

