Add spotless for codestyle (#410)

* Add spotless for codestyle * Fix license header file * Bump Gradle from 8.10.2 to 8.11
jonesdevelopment · Nov 11, 2024 · ff9216c · ff9216c
1 parent 43a1aa2
commit ff9216c
Show file tree

Hide file tree

Showing 15 changed files with 56 additions and 64 deletions.
diff --git a/HEADER b/HEADER
@@ -1,5 +1,5 @@
 /*
- * Copyright (C) ${YEAR} Sonar Contributors
+ * Copyright (C) 2024 Sonar Contributors
  *
  * This program is free software: you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
@@ -14,3 +14,4 @@
  * You should have received a copy of the GNU General Public License
  * along with this program.  If not, see <https://www.gnu.org/licenses/>.
  */
+
diff --git a/api/build.gradle.kts b/api/build.gradle.kts
@@ -14,6 +14,3 @@ tasks {
     archiveFileName = "sonar-api-${rootProject.version}.jar"
   }
 }
-
-java.sourceCompatibility = JavaVersion.VERSION_11
-java.targetCompatibility = JavaVersion.VERSION_11
diff --git a/api/src/main/java/xyz/jonesdev/sonar/api/Sonar.java b/api/src/main/java/xyz/jonesdev/sonar/api/Sonar.java
@@ -75,28 +75,23 @@ public interface Sonar {
 
   void reload();
 
-  @NotNull
-  default SonarVersion getVersion() {
+  @NotNull default SonarVersion getVersion() {
     return SonarVersion.INSTANCE;
   }
 
-  @NotNull
-  default SonarEventManager getEventManager() {
+  @NotNull default SonarEventManager getEventManager() {
     return SonarEventManager.INSTANCE;
   }
 
-  @NotNull
-  default AttackTracker getAttackTracker() {
+  @NotNull default AttackTracker getAttackTracker() {
     return AttackTracker.INSTANCE;
   }
 
-  @NotNull
-  default Fallback getFallback() {
+  @NotNull default Fallback getFallback() {
     return Fallback.INSTANCE;
   }
 
-  @NotNull
-  static Sonar get() {
+  @NotNull static Sonar get() {
     return SonarSupplier.sonar;
   }
 }
diff --git a/api/src/main/java/xyz/jonesdev/sonar/api/fallback/FallbackUser.java b/api/src/main/java/xyz/jonesdev/sonar/api/fallback/FallbackUser.java
@@ -27,23 +27,17 @@
 import java.net.InetAddress;
 
 public interface FallbackUser {
-  @NotNull
-  Channel channel();
+  @NotNull Channel channel();
 
-  @NotNull
-  InetAddress getInetAddress();
+  @NotNull InetAddress getInetAddress();
 
-  @NotNull
-  ProtocolVersion getProtocolVersion();
+  @NotNull ProtocolVersion getProtocolVersion();
 
-  @NotNull
-  SystemTimer getLoginTimer();
+  @NotNull SystemTimer getLoginTimer();
 
-  @NotNull
-  String getFingerprint();
+  @NotNull String getFingerprint();
 
-  @NotNull
-  String getUsername();
+  @NotNull String getUsername();
 
   boolean isForceCaptcha();
 

diff --git a/api/src/main/java/xyz/jonesdev/sonar/api/fallback/captcha/CaptchaGenerator.java b/api/src/main/java/xyz/jonesdev/sonar/api/fallback/captcha/CaptchaGenerator.java
@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2023-2024 Sonar Contributors
+ * Copyright (C) 2024 Sonar Contributors
  *
  * This program is free software: you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by

diff --git a/build.gradle.kts b/build.gradle.kts
@@ -3,7 +3,8 @@ import net.kyori.indra.git.IndraGitExtension
 plugins {
   java
   alias(libs.plugins.shadow)
-  alias(libs.plugins.indra.git) apply true
+  alias(libs.plugins.indra.git)
+  alias(libs.plugins.spotless)
 }
 
 allprojects {
@@ -15,6 +16,7 @@ allprojects {
 
   apply(plugin = "java")
   apply(plugin = "com.gradleup.shadow")
+  apply(plugin = "com.diffplug.spotless")
 
   dependencies {
     compileOnly(rootProject.libs.lombok)
@@ -31,6 +33,17 @@ allprojects {
     compileOnly(rootProject.libs.libby.core)
   }
 
+  spotless {
+    java {
+      endWithNewline()
+      formatAnnotations()
+      removeUnusedImports()
+      trimTrailingWhitespace()
+      indentWithSpaces(2)
+      licenseHeaderFile("../HEADER")
+    }
+  }
+
   tasks {
     shadowJar {
       // Set the file name of the shadowed jar
@@ -80,14 +93,17 @@ allprojects {
         attributes["Git-Commit"] = gitCommit
       }
     }
+
+    java.sourceCompatibility = JavaVersion.VERSION_11
+    java.targetCompatibility = JavaVersion.VERSION_11
   }
 }
 
 tasks {
   // This is a small wrapper tasks to simplify the building process
   register("build-sonar") {
     val subprojects = listOf("api", "captcha", "common", "bukkit", "bungeecord", "velocity")
-    val buildTasks = subprojects.flatMap { listOf("$it:clean", "$it:shadowJar") }
+    val buildTasks = subprojects.flatMap { listOf("$it:clean", "$it:spotlessApply", "$it:shadowJar") }
     dependsOn(buildTasks)
   }
 }
diff --git a/bukkit/build.gradle.kts b/bukkit/build.gradle.kts
@@ -46,6 +46,3 @@ tasks {
     relocate("net.kyori", "xyz.jonesdev.sonar.libs.kyori")
   }
 }
-
-java.sourceCompatibility = JavaVersion.VERSION_11
-java.targetCompatibility = JavaVersion.VERSION_11
diff --git a/bungeecord/build.gradle.kts b/bungeecord/build.gradle.kts
@@ -30,6 +30,3 @@ tasks {
     archiveFileName = "Sonar-Bungee.jar" // Hardcode a shortened version of the name
   }
 }
-
-java.sourceCompatibility = JavaVersion.VERSION_11
-java.targetCompatibility = JavaVersion.VERSION_11
diff --git a/captcha/build.gradle.kts b/captcha/build.gradle.kts
@@ -5,6 +5,3 @@ dependencies {
   testCompileOnly(project(":api"))
   testCompileOnly(rootProject.libs.imagefilters)
 }
-
-java.sourceCompatibility = JavaVersion.VERSION_11
-java.targetCompatibility = JavaVersion.VERSION_11
diff --git a/captcha/src/main/java/xyz/jonesdev/sonar/captcha/filters/CircleInverseFilter.java b/captcha/src/main/java/xyz/jonesdev/sonar/captcha/filters/CircleInverseFilter.java
@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2023-2024 Sonar Contributors
+ * Copyright (C) 2024 Sonar Contributors
  *
  * This program is free software: you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by

diff --git a/common/build.gradle.kts b/common/build.gradle.kts
@@ -3,6 +3,3 @@ dependencies {
   implementation(project(":captcha"))
   compileOnly(rootProject.libs.adventure.nbt)
 }
-
-java.sourceCompatibility = JavaVersion.VERSION_11
-java.targetCompatibility = JavaVersion.VERSION_11
diff --git a/common/src/main/java/xyz/jonesdev/sonar/common/util/ProtocolUtil.java b/common/src/main/java/xyz/jonesdev/sonar/common/util/ProtocolUtil.java
@@ -15,27 +15,6 @@
  * along with this program.  If not, see <https://www.gnu.org/licenses/>.
  */
 
-/*
- * Copyright 2021 Andrew Steinborn
- *
- * Permission is hereby granted, free of charge, to any person obtaining a copy
- * of this software and associated documentation files (the "Software"), to deal
- * in the Software without restriction, including without limitation the rights
- * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
- * of the Software, and to permit persons to whom the Software is furnished to do so,
- * subject to the following conditions:
- *
- * The above copyright notice and this permission notice shall be included in all copies
- * or substantial portions of the Software.
- *
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
- * INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
- * PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
- * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
- * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
- * USE OR OTHER DEALINGS IN THE SOFTWARE.
- */
-
 package xyz.jonesdev.sonar.common.util;
 
 import io.netty.buffer.ByteBuf;
@@ -102,6 +81,27 @@ public static int readVarInt(final @NotNull ByteBuf byteBuf) {
     throw DEBUG ? new DecoderException("Bad VarInt") : QuietDecoderException.INSTANCE;
   }
 
+  /*
+   * Copyright 2021 Andrew Steinborn
+   *
+   * Permission is hereby granted, free of charge, to any person obtaining a copy
+   * of this software and associated documentation files (the "Software"), to deal
+   * in the Software without restriction, including without limitation the rights
+   * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
+   * of the Software, and to permit persons to whom the Software is furnished to do so,
+   * subject to the following conditions:
+   *
+   * The above copyright notice and this permission notice shall be included in all copies
+   * or substantial portions of the Software.
+   *
+   * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
+   * INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
+   * PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+   * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+   * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
+   * USE OR OTHER DEALINGS IN THE SOFTWARE.
+   */
+
   public static void writeVarInt(final @NotNull ByteBuf byteBuf, final int value) {
     // Peel the one and two byte count cases explicitly as they are the most common VarInt sizes
     // that the proxy will write, to improve inlining.

diff --git a/gradle/libs.versions.toml b/gradle/libs.versions.toml
@@ -9,6 +9,7 @@ pluginyml = "0.6.0"
 [plugins]
 indra-git = "net.kyori.indra.git:3.1.3"
 shadow = "com.gradleup.shadow:8.3.5"
+spotless = "com.diffplug.spotless:7.0.0.BETA4"
 pluginyml-bungee = { id = "net.minecrell.plugin-yml.bungee", version.ref = "pluginyml" }
 pluginyml-bukkit = { id = "net.minecrell.plugin-yml.bukkit", version.ref = "pluginyml" }
 

diff --git a/gradle/wrapper/gradle-wrapper.properties b/gradle/wrapper/gradle-wrapper.properties
@@ -1,6 +1,6 @@
 distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
-distributionUrl=https\://services.gradle.org/distributions/gradle-8.10.2-bin.zip
+distributionUrl=https\://services.gradle.org/distributions/gradle-8.11-bin.zip
 networkTimeout=10000
 validateDistributionUrl=true
 zipStoreBase=GRADLE_USER_HOME

diff --git a/gradlew.bat b/gradlew.bat