Merge pull request #49 from EndlessCodeGroup/feature/to_kotlin

To Kotlin: Final

Author: osipxd

CHANGELOG.md

@@ -1,22 +1,58 @@
 ## Unreleased
 
+### Reworked tasks hierarchy
+
+All plugin's tasks reworked to use actual Gradle APIs:
+- [Task Configuration Avoidance][tca].
+  Plugin's tasks will be created and configured only when it needed
+- [Up-to-date checks][uptodate].
+  Tasks will not re-run if input data not changed
+- Optimized work in offline mode.
+
 ### Property syntax to configure meta fields
-Instead of:
-```kotlin
+Use `.set` instead of `=`:
+```diff
 bukkit {
     meta {
-        desctiption = "My plugin's description"
+-        desctiption = "My plugin's description"
++        description.set("My plugin's description")
     }
 }
 ```
-You should use:
+
+### run -> server
+`bukkit.run` renamed to `bukkit.server`. The old name is deprecated
+
+### Improved Bukkit version management
+
+Field `bukkit.version` is deprecated now, you should use `bukkit.apiVersion` instead.
+Also, you can specify a version for dev server different from `apiVersion`:
 ```kotlin
 bukkit {
-    meta {
-        description.set("My plugin's description")
+    apiVersion = "1.16.4"
+    server {
+        version = "1.15.2" // Want to test plugin on older minecraft version 
     }
 }
 ```
+If `bukkit.server.version` is not specified, will be used `bukkit.apiVersion` for server.
+
+### 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.
 
 ### Added
 - Configuration avoidance and build cache for task `generateMetaData`
+
+### 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
+
+### 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

README.md

@@ -2,15 +2,18 @@ BukkitGradle [![Version](https://img.shields.io/github/release/EndlessCodeGroup/
 ============
 Gradle utilities for easier writing Bukkit plugins.
 
-## Table of Contents
-1. [Apply plugin](#apply-plugin)
-2. [Usage](#usage)
-    1. [First steps](#first-steps)
-    2. [Configuring plugin](#configuring-plugin)
-        1. [Quotes around values](#quotes-around-values)
-    3. [Repositories and Dependencies](#repositories-and-dependencies)
-    4. [Running Dev server](#running-dev-server)
-        1. [Server run configurations](#server-run-configurations)
+<!-- START doctoc generated TOC please keep comment here to allow auto update -->
+<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
+
+
+- [Apply plugin](#apply-plugin)
+- [Usage](#usage)
+  - [First steps](#first-steps)
+  - [Configuring plugin](#configuring-plugin)
+  - [Repositories and Dependencies](#repositories-and-dependencies)
+  - [Running Dev server](#running-dev-server)
+
+<!-- END doctoc generated TOC please keep comment here to allow auto update -->
 
 #### Features:
 - Automatically applies plugin: java
@@ -142,13 +145,13 @@ BukkitGradle provides short extension-functions to add common repositories and d
 There are list of its.
 
 Usage example:
-```groovy
+```kotlin
 repositories {
     spigot() // Adds spigot repo
 }
 
 dependencies {
-    compileOnly paperApi() // Adds paper-api dependency
+    compileOnly(paperApi()) // Adds paper-api dependency
 }
 ```
 
@@ -169,15 +172,14 @@ Some dependencies also applies repo needed for them.
 
  Name        | Signature                                     | Applies repo
 -------------|-----------------------------------------------|---------------
- spigot      | org.spigotmc:spigot:$apiVersion               | -   
+ spigot      | org.spigotmc:spigot:$apiVersion               | mavenLocal
  spigotApi   | org.spigotmc:spigot-api:$apiVersion           | spigot
  bukkit      | org.bukkit:bukkit:$apiVersion                 | spigot
- craftbukkit | org.bukkit:craftbukkit:$apiVersion            | -
  paperApi    | com.destroystokyo.paper:paper-api:$apiVersion | destroystokyo
 
  **Note:** `$apiVersion` - is `${version}-R0.1-SNAPSHOT` (where `$version` is `bukkit.version`)
 
-If you want more extension-functions - you can [write issue](https://github.com/EndlessCodeGroup/BukkitGradle/issues/new).
+If you need more extension-functions, [create issue](https://github.com/EndlessCodeGroup/BukkitGradle/issues/new).
 
 ### Running Dev server
 Before running server you should configure dev server location.
@@ -188,7 +190,7 @@ You can define it in `local.properties` file (that was automatically created in
 server.dir=/path/to/buildtools/
 ```
 
-If you use Spigot (see `bukkit.run.core`) you also should specify BuildTools location. For Paper no additional actions 
+If you use Spigot (see `bukkit.server.core`) you also should specify BuildTools location. For Paper no additional actions 
 needed.
 ```properties
 # Absolute path to directory that contains BuildTools.jar
@@ -208,12 +210,12 @@ server configurations.
 ##### On other IDEs
 Run `:startServer` task.
 
-#### Server run configurations
-To accept EULA and change settings use `bukkit.run` section:
+#### Dev server configuration
+To accept EULA and change settings use `bukkit.server` section:
 ```groovy
 bukkit {
     // INFO: Here used default values
-    run {
+    server {
         // Core type. It can be 'spigot' or 'paper'
         core = "spigot"
         // Accept EULA

build.gradle.kts

@@ -4,7 +4,7 @@ plugins {
     id("groovy")
     id("maven-publish")
     id("com.gradle.plugin-publish") version "0.12.0"
-    id("com.github.ben-manes.versions") version "0.28.0"
+    id("com.github.ben-manes.versions") version "0.36.0"
 }
 
 java {
@@ -20,19 +20,11 @@ tasks.test {
     useJUnitPlatform()
 }
 
-// TODO: Remove after migration to Kotlin
-tasks.compileGroovy {
-    dependsOn(tasks.compileKotlin)
-    classpath += files(tasks.compileKotlin.get().destinationDir)
-}
-
 repositories {
     jcenter()
 }
 
 dependencies {
-    implementation(gradleApi())
-    implementation(localGroovy())
     implementation("de.undercouch:gradle-download-task:4.1.1")
     testImplementation("junit:junit:4.13")
     testImplementation(platform("org.spockframework:spock-bom:2.0-M2-groovy-2.5"))