feat: use project name, version, and description if not specified

Author: smartcmd

README.md

@@ -5,31 +5,40 @@ A Gradle plugin designed to boost Allay plugin development!
 ## Usage
 
 ```kt
+
+group = "org.allaymc.gradle.sample"
+version = "0.1.0"
+description = "Test plugin for AllayGradle!"
+
 allay {
-    // API dependency version (required if `apiOnly = true`).
+    // API version (required if `apiOnly = true`).
     api = "0.15.0"
 
-    // Specify server version for `runServer` and dependency version when `apiOnly = false`.
-    // Set to null for the latest version.
-    server = null
-
-    // Depend on the server module instead of the API module for server-specific features.
+    // Set this field to `false` to access the server module to use the internal APIs. However, this is not
+    // recommended as internal APIs can change at any time.
+    // The default value is `true`.
     apiOnly = true
 
-    // Configure the plugin descriptor.
+    // Specify the server version used in the `runServer` task. This will also be the dependency version if
+    // `apiOnly` is set to `false`. If this field is set to `null`, the latest server version will be used.
+    // The default value is `null`.
+    server = null
+
+    // Configure the plugin descriptor (plugin.json).
     plugin {
         entrance = "org.allaymc.gradle.sample.TestPlugin"
-        // Or use relative path if project's group is set.
+        // Or use the relative path if the project's group is set.
         // entrance = ".TestPlugin"
 
-        name = "TestPlugin"
-        version = "0.1.0-alpha"
+        apiVersion = ">=0.15.0"
         authors += "Cdm2883"
-        api = ">= 0.15.0"
-        description = "Test plugin for AllayGradle!"
         website = "https://github.com/AllayMC/AllayGradle"
+        
+        // By default, the following fields are set to the project's group, version, and description.
+        // However, you can override them if you want.
+        // name = "..."
+        // version = "..."
+        // description = "..."
     }
 }
 ```
-
-> See a full example in [sample/build.gradle.kts](sample/build.gradle.kts).

gradle/libs.versions.toml

@@ -1,5 +1,5 @@
 [versions]
-allay-gradle = "0.1.0-alpha"
+allay-gradle = "0.1.0-SNAPSHOT"
 
 kotlin = "1.9.23"
 kotlinx-serialization = "1.5.0"

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

@@ -38,7 +38,7 @@ abstract class AllayExtension @Inject constructor(objects: ObjectFactory) {
         val version: Property<String> = objects.property(String::class.java)
         val authors: ListProperty<String> = objects.listProperty(String::class.java).convention(emptyList())
         fun authors(vararg names: String) = authors.addAll(names.toList())
-        val api: Property<String> = objects.property(String::class.java)
+        val apiVersion: Property<String> = objects.property(String::class.java)
         val description: Property<String> = objects.property(String::class.java)
         val dependencies: ListProperty<PluginDescriptor.Dependency> =
             objects.listProperty(PluginDescriptor.Dependency::class.java).convention(emptyList())

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

@@ -53,7 +53,7 @@ class AllayPlugin : Plugin<Project> {
 
     private fun createShadowJarImplement(project: Project) = project.tasks.register("shadowJar", Jar::class.java) {
         group = Constant.TASK_GROUP
-        archiveClassifier.set("shadow")
+        archiveClassifier.set("shaded")
         val sourceSets = project.extensions.getByType(SourceSetContainer::class.java)
         from(sourceSets.getByName("main").output)
         val runtimeClasspath = project.configurations.getByName("runtimeClasspath")

plugin/src/main/kotlin/org/allaymc/gradle/plugin/descriptor/DescriptorInjector.kt

@@ -53,11 +53,11 @@ fun descriptorInject(project: Project, extension: AllayExtension) =
 
 private fun PluginDescriptor.inject(project: Project, extension: AllayExtension.Plugin) = copy(
     entrance = (entrance ?: extension.entrance.orNull).ensureEntrance(project),
-    name = name.template(extension.name),
+    name = name.ensureName(project, extension.name),
     version = version.ensureVersion(project, extension.version),
     authors = authors + extension.authors,
-    api = api.template(extension.api),
-    description = description.template(extension.description),
+    apiVersion = apiVersion.template(extension.apiVersion),
+    description = description.ensureDescription(project, extension.description),
     dependencies = dependencies + extension.dependencies,
     website = website.template(extension.website),
 )
@@ -67,6 +67,12 @@ private fun String?.ensureEntrance(project: Project) = this
     ?.let { if (it.startsWith(".")) "${project.group}$it" else it }
     ?: error("Entrance is not defined!")
 
+private fun String?.ensureName(project: Project, property: Property<String>) =
+    template(property) ?: project.name.takeUnless { it == "unspecified" } ?: error("Name is not defined!")
+
+private fun String?.ensureDescription(project: Project, property: Property<String>) =
+    template(property) ?: project.description ?: ""
+
 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-]+)*))?\$")
 

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

@@ -10,7 +10,7 @@ data class PluginDescriptor(
     val version: String?,
     val authors: List<String>?,
     @SerialName("api_version")
-    val api: String?,
+    val apiVersion: String?,
     val description: String?,
     val dependencies: List<Dependency>?,
     val website: String?,

sample/build.gradle.kts

@@ -3,16 +3,19 @@ plugins {
     alias(libs.plugins.allay.gradle)
 }
 
-group = "org.allaymc.gradle.sample"  // for entrance splicing
+// for entrance splicing
+group = "org.allaymc.gradle.sample"
+version = libs.versions.allay.gradle.get()
+description = "Test plugin of AllayGradle!"
 
 allay {
     api = "0.15.0"
     plugin {
         name = "TestPlugin"
-        entrance = ".TestPlugin"  // "org.allaymc.gradle.sample.TestPlugin"
-        description = "Test plugin of AllayGradle!"
+        // "org.allaymc.gradle.sample.TestPlugin"
+        entrance = ".TestPlugin"
+        apiVersion = ">=0.15.0"
         authors += "Cdm2883"
-        version = libs.versions.allay.gradle
         website = "https://github.com/AllayMC/AllayGradle"
     }
 }