Mermaid is the only graph output format

Platform spec ADR

Mermaid is the only graph output format

Back to Graph visualization ◎ Open feature in platform map

Spec standingStandard

Owner

Piotr Mikstacki pmikstacki@cybernomad.it

Submitter

Piotr Mikstacki pmikstacki@cybernomad.it

Current document

Articles

• Contracts and edge cases LSP beskid.getGraph payload, CLI flags, and graph edge-case policy. article Standard Reviewed Sat May 30
• Design model GraphSpec IR, GraphKind, GraphPayload, and revision fingerprints. article Standard Reviewed Sat May 30

History

0 revisions (git unavailable at build; counts may be empty)

Open full history on GitHub

No commits recorded for this path.

Completeness

OKarea · 4 SpecSection(s) · 0 H2 heading(s)

Section id	Required	Found
what-this-feature-specifies	yes	yes
implementation-anchors	yes	yes

Full tree: run pnpm verify:platform-spec-layout (writes src/generated/platform-spec-layout-report.json).

Related spec docs

• Feature
  Graph visualization

  Parent feature hub

Context

Graph data was exported as bespoke LSP JSON, CLI ASCII trees, and unused edge arrays. Multiple presentation paths diverged from the same domain graphs.

Decision

1. beskid_graph renders all tooling graphs to Mermaid flowcharts using mermaid-builder only.
2. No DOT, GraphViz, or hand-rolled ASCII graph renderers in compiler presentation code.
3. CLI uses graphs-tui to display Mermaid in the terminal; VS Code uses bundled Mermaid.js.

Consequences

• Domain graphs in beskid_analysis (daggy, module tree) stay for compile correctness.
• All consumers share one Mermaid string from Salsa memoization.

Status

Accepted — reference implementation in compiler/crates/beskid_graph/.