/frame_transpiler

Frame is a markdown language for creating state machines (automata) in 7 programming languages as well as generating UML documentation.

Primary LanguageRustMIT LicenseMIT

Frame Language Transpiler v0.5.1

Hi! So very glad you are interested in Frame. Frame system design markdown language for software architects and engineers. It is an easy to learn textual language for defining system specifications that can generate both UML documentation as well as code in 7 langauges.

Purpose

This project contains the code for building the Frame Language Transpiler - the Framepiler. The Framepiler is written in Rust and transpiles Frame specification documents into 6 programming languages (more to come) and UML documentation.

New in this release

This release brings a slew of features focused on Rust, Frame's newest language. All of these new capabilites are only implemented in Rust, but will be rolled out to other languages as they gain users and build a community.

  1. Configurable code generation
  2. Rust formatting improvements
  3. Code conforms more closely to rustfmt guidelines.
  4. Added introspection - codegen to discover the current state
  5. Added interface call syntax iface() - call the interface from event handlers.
  6. Rust Transition hook - inject a call to al trait function to log transition data.

Resources

The Frame project is just getting started but there are some resources and communities to help. You can now download VSCode and Atom extensions to work with Frame in these popular free development applications.

An online version of the Framepiler is also available and provides examples and links to other resources. You can learn more about the Frame language at frame-lang.org as well as find general resources about programming with automata at Reddit re on the r/statemachines subreddit.

Communities exist at Gitter and Discord.

Frame Examples

The Framepiler itself has a number of examples baked into it but I also have started a Gitter Frame Examples channel for contributions. The Framepiler supports links to Gists so please create and share!

The Frame Solution Depot is a Github repo and growing body of examples and test specifications. This is useful in conjunction with the VSCode and Atom extensions.

Bugs and Problems

For now please report issues to the Gitter Bug Channel while we get a better system in place. If you have a recommendation please let me know there!

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

Installing

MacOS

  1. Install Rust.
  2. Navigate to the framepiler/framec directory.
  3. Type cargo build. 3.a You will see a bunch of warnings. Apologies but this is pre-alpha code.
  4. Type ./target/debug/framec ../examples/HelloWorld.frm c_sharp. 4.a You should see a base class for a Frame controller generated to stdout.
  5. If you want to generate a release build: 5.a Type cargo build --release 5.b Type ./target/release/framec ../examples/HelloWorld.frm c_sharp
  6. You now have working debug and release Framepilers. Congratulations!
  7. You can try 6 other languages + Plant UML. Replace the c_sharp above with any of these: 7.a javascript 7.b cpp 7.c gdscript 7.d java_8 7.e plantuml (try output at PlantUml site) 7.f python_3 7.g rust (experimental - only partially implemented)

Linux

  1. Install Rust.
  2. Probably the same as MacOS but guessing you can figure it out if you know Linux and Rust. Still - please send me instructions on Gitter Bug Channel and I will add to next release notes. Thanks!

Windows

  1. Install Rust.
  2. Help needed. Please send me instructions on Gitter Bug Channel and I will add to next release notes. Thanks!

Built With

  • Rust - Rust language

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

Author

  • Mark Truluck - Creator of Frame - LinkedIn

License

This project is licensed under the MIT License - see the LICENSE.md file for details

Acknowledgments