# @glyphjs/compiler 中文文档

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

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

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

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

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

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

## 中文简介

将 Glyph AST 编译为 IR ,并配有 chema 验证和诊断

## 安装

```sh
npm install @glyphjs/compiler
```

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

## README

# @glyphjs/ 编译器

将 Glyph 标记降为经验证的IR(中间代表),并配有 schema 验证和诊断.

## 安装

```bash
pnpm add @glyphjs/compiler
```

## 使用量

```ts
import { compile } from '@glyphjs/compiler';

const markdown = `
# My Document

\`\`\`ui:graph
nodes:
  - id: a
    label: Start
edges:
  - from: a
    to: b
\`\`\`
`;

const result = compile(markdown);
// result.ir       -- the compiled GlyphIR document
// result.diagnostics -- any warnings or errors
```

## API 密码

-   `compile(markdown, options?)` -- 端到端标记下- IR 汇编
-   `translateNode(node, context)` -- 将单个 AST 节点转换为 IR 块
-   `extractAllInlineReferences(ir)` -- 提取交叉块引用
-   `compileContainerBlocks(blocks)` -- 编译嵌入式容器结构
-   `createDiagnostic(...)` -- 用于构建诊断对象的助手

## 文档

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

## 常见问题

### @glyphjs/compiler 是什么？

将 Glyph AST 编译为 IR ,并配有 chema 验证和诊断

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

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

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

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

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

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

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

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

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

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

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

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

