Lime and OpenFL Maven Plugin 1.0

September 07, 2022

Josh Tynjala

Apache Maven is a very popular build tool in the Java ecosystem, and organizations that use Maven may want to integrate an OpenFL or Feathers UI frontend into their existing build process. With that in mind, today, I'm releasing a new Lime & OpenFL Maven Plugin.

This is just one of many projects that I'm releasing as part of the Feathers UI v1.0 release week celebration.

The Lime & OpenFL Maven plugin supports the following actions:

  • It will either detect your existing project.xml file, or it can automatically generate one using a new <limeProject> parameter configured in your Maven pom.xml file.
  • The plugin installs any Haxelib libraries specified in project.xml or pom.xml.
  • It can execute the lime build command for the specified target (such as html5, hl, android, etc.) to compile your project.
  • It can detect utest test cases and generate a runner class for them.
  • It can build and launch the test runner, including detecting whether the tests passed or failed.

Using lime-openfl-maven-plugin v1.0.0

lime-openfl-maven-plugin v1.0.0 may added to your Maven pom.xml file.

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
  <modelVersion>4.0.0</modelVersion>

  <groupId>com.example</groupId>
  <artifactId>example-lime-project</artifactId>
  <version>1.0.0-SNAPSHOT</version>
  <packaging>lime-openfl</packaging>

  <build>
    <plugins>
      <plugin>
        <groupId>com.feathersui.maven.plugins</groupId>
        <artifactId>lime-openfl-maven-plugin</artifactId>
        <version>1.0.0</version>
        <extensions>true</extensions>
      </plugin>
    </plugins>
  </build>
</project>

The plugin will automatically detect your project.xml file. See the documentation if you'd like to generate one automatically using the <limeProject> parameter in pom.xml.

To build your project, run the following command in a terminal:

mvn compile

To compile and launch the tests, run this command:

mvn test

You may find a few sample projects on Github.

Documentation

The API Reference includes descriptions of all APIs available in lime-openfl-maven-plugin.

Questions or comments?

If you need some help, or want to give feedback, feel free to create a thread in either the Feathers UI Community forum or the OpenFL Community forum.