Contributing to Lexi

This project is open-source and contributions are more than welcome! Feel free to open a pull request! You can also reach out to me at matt@mattmoore.io if you have any questions or want to know how to get started.

Check out the architecture docs to learn the internals of the compiler.

Developer Setup

Note:

While Lexi is itself written in Scala (v3), the JDK you use must be greater than 8.

While you can compile with JDK 8 and above, I build against GraalVM Community Edition 11. The reason for this is to easily generate native images of the compiler, so compiler end users do not have to worry about JDK versions.

Requirements

You’ll need sbt 1.4.5.

Tests

To run the tests: sbt test

Building

To build a standalone compiler executable: sbt nativeImage. This will compile a native executable stored in target/native-image/

You can compile a Kotlin file into a Java class file: lexi Main.kt. The same concept applies for Scala: lexi Main.scala