@eraserlabs/diagrams-cli (英语)

导言

@eraserlabs/diagrams-cli 是命令行接口 擦除图它使图表 JSON 变成 PNG 或 HTML ,并在没有浏览器的情况下验证文档,使用 @eraserlabs/diagrams。 。 。 .

使用量

npm install -D @eraserlabs/diagrams-cli
npx eraser-diagrams render diagram.json -o diagram.png

需要Node.js 22.23.4+, 24.22.1+, 或 26.12.1+, 以及机器上的铬-家族浏览器(不捆绑).

eraser-diagrams render <input...>     Render diagram JSON to PNG or HTML (needs Chromium)
eraser-diagrams validate <input...>   Validate diagram JSON without a browser
eraser-diagrams registry              Print the tag registry as JSON
eraser-diagrams schema <tag>          Print the JSON Schema of one tag
eraser-diagrams init                  Write eraser-diagrams.config.json in the current directory

<input> 是文件路径或 - 为斯丁。 一些投入共享了一台暖气浏览器. 接受的文件为: { "elements": [...] } 或拆分 { "entities": [...], "connections": [...] }空 JSON 阵列失败 E_ENVELOPEA级 { "definition": { "elements": [...] } } 包装被抬起,上面有条纸条.

提供选项

对于具有透明背景的巴布亚新几内亚:

eraser-diagrams render diagram.json --transparent --scale 2 -o diagram.png

validate 接受 --json, (中文(简体) ), --fail-on-warning, (中文(简体) ), --quiet, (中文(简体) ), --debug。 。 。 .

全球备选方案

铬

优先发言: --chromium-path > 翻译: CHROMIUM_PATH > 翻译: chromiumPath 在配置文件 > 自动检测中。 自动探测探测器 通常的Chrome和Chromium 安装位置 并报告它选择的. eraser-diagrams init 将检测到的路径写入配置文件, 使其保持被绑定 .

配置文件

eraser-diagrams.config.json 是通过从当前目录上走来找到的(在包含 .git)),或给予 --config 或者说 ERASER_DIAGRAMS_CONFIG优先是 旗帜 > 环境 > 配置文件 > 默认。相对于文件本身的目录,文件解析中的相对路径。 未知密钥被拒绝 .

{
  "chromiumPath": "/Applications/Google Chrome.app/Contents/MacOS/Google Chrome",
  "format": "png",
  "outDir": "./diagrams",
  "deviceScaleFactor": 2,
  "pages": 2,
  "icons": {
    "baseUrl": "https://storage.googleapis.com/eraser-public-assets/canvas-icons/",
    "cacheDir": "./.eraser/icons",
    "timeoutMs": 5000,
    "cacheTtlMs": 86400000,
    "onUnknown": "placeholder"
  },
  "fonts": "./fonts.json",
  "library": "./my-library.mjs",
  "overrides": "./my-overrides.mjs",
  "failOnWarning": false
}

除了别的事 --format 而输出路径在浏览器靴子时被固定,因此适用于整批.

输出和退出代码

状态到 stderr,每输入一行,然后是问题:

ok    diagram.json  → out/diagram.png  412 ms  1 warning
  warning W_UNKNOWN_ICON /elements/1/icon (Icon#api) — Unknown icon "nodejs"; using a placeholder glyph.
FAIL  other.json  E_UNKNOWN_TAG
  error   E_UNKNOWN_TAG /elements/0 (Shpe) — Unknown tag "Shpe". Did you mean "Shape"?

--json 在 stdout 上打印一个报表:

{
  "ok": false,
  "degradedFonts": [],
  "results": [
    {
      "input": "diagram.json",
      "out": "out/diagram.png",
      "ok": true,
      "errors": [],
      "warnings": [],
      "ms": 412
    },
    {
      "input": "other.json",
      "ok": false,
      "errors": [
        {
          "code": "E_UNKNOWN_TAG",
          "severity": "error",
          "path": "/elements/0",
          "message": "Unknown tag \"Shpe\".",
          "suggestion": "Shape"
        }
      ],
      "warnings": []
    }
  ]
}

Ctrl-C 退出前关闭铬.