mix ash.signals (ash v3.36.1)

Copy Markdown View Source

Prints the signals of your application: the actions that emit each signal, and the listeners that react to it.

$ mix ash.signals
$ mix ash.signals MyApp.Shop.Signals
$ mix ash.signals --format mermaid --output signals.mmd

Pass signal modules to only print their signals.

Listeners are found wherever they are defined. Emitters are found in the resources of the domains in your :ash_domains config, and in resources that listen to signals.

Command line options

  • --format - Can be set to one of either:
    • text - A list of each signal's emitters and listeners. This is the default.
    • mermaid - A Mermaid flowchart.
    • md - A Mermaid flowchart in a markdown code block.
    • svg, pdf or png - An image of the Mermaid flowchart. Requires --output, and the Mermaid CLI. See https://github.com/mermaid-js/mermaid-cli
  • --output - Writes to the given file, instead of printing.

Summary

Functions

Prints the signals of your application, and what emits and listens to them

Functions

run(argv)

Prints the signals of your application, and what emits and listens to them