fix: PluginDependency and PluginDescriptor should implement java.io.Serializable

Author: smartcmd

README.md

@@ -18,7 +18,7 @@ It is pretty simple to use this plugin. Just add the following code to your `bui
 ```kt
 plugins {
     id("java-library")
-    id("org.allaymc.gradle.plugin").version("0.1.1")
+    id("org.allaymc.gradle.plugin").version("0.2.0")
 }
 
 group = "org.allaymc.gradle.sample"

plugin/src/main/kotlin/org/allaymc/gradle/plugin/AllayPlugin.kt

@@ -53,8 +53,8 @@ class AllayPlugin : Plugin<Project> {
         }
 
         val shadowJarTask = if (
-            project.plugins.hasPlugin("com.gradleup.shadow")
-            || project.plugins.hasPlugin("com.github.johnrengelman.shadow")
+            project.plugins.hasPlugin("com.gradleup.shadow") ||
+            project.plugins.hasPlugin("com.github.johnrengelman.shadow")
         ) {
             project.tasks.named("shadowJar", Jar::class.java)
         } else {
@@ -68,22 +68,23 @@ class AllayPlugin : Plugin<Project> {
         }
 
         if (extension.generatePluginDescriptor.get()) {
-            val generatePluginDescriptorTask = project.tasks.register<GeneratePluginDescriptorTask>("generatePluginDescriptor") {
-                outputFile.set(project.layout.buildDirectory.file("resources/main/plugin.json"))
+            val generatePluginDescriptorTask =
+                project.tasks.register<GeneratePluginDescriptorTask>("generatePluginDescriptor") {
+                    outputFile.set(project.layout.buildDirectory.file("resources/main/plugin.json"))
 
-                pluginEntrance.set(extension.plugin.entrance)
-                pluginName.set(extension.plugin.name)
-                pluginVersion.set(extension.plugin.version)
-                pluginAuthors.set(extension.plugin.authors)
-                pluginApiVersion.set(extension.plugin.apiVersion)
-                pluginDescription.set(extension.plugin.description)
-                pluginDependencies.set(extension.plugin.dependencies)
-                pluginWebsite.set(extension.plugin.website)
+                    pluginEntrance.set(extension.plugin.entrance)
+                    pluginName.set(extension.plugin.name)
+                    pluginVersion.set(extension.plugin.version)
+                    pluginAuthors.set(extension.plugin.authors)
+                    pluginApiVersion.set(extension.plugin.apiVersion)
+                    pluginDescription.set(extension.plugin.description)
+                    pluginDependencies.set(extension.plugin.dependencies)
+                    pluginWebsite.set(extension.plugin.website)
 
-                projectName.set(project.name)
-                projectVersion.set(project.version.toString())
-                projectDescription.set(project.description)
-            }
+                    projectName.set(project.name)
+                    projectVersion.set(project.version.toString())
+                    projectDescription.set(project.description)
+                }
 
             project.tasks.named("processResources") {
                 dependsOn(generatePluginDescriptorTask)

plugin/src/main/kotlin/org/allaymc/gradle/plugin/data/PluginDependency.kt

@@ -3,4 +3,4 @@ package org.allaymc.gradle.plugin.data
 import kotlinx.serialization.Serializable
 
 @Serializable
-data class PluginDependency(val name: String, val version: String?, val optional: Boolean?)
+data class PluginDependency(val name: String, val version: String?, val optional: Boolean?) : java.io.Serializable

plugin/src/main/kotlin/org/allaymc/gradle/plugin/data/PluginDescriptor.kt

@@ -14,5 +14,4 @@ data class PluginDescriptor(
     val description: String?,
     val dependencies: List<PluginDependency>?,
     val website: String?,
-) {
-}
+) : java.io.Serializable

plugin/src/main/kotlin/org/allaymc/gradle/plugin/dsl/PluginDsl.kt

@@ -3,7 +3,6 @@ package org.allaymc.gradle.plugin.dsl
 import org.allaymc.gradle.plugin.data.PluginDependency
 import org.gradle.api.model.ObjectFactory
 import org.gradle.api.provider.ListProperty
-import org.gradle.api.provider.MapProperty
 import org.gradle.api.provider.Property
 import javax.inject.Inject
 
@@ -16,24 +15,21 @@ abstract class PluginDsl @Inject constructor(objects: ObjectFactory) {
     val authors: ListProperty<String> = objects.listProperty(String::class.java).convention(emptyList())
     fun authors(vararg names: String) = authors.addAll(names.toList())
 
+    /* Optional Fields */
+
     val apiVersion: Property<String> = objects.property(String::class.java)
+
     /** Alias for [apiVersion]. */
     val api = apiVersion
 
     val description: Property<String> = objects.property(String::class.java)
 
-    val dependencies: ListProperty<PluginDependency> =
-        objects.listProperty(PluginDependency::class.java).convention(emptyList())
+    val dependencies: ListProperty<PluginDependency> = objects.listProperty(PluginDependency::class.java)
     fun dependencies(vararg plugins: PluginDependency) = dependencies.addAll(plugins.toList())
     fun dependency(name: String, version: String? = null, optional: Boolean = false) =
-        PluginDependency(name, version, optional)
+        dependencies.add(PluginDependency(name, version, optional))
 
     val website: Property<String> = objects.property(String::class.java)
 
-    operator fun <K : Any, V : Any> MapProperty<K, V>.set(key: K, value: V?) {
-        @Suppress("NULLABILITY_MISMATCH_BASED_ON_JAVA_ANNOTATIONS")
-        if (value != null) put(key, value)
-    }
-
     operator fun <T : Any> ListProperty<T>.plusAssign(item: T) = addAll(item)
 }

plugin/src/main/kotlin/org/allaymc/gradle/plugin/tasks/GeneratePluginDescriptorTask.kt

@@ -1,7 +1,6 @@
 package org.allaymc.gradle.plugin.tasks
 
 import kotlinx.serialization.ExperimentalSerializationApi
-import kotlinx.serialization.InternalSerializationApi
 import kotlinx.serialization.builtins.MapSerializer
 import kotlinx.serialization.builtins.serializer
 import kotlinx.serialization.json.Json
@@ -10,7 +9,6 @@ import kotlinx.serialization.json.jsonObject
 import org.allaymc.gradle.plugin.data.PluginDependency
 import org.allaymc.gradle.plugin.data.PluginDescriptor
 import org.gradle.api.DefaultTask
-import org.gradle.api.Project
 import org.gradle.api.file.RegularFileProperty
 import org.gradle.api.provider.ListProperty
 import org.gradle.api.provider.Property
@@ -25,7 +23,6 @@ private val Serialization = Json {
     prettyPrint = true
 }
 
-@OptIn(InternalSerializationApi::class)
 abstract class GeneratePluginDescriptorTask : DefaultTask() {
     @get:OutputFile
     abstract val outputFile: RegularFileProperty
@@ -82,9 +79,12 @@ abstract class GeneratePluginDescriptorTask : DefaultTask() {
 
     private fun createDescriptor(): PluginDescriptor {
         return PluginDescriptor(
-            pluginEntrance.get().ensureEntrance(project),
+            pluginEntrance.get().takeIf { it.isNotEmpty() }
+                ?.let { if (it.startsWith(".")) "${project.group}$it" else it }
+                ?: error("Entrance is not defined!"),
             pluginName.orNull ?: projectName.get().takeUnless { it == "unspecified" } ?: error("Name is not defined!"),
-            (pluginVersion.orNull ?: projectVersion.get().takeUnless { it == "unspecified" } ?: error("Version is not defined!"))
+            (pluginVersion.orNull ?: projectVersion.get().takeUnless { it == "unspecified" }
+            ?: error("Version is not defined!"))
                 .takeIf { it.matches(semVerRegex) } ?: error("Version is invalid! (Please check https://semver.org/)"),
             pluginAuthors.getOrElse(emptyList()),
             pluginApiVersion.orNull,
@@ -94,15 +94,10 @@ abstract class GeneratePluginDescriptorTask : DefaultTask() {
         )
     }
 
-    private fun String?.ensureEntrance(project: Project) = this
-        ?.takeIf { it.isNotEmpty() }
-        ?.let { if (it.startsWith(".")) "${project.group}$it" else it }
-        ?: error("Entrance is not defined!")
-
     private val semVerRegex =
         Regex("^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)\\.(0|[1-9]\\d*)(?:-((?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\\.(?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\\+([0-9a-zA-Z-]+(?:\\.[0-9a-zA-Z-]+)*))?$")
 
-    internal class GenDescriptorException(message: String) : Exception(message)
+    internal class GeneratePluginDescriptorException(message: String) : Exception(message)
 
-    internal fun error(message: String): Nothing = throw GenDescriptorException(message)
+    internal fun error(message: String): Nothing = throw GeneratePluginDescriptorException(message)
 }

sample/build.gradle.kts

@@ -12,7 +12,7 @@ allay {
     plugin {
         name = "TestPlugin"
         entrance = ".TestPlugin"
-        authors += "Cdm2883"
+        authors = listOf("Cdm2883", "daoge_cmd")
         website = "https://github.com/AllayMC/AllayGradle"
     }
 }