Move the SLF4J ban to checkstyle

It was inconsistent to exclude the dependencies
EngineHub · Aug 25, 2024 · fc44a3a · fc44a3a
1 parent 54be5fa
commit fc44a3a
Show file tree

Hide file tree

Showing 8 changed files with 4 additions and 39 deletions.
diff --git a/build-logic/src/main/kotlin/buildlogic.adapter.gradle.kts b/build-logic/src/main/kotlin/buildlogic.adapter.gradle.kts
@@ -8,10 +8,6 @@ plugins {
     id("io.papermc.paperweight.userdev")
 }
 
-configure<buildlogic.CommonJavaExtension> {
-    banSlf4j = false
-}
-
 paperweight {
     injectPaperRepository = false
 }

diff --git a/build-logic/src/main/kotlin/buildlogic.common-java.gradle.kts b/build-logic/src/main/kotlin/buildlogic.common-java.gradle.kts
@@ -8,9 +8,6 @@ plugins {
     id("buildlogic.common")
 }
 
-val commonJava = extensions.create<buildlogic.CommonJavaExtension>("commonJava")
-commonJava.banSlf4j.convention(true)
-
 tasks
     .withType<JavaCompile>()
     .matching { it.name == "compileJava" || it.name == "compileTestJava" }
@@ -67,16 +64,6 @@ configure<JavaPluginExtension> {
     withSourcesJar()
 }
 
-configurations["compileClasspath"].apply {
-    resolutionStrategy.componentSelection {
-        withModule("org.slf4j:slf4j-api") {
-            if (commonJava.banSlf4j.get()) {
-                reject("No SLF4J allowed on compile classpath")
-            }
-        }
-    }
-}
-
 tasks.named("check").configure {
     dependsOn("checkstyleMain", "checkstyleTest")
 }
diff --git a/build-logic/src/main/kotlin/buildlogic/CommonJavaExtension.kt b/build-logic/src/main/kotlin/buildlogic/CommonJavaExtension.kt
diff --git a/config/checkstyle/checkstyle.xml b/config/checkstyle/checkstyle.xml
@@ -145,6 +145,10 @@ Checks based on Google Checks, modified for EngineHub.
             <property name="sortImportsInGroupAlphabetically" value="true"/>
             <property name="customImportOrderRules" value="THIRD_PARTY_PACKAGE###STANDARD_JAVA_PACKAGE###STATIC"/>
         </module>
+        <module name="IllegalImport">
+            <property name="illegalPkgs" value="org.slf4j"/>
+            <message key="name.invalidPattern" value="Illegal import - {0}. Use Log4J instead."/>
+        </module>
         <module name="MethodParamPad"/>
         <module name="OperatorWrap">
             <property name="option" value="NL"/>

diff --git a/worldedit-bukkit/build.gradle.kts b/worldedit-bukkit/build.gradle.kts
@@ -56,7 +56,6 @@ dependencies {
         because("Resolving Spigot annotations")
     }
     "compileOnly"(libs.paperApi) {
-        exclude("org.slf4j", "slf4j-api")
         exclude("junit", "junit")
     }
     "implementation"(libs.paperLib)

diff --git a/worldedit-fabric/build.gradle.kts b/worldedit-fabric/build.gradle.kts
@@ -10,11 +10,6 @@ plugins {
     id("buildlogic.platform")
 }
 
-commonJava {
-    // Not easy to do, because it's in a bunch of separate configurations
-    banSlf4j = false
-}
-
 platform {
     kind = buildlogic.WorldEditKind.Mod
     includeClasspath = true

diff --git a/worldedit-neoforge/build.gradle.kts b/worldedit-neoforge/build.gradle.kts
@@ -7,11 +7,6 @@ plugins {
     id("buildlogic.platform")
 }
 
-commonJava {
-    // Not easy to do, because it's in a bunch of separate configurations
-    banSlf4j = false
-}
-
 platform {
     kind = buildlogic.WorldEditKind.Mod
 }

diff --git a/worldedit-sponge/build.gradle.kts b/worldedit-sponge/build.gradle.kts
@@ -14,10 +14,6 @@ platform {
     includeClasspath = true
 }
 
-commonJava {
-    banSlf4j = false
-}
-
 minecraft {
     injectRepositories(false)
     version(libs.versions.sponge.minecraft.get())