Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/openjfx/javafx-gradle-plugin
Gradle plugin that makes it easy to work with JavaFX 11+
https://github.com/openjfx/javafx-gradle-plugin
gradle-plugin javafx javafx-gradle-plugin javafx-modules
Last synced: 5 days ago
JSON representation
Gradle plugin that makes it easy to work with JavaFX 11+
- Host: GitHub
- URL: https://github.com/openjfx/javafx-gradle-plugin
- Owner: openjfx
- License: bsd-3-clause
- Created: 2018-11-14T14:34:34.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2024-07-11T12:42:27.000Z (5 months ago)
- Last Synced: 2024-11-21T07:36:55.428Z (22 days ago)
- Topics: gradle-plugin, javafx, javafx-gradle-plugin, javafx-modules
- Language: Java
- Homepage: https://openjfx.io/
- Size: 6.57 MB
- Stars: 359
- Watchers: 18
- Forks: 62
- Open Issues: 54
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- aboutfx - JavaFX Gradle Plugin - gradle-plugin?style=social) | `#build`, `#gradle` | Simplifies working with JavaFX 11+ for gradle projects | (Community / Tools)
README
# JavaFX Gradle Plugin
Simplifies working with JavaFX 11+ for gradle projects.
[](https://plugins.gradle.org/plugin/org.openjfx.javafxplugin)
[](https://opensource.org/licenses/BSD-3-Clause)
## Getting started
To use the plugin, apply the following two steps:
### 1. Apply the plugin
##### Using the `plugins` DSL:
**Groovy**
plugins {
id 'org.openjfx.javafxplugin' version '0.1.0'
}
**Kotlin**
plugins {
id("org.openjfx.javafxplugin") version "0.1.0"
}
##### Alternatively, you can use the `buildscript` DSL:
**Groovy**
buildscript {
repositories {
maven {
url "https://plugins.gradle.org/m2/"
}
}
dependencies {
classpath 'org.openjfx:javafx-plugin:0.1.0'
}
}
apply plugin: 'org.openjfx.javafxplugin'
**Kotlin**
buildscript {
repositories {
maven {
setUrl("https://plugins.gradle.org/m2/")
}
}
dependencies {
classpath("org.openjfx:javafx-plugin:0.1.0")
}
}
apply(plugin = "org.openjfx.javafxplugin")
### 2. Specify JavaFX modules
Specify all the JavaFX modules that your project uses:
**Groovy**
javafx {
modules = [ 'javafx.controls', 'javafx.fxml' ]
}
**Kotlin**
javafx {
modules("javafx.controls", "javafx.fxml")
}
### 3. Specify JavaFX version
To override the default JavaFX version, a version string can be declared.
This will make sure that all the modules belong to this specific version:
**Groovy**
javafx {
version = '17'
modules = [ 'javafx.controls', 'javafx.fxml' ]
}
**Kotlin**
javafx {
version = "17"
modules("javafx.controls", "javafx.fxml")
}
### 4. Cross-platform projects and libraries
The plugin will include JavaFX dependencies for the current platform.
However, a different target platform can also be specified.
Supported targets are:
* linux
* linux-aarch64
* win or windows
* osx or mac or macos
* osx-aarch64 or mac-aarch64 or macos-aarch64 (support added in JavaFX 11.0.12 LTS and JavaFX 17 GA)
**Groovy**
javafx {
modules = [ 'javafx.controls', 'javafx.fxml' ]
platform = 'mac'
}
**Kotlin**
javafx {
modules("javafx.controls", "javafx.fxml")
platform = 'mac'
}
### 5. Dependency scope
JavaFX application require native binaries for each platform to run.
By default, the plugin will include these binaries for the target platform.
Native dependencies can be avoided by declaring the dependency configuration as **compileOnly**.
**Groovy**
javafx {
modules = [ 'javafx.controls', 'javafx.fxml' ]
configuration = 'compileOnly'
}
**Kotlin**
javafx {
modules("javafx.controls", "javafx.fxml")
configuration = "compileOnly"
}
Multiple configurations can also be targeted by using `configurations`.
For example, JavaFX dependencies can be added to both `implementation` and `testImplementation`.
**Groovy**
javafx {
modules = [ 'javafx.controls', 'javafx.fxml' ]
configurations = [ 'implementation', 'testImplementation' ]
}
**Kotlin**
javafx {
modules("javafx.controls", "javafx.fxml")
configurations("implementation", "testImplementation")
}
### 5. Using a local JavaFX SDK
By default, JavaFX modules are retrieved from Maven Central.
However, a local JavaFX SDK can be used instead, for instance in the case of
a custom build of OpenJFX.
Setting a valid path to the local JavaFX SDK will take precedence:
**Groovy**
javafx {
sdk = '/path/to/javafx-sdk'
modules = [ 'javafx.controls', 'javafx.fxml' ]
}
**Kotlin**
javafx {
sdk = "/path/to/javafx-sdk"
modules("javafx.controls", "javafx.fxml")
}
## Issues and Contributions
Issues can be reported to the [Issue tracker](https://github.com/openjfx/javafx-gradle-plugin/issues/).
Contributions can be submitted via [Pull requests](https://github.com/openjfx/javafx-gradle-plugin/pulls/),
providing you have signed the [Gluon Individual Contributor License Agreement (CLA)](https://cla.gluonhq.com/).
## Migrating from 0.0.14 to 0.1.0
Version `0.1.0` introduced several changes and improvements, including lazy dependency declaration,
variant-aware dependency management, and support for Gradle's built-in JPMS functionality. In the
previous version, the classpath/module path was rewritten. This is no longer the case. As a result,
your past builds might be affected when you upgrade the plugin. In the next section, there are a few
troubleshooting steps that might help with the transition if you encounter issues when upgrading.
These examples are provided on a best-effort basis, but feel free to open an issue if you believe
there's a migration scenario not covered here that should be included.
### Troubleshooting
#### Gradle version
The plugin now requires `Gradle 6.1` or higher. Consider updating your Gradle settings, wrapper,
and build to a more recent version of Gradle. Additionally, updating your plugins and dependencies
can help minimize issues with the plugin.
#### Mixed JavaFX jars
If you encounter mixed classified JavaFX jars or see errors like `Error initializing QuantumRenderer: no
suitable pipeline found` during executing task like `build`, `test`, `assemble`, etc., it is likely one
or more of your dependencies have published metadata that includes JavaFX dependencies with classifiers.
The ideal solution is to reach out to library authors to update their JavaFX plugin and publish a patch
with fixed metadata. A fallback solution to this is to `exclude group: 'org.openjfx'` on the dependencies
causing the issue.
```groovy
implementation('com.example.fx:foo:1.0.0') {
exclude group: 'org.openjfx', module: '*'
}
```
#### Variants
If you encounter errors such as `Cannot choose between the following variants of org.openjfx...` it is possible
that your build or another plugin is interacting with the classpath/module path in a way that "breaks" functionality
provided by this plugin. In such cases, you may need to re-declare the variants yourself as described in [Gradle docs
on attribute matching/variants](https://docs.gradle.org/current/userguide/variant_attributes.html) or reach out to
the plugin author in an attempt to remediate the situation.
```groovy
// Approach 1: Explicit Variant
// The following snippet will let you add attributes for linux and x86_64 to a configuration
configurations.someConfiguration {
attributes {
attribute(Usage.USAGE_ATTRIBUTE, objects.named(Usage, Usage.JAVA_RUNTIME))
attribute(OperatingSystemFamily.OPERATING_SYSTEM_ATTRIBUTE, objects.named(OperatingSystemFamily, "linux"))
attribute(MachineArchitecture.ARCHITECTURE_ATTRIBUTE, objects.named(MachineArchitecture, "x86-64"))
}
}
// Approach 2: Copy existing configuration into another configuration
configurations.someConfiguration {
def runtimeAttributes = configurations.runtimeClasspath.attributes
runtimeAttributes.keySet().each { key ->
attributes.attribute(key, runtimeAttributes.getAttribute(key))
}
}
```
#### Extra plugins
In versions `0.0.14` and below, there was a transitive dependency on `org.javamodularity.moduleplugin`.
If your **modular** project stops working after updating to `0.1.0` or above, it is likely that you need to
explicitly add the [org.javamodularity.moduleplugin](https://plugins.gradle.org/plugin/org.javamodularity.moduleplugin)
back to your build and set `java.modularity.inferModulePath.set(false)` to keep things working as they were.
This plugin helped with transitive dependencies on legacy jars that haven't been modularized yet, but now you
have to option choose which approach to take. This change should not be required for non-modular projects.
**Before**
````groovy
plugins {
id 'org.openjfx.javafxplugin' version '0.0.14'
}
````
**After**
````groovy
plugins {
id 'org.openjfx.javafxplugin' version '0.1.0'
id 'org.javamodularity.moduleplugin' version '1.8.12'
}
java {
modularity.inferModulePath.set(false)
}
````
**Note**: There are other recommended alternatives over `org.javamodularity.moduleplugin` for modular projects such as
[extra-java-module-info](https://github.com/gradlex-org/extra-java-module-info) that would allow you to keep
`inferModulePath` set to **true** by declaring missing module information from legacy jars. More details on how to
accomplish can be found on the plugin's source code repository.
#### Dependency hierarchy
Version `0.1.0` now relies on JavaFX modules defining their transitive modules rather than flattening them.
This change allows you to publish metadata declaring only the JavaFX modules you need, meaning it does not
include transitive JavaFX modules as part of your published metadata.
Some plugins rely on having all modules (transitive included) declared as "top-level" modules such as the
`badass-runtime-plugin` on **non-modular** projects. In this particular case, it is necessary to declare
all modules to restore previous functionality from `0.0.14` and below.
**Before**
````groovy
javafx {
modules = ['javafx.controls']
}
````
**After**
````groovy
javafx {
modules = ['javafx.base', 'javafx.graphics', 'javafx.controls']
}
````