Setup

API Dependency

To use the LiquidJava annotations, add the liquidjava-api dependency to your Java project:

Maven

<dependency>
    <groupId>io.github.liquid-java</groupId>
    <artifactId>liquidjava-api</artifactId>
    <version>0.0.4</version>
</dependency>

Gradle

repositories {
    mavenCentral()
}
dependencies {
    implementation 'io.github.liquid-java:liquidjava-api:0.0.4'
}

VS Code Extension

Requirements

• Visual Studio Code with the Language Support for Java by Red Hat extension
• A Java project with the liquidjava-api dependency

Steps

• Install the LiquidJava VS Code extension
• Open a Java project with the liquidjava-api dependency

The extension then provides real-time diagnostics, syntax highlighting for refinements, and more.

You can find more about the extension here.

Command-Line Interface

If you prefer to run the verifier directly from the terminal, you can use the command-line interface.

Requirements

• Java 20+
• Maven 3.6+
• A Java project with the liquidjava-api dependency

Steps

git clone https://github.com/liquid-java/liquidjava
cd liquidjava
mvn clean install
./liquidjava /path/to/your/project

This runs the verifier on your project and prints any errors to the console.

You can find more about the command-line interface here.