mix ash_dispatch.gen.diagrams (AshDispatch v0.5.1)

View Source

Generates Mermaid diagrams showing AshDispatch events, channels, and counters.

Extends Ash's standard resource diagrams with dispatch-specific information:

  • Events triggered by actions
  • Channels with transports and audiences
  • Counter broadcasts
  • Recipient flows

Usage

# Generate diagrams for all domains
mix ash_dispatch.gen.diagrams

# Generate for specific domain
mix ash_dispatch.gen.diagrams --only MyApp.Accounts

# Generate as SVG (requires mermaid-cli)
mix ash_dispatch.gen.diagrams --format svg

Output Formats

  • plain (default) - Mermaid syntax in .mmd files
  • md - Markdown code blocks
  • svg - SVG images (requires mermaid-cli)
  • png - PNG images (requires mermaid-cli)

Generated Files

Creates one diagram per domain in ./dispatch_diagrams/:

  • my_app_accounts.mmd - Mermaid source
  • my_app_accounts.svg - (if --format svg)

Summary

Functions

Callback implementation for Mix.Task.run/1.

Functions

run(args)

Callback implementation for Mix.Task.run/1.