# @glyphjs/ir 中文文档

规范地址：https://npmcn.com/package/%40glyphjs/ir/

版本：0\.10\.0
npm 元数据更新时间：2026-04-19T07:34:38.153Z
中文译文更新时间：2026-11-16T16:56:24.198Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：117 kB，9 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：1 个
- 首次发布：2026-02-04T22:04:50.458Z
- 最新版本发布：2026-04-19T07:34:38.010Z
- 近 30 天下载量：2928（2026-10-17 至 2026-11-15，npm 官方下载统计）
- 已发布版本数：12（近 12 个月 12 个）

## 中文简介

IR 公用事业:验证、疏导、补丁、迁移

## 安装

```sh
npm install @glyphjs/ir
```

也可以使用：`pnpm add @glyphjs/ir`、`yarn add @glyphjs/ir`、`bun add @glyphjs/ir`

## README

# @glyphjs/ir (英语)

Glyph JS的IR(中间代表)公用事业:验证、疏通、补丁和迁移.

## 安装

```bash
pnpm add @glyphjs/ir
```

## 使用量

```ts
import { validateIR, diffIR, applyPatch, createEmptyIR } from '@glyphjs/ir';

// Create a blank document
const doc = createEmptyIR();

// Validate an IR document
const diagnostics = validateIR(doc);

// Diff two IR documents
const patch = diffIR(oldDoc, newDoc);

// Apply a patch
const updated = applyPatch(oldDoc, patch);
```

## API 密码

-   `validateIR(ir)` -- 验证IR文档并返回诊断
-   `diffIR(a, b)` -- 计算转换的补丁 `a` 输入 `b`
-   `applyPatch(ir, patch)` -- 对IR 文档应用补丁
-   `composePatch(a, b)` -- 将两个补丁组成一个
-   `registerMigration(migration)` 编号 : `migrateIR(ir)` -- 版本迁移支持
-   `generateBlockId()` 编号 : `generateDocumentId()` -- 确定性身份证生成
-   `createEmptyIR()` -- 空白IR文档的工厂

## 文档

[https://github.com/VledicFranco/glyphjs (中文(简体) )](https://github.com/VledicFranco/glyphjs)

## 常见问题

### @glyphjs/ir 是什么？

IR 公用事业:验证、疏导、补丁、迁移

### 如何安装 @glyphjs/ir？

在项目目录运行 npm install @glyphjs/ir，或使用 pnpm add / yarn add / bun add。

### @glyphjs/ir 支持 TypeScript 吗？

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

### @glyphjs/ir 支持 ESM 还是 CommonJS？

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

### @glyphjs/ir 可以商用吗？

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

### @glyphjs/ir 的下载量有多少？

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

### @glyphjs/ir 还在维护吗？

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

