feat(Meta): Add ability to disable plugin.yml generation

Author: osipxd

CHANGELOG.md

@@ -49,6 +49,18 @@ bukkit {
 }
 ```
 
+### Smarter plugin.yml generation
+
+BukkitGradle will not "eat" your existing plugin.yml file.
+Its content will be used if you've not configured `bukkit.meta` in BukkitGradle.
+
+If you don't want plugin.yml generation at all, you can disable it:
+```kotlin
+bukkit {
+    disableMetaGeneration()
+}
+```
+
 ### Re-written in Kotlin
 The plugin has been converted to Kotlin to make support easier.
 The plugin still can be configured with Groovy DSL but

src/main/kotlin/Bukkit.kt

@@ -13,4 +13,7 @@ public interface Bukkit {
 
     /** Bukkit version. */
     public val apiVersion: String
+
+    /** Plugin Meta generation enabled. */
+    public val generateMeta: Boolean
 }

src/main/kotlin/BukkitExtension.kt

@@ -12,11 +12,14 @@ import ru.endlesscode.bukkitgradle.server.extension.ServerConfigurationImpl
 
 // TODO 1.0: Remove deprecated fields on release
 public open class BukkitExtension(
-    public override val meta: PluginMetaImpl,
-    public override val server: ServerConfigurationImpl
+    public final override val meta: PluginMetaImpl,
+    public final override val server: ServerConfigurationImpl
 ) : Bukkit {
 
-    public override var apiVersion: String = ServerConstants.DEFAULT_VERSION
+    public final override var apiVersion: String = ServerConstants.DEFAULT_VERSION
+
+    public final override var generateMeta: Boolean = true
+        private set
 
     private val logger = LoggerFactory.getLogger("BukkitExtension")
 
@@ -54,6 +57,11 @@ public open class BukkitExtension(
         logger.warnSyntaxChanged("bukkit.version = '...'", "bukkit.apiVersion = '...'")
         apiVersion = version
     }
+
+    /** Disabled plugin.yml generation. */
+    public fun disableMetaGeneration() {
+        generateMeta = false
+    }
 }
 
 internal val Project.bukkit: Bukkit get() = extensions.getByType()

src/main/kotlin/meta/PluginMetaPlugin.kt

@@ -32,13 +32,17 @@ public class PluginMetaPlugin : Plugin<Project> {
             this.yaml = yaml
             this.meta = project.bukkit.meta as PluginMetaImpl
             this.metaFile.set(metaFile)
+
+            onlyIf { project.bukkit.generateMeta }
         }
 
         val mergePluginMeta = project.tasks.register<MergePluginMeta>("mergePluginMeta") {
             this.yaml = yaml
             meta = project.bukkit.meta
             metaYaml.set(parsePluginMeta.map { it.pluginMetaYaml.get() })
             dependsOn(parsePluginMeta)
+
+            onlyIf { project.bukkit.generateMeta }
         }
 
         project.tasks.named<CopySpec>("processResources").configure {

src/test/groovy/ru/endlesscode/bukkitgradle/meta/task/MergePluginMetaSpec.groovy

@@ -33,6 +33,20 @@ class MergePluginMetaSpec extends PluginSpecification {
         taskOutcome(":parsePluginMetaFile") == TaskOutcome.SUCCESS
     }
 
+    def 'when run processResources - and meta generation disabled - should not run generatePluginMeta'() {
+        given: "meta generation disabled"
+        buildFile << "bukkit.disableMetaGeneration()"
+
+        when: "run processResources"
+        run(':processResources')
+
+        then: "task generatePluginMeta completed successfully"
+        taskOutcome(TASK_PATH) == TaskOutcome.SKIPPED
+
+        and: "task generatePluginMeta completed successfully"
+        taskOutcome(":parsePluginMetaFile") == TaskOutcome.SKIPPED
+    }
+
     def 'when merge meta - should generate default plugin meta successfully'() {
         when: "run generate meta task"
         run(TASK_PATH)