Skip to content

Move pele from 1.8.0 to 1.13.0 #805

Open

Description

@HMarzban

What

Move pele, the Mermaid renderer, from 1.8.0 to 1.13.0 (2026-10-31, the latest). It is pinned exactly in three places: the root package.json override, extensions/extension-mermaid and apps/hocuspocus.server. Maintainer request, 2026-11-21.

Why it was held

On 2026-10-24 the pin stayed at 1.8.0, because 1.9.0 changed how labels draw, and nobody had checked the extension and the server's diagram check against it.

What changes for us (from the 1.9.0 to 1.13.0 release notes)

  • Labels: more HTML tags draw (<sub>, <sup>, <code>, <kbd> and others). A tag that is not HTML, such as List<T> or <foreignObject>, now shows as plain text. Raw HTML such as <img> and <script> is still stripped.
  • Error lines (1.10.0): lines and columns count the source as written, including front matter, directives and comments. The extension added its own offset for those lines, so with 1.13.0 an error after front matter would point 3 lines too low. The server's MCP diagram check dropped the line number for the same old reason.
  • Colours (1.12.0, 1.13.0): labels on a custom fill pick --pele-fg-on-light or --pele-fg-on-dark, whichever reads better. --pele-series-1 to --pele-series-8 still work.

Plan

  1. Bump the three pins and bun.lock.
  2. Remove the extension's line offset (createRenderer.ts). Keep the line number in the server's diagram check (checkDiagrams.ts).
  3. Update the two Cypress tests that pin the old behaviour, plus the docs that name 1.8.0.

Checks

  • @docs.plus/extension-mermaid: unit tests, typecheck, build, and the full Cypress suite.
  • Server: the MCP unit tests and typecheck.
  • pele has no install scripts, and no child_process, net, vm, eval or fetch use, in 1.8.0 or 1.13.0.
  • Render time, 1.8.0 against 1.13.0, same machine, so that the phone limits (10000 characters, 250 edges) still hold.

Activity

  1. added this to the v2.3.7 milestone on Nov 21, 2026
  2. HMarzban commented on Nov 21, 2026

    @HMarzban
    CollaboratorAuthor

    Measured, 2026-11-21: 1.8.0 against 1.13.0

    Local tree, not committed yet. Bun 1.4.5, Apple M5 Max.

    Tests

    Check 1.13.0 with no code change After the fix
    extension-mermaid unit tests 14 of 14 14 of 14
    extension-mermaid Cypress, 12 specs 121 of 123 123 of 123
    Typecheck and build pass pass
    Server MCP unit tests 32 of 32 32 of 32

    The 2 Cypress failures were the two expected ones:

    • edge-sources.cy.ts: an error after 3 lines of front matter said line 10, not line 7. Pele now counts the front matter, and the extension added it a second time. The fix removes the extension's offset code (createRenderer.ts: 53 lines removed, 4 added).
    • complex-flowchart.cy.ts: the label <foreignObject><div>inside</div></foreignObject> now reads <foreignObject>inside</foreignObject> as text. <div> is still stripped. The test's safety check passes: no img, script, foreignObject, iframe or a element exists, and no on* attribute.

    Server: the MCP diagram check now keeps Pele's line. For the same broken source, it reports line 7 after front matter, line 5 after a comment, and line 4 with nothing above. Those are the right lines.

    Render time

    pele.render() in Bun, no DOM. One warm-up, then 50 draws, 3 rounds for each version, run in turn. Values are the median p50 of the 3 rounds, with the range in brackets.

    Source 1.8.0 1.13.0 Change
    Flowchart, 250 edges 0.99 ms (0.97 to 1.04) 1.05 ms (1.04 to 1.09) 6 % more time
    Sequence, 9,917 characters 0.43 ms (0.43 to 0.44) 0.46 ms (0.46 to 0.46) 6 % more time

    Both are under 0.1 ms slower. This is not the phone run behind the default limits, but it gives no reason to move them.

    Package checks

    Neither version has an install script, or any child_process, net, vm, eval or fetch use in dist. Facts in docs/pele.md checked on 1.13.0: 33 diagram types, MIT, no runtime dependencies, Mermaid 12.1.0 syntax.

  3. HMarzban commented on Nov 21, 2026

    @HMarzban
    CollaboratorAuthor

    Committed as 7d405e20f (chore(deps): move pele from 1.8.0 to 1.13.0), 14 files. Not pushed yet. npm users get the @docs.plus/extension-mermaid change in the next extension family release.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions