Scdlang

^{Statecharts Description Language}

🚧 Still Work in Progress 🏗️

About

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, see State Machine cat.

Philosophy

• 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)

Key Features

• [x] Awesome CLI
• [x] Syntax is inspired from various drawing languages like mermaid, Graphviz, PlantUML, and many more
• [x] Decent error message
• [x] Avoid invalid and ambigous transition via semantics analysis
• Transpile into other formats:
  • [x] [XState](https://xstate.js.org/docs/)
  • []
  • [ ] [Sismic](https://sismic.readthedocs.io/en/latest/)
  • [ ] [SCXML](https://www.w3.org/TR/scxml/)
• Compile into other formats (hopefully, no promise):
  • [ ] WebAssembly (possibly via AssemblyScript CLI 😋)
• Code generation 🤔
  • [ ] Rust macro derive? (I'm still afraid if it will conflict with another crates)

For more info, see the changelog in the release page

Getting Started

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

Installing

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

Linux

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

MacOS

TODO: brew or via shellscript just like installing rustup

Windows

TODO: chocolatey or via msi installer just like installing rustup

Docker

console docker pull scdlang/scrap

via Cargo

TODO: TBD

Contributing

Any contributions are welcome as long as it follow Code 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 👹.}

License

This project is licensed under the UPL-1.0 License - see the LICENSE file for details

Credits

• Statecharts in the Making: A Personal Account by David Harel
• Welcome to the world of Statecharts started by @mogsie in December 2017
• Fundamentals: why state machines? by @thure