About this project
RIDDL (Reactive Interface to Domain Definition Language) is a specification language plus tooling for capturing requirements and specifying designs for systems suited to Domain-Driven Design and distributed, reactive, cloud-native architectures. It lets subject matter experts, business analysts and system architects work at a higher abstraction level than direct coding, aiming to reduce the burden of maintaining infrastructural code as system abstractions evolve.
The repository centers on the riddlc compiler, written in Scala and published to Maven Central, with Scala.js support. Documentation is hosted separately and includes an introduction, conceptual material, guides for different audiences, and a language reference. Tutorials and a language reference are linked from the README.
Usage: run `riddlc help` for current options; `riddlc info` and `riddlc version` print build information and the version number. Building locally uses sbt: clone the repository, add the staged bin directory to PATH, run `sbt compile`, then `sbt stage` in the riddlc sub-project to produce the executable under riddlc/target/universal/stage/bin. Homebrew installation is listed as TBD.
The repository also ships IntelliJ IDEA support in the `language` directory: a file-type settings zip for `.riddl` files and a color scheme jar that distinguishes keywords, readability words, definitions, punctuation and types. Both are imported through IntelliJ settings dialogs.
Project health badges cover CI builds for code and documentation, Coveralls coverage, Maven Central, Scala.js, Scala Steward, Apache 2 license, and SonarCloud metrics (code smells, bugs, vulnerabilities, security, maintainability, reliability, lines of code, duplication, technical debt). Contributions are welcomed via pull requests, with a CONTRIBUTING.md workflow and a required Contributor License Agreement signed through CLA Assistant. The project is owned by Ossum Inc.
Comments
0 Rating appears after 10 ratings
Sign in to join the discussion.