Skip to content

README.md

Latest commit

 

History

History
91 lines (74 loc) · 2.58 KB

README.md

File metadata and controls

91 lines (74 loc) · 2.58 KB

Elide Maven Plugin

This plugin can be consumed in a Maven project to use Elide for compiling Java and Kotlin sources.

Warning

This plugin is currently under development.

Features

  • Swap out javac ... for elide javac -- ...
  • Supports explicit path to elide
  • Resolve elide via the PATH
  • Swap out kotlinc ... for elide kotlinc -- ...
  • Usability of Elide as a Maven toolchain

Usage

Elide Plugin

The easiest way to start using Elide in your project is the elide-maven-plugin. Enable it and set extensions to true and all of your Java and Kotlin sources will be compiled with Elide javac and kotlinc.

pom.xml

<build>
    <plugins>
        <plugin>
            <groupId>dev.elide</groupId>
            <artifactId>elide-maven-plugin</artifactId>
            <version>1.0.0</version>
            <extensions>true</extensions>
        </plugin>
    </plugins>
</build>

Tip

See the Mixed sources sample project for a usage example.

Kotlin drop-in replacement

If you already have a project that uses the kotlin-maven-plugin, you can use the elide-kotlin-maven-plugin as a drop-in replacement. It supports all configuration you would expect from the Kotlin Maven plugin.

pom.xml

<build>
    <plugins>
        <plugin>
            <groupId>dev.elide</groupId>
            <artifactId>elide-kotlin-maven-plugin</artifactId>
            <version>1.0.0</version>
            <extensions>true</extensions>
        </plugin>
    </plugins>
</build>

Tip

See the Kotlin sample project for a usage example.

Java Compiler

If you already have a complex project and just want the Elide Java compiler, you can set the maven-compiler-plugin's compilerId to elide to use Elide just as a Java compiler without using any plugins.

pom.xml

<build>
    <plugins>
        <plugin>
            <artifactId>maven-compiler-plugin</artifactId>
            <version>3.15.0</version>
            <dependencies>
                <dependency>
                    <groupId>dev.elide</groupId>
                    <artifactId>elide-java-compiler</artifactId>
                    <version>1.0.0</version>
                </dependency>
            </dependencies>
            <configuration>
                <compilerId>elide</compilerId>
            </configuration>
        </plugin>
    </plugins>
</build>

Tip

See the Java sample project for a usage example. Elide also provides a Gradle plugin.