Repository files navigation

^{StatechartsDescriptionLanguage}

🚧Status:🗶perimental4ever^🤞

Scdlang (pronounced/ˈesˌsi:ˈdi:ˈlæŋ/) is a description language for describing Statecharts that later can be used to generate code or just transpile it into another format. This project is more focus on how to describe Statecharts universally that can be used in another language/platform rather than drawing a Statecharts diagram. For drawing, seeState Machine Cat.

• Readable just like you read then visualize a state diagram
• Writeable just like you write code which is concise, clear, and can be refactored
• Transferable to any implementation (e.g platform, programming language, runtime, etc)

• CLI utils (seeusage)
• Syntax is inspired from various drawing languages likemermaid,Graphviz,PlantUML, and many more
• Decent error message
• Avoid invalid and ambigous transition via semantics analysis
• Rule definition for static analysis and formal verification
• Transpile into other formats:
  • XState
  • State Machine Cat
  • Kingly
  • CSV
  • Sismic
  • SCXML
  • WaveDrom
• Compile into other formats (need this to make it being an embeddable DSL):
  • WebAssembly (usingparity-wasm)
  • LLVM IR 🤔 (open the possibility to be compiled as wasm, dynlib, and static lib)
• Code generation 🤔 (not sure if I need this but why not?)
  • Julia via@generated implemented asparametricmultiple-dispatchfunctors
  • Rust via#[proc_macro_attribute] implemented astypestate programming? (I'm still afraid if it will conflict with another crates)
  • Elixir viause macro which desugar intogen_statem 💪
  • Flutter viabuilder_factories (waiting for theFFI to be stable)

For more info, see the changelog in therelease page

Currently, this project only have the binary CLI for each OS. Please go to therelease page to download then extract it. It also shipped with auto-completions script for your preffered shell.

Just download the binary in therelease page or follow this instructions 👇

TODO: (AUR, DEB, RPM) or via shellscript just like installing rustup

TODO: brew or via shellscript just like installing rustup

TODO: chocolatey or via msi installer just like installing rustup

smcat,dot, andgraph-easy are pre-installed in this docker image

docker pull scdlang/scrap

cargo install s-crap

Any contributions are welcome as long as it followCode of Conduct.
^{If anyone have questions or something to discuss, feel free to DM or mention me in any platform that have my profile picture 👹.}

This project is licensed under the Universal Permissive License 1.0 - see theLICENSE file for more detail.

• Statecharts in the Making: A Personal Account by David Harel
• Welcome to the world of Statecharts