feat: Use resolution strategy to resolve bukkit dependency version and paper group

osipxd · osipxd · commit 67cce9d11275 · 2025-04-18T18:47:56.000+02:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -3,6 +3,12 @@
 ### Added
 
 - Support setting "api-version" containing a patch version for v1.20.5+
+- Add dependency substitution rules fixing paper groupId and substituting bukkit version.
+  In version catalogs placeholder value `{bukkit.version}` can be used, and it will be replaced with the actual version:
+  ```toml
+  [libraries]
+  paperApi = { module = "io.papermc.paper:paper-api", version = "{bukkit.apiVersion}" }
+  ```
 
 ### Changed
 
diff --git a/README.md b/README.md
@@ -175,11 +175,12 @@ When adding dependencies, make sure you've added the corresponding repository.
 |-------------|------------------------------------------|---------------------|
 | `spigot`    | `org.spigotmc:spigot:$apiVersion`        | `mavenLocal()`*     |
 | `spigotApi` | `org.spigotmc:spigot-api:$apiVersion`    | `spigot()`          |
-| `bukkitApi` | `org.bukkit:bukkit:$apiVersion`          | `spigot()`          |
+| `bukkitApi` | `org.bukkit:bukkit:$apiVersion`          | `mavenLocal()`**    |
 | `paperApi`  | `io.papermc.paper:paper-api:$apiVersion` | `papermc()`         |
 
 \* Spigot is available in `mavenLocal()` only if you've built it locally using [Spigot BuildTools][buildtools]. \
-\*\* `$apiVersion` - is `${version}-R0.1-SNAPSHOT` (where `$version` is `bukkit.apiVersion`)
+\*\* Bukkit should be built locally. However, some versions are available in `spigot()` repository.  \
+\*\*\* `$apiVersion` - is `${version}-R0.1-SNAPSHOT` (where `$version` is `bukkit.apiVersion`).
 
 If you need more shortcuts, [file an issue][issue].
 
diff --git a/src/main/kotlin/BukkitExtension.kt b/src/main/kotlin/BukkitExtension.kt
@@ -3,24 +3,29 @@ package ru.endlesscode.bukkitgradle
 import org.gradle.api.Action
 import org.gradle.api.model.ObjectFactory
 import org.gradle.api.provider.Property
+import org.gradle.api.provider.ProviderFactory
 import org.gradle.kotlin.dsl.property
-import ru.endlesscode.bukkitgradle.extensions.finalizedOnRead
+import ru.endlesscode.bukkitgradle.extensions.finalizeAndGet
 import ru.endlesscode.bukkitgradle.plugin.plugin
+import ru.endlesscode.bukkitgradle.plugin.util.MinecraftVersion
 import ru.endlesscode.bukkitgradle.server.ServerConstants
 import ru.endlesscode.bukkitgradle.server.extension.ServerConfigurationImpl
 import xyz.jpenilla.resourcefactory.bukkit.BukkitPluginYaml
 
 public open class BukkitExtension internal constructor(
     public final override val server: ServerConfigurationImpl,
     objects: ObjectFactory,
+    providers: ProviderFactory,
 ) : Bukkit {
 
     override val generatePluginYaml: Property<Boolean> = objects.property<Boolean>()
         .convention(true)
 
     public final override val apiVersion: Property<String> = objects.property<String>()
         .convention(ServerConstants.DEFAULT_VERSION)
-        .finalizedOnRead()
+
+    internal val finalApiVersion = providers.provider { apiVersion.finalizeAndGet() }
+    internal val parsedApiVersion = finalApiVersion.map(MinecraftVersion::parse)
 
     public fun server(body: Action<ServerConfigurationImpl>) {
         body.execute(server)
diff --git a/src/main/kotlin/BukkitGradlePlugin.kt b/src/main/kotlin/BukkitGradlePlugin.kt
@@ -12,7 +12,6 @@ import org.gradle.kotlin.dsl.withType
 import ru.endlesscode.bukkitgradle.dependencies.Dependencies.configureDependencyExtensions
 import ru.endlesscode.bukkitgradle.extensions.java
 import ru.endlesscode.bukkitgradle.plugin.configurePluginYamlFeature
-import ru.endlesscode.bukkitgradle.plugin.util.parsedApiVersion
 import ru.endlesscode.bukkitgradle.plugin.util.resolveMinimalJavaVersion
 import ru.endlesscode.bukkitgradle.server.configureDevServerFeature
 import ru.endlesscode.bukkitgradle.server.extension.ServerConfigurationImpl
@@ -37,7 +36,7 @@ public class BukkitGradlePlugin : Plugin<Project> {
         configureDependencyExtensions(bukkit)
     }
 
-    private fun Project.configureJavaCompilation(bukkit: Bukkit) {
+    private fun Project.configureJavaCompilation(bukkit: BukkitExtension) {
         java.toolchain {
             languageVersion.convention(bukkit.parsedApiVersion.map(::resolveMinimalJavaVersion))
         }
diff --git a/src/main/kotlin/dependencies/Dependencies.kt b/src/main/kotlin/dependencies/Dependencies.kt
@@ -7,13 +7,10 @@ import org.gradle.api.artifacts.dsl.DependencyHandler
 import org.gradle.api.artifacts.dsl.RepositoryHandler
 import org.gradle.api.artifacts.repositories.MavenArtifactRepository
 import org.gradle.api.plugins.ExtraPropertiesExtension
-import org.gradle.api.provider.Provider
-import org.gradle.kotlin.dsl.KotlinClosure0
 import org.gradle.kotlin.dsl.extra
 import org.gradle.kotlin.dsl.maven
-import ru.endlesscode.bukkitgradle.Bukkit
+import ru.endlesscode.bukkitgradle.BukkitExtension
 import ru.endlesscode.bukkitgradle.plugin.util.MinecraftVersion
-import ru.endlesscode.bukkitgradle.plugin.util.parsedApiVersion
 
 private typealias RepositoryClosure = Closure<MavenArtifactRepository>
 
@@ -29,42 +26,40 @@ internal object Dependencies {
     const val URL_AIKAR = "https://repo.aikar.co/content/groups/aikar/"
     const val URL_CODEMC = "https://repo.codemc.org/repository/maven-public/"
 
-    private lateinit var apiVersion: Provider<String>
-    private lateinit var parsedApiVersion: Provider<MinecraftVersion>
+    const val BUKKIT_VERSION_PLACEHOLDER = "{bukkit.apiVersion}"
+    const val BUKKIT_VERSION_SUFFIX = "-R0.1-SNAPSHOT"
 
-    private lateinit var repoHandler: RepositoryHandler
-    private lateinit var depHandler: DependencyHandler
+    const val PAPER_GROUP = "io.papermc.paper"
+    const val PAPER_OLD_GROUP = "com.destroystokyo.paper"
 
     private val RepositoryHandler.extra: ExtraPropertiesExtension
         get() = InvokerHelper.getProperty(this, "ext") as ExtraPropertiesExtension
 
     @JvmStatic
-    fun Project.configureDependencyExtensions(bukkit: Bukkit) {
-        apiVersion = bukkit.apiVersion
-        parsedApiVersion = bukkit.parsedApiVersion
+    fun Project.configureDependencyExtensions(bukkit: BukkitExtension) {
+        repositories.addGroovyExtensions()
+        dependencies.addGroovyExtensions()
 
-        repoHandler = repositories
-        depHandler = dependencies
-        addGroovyExtensions()
+        configureResolutionStrategy(bukkit)
     }
 
-    private fun addGroovyExtensions() {
-        val repoExtra = repoHandler.extra
-        repoExtra["spigot"] = repoHandler.repositoryClosure("Spigot", URL_SPIGOT)
-        repoExtra["sk89q"] = repoHandler.repositoryClosure("sk89q", URL_SK89Q)
-        repoExtra["papermc"] = repoHandler.repositoryClosure("PaperMC", URL_PAPERMC)
-        repoExtra["dmulloy2"] = repoHandler.repositoryClosure("dmulloy2", URL_DMULLOY2)
-        repoExtra["md5"] = repoHandler.repositoryClosure("md5", URL_MD5)
-        repoExtra["jitpack"] = repoHandler.repositoryClosure("jitpack", URL_JITPACK)
-        repoExtra["placeholderapi"] = repoHandler.repositoryClosure("PlaceholderAPI", URL_PLACEHOLDERAPI)
-        repoExtra["aikar"] = repoHandler.repositoryClosure("aikar", URL_AIKAR)
-        repoExtra["codemc"] = repoHandler.repositoryClosure("codemc", URL_CODEMC)
-
-        val depExtra = depHandler.extra
-        depExtra["spigot"] = depClosureOf { depHandler.api("org.spigotmc", "spigot") }
-        depExtra["spigotApi"] = depClosureOf { depHandler.api("org.spigotmc", "spigot-api") }
-        depExtra["bukkitApi"] = depClosureOf { depHandler.api("org.bukkit", "bukkit") }
-        depExtra["paperApi"] = depClosureOf { depHandler.api(resolvePaperGroupId(), "paper-api") }
+    private fun RepositoryHandler.addGroovyExtensions() {
+        extra["spigot"] = repositoryClosure("Spigot", URL_SPIGOT)
+        extra["sk89q"] = repositoryClosure("sk89q", URL_SK89Q)
+        extra["papermc"] = repositoryClosure("PaperMC", URL_PAPERMC)
+        extra["dmulloy2"] = repositoryClosure("dmulloy2", URL_DMULLOY2)
+        extra["md5"] = repositoryClosure("md5", URL_MD5)
+        extra["jitpack"] = repositoryClosure("jitpack", URL_JITPACK)
+        extra["placeholderapi"] = repositoryClosure("PlaceholderAPI", URL_PLACEHOLDERAPI)
+        extra["aikar"] = repositoryClosure("aikar", URL_AIKAR)
+        extra["codemc"] = repositoryClosure("codemc", URL_CODEMC)
+    }
+
+    private fun DependencyHandler.addGroovyExtensions() {
+        extra["spigot"] = withBukkitVersion("org.spigotmc", "spigot")
+        extra["spigotApi"] = withBukkitVersion("org.spigotmc", "spigot-api")
+        extra["bukkitApi"] = withBukkitVersion("org.bukkit", "bukkit")
+        extra["paperApi"] = withBukkitVersion(PAPER_GROUP, "paper-api")
     }
 
     private fun RepositoryHandler.repositoryClosure(name: String, url: String): RepositoryClosure =
@@ -84,20 +79,39 @@ internal object Dependencies {
         }
     }
 
-    @Suppress("unused") // Receiver required for scope
-    fun DependencyHandler.api(groupId: String, artifactId: String): String {
-        val version = "${apiVersion.get()}-R0.1-SNAPSHOT"
-        return dep(groupId, artifactId, version)
-    }
-
-    private fun dep(groupId: String, artifactId: String, version: String): String {
-        return "$groupId:$artifactId:$version"
+    fun withBukkitVersion(groupId: String, artifactId: String): String {
+        return "$groupId:$artifactId:$BUKKIT_VERSION_PLACEHOLDER"
     }
 
-    internal fun resolvePaperGroupId(): String {
-        val useNewGroup = parsedApiVersion.get() >= MinecraftVersion.V1_17_0
-        return if (useNewGroup) "io.papermc.paper" else "com.destroystokyo.paper"
+    private fun Project.configureResolutionStrategy(bukkit: BukkitExtension) {
+        val bukkitVersion = bukkit.finalApiVersion
+            .map { "$it$BUKKIT_VERSION_SUFFIX" }
+
+        configurations.configureEach {
+            resolutionStrategy.eachDependency {
+                val version = if (requested.version == BUKKIT_VERSION_PLACEHOLDER) {
+                    bukkitVersion.get()
+                } else {
+                    requested.version
+                }
+
+                val shouldUseOldPaperGroup by lazy {
+                    version != null && MinecraftVersion.parse(version) < MinecraftVersion.V1_17_0
+                }
+                val group = when (requested.group) {
+                    PAPER_GROUP -> if (shouldUseOldPaperGroup) PAPER_OLD_GROUP else requested.group
+                    PAPER_OLD_GROUP -> if (!shouldUseOldPaperGroup) PAPER_GROUP else requested.group
+                    else -> requested.group
+                }
+
+                if (requested.group != group) {
+                    useTarget("$group:${requested.name}:$version")
+                    because("Fix paper group as it was changed in 1.17")
+                } else if (requested.version != version && version != null) {
+                    useVersion(version)
+                    because("Substitute bukkit version")
+                }
+            }
+        }
     }
-
-    private fun depClosureOf(body: () -> String) = KotlinClosure0(body)
 }
diff --git a/src/main/kotlin/dependencies/DependenciesExtensions.kt b/src/main/kotlin/dependencies/DependenciesExtensions.kt
@@ -1,10 +1,11 @@
-@file:Suppress("SpellCheckingInspection")
+@file:Suppress("SpellCheckingInspection", "UnusedReceiverParameter")
 
 package ru.endlesscode.bukkitgradle.dependencies
 
 import org.gradle.api.artifacts.dsl.DependencyHandler
 import org.gradle.api.artifacts.dsl.RepositoryHandler
 import org.gradle.api.artifacts.repositories.MavenArtifactRepository
+import ru.endlesscode.bukkitgradle.dependencies.Dependencies.PAPER_GROUP
 import ru.endlesscode.bukkitgradle.dependencies.Dependencies.URL_AIKAR
 import ru.endlesscode.bukkitgradle.dependencies.Dependencies.URL_CODEMC
 import ru.endlesscode.bukkitgradle.dependencies.Dependencies.URL_DMULLOY2
@@ -15,8 +16,7 @@ import ru.endlesscode.bukkitgradle.dependencies.Dependencies.URL_PLACEHOLDERAPI
 import ru.endlesscode.bukkitgradle.dependencies.Dependencies.URL_SK89Q
 import ru.endlesscode.bukkitgradle.dependencies.Dependencies.URL_SPIGOT
 import ru.endlesscode.bukkitgradle.dependencies.Dependencies.addRepo
-import ru.endlesscode.bukkitgradle.dependencies.Dependencies.api
-import ru.endlesscode.bukkitgradle.dependencies.Dependencies.resolvePaperGroupId
+import ru.endlesscode.bukkitgradle.dependencies.Dependencies.withBukkitVersion
 
 public fun RepositoryHandler.spigot(configure: MavenArtifactRepository.() -> Unit = {}): MavenArtifactRepository =
     addRepo("Spigot", URL_SPIGOT, configure)
@@ -46,13 +46,13 @@ public fun RepositoryHandler.codemc(configure: MavenArtifactRepository.() -> Uni
     addRepo("codemc", URL_CODEMC, configure)
 
 public val DependencyHandler.spigot: String
-    get() = api("org.spigotmc", "spigot")
+    get() = withBukkitVersion("org.spigotmc", "spigot")
 
 public val DependencyHandler.spigotApi: String
-    get() = api("org.spigotmc", "spigot-api")
+    get() = withBukkitVersion("org.spigotmc", "spigot-api")
 
 public val DependencyHandler.bukkitApi: String
-    get() = api("org.bukkit", "bukkit")
+    get() = withBukkitVersion("org.bukkit", "bukkit")
 
 public val DependencyHandler.paperApi: String
-    get() = api(resolvePaperGroupId(), "paper-api")
+    get() = withBukkitVersion(PAPER_GROUP, "paper-api")
diff --git a/src/main/kotlin/plugin/PluginYamlFeature.kt b/src/main/kotlin/plugin/PluginYamlFeature.kt
@@ -15,7 +15,6 @@ import ru.endlesscode.bukkitgradle.extensions.sourceSets
 import ru.endlesscode.bukkitgradle.plugin.task.ParsePluginYaml
 import ru.endlesscode.bukkitgradle.plugin.util.MinecraftVersion
 import ru.endlesscode.bukkitgradle.plugin.util.StringUtils
-import ru.endlesscode.bukkitgradle.plugin.util.parsedApiVersion
 import xyz.jpenilla.resourcefactory.ExecuteResourceFactories
 import xyz.jpenilla.resourcefactory.ResourceFactoryPlugin
 import xyz.jpenilla.resourcefactory.bukkit.BukkitPluginYaml
diff --git a/src/main/kotlin/plugin/util/MinecraftVersion.kt b/src/main/kotlin/plugin/util/MinecraftVersion.kt
@@ -1,7 +1,7 @@
 package ru.endlesscode.bukkitgradle.plugin.util
 
 import org.gradle.jvm.toolchain.JavaLanguageVersion
-import ru.endlesscode.bukkitgradle.Bukkit
+import ru.endlesscode.bukkitgradle.dependencies.Dependencies
 
 @JvmInline
 internal value class MinecraftVersion(private val value: Int) : Comparable<MinecraftVersion> {
@@ -16,7 +16,9 @@ internal value class MinecraftVersion(private val value: Int) : Comparable<Minec
 
     companion object {
         fun parse(version: String): MinecraftVersion {
-            val versionParts = version.split('.').mapNotNull { it.toIntOrNull() }
+            val versionParts = version
+                .removeSuffix(Dependencies.BUKKIT_VERSION_SUFFIX)
+                .split('.').mapNotNull { it.toIntOrNull() }
             require(versionParts.size in 2..3) { "Unable to parse API version '$version'." }
             val (major, minor, patch) = versionParts + 0
             return MinecraftVersion(major * 1_00_00 + minor * 1_00 + patch)
@@ -29,8 +31,6 @@ internal value class MinecraftVersion(private val value: Int) : Comparable<Minec
     }
 }
 
-internal val Bukkit.parsedApiVersion get() = apiVersion.map(MinecraftVersion::parse)
-
 internal fun resolveMinimalJavaVersion(version: String) = resolveMinimalJavaVersion(MinecraftVersion.parse(version))
 
 internal fun resolveMinimalJavaVersion(version: MinecraftVersion): JavaLanguageVersion = when {
diff --git a/src/main/kotlin/server/DevServerFeature.kt b/src/main/kotlin/server/DevServerFeature.kt
@@ -6,7 +6,7 @@ import org.gradle.api.provider.Provider
 import org.gradle.api.tasks.TaskProvider
 import org.gradle.jvm.toolchain.JavaToolchainService
 import org.gradle.kotlin.dsl.*
-import ru.endlesscode.bukkitgradle.Bukkit
+import ru.endlesscode.bukkitgradle.BukkitExtension
 import ru.endlesscode.bukkitgradle.extensions.java
 import ru.endlesscode.bukkitgradle.plugin.util.resolveMinimalJavaVersion
 import ru.endlesscode.bukkitgradle.server.extension.ServerConfiguration
@@ -15,13 +15,13 @@ import ru.endlesscode.bukkitgradle.server.task.PrepareServer
 import xyz.jpenilla.runpaper.RunPaperPlugin
 import xyz.jpenilla.runpaper.task.RunServer
 
-internal fun Project.configureDevServerFeature(bukkit: Bukkit) {
+internal fun Project.configureDevServerFeature(bukkit: BukkitExtension) {
     apply<RunPaperPlugin>()
     val configuredServerDir = resolveConfiguredServerDir()
 
     // Preconfigure the RunServer task
     val serverConfiguration = bukkit.server
-    val serverVersion = provider<String> { serverConfiguration.version }.orElse(bukkit.apiVersion)
+    val serverVersion = provider<String> { serverConfiguration.version }.orElse(bukkit.finalApiVersion)
     val runServer = tasks.named<RunServer>("runServer") {
         version.convention(serverVersion)
         if (configuredServerDir != null) runDirectory.convention(configuredServerDir)
diff --git a/src/test/groovy/ru/endlesscode/bukkitgradle/BukkitGradlePluginSpec.groovy b/src/test/groovy/ru/endlesscode/bukkitgradle/BukkitGradlePluginSpec.groovy
