Gradle plugin for repackaging the build output and dependencies.
Dependencies are remapped before they are imported into the IDE. This allows you to use multiple versions of the same library in your project.
To use this plugin, you need to add the gradle plugin portal to your plugin repositories:
pluginManagement {
repositories {
gradlePluginPortal()
}
}alternatively, you can add my maven repository instead:
pluginManagement {
repositories {
maven {
name = "lenni0451 releases"
url = "https://maven.lenni0451.net/releases"
}
}
}After adding the repository, you can add the plugin to your project:
plugins {
id "net.lenni0451.repackager" version "x.x.x"
}Configure build output repackaging:
repackager {
jarFile = jar.archiveFile //The input jar file
outputFile = file("$buildDir/libs/${project.name}-repackaged.jar") //The output jar file (optional, default: override input)
relocations = [ //All relocated packages (optional, default: none)
"net": "repackaged.net", //Relocate all classes in packages starting with "net" to "repackaged.net"
"org.": "repackaged.org." //Relocate all classes in the "org" package to the "repackaged.org" package
]
removals = [ //All removed files/folders (optional, default: none)
//The files are removed from the jar after repackaging. Make sure to use the correct path.
//e.g. "org/" would need to be "repackaged/org/" according to the relocations above.
"META-INF/services/", //Remove all files in the "META-INF/services" folder
"example/unused/library/" //Remove all files in the "example/unused/library" folder
]
remapStrings = true //Search for matches in strings and remap them (optional, default: false)
remapServices = true //Remap service providers (optional, default: true)
remapManifest = true //Remap the manifest file (optional, default: true)
removeEmptyDirs = true //Remove empty directories after repackaging (optional, default: false)
}Configure dependency repackaging:
dependencyRepackager {
configuration = configurations.transformed //The configuration to search for dependencies
relocations = [ //All relocated packages (optional, default: none)
"net": "repackaged.net", //Relocate all classes in packages starting with "net" to "repackaged.net"
"org.": "repackaged.org." //Relocate all classes in the "org" package to the "repackaged.org" package
]
removals = [ //All removed files/folders (optional, default: none)
//The files are removed from the jar after repackaging. Make sure to use the correct path.
//e.g. "org/" would need to be "repackaged/org/" according to the relocations above.
"META-INF/services/", //Remove all files in the "META-INF/services" folder
"example/unused/library/" //Remove all files in the "example/unused/library" folder
]
remapStrings = true //Search for matches in strings and remap them (optional, default: false)
remapServices = true //Remap service providers (optional, default: true)
remapManifest = true //Remap the manifest file (optional, default: true)
removeEmptyDirs = true //Remove empty directories after repackaging (optional, default: false)
}If you want more control over the repackaging task, you can register the task yourself:
tasks.register("repackage", net.lenni0451.repackager.tasks.RepackageTask) {
jarFile = jar.archiveFile
outputFile = file("$buildDir/libs/${project.name}-repackaged.jar")
relocations = [
"net": "repackaged.net",
"org.": "repackaged.org."
]
removals = [
"META-INF/services/",
"example/unused/library/"
]
remapStrings = true
remapServices = true
remapManifest = true
removeEmptyDirs = true
}Because dependency remapping is a more involved process, a register method is provided:
dependencyRepackager.register(
/* configuration = */ configurations.transformedLib,
/* relocations = */ [
"net": "repackaged.net",
"org.": "repackaged.org."
],
/* removals = */ [
"META-INF/services/",
"example/unused/library/"
],
/* remapStrings = */ false,
/* remapServices = */ true,
/* remapManifest = */ true,
/* removeEmptyDirs = */ false
)This is the recommended (and only) way if you want to repackage multiple configurations.