Merge pull request #51 from EndlessCodeGroup/feature/smarter_meta

Smarter plugin.yml generation

Author: osipxd

CHANGELOG.md

@@ -37,24 +37,51 @@ bukkit {
 ```
 If `bukkit.server.version` is not specified, will be used `bukkit.apiVersion` for server.
 
+Now, BukkitGradle adds `api-version` field to `plugin.yml`.
+It will be parsed from `bukkit.apiVersion` but you can override it with `bukkit.meta.apiVersion` if need:
+```kotlin
+bukkit {
+    apiVersion = "1.16.4" // Inferred api-version is 1.16
+    
+    meta {
+        apiVersion.set("1.13") // But here you can override it
+    }
+}
+```
+
+### 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
 now it is friendly to Kotlin DSL.
 
 ### Removed
-- Task `:rebuildServerCore`, use `:buildServerCore --rerun-tasks` instead
-- Extension `DependencyHandler.craftbukkit()`, use `DependencyHandler.spigot()` instead
-- Automatic `mavenLocal()` apply, you should apply it manually if you need it
+- Removed task `:rebuildServerCore`, use `:buildServerCore --rerun-tasks` instead
+- Removed extension `DependencyHandler.craftbukkit()`, use `DependencyHandler.spigot()` instead
+- Removed automatic `mavenLocal()` apply, you should apply it manually if you need it
+- Removed repository extension `RepositoryHandler.vault()`, use `RepositoryHandler.jitpack()` instead and read [VaultAPI README][vault]
 
 ### Changed
 - Add `nogui` argument by default to `bukkitArgs`
 - Type of properties `server.jvmArgs` and `server.bukkitArgs` changed from `String` to `List<String>`.
   It makes it easier to add arguments without overriding defaults
+- Default main class pattern changed from `<groupId>.<lowercased name>.<name>` to `<groupId>.<name>` 
 
 ### Housekeeping
 - Default bukkit version now is 1.16.4
 - Update Gradle to 6.7.1
 
 [tca]: https://docs.gradle.org/current/userguide/task_configuration_avoidance.html
 [uptodate]: https://docs.gradle.org/current/userguide/more_about_tasks.html#sec:up_to_date_checks
+[vault]: https://github.com/MilkBowl/VaultAPI

README.md

@@ -32,7 +32,7 @@ Gradle utilities for easier writing Bukkit plugins.
 
 ## Apply plugin
 [BukkitGradle on plugins.gradle.org](https://plugins.gradle.org/plugin/ru.endlesscode.bukkitgradle)
-> **NOTE:** Gradle 5.0+ required
+> **Note:** Gradle 6.6+ required
 
 #### With new plugins mechanism
 ```groovy
@@ -66,7 +66,7 @@ plugins {
 }
  
 // Project information
-group = "com.example"
+group = "com.example.myplugin"
 description = "My first Bukkit plugin with Gradle"
 version = "0.1"
 
@@ -76,23 +76,27 @@ dependencies {
     // see section 'Dependencies' for more info
 }
 ```
-`compileOnly` - it's like provided scope in Maven. It means that this dependncy will not included to your final jar.
-It's enough! Will be hooked latest version of Bukkit and automatically generated `plugin.yml` with next content:
+> **Note:** `compileOnly` - it's like `provided` scope in Maven.
+It means that this dependency will not be included to your final jar.
+
+It's enough!
+Will be hooked the latest version of Bukkit and automatically generated `plugin.yml` with next content:
 ```yaml
 name: MyPlugin
 description: My first Bukkit plugin with Gradle
 main: com.example.myplugin.MyPlugin
 version: 0.1
+api-version: 1.16
 ```
-Main class build by pattern: `<groupId>.<lower case name>.<name>`
+> **Note:** Main class built by following pattern: `<groupId>.<name>`
 
 ### Configuring plugin
 You can configure attributes that will be placed to `plugin.yml`:
 ```groovy
 // Override default configurations
 bukkit {
-    // Version of API (if you will not set this property, will be used latest available)
-    version = "1.12.2"
+    // Version of API (if you will not set this property, will be used latest version at moment of BukkitGradle release)
+    apiVersion = "1.15.2"
  
     // Attributes for plugin.yml
     meta {
@@ -106,39 +110,19 @@ bukkit {
 }
 ```
 
-Will be generated next `plugin.yml` file:
+Will be generated `plugin.yml` file:
 ```yaml
 name: MyPlugin
 description: My amazing plugin, that doing nothing
 main: com.example.plugin.MyPlugin
 version: 1.0
+api-version: 1.15
 website: http://www.example.com
 authors: [OsipXD, Contributors]
 ```
 
-Also you can add custom (unsupported by BukkitGradle) attributes like a `depend` etc.
-Just create `plugin.yml` file and put custom attributes into.
-
-#### Quotes around values
-In some cases you may need put meta value in quotes. For this you can use `q` and `qq` functions.
-
-For example, we have meta:
-```groovy
-meta {
-    name.set(qq("Double Quoted Name"))
-    description.set(q("Single quoted description"))
-    url.set("http://without.quot.es/")
-}
-```
-
-And will be generated:
-```yaml
-name: "Double Quoted Name"
-description: 'Single quoted description'
-website: http://without.quot.es/
-```
-
-**Note:** In Groovy you can use functions in two ways: normal - `q("value")` and without braces - `q "value"`
+If you want to add unsupported by BukkitGradle attributes, like a `depend`, `commands` etc.
+Create `plugin.yml` file and put custom attributes there.
 
 ### Repositories and Dependencies
 BukkitGradle provides short extension-functions to add common repositories and dependencies.
@@ -158,13 +142,13 @@ dependencies {
 ##### Repositories:
  Name           | Url
 ----------------|-------------------------------------------------------------------
- spigot         | https://hub.spigotmc.org/nexus/content/repositories/snapshots/   
- sk98q          | http://maven.sk89q.com/repo/                                     
- destroystokyo  | https://repo.destroystokyo.com/repository/maven-public/ 
- dmulloy2       | http://repo.dmulloy2.net/nexus/repository/public/
- md5            | http://repo.md-5.net/content/groups/public/
- vault          | http://nexus.hc.to/content/repositories/pub_releases/
- placeholderapi | http://repo.extendedclip.com/content/repositories/placeholderapi/
+ spigot         | https://hub.spigotmc.org/nexus/content/repositories/snapshots/
+ sk98q          | https://maven.sk89q.com/repo/
+ papermc        | https://papermc.io/repo/repository/maven-public/
+ dmulloy2       | https://repo.dmulloy2.net/nexus/repository/public/
+ md5            | https://repo.md-5.net/content/groups/public/
+ jitpack        | https://jitpack.io/
+ placeholderapi | https://repo.extendedclip.com/content/repositories/placeholderapi/
  aikar          | https://repo.aikar.co/content/groups/aikar/
 
 ##### Dependencies:
@@ -198,17 +182,19 @@ buildtools.dir=/path/to/buildtools/
 ```
 If there no BuildTools.jar it will be automatically downloaded.
 
-**TIP:** you can define it globally (for all projects that uses BukkitGradle) with environment variables `BUKKIT_DEV_SERVER_HOME` 
+> **Tip:** you can define it globally, for all projects that uses BukkitGradle.
+> Specify environment variables `BUKKIT_DEV_SERVER_HOME` 
 and `BUKKIT_BUILDTOOLS_HOME`.
 
 ##### On IntelliJ IDEA
-Run `:buildIdeaRun` task. To your IDE will be added Run Configuration that will dynamically refreshes when you change 
-server configurations.
+Run `:buildIdeaRun` task.
+Run Configuration will be added to your IDE.
+It will be automatically refreshed when you change server configurations.
 
 ![Run Configuration](http://image.prntscr.com/image/1a12a03b8ac54fccb7d5b70a335fa996.png)
 
 ##### On other IDEs
-Run `:startServer` task.
+Run `:runServer` task.
 
 #### Dev server configuration
 To accept EULA and change settings use `bukkit.server` section:
@@ -218,6 +204,8 @@ bukkit {
     server {
         // Core type. It can be 'spigot' or 'paper'
         core = "spigot"
+        // Server version
+        version = "1.16.4" // If not specified, apiVersion will be used
         // Accept EULA
         eula = false
         // Set online-mode flag

build.gradle.kts

@@ -3,6 +3,7 @@ plugins {
     `maven-publish`
     groovy
     kotlin("jvm") version "1.4.21"
+    kotlin("plugin.serialization") version "1.4.21"
     id("com.gradle.plugin-publish") version "0.12.0"
     id("com.github.ben-manes.versions") version "0.36.0"
 }
@@ -27,6 +28,8 @@ repositories {
 
 dependencies {
     implementation("de.undercouch:gradle-download-task:4.1.1")
+    implementation("org.jetbrains.kotlinx:kotlinx-serialization-json:1.0.1")
+    implementation("com.charleskorn.kaml:kaml:0.26.0")
     testImplementation("junit:junit:4.13")
     testImplementation(platform("org.spockframework:spock-bom:2.0-M2-groovy-2.5"))
     testImplementation("org.spockframework:spock-core")

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/BukkitGradlePlugin.kt

@@ -48,6 +48,7 @@ public class BukkitGradlePlugin : Plugin<Project> {
             description.convention(provider { project.description })
             main.convention(name.map { "${project.group}.${StringUtils.toPascalCase(it)}" })
             version.convention(provider { project.version.toString() })
+            apiVersion.convention(provider { StringUtils.parseApiVersion(bukkit.apiVersion) })
             url.convention(provider { findProperty("url")?.toString() })
         }
     }

src/main/kotlin/dependencies/Dependencies.kt

@@ -20,7 +20,7 @@ internal object Dependencies {
     const val URL_PAPERMC = "https://papermc.io/repo/repository/maven-public/"
     const val URL_DMULLOY2 = "https://repo.dmulloy2.net/nexus/repository/public/"
     const val URL_MD5 = "https://repo.md-5.net/content/groups/public/"
-    const val URL_VAULT = "http://nexus.hc.to/content/repositories/pub_releases/"
+    const val URL_JITPACK = "https://jitpack.io"
     const val URL_PLACEHOLDERAPI = "https://repo.extendedclip.com/content/repositories/placeholderapi/"
     const val URL_AIKAR = "https://repo.aikar.co/content/groups/aikar/"
 
@@ -46,7 +46,7 @@ internal object Dependencies {
         repoExtra["papermc"] = closureOf<Any?> { repoHandler.addRepo("PaperMC", URL_PAPERMC) }
         repoExtra["dmulloy2"] = closureOf<Any?> { repoHandler.addRepo("dmulloy2", URL_DMULLOY2) }
         repoExtra["md5"] = closureOf<Any?> { repoHandler.addRepo("md5", URL_MD5) }
-        repoExtra["vault"] = closureOf<Any?> { repoHandler.addRepo("Vault", URL_VAULT) }
+        repoExtra["jitpack"] = closureOf<Any?> { repoHandler.addRepo("jitpack", URL_JITPACK) }
         repoExtra["placeholderapi"] = closureOf<Any?> { repoHandler.addRepo("PlaceholderAPI", URL_PLACEHOLDERAPI) }
         repoExtra["aikar"] = closureOf<Any?> { repoHandler.addRepo("aikar", URL_AIKAR) }
 

src/main/kotlin/dependencies/DependenciesExtensions.kt

@@ -5,12 +5,12 @@ import org.gradle.api.artifacts.dsl.RepositoryHandler
 import org.gradle.api.artifacts.repositories.MavenArtifactRepository
 import ru.endlesscode.bukkitgradle.dependencies.Dependencies.URL_AIKAR
 import ru.endlesscode.bukkitgradle.dependencies.Dependencies.URL_DMULLOY2
+import ru.endlesscode.bukkitgradle.dependencies.Dependencies.URL_JITPACK
 import ru.endlesscode.bukkitgradle.dependencies.Dependencies.URL_MD5
 import ru.endlesscode.bukkitgradle.dependencies.Dependencies.URL_PAPERMC
 import ru.endlesscode.bukkitgradle.dependencies.Dependencies.URL_PLACEHOLDERAPI
 import ru.endlesscode.bukkitgradle.dependencies.Dependencies.URL_SK89Q
 import ru.endlesscode.bukkitgradle.dependencies.Dependencies.URL_SPIGOT
-import ru.endlesscode.bukkitgradle.dependencies.Dependencies.URL_VAULT
 import ru.endlesscode.bukkitgradle.dependencies.Dependencies.addRepo
 import ru.endlesscode.bukkitgradle.dependencies.Dependencies.api
 
@@ -34,8 +34,8 @@ public fun RepositoryHandler.md5(configure: MavenArtifactRepository.() -> Unit =
     addRepo("md5", URL_MD5, configure)
 }
 
-public fun RepositoryHandler.vault(configure: MavenArtifactRepository.() -> Unit = {}) {
-    addRepo("Vault", URL_VAULT, configure)
+public fun RepositoryHandler.jitpack(configure: MavenArtifactRepository.() -> Unit = {}) {
+    addRepo("jitpack", URL_JITPACK, configure)
 }
 
 public fun RepositoryHandler.placeholderApi(configure: MavenArtifactRepository.() -> Unit = {}) {