Skip to content

Latest commit

 

History

History
100 lines (77 loc) · 3.48 KB

README.md

File metadata and controls

100 lines (77 loc) · 3.48 KB
Raw

Lime & OpenFL Maven Plugin

A plugin to build Lime, OpenFL, and Feathers UI projects with Apache Maven.

Performs the following actions:

  • Either detects your existing Lime project.xml file or generates one from the limeProject parameter configured in your Maven pom.xml file.
  • Installs any Haxelib libraries specified in project.xml or pom.xml.
  • Executes the lime build command for the specified target to build your application.
  • Detects utest test cases and generates a runner.
  • Executes the test runner.

Prerequisites

  • The Haxe compiler must be installed.

Usage

The lime-openfl-maven-plugin includes a couple of goals for building Lime projects.

Build a Lime project

The following sample Maven pom.xml demonstrates how to build an existing project with the plugin. Your existing project.xml file should be in the same directory as your 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>

Run mvn compile in a terminal to build your project.

Generate a Lime project.xml file

If you don't have an existing Lime project.xml file, or if you prefer to manage all build configuration in the Maven pom.xml file, you can add a <limeProject> parameter in the configuration section for the plugin.

<plugin>
  <groupId>com.feathersui.maven.plugins</groupId>
  <artifactId>lime-openfl-maven-plugin</artifactId>
  <version>1.0.0</version>
  <extensions>true</extensions>
  <configuration>
    <limeProject>
      <app>
        <main>com.example.MyApp</main>
        <file>myapp</file>
      </app>
      <window>
        <fps>60</fps>
        <allowHighDpi>true</allowHighDpi>
      </window>
      <haxelibs>
        <haxelib>openfl</haxelib>
        <haxelib>actuate</haxelib>
      </haxelibs>
      <icons>
        <icon>assets/myapp-icon.svg</icon>
      </icons>
    </limeProject>
  </configuration>
</plugin>

Configuring editors with generated project file

In Visual Studio Code, you can specify the lime.projectFile setting to use the generated project file.

{
  "lime.projectFile": "target/project.xml"
}

For code intelligence to work properly, you must build the project at least once with Maven to ensure that this file exists.

Build the plugin from source

Run the following command in this directory to build and install the lime-openfl-maven-plugin in your local repository.

mvn clean install