@block-ml/core

中文文档
0.4.3发布于 2026/10/30MITTypeScriptES Module零依赖构建来源已验证近 30 天下载 2176

BlockML parser, validator, serializer and geometry helpers

原始使用文档
文档目录4 节
  1. 安装
  2. 用法
  3. 相关包
  4. License

@block-ml/core

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

BlockML 是 diagram-as-code 语言:作者只写语义,默认布局与走线由平台负责; 编辑器拖动后的坐标回写到同一个 .blockml 文件。

安装

npm i @block-ml/core

用法

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 等

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

相关包

语言规范与示例:Roiocam/blockml

License

MIT

版本与发布记录

@block-ml/core 共发布 11 个版本,首次发布于 2026/10/29;过去 12 个月发布了 11 个版本。最新版本附带 npm provenance 构建来源证明,可追溯到公开的 CI 构建记录。

版本发布日期距今
0.4.3latest2026/10/309 天前
0.4.22026/10/309 天前
0.4.12026/10/309 天前
0.4.02026/10/309 天前
0.3.12026/10/309 天前
0.3.02026/10/309 天前

关于 @block-ml/core 的常见问题

@block-ml/core 是什么?

BlockML parser, validator, serializer and geometry helpers

如何安装 @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 和提交记录判断。