Skip to content

generateMermaidDiff

function generateMermaidDiff(params): MermaidDiffOutput;

Defined in: src/diff.ts:516

Generate Mermaid diff code comparing two AWS Step Functions ASL definitions.

Produces stateDiagram-v2 syntax where added states are green, modified states yellow, and removed states red (via Mermaid classDefs) — rendered natively by GitHub, GitLab, and docs tooling with no image hosting required. Removed states are kept as orphan nodes so they stay visible.

GenerateMermaidDiffParams

MermaidDiffOutput

MermaidDiffOutput with Mermaid code and a per-category state summary