feat: Switch from JVM compatibility to JVM toolchains

Fixes #62

Author: osipxd

CHANGELOG.md

@@ -1,5 +1,15 @@
 ## [Unreleased]
 
+### Added
+
+- Support setting "api-version" containing a patch version for v1.20.5+
+
+### Changed
+
+- Set the default [JVM toolchain](https://docs.gradle.org/current/userguide/toolchains.html) version
+  instead of setting JVM target and source compatibility to 1.8.
+  The default JVM version depends on [Paper requirements](https://docs.papermc.io/paper/getting-started#requirements).
+
 ### Fixed
 
 - Fix compatibility with new versions of Shadow plugin

src/main/kotlin/BukkitGradlePlugin.kt

@@ -1,15 +1,17 @@
 package ru.endlesscode.bukkitgradle
 
-import org.gradle.api.JavaVersion
 import org.gradle.api.Plugin
 import org.gradle.api.Project
 import org.gradle.api.plugins.JavaPluginExtension
 import org.gradle.api.tasks.compile.JavaCompile
+import org.gradle.jvm.toolchain.JavaLanguageVersion
 import org.gradle.kotlin.dsl.*
 import ru.endlesscode.bukkitgradle.dependencies.Dependencies
 import ru.endlesscode.bukkitgradle.meta.PluginMetaPlugin
 import ru.endlesscode.bukkitgradle.meta.extension.PluginMetaImpl
+import ru.endlesscode.bukkitgradle.meta.util.MinecraftVersion
 import ru.endlesscode.bukkitgradle.meta.util.StringUtils
+import ru.endlesscode.bukkitgradle.meta.util.parsedApiVersion
 import ru.endlesscode.bukkitgradle.server.DevServerPlugin
 import ru.endlesscode.bukkitgradle.server.extension.ServerConfigurationImpl
 
@@ -28,7 +30,7 @@ public class BukkitGradlePlugin : Plugin<Project> {
 
     /** Adds needed plugins. */
     private fun Project.addPlugins() {
-        extensions.create<BukkitExtension>("bukkit", configurePluginMeta(), ServerConfigurationImpl())
+        val bukkit = extensions.create<BukkitExtension>("bukkit", configurePluginMeta(), ServerConfigurationImpl())
 
         with(plugins) {
             apply("java")
@@ -37,8 +39,9 @@ public class BukkitGradlePlugin : Plugin<Project> {
         }
 
         extensions.configure<JavaPluginExtension> {
-            sourceCompatibility = JavaVersion.VERSION_1_8
-            targetCompatibility = JavaVersion.VERSION_1_8
+            toolchain {
+                languageVersion.convention(provider { resolveRecommendedJavaVersion(bukkit.parsedApiVersion) })
+            }
         }
     }
 
@@ -48,7 +51,7 @@ public class BukkitGradlePlugin : Plugin<Project> {
             description.convention(provider { project.description })
             main.convention(name.map { "${project.group}.${StringUtils.toPascalCase(it)}" })
             version.convention(provider { project.version.toString() })
-            apiVersion.convention(provider { StringUtils.parseApiVersion(bukkit.apiVersion) })
+            apiVersion.convention(provider { resolveDefaultApiVersion(bukkit.parsedApiVersion) })
             url.convention(provider { providers.gradleProperty("url").orNull })
         }
     }
@@ -66,4 +69,20 @@ public class BukkitGradlePlugin : Plugin<Project> {
             mavenCentral()
         }
     }
+
+    private fun resolveDefaultApiVersion(version: MinecraftVersion): String? = when {
+        // "API version" has been introduced in Spigot 1.13
+        version < MinecraftVersion.V1_13_0 -> null
+        // From 1.20.5 and onward, a patch version is supported.
+        version < MinecraftVersion.V1_20_5 -> version.withoutPatch().toString()
+        else -> version.toString()
+    }
+
+    // See: https://docs.papermc.io/paper/getting-started#requirements
+    private fun resolveRecommendedJavaVersion(version: MinecraftVersion): JavaLanguageVersion = when {
+        version >= MinecraftVersion.V1_17_1 -> JavaLanguageVersion.of(21)
+        version >= MinecraftVersion.V1_16_5 -> JavaLanguageVersion.of(16)
+        version >= MinecraftVersion.V1_12_0 -> JavaLanguageVersion.of(11)
+        else -> JavaLanguageVersion.of(8)
+    }
 }

src/main/kotlin/meta/util/MinecraftVersion.kt

@@ -0,0 +1,32 @@
+package ru.endlesscode.bukkitgradle.meta.util
+
+import ru.endlesscode.bukkitgradle.Bukkit
+
+@JvmInline
+internal value class MinecraftVersion(private val value: Int) : Comparable<MinecraftVersion> {
+    private val major: Int get() = value / 1_00_00
+    private val minor: Int get() = (value / 1_00) % 100
+    private val patch: Int get() = value % 100
+
+    fun withoutPatch(): MinecraftVersion = MinecraftVersion(value - patch)
+
+    override fun toString(): String = if (patch == 0) "$major.$minor" else "$major.$minor.$patch"
+    override fun compareTo(other: MinecraftVersion): Int = value.compareTo(other.value)
+
+    companion object {
+        fun parse(version: String): MinecraftVersion {
+            val versionParts = version.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)
+        }
+
+        val V1_12_0 = MinecraftVersion(1_12_00)
+        val V1_13_0 = MinecraftVersion(1_13_00)
+        val V1_16_5 = MinecraftVersion(1_16_05)
+        val V1_17_1 = MinecraftVersion(1_17_01)
+        val V1_20_5 = MinecraftVersion(1_20_05)
+    }
+}
+
+internal val Bukkit.parsedApiVersion get() = MinecraftVersion.parse(apiVersion)

src/main/kotlin/meta/util/StringUtils.kt

@@ -8,12 +8,4 @@ internal object StringUtils {
         val camelCaseText = text.replace(Regex("[ _-]([A-Za-z0-9])")) { match -> match.groupValues[1].uppercase() }
         return camelCaseText.replaceFirstChar { it.uppercase() }
     }
-
-    @JvmStatic
-    fun parseApiVersion(version: String): String? {
-        val versionParts = version.split('.').mapNotNull { it.toIntOrNull() }
-        require(versionParts.size in 2..3) { "Unable to parse API version '$version'." }
-        val (major, minor) = versionParts
-        return if (major >= 1 && minor >= 13) "$major.$minor" else null
-    }
 }

src/test/groovy/ru/endlesscode/bukkitgradle/BukkitGradlePluginSpec.groovy

@@ -12,6 +12,23 @@ class BukkitGradlePluginSpec extends PluginSpecification {
         project.pluginManager.hasPlugin("java")
     }
 
+    def "when initialized - should set default JVM toolchain"(String apiVersion, int jvmVersion) {
+        when: "apiVersion is set to $apiVersion"
+        project.bukkit.apiVersion = apiVersion
+
+        then: "JVM toolchain version should be"
+        project.java.toolchain.languageVersion.get().asInt() == jvmVersion
+
+        where:
+        apiVersion | jvmVersion
+        "1.11"     | 8
+        "1.12"     | 11
+        "1.16.4"   | 11
+        "1.16.5"   | 16
+        "1.17"     | 16
+        "1.17.1"   | 21
+    }
+
     def "when use custom repos extension - should add repos"() {
         when: "use repo extension"
         project.repositories.sk89q()

src/test/groovy/ru/endlesscode/bukkitgradle/meta/task/MergePluginMetaSpec.groovy

@@ -60,6 +60,31 @@ class MergePluginMetaSpec extends PluginSpecification {
                          """.stripIndent().trim()
     }
 
+    def 'when merge meta - should set api-version'(String apiVersion, String expectedResult) {
+        when: "api version is $apiVersion"
+        buildFile << """
+            bukkit.apiVersion = "$apiVersion"
+        """.stripIndent()
+
+        and: "run generate meta task"
+        run(TASK_PATH)
+
+        then: "meta file content corresponds to default config"
+        metaFile.text == """
+                         main: "com.example.testplugin.TestPlugin"
+                         name: "test-plugin"
+                         version: "1.0"
+                         api-version: "$expectedResult"
+                         """.stripIndent().trim()
+
+        where:
+        apiVersion | expectedResult
+        "1.16.5"   | "1.16"
+        "1.20.4"   | "1.20"
+        "1.20.5"   | "1.20.5"
+        "1.21.1"   | "1.21.1"
+    }
+
     def 'when merge meta - and generate it again - should skip second task run'() {
         when: "run generate meta task"
         run(TASK_PATH)