# @block-ml/core 中文文档

规范地址：https://npmcn.com/package/%40block-ml/core/

版本：0\.4\.3
npm 元数据更新时间：2026-10-30T07:50:30.013Z
中文译文更新时间：2026-11-08T07:08:14.726Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40block-ml/core
原文对照：https://npmcn.com/package/%40block-ml/core/?lang=original
项目主页：https://github.com/Roiocam/blockml#readme
源码仓库：https://github.com/Roiocam/blockml

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

- 包体积（解压后）：201 kB，15 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：0 个
- 首次发布：2026-10-29T11:27:36.153Z
- 最新版本发布：2026-10-30T07:50:29.681Z
- 近 30 天下载量：2176（2026-10-09 至 2026-11-07，npm 官方下载统计）
- 已发布版本数：11（近 12 个月 11 个）

## 中文简介

BlockML 解析器、验证器、序列器和几何辅助器

## 安装

```sh
npm install @block-ml/core
```

也可以使用：`pnpm add @block-ml/core`、`yarn add @block-ml/core`、`bun add @block-ml/core`

## README

# @block-ml/core

BlockML 的解析、校验、序列化、布局与可见性计算。纯 TypeScript，无运行时依赖。

[BlockML](https://github.com/Roiocam/blockml) 是 diagram-as-code 语言：作者只写语义，默认布局与走线由平台负责； 编辑器拖动后的坐标回写到同一个 `.blockml` 文件。

## 安装

```bash
npm i @block-ml/core
```

## 用法

```ts
import { parse, serialize, hasErrors } from "@block-ml/core";

const { document, diagnostics } = parse(source);
if (hasErrors(diagnostics)) {
  throw new Error(
    diagnostics
      .filter((d) => d.severity === "error")
      .map((d) => `${d.line}:${d.column} ${d.message}`)
      .join("\n"),
  );
}

const text = serialize(document); // 规范化：缩进、属性顺序、数字格式
```

主要导出：

| 能力 | API |
| --- | --- |
| 解析 / 词法 | `parse`、`tokenize` |
| 回写 | `serialize` |
| 布局 | `defaultLayout`（分层默认 + 固定坐标覆盖）、`layoutDocument`、`applyLayout`、`LAYOUT_ALGORITHMS` |
| 几何 / 走线 | `planCurveSides`、`planPorts` / `planSidePorts`（共享侧端口）、`edgeGeometry`、`orthogonalRoute`、`placeLabelOnPath`、`routeCrosses`、`boxOf` |
| 可见性 | `resolveVisibility`、`visibleNodes`、`visibleEdges`、`visibleGroups` |
| 类型 | `BlockDocument`、`NodeDecl`、`EdgeDecl`、`GroupDecl`、`Diagnostic` 等 |

两种走线共用同一套端口、法线出线、标签贴合与节点避让规则。

## 相关包

-   [`@block-ml/viewer`](https://www.npmjs.com/package/@block-ml/viewer)：交互画布，拖拽后回写同一份源码
-   [`@block-ml/cli`](https://www.npmjs.com/package/@block-ml/cli)：`blockml validate / render / fmt / layout / inspect`

语言规范与示例：[Roiocam/blockml](https://github.com/Roiocam/blockml)

## License

MIT

## 常见问题

### @block-ml/core 是什么？

BlockML 解析器、验证器、序列器和几何辅助器

### 如何安装 @block-ml/core？

在项目目录运行 npm install @block-ml/core，或使用 pnpm add / yarn add / bun add。

### @block-ml/core 支持 TypeScript 吗？

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

### @block-ml/core 支持 ESM 还是 CommonJS？

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

### @block-ml/core 可以商用吗？

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

### @block-ml/core 的下载量有多少？

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

### @block-ml/core 还在维护吗？

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