TLX.Emitter.PlantUML (TLX v0.5.2)

Copy Markdown

Emits a PlantUML state diagram from a compiled TLX.Spec module.

Renders with any PlantUML-compatible tool (plantuml.jar, Kroki, IntelliJ, Confluence, GitLab, etc.).

Usage

TLX.Emitter.PlantUML.emit(MySpec)
TLX.Emitter.PlantUML.emit(MySpec, state_var: :status)

Output:

@startuml
[*] --> red
red --> green : to_green
green --> yellow : to_yellow
yellow --> red : to_red
@enduml

Summary

Functions

Generate a PlantUML state diagram string from a compiled spec module.

Functions

emit(module, opts \\ [])

Generate a PlantUML state diagram string from a compiled spec module.

Options:

  • :state_var — name of the state variable (auto-detected if omitted)