https://github.com/feathersui/lime-openfl-maven-plugin
A plugin to build Lime, OpenFL, and Feathers UI projects with Apache Maven
https://github.com/feathersui/lime-openfl-maven-plugin
feathers-ui haxe maven maven-plugin openfl
Last synced: about 2 months ago
JSON representation
A plugin to build Lime, OpenFL, and Feathers UI projects with Apache Maven
- Host: GitHub
- URL: https://github.com/feathersui/lime-openfl-maven-plugin
- Owner: feathersui
- License: apache-2.0
- Created: 2022-01-30T07:15:43.000Z (about 3 years ago)
- Default Branch: master
- Last Pushed: 2023-01-03T00:01:12.000Z (over 2 years ago)
- Last Synced: 2025-01-22T17:28:51.714Z (3 months ago)
- Topics: feathers-ui, haxe, maven, maven-plugin, openfl
- Language: Java
- Homepage: https://feathersui.github.io/lime-openfl-maven-plugin/
- Size: 433 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# Lime & OpenFL Maven Plugin
A plugin to build [Lime](https://lime.software/), [OpenFL](https://openfl.org/), and [Feathers UI](https://feathersui.com/) projects with [Apache Maven](https://maven.apache.org/).
Performs the following actions:
- Either detects your existing [Lime _project.xml_ file](https://lime.software/docs/project-files/xml-format/) or generates one from the [`limeProject` parameter](https://feathersui.github.io/lime-openfl-maven-plugin/apidocs/com/feathersui/maven/plugin/lime_openfl/LimeProject.html) 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](https://lib.haxe.org/p/utest/) test cases and generates a runner.
- Executes the test runner.
## Prerequisites
- The [Haxe](https://haxe.org/download/) 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
4.0.0
com.example
example-lime-project
1.0.0-SNAPSHOT
lime-openfl
com.feathersui.maven.plugins
lime-openfl-maven-plugin
1.0.0
true
```
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 [`` parameter](https://feathersui.github.io/lime-openfl-maven-plugin/apidocs/com/feathersui/maven/plugin/lime_openfl/LimeProject.html) in the `configuration` section for the plugin.
```xml
com.feathersui.maven.plugins
lime-openfl-maven-plugin
1.0.0
true
com.example.MyApp
myapp
60
true
openfl
actuate
assets/myapp-icon.svg
```
#### Configuring editors with generated project file
In Visual Studio Code, you can specify the `lime.projectFile` setting to use the generated project file.
```json
{
"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.
```sh
mvn clean install
```