build!: fix dependencies (#289)

Fix Gradle dependency problem (@joshuasing PEBKAC) introduced in 21ec9eb `compileOnlyApi` results in the Maven scope `compile` which causes the dependency to be included by the Maven shade plugin. Use `compileOnly` for platform dependencies (e.g. Bukkit, BungeeCord). Use `api` for dependencies that should be transitvely exported to consumers (e.g. chameleon-api, adventure). More information: https://docs.gradle.org/current/userguide/java_library_plugin.html
ChameleonFramework · Sep 19, 2023 · 6f00201 · 6f00201
1 parent b217888
commit 6f00201
Show file tree

Hide file tree

Showing 10 changed files with 42 additions and 25 deletions.
diff --git a/annotations/build.gradle.kts b/annotations/build.gradle.kts
@@ -35,4 +35,4 @@ dependencies {
         exclude(group = "org.apache", module = "velocity")
     }
     implementation(libs.gson)
-}
+}
diff --git a/api/build.gradle.kts b/api/build.gradle.kts
@@ -31,7 +31,9 @@ dependencies {
     api(libs.adventure.textSerializer.legacy)
     api(libs.adventure.textSerializer.gson)
     api(libs.adventure.platform.api)
+    compileOnlyApi(libs.annotations)
+
+    // Logging libraries for logger wrappers
     compileOnly(libs.slf4j)
     compileOnly(libs.log4j) // Scary...
-    compileOnlyApi(libs.annotations)
 }
diff --git a/example/build.gradle.kts b/example/build.gradle.kts
@@ -51,14 +51,34 @@ repositories {
 }
 
 dependencies {
+    // Chameleon API
     implementation(projects.chameleonApi) // dev.hypera:chameleon-api
+
+    // Bukkit support
     implementation(projects.chameleonPlatformBukkit) // dev.hypera:chameleon-platform-bukkit
+    compileOnly(libs.platform.bukkit) // org.spigotmc:spigot-api
+
+    // BungeeCord support
     implementation(projects.chameleonPlatformBungeecord) // dev.hypera:chameleon-platform-bungeecord
+    compileOnly(libs.platform.bungeecord) // net.md-5:bungeecord-api
+
+    // Folia support
     implementation(projects.chameleonPlatformFolia) // dev.hypera:chameleon-platform-folia
+    compileOnly(libs.platform.folia) // dev.folia:folia-api
+
+    // Nukkit support
     implementation(projects.chameleonPlatformNukkit) // dev.hypera:chameleon-platform-nukkit
-    implementation(projects.chameleonPlatformVelocity) // dev.hypera:chameleon-platform-velocity
+    compileOnly(libs.platform.nukkit) // cn.nukkit:nukkit
+
+    // Sponge support
     implementation(projects.chameleonPlatformSponge) // dev.hypera:chameleon-platform-sponge
+    compileOnly(libs.platform.sponge) // org.spongepowered:spongeapi
+
+    // Velocity support
+    implementation(projects.chameleonPlatformVelocity) // dev.hypera:chameleon-platform-velocity
+    compileOnly(libs.platform.velocity) // com.velocitypowered:velocity-api
 
+    // Annotation-based platform "main class" and manifest generation
     compileOnly(projects.chameleonAnnotations) // dev.hypera:chameleon-annotations
     annotationProcessor(projects.chameleonAnnotations) // dev.hypera:chameleon-annotations
 }

diff --git a/platform-api/build.gradle.kts b/platform-api/build.gradle.kts
@@ -27,5 +27,5 @@ plugins {
 }
 
 dependencies {
-    compileOnlyApi(projects.chameleonApi)
+    api(projects.chameleonApi)
 }
diff --git a/platform-bukkit/build.gradle.kts b/platform-bukkit/build.gradle.kts
@@ -31,8 +31,7 @@ repositories {
 }
 
 dependencies {
-    compileOnlyApi(projects.chameleonApi)
-    compileOnlyApi(projects.chameleonPlatformApi)
-    compileOnlyApi(libs.platform.bukkit)
+    api(projects.chameleonPlatformApi)
+    compileOnly(libs.platform.bukkit)
     implementation(libs.adventure.platform.bukkit)
-}
+}
diff --git a/platform-bungeecord/build.gradle.kts b/platform-bungeecord/build.gradle.kts
@@ -31,8 +31,7 @@ repositories {
 }
 
 dependencies {
-    compileOnlyApi(projects.chameleonApi)
-    compileOnlyApi(projects.chameleonPlatformApi)
-    compileOnlyApi(libs.platform.bungeecord)
+    api(projects.chameleonPlatformApi)
+    compileOnly(libs.platform.bungeecord)
     implementation(libs.adventure.platform.bungeecord)
-}
+}
diff --git a/platform-folia/build.gradle.kts b/platform-folia/build.gradle.kts
@@ -35,5 +35,5 @@ dependencies {
     api(projects.chameleonPlatformBukkit) {
         exclude("org.spigotmc", "spigot-api")
     }
-    compileOnlyApi(libs.platform.folia)
+    compileOnly(libs.platform.folia)
 }
diff --git a/platform-nukkit/build.gradle.kts b/platform-nukkit/build.gradle.kts
@@ -31,7 +31,6 @@ repositories {
 }
 
 dependencies {
-    compileOnlyApi(projects.chameleonApi)
-    compileOnlyApi(projects.chameleonPlatformApi)
-    compileOnlyApi(libs.platform.nukkit)
-}
+    api(projects.chameleonPlatformApi)
+    compileOnly(libs.platform.nukkit)
+}
diff --git a/platform-sponge/build.gradle.kts b/platform-sponge/build.gradle.kts
@@ -31,9 +31,8 @@ repositories {
 }
 
 dependencies {
-    compileOnlyApi(projects.chameleonApi)
-    compileOnlyApi(projects.chameleonPlatformApi)
-    compileOnlyApi(libs.platform.sponge) {
+    api(projects.chameleonPlatformApi)
+    compileOnly(libs.platform.sponge) {
         exclude(module = "configurate-*")
     }
-}
+}
diff --git a/platform-velocity/build.gradle.kts b/platform-velocity/build.gradle.kts
@@ -31,7 +31,6 @@ repositories {
 }
 
 dependencies {
-    compileOnlyApi(projects.chameleonApi)
-    compileOnlyApi(projects.chameleonPlatformApi)
-    compileOnlyApi(libs.platform.velocity)
-}
+    api(projects.chameleonPlatformApi)
+    compileOnly(libs.platform.velocity)
+}