1.9.0 release

Author: phinner

CHANGELOG.md

@@ -1 +1,2 @@
-- Now, this repo is powered by shadowJar for building plugins instead of the fatJar trick.
+- optimized `build.gradle`
+  - Added checking frameworks.

README.md

@@ -14,6 +14,7 @@ This template features some cool stuff such as:
 - GitHub action for easier release and Jitpack usage:
    - You just have to run the `Release` workflow manually,
      it will automatically take the plugin version in your plugin.json file and upload the jar.
+   - Changelog support: edit `CHANGELOG.md` before each release, it will be used as the release text.
 
 When using this template, don't forget to change `plugin.json` and `gradle.properties`.
 

build.gradle

@@ -1,7 +1,6 @@
 import groovy.json.JsonSlurper
-import org.apache.groovy.json.internal.LazyMap
 import java.nio.charset.StandardCharsets
-
+import net.ltgt.gradle.errorprone.CheckSeverity
 
 buildscript{
     repositories{
@@ -11,24 +10,25 @@ buildscript{
     dependencies{
         classpath "org.codehaus.groovy:groovy-json:3.0.8" // <- For JsonSlurper syntax highlighting
     }
+
+    ext{
+        serverDirectoryPath = System.getenv("MINDUSTRY_SERVER_HOME")
+        metadata = new JsonSlurper().parseText(file("$rootDir/plugin.json").text)
+
+        versions = [
+                "mindustry": property("props.mindustry-version"),
+                "arc": property("props.arc-version"),
+                "junit": "5.8.2"
+        ]
+    }
 }
 
 plugins{
     id "java"
     id "maven-publish"
     id "com.github.johnrengelman.shadow" version "7.1.2"
-}
-
-
-ext{
-    serverDirectoryPath = System.getenv("MINDUSTRY_SERVER_HOME")
-    metadata = new JsonSlurper().parseText(file("$rootDir/plugin.json").text) as LazyMap
-
-    versions = [
-            "mindustry": property("props.mindustry-version"),
-            "arc": property("props.arc-version"),
-            "junit": "5.8.2"
-    ]
+    id "net.ltgt.errorprone" version "2.0.2"
+    id "org.checkerframework" version "0.6.7"
 }
 
 group property("props.project-group")
@@ -56,10 +56,17 @@ dependencies{
     testImplementation "org.junit.jupiter:junit-jupiter-params:${versions.junit}"
     testImplementation "org.junit.jupiter:junit-jupiter-api:${versions.junit}"
     testRuntimeOnly "org.junit.jupiter:junit-jupiter-engine:${versions.junit}"
+
+    // Annotations
+    compileOnly "org.checkerframework:checker-qual:3.21.1"
+    annotationProcessor "com.uber.nullaway:nullaway:0.9.4"
+    errorprone "com.google.errorprone:error_prone_core:2.10.0"
+    errorproneJavac "com.google.errorprone:javac:9+181-r4173-1"
 }
 
 java{
     withSourcesJar()
+    withJavadocJar()
 }
 
 test{
@@ -70,8 +77,16 @@ tasks.withType(JavaCompile).configureEach {
     sourceCompatibility = JavaVersion.VERSION_16
     targetCompatibility = JavaVersion.VERSION_16
     options.encoding = StandardCharsets.UTF_8
-}
 
+    options.errorprone.with{
+        disableWarningsInGeneratedCode = true
+        disable "MissingSummary"
+        if(!name.containsIgnoreCase("test")){
+            check("NullAway", CheckSeverity.ERROR)
+            option("NullAway:AnnotatedPackages", "fr.xpdustry.template")
+        }
+    }
+}
 
 shadowJar{
     from "$rootDir/plugin.json"
@@ -115,9 +130,15 @@ task getArtifactPath{
     doLast{ println shadowJar.archiveFile.get().toString() }
 }
 
+// Avoid publishing shadow artifacts to maven repo
+// > https://github.com/johnrengelman/shadow/issues/651
+components.withType(AdhocComponentWithVariants).forEach { c ->
+    c.withVariantsFromConfiguration(configurations.shadowRuntimeElements) {skip() }
+}
+
 publishing{
     publications{
-        create("jitpack", MavenPublication){
+        create("maven", MavenPublication){
             from components.java
 
             pom{

plugin.json

@@ -3,7 +3,7 @@
   "displayName": "Xpdustry TemplatePlugin",
   "author": "Xpdustry",
   "description": "A template plugin for easier development, enjoy.",
-  "version": "1.8",
+  "version": "1.9.0",
   "minGameVersion": "105",
   "hidden": true,
   "java": true,

src/main/java/fr/xpdustry/template/TemplatePlugin.java

@@ -16,15 +16,13 @@ public void init(){
 
     /**
      * This method is called when the game register the server-side commands.
-     * Make sure your plugin don't load the commands twice by adding a simple boolean check.
      */
     @Override
     public void registerServerCommands(CommandHandler handler){
     }
 
     /**
      * This method is called when the game register the client-side commands.
-     * Make sure your plugin don't load the commands twice by adding a simple boolean check.
      */
     @Override
     public void registerClientCommands(CommandHandler handler){