feat: Paperweight support (#1362)

* Initial work towards paperweight * feat: Port Fawe classes to paperweight - Hide UnsafeUtilities in javadocs - Fix typo in Regenerator - Create fawe tmp directory for fawe regen * Update adapters * chore: Update MiniMessage * Address todos * Fix leftover Tuinity loggers
2025-06-12 04:23:54 +00:00 · 2021-10-17 16:32:36 +02:00
parent 9c1c8bfdf2
commit f0880a27a0
30 changed files with 8383 additions and 68 deletions
--- a/buildSrc/build.gradle.kts
+++ b/buildSrc/build.gradle.kts
@ -6,7 +6,12 @@ plugins {
 }

 repositories {
+    mavenCentral()
    gradlePluginPortal()
+    maven {
+        name = "PaperMC"
+        url = uri("https://papermc.io/repo/repository/maven-public/")
+    }
    maven {
        name = "EngineHub"
        url = uri("https://maven.enginehub.org/repo/")
@ -23,4 +28,5 @@ dependencies {
    implementation(gradleApi())
    implementation("org.ajoberstar.grgit:grgit-gradle:4.1.0")
    implementation("gradle.plugin.com.github.jengelman.gradle.plugins:shadow:7.0.0")
+    implementation("io.papermc.paperweight.userdev:io.papermc.paperweight.userdev.gradle.plugin:1.1.11")
 }
--- a/buildSrc/src/main/kotlin/AdapterConfig.kt
+++ b/buildSrc/src/main/kotlin/AdapterConfig.kt
@ -0,0 +1,47 @@
+import io.papermc.paperweight.util.constants.REOBF_CONFIG
+import org.gradle.api.Named
+import org.gradle.api.Project
+import org.gradle.api.attributes.Attribute
+import org.gradle.kotlin.dsl.apply
+import org.gradle.kotlin.dsl.dependencies
+import org.gradle.kotlin.dsl.get
+import org.gradle.kotlin.dsl.named
+
+// TODO https://github.com/PaperMC/paperweight/pull/87
+interface Obfuscation : Named {
+    companion object {
+        val OBFUSCATION_ATTRIBUTE = Attribute.of(
+                "com.fastasyncworldedit.obfuscation",
+                Obfuscation::class.java
+        )
+        const val NONE = "none"
+        const val REOBFUSCATED = "reobfuscated"
+    }
+}
+
+// For specific version pinning, see
+// https://papermc.io/repo/service/rest/repository/browse/maven-public/io/papermc/paper/dev-bundle/
+fun Project.applyPaperweightAdapterConfiguration(
+        paperVersion: String
+) {
+    applyCommonConfiguration()
+    apply(plugin = "java-library")
+    applyCommonJavaConfiguration(
+            sourcesJar = true,
+            banSlf4j = false,
+    )
+    apply(plugin = "io.papermc.paperweight.userdev")
+
+    dependencies {
+        paperDevBundle(paperVersion)
+        "implementation"(project(":worldedit-bukkit"))
+    }
+
+    tasks.named("assemble") {
+        dependsOn("reobfJar")
+    }
+
+    configurations[REOBF_CONFIG].attributes {
+        attribute(Obfuscation.OBFUSCATION_ATTRIBUTE, objects.named(Obfuscation.REOBFUSCATED))
+    }
+}
--- a/buildSrc/src/main/kotlin/CommonJavaConfig.kt
+++ b/buildSrc/src/main/kotlin/CommonJavaConfig.kt
@ -0,0 +1,92 @@
+import org.gradle.api.Project
+import org.gradle.api.attributes.java.TargetJvmVersion
+import org.gradle.api.plugins.JavaPluginExtension
+import org.gradle.api.plugins.quality.CheckstyleExtension
+import org.gradle.api.tasks.compile.JavaCompile
+import org.gradle.api.tasks.javadoc.Javadoc
+import org.gradle.api.tasks.testing.Test
+import org.gradle.external.javadoc.StandardJavadocDocletOptions
+import org.gradle.kotlin.dsl.apply
+import org.gradle.kotlin.dsl.configure
+import org.gradle.kotlin.dsl.dependencies
+import org.gradle.kotlin.dsl.get
+import org.gradle.kotlin.dsl.withType
+
+fun Project.applyCommonJavaConfiguration(sourcesJar: Boolean, banSlf4j: Boolean = true) {
+    applyCommonConfiguration()
+    apply(plugin = "eclipse")
+    apply(plugin = "idea")
+
+    tasks
+            .withType<JavaCompile>()
+            .matching { it.name == "compileJava" || it.name == "compileTestJava" }
+            .configureEach {
+                val disabledLint = listOf(
+                        "processing", "path", "fallthrough", "serial"
+                )
+                options.release.set(11)
+                options.compilerArgs.addAll(listOf("-Xlint:all") + disabledLint.map { "-Xlint:-$it" })
+                options.isDeprecation = true
+                options.encoding = "UTF-8"
+                options.compilerArgs.add("-parameters")
+            }
+
+    configurations.all {
+        attributes.attribute(TargetJvmVersion.TARGET_JVM_VERSION_ATTRIBUTE, 16)
+    }
+
+    tasks.withType<Test>().configureEach {
+        useJUnitPlatform()
+    }
+
+    dependencies {
+        "compileOnly"("com.google.code.findbugs:jsr305:3.0.2")
+        "testImplementation"("org.junit.jupiter:junit-jupiter-api:5.8.1")
+        "testImplementation"("org.junit.jupiter:junit-jupiter-params:5.8.1")
+        "testImplementation"("org.mockito:mockito-core:3.12.4")
+        "testImplementation"("org.mockito:mockito-junit-jupiter:3.12.4")
+        "testRuntimeOnly"("org.junit.jupiter:junit-jupiter-engine:5.8.1")
+    }
+
+    // Java 8 turns on doclint which we fail
+    tasks.withType<Javadoc>().configureEach {
+        (options as StandardJavadocDocletOptions).apply {
+            addStringOption("Xdoclint:none", "-quiet")
+            tags(
+                    "apiNote:a:API Note:",
+                    "implSpec:a:Implementation Requirements:",
+                    "implNote:a:Implementation Note:"
+            )
+            options.encoding = "UTF-8"
+            links(
+                    "https://javadoc.io/doc/com.google.code.findbugs/jsr305/3.0.2/",
+                    "https://jd.adventure.kyori.net/api/4.9.1/",
+                    "https://javadoc.io/doc/org.apache.logging.log4j/log4j-api/2.14.1/",
+                    "https://javadoc.io/doc/com.google.guava/guava/21.0/",
+                    "https://www.antlr.org/api/Java/",
+                    "https://docs.enginehub.org/javadoc/org.enginehub.piston/core/0.5.7/",
+                    "https://docs.enginehub.org/javadoc/org.enginehub.piston/default-impl/0.5.7/",
+                    "https://papermc.io/javadocs/paper/1.17/",
+                    "https://ci.athion.net/job/FastAsyncWorldEdit-1.17-Core-Javadocs/javadoc/" // needed for other module linking
+            )
+        }
+    }
+
+    configure<JavaPluginExtension> {
+        disableAutoTargetJvm()
+        withJavadocJar()
+        if (sourcesJar) {
+            withSourcesJar()
+        }
+    }
+
+    if (banSlf4j) {
+        configurations["compileClasspath"].apply {
+            resolutionStrategy.componentSelection {
+                withModule("org.slf4j:slf4j-api") {
+                    reject("No SLF4J allowed on compile classpath")
+                }
+            }
+        }
+    }
+}
--- a/buildSrc/src/main/kotlin/GradleExtras.kt
+++ b/buildSrc/src/main/kotlin/GradleExtras.kt
@ -1,6 +1,6 @@
 import org.gradle.api.Project
 import org.gradle.api.plugins.ExtraPropertiesExtension
-import org.gradle.api.plugins.JavaPluginConvention
+import org.gradle.api.plugins.JavaPluginExtension
 import org.gradle.api.tasks.SourceSetContainer
 import org.gradle.kotlin.dsl.getByType
 import org.gradle.kotlin.dsl.the
@ -9,4 +9,4 @@ val Project.ext: ExtraPropertiesExtension
    get() = extensions.getByType()

 val Project.sourceSets: SourceSetContainer
-    get() = the<JavaPluginConvention>().sourceSets
+    get() = the<JavaPluginExtension>().sourceSets
--- a/buildSrc/src/main/kotlin/PlatformConfig.kt
+++ b/buildSrc/src/main/kotlin/PlatformConfig.kt
@ -14,7 +14,6 @@ import org.gradle.kotlin.dsl.apply
 import org.gradle.kotlin.dsl.configure
 import org.gradle.kotlin.dsl.dependencies
 import org.gradle.kotlin.dsl.get
-import org.gradle.kotlin.dsl.getByName
 import org.gradle.kotlin.dsl.named
 import org.gradle.kotlin.dsl.provideDelegate
 import org.gradle.kotlin.dsl.register
@ -29,68 +28,16 @@ fun Project.applyPlatformAndCoreConfiguration() {
    apply(plugin = "maven-publish")
    apply(plugin = "com.github.johnrengelman.shadow")

+    applyCommonJavaConfiguration(
+            sourcesJar = name in setOf("worldedit-core", "worldedit-bukkit"),
+    )
+
    if (project.hasProperty("buildnumber")) {
        ext["internalVersion"] = "$version;${rootProject.ext["gitCommitHash"]}"
    } else {
        ext["internalVersion"] = "$version"
    }

-    tasks
-        .withType<JavaCompile>()
-        .matching { it.name == "compileJava" || it.name == "compileTestJava" }
-        .configureEach {
-            val disabledLint = listOf(
-                "processing", "path", "fallthrough", "serial"
-            )
-            options.release.set(11)
-            options.compilerArgs.addAll(listOf("-Xlint:all") + disabledLint.map { "-Xlint:-$it" })
-            options.isDeprecation = false
-            options.encoding = "UTF-8"
-            options.compilerArgs.add("-parameters")
-        }
-
-    configurations.all {
-        attributes.attribute(TargetJvmVersion.TARGET_JVM_VERSION_ATTRIBUTE, 16)
-    }
-
-    tasks.withType<Test>().configureEach {
-        useJUnitPlatform()
-    }
-
-    dependencies {
-        "compileOnly"("com.google.code.findbugs:jsr305:3.0.2")
-        "testImplementation"("org.junit.jupiter:junit-jupiter-api:5.8.1")
-        "testImplementation"("org.junit.jupiter:junit-jupiter-params:5.8.1")
-        "testImplementation"("org.mockito:mockito-core:3.12.4")
-        "testImplementation"("org.mockito:mockito-junit-jupiter:3.12.4")
-        "testImplementation"("net.bytebuddy:byte-buddy:1.11.9")
-        "testRuntimeOnly"("org.junit.jupiter:junit-jupiter-engine:5.8.1")
-    }
-
-    // Java 8 turns on doclint which we fail
-    tasks.withType<Javadoc>().configureEach {
-        (options as StandardJavadocDocletOptions).apply {
-            addStringOption("Xdoclint:none", "-quiet")
-            tags(
-                "apiNote:a:API Note:",
-                "implSpec:a:Implementation Requirements:",
-                "implNote:a:Implementation Note:"
-            )
-            options.encoding = "UTF-8"
-            links(
-                    "https://javadoc.io/doc/com.google.code.findbugs/jsr305/3.0.2/",
-                    "https://jd.adventure.kyori.net/api/4.9.1/",
-                    "https://javadoc.io/doc/org.apache.logging.log4j/log4j-api/2.14.1/",
-                    "https://javadoc.io/doc/com.google.guava/guava/21.0/",
-                    "https://www.antlr.org/api/Java/",
-                    "https://docs.enginehub.org/javadoc/org.enginehub.piston/core/0.5.7/",
-                    "https://docs.enginehub.org/javadoc/org.enginehub.piston/default-impl/0.5.7/",
-                    "https://papermc.io/javadocs/paper/1.17/",
-                    "https://ci.athion.net/job/FastAsyncWorldEdit-1.17-Core-Javadocs/javadoc/" // needed for other module linking
-            )
-        }
-    }
-
    configure<JavaPluginExtension> {
        disableAutoTargetJvm()
        withJavadocJar()