build: Add simple spotless checks for import order and annotations

Author: zml2008

.checkstyle/checkstyle.xml

@@ -271,6 +271,8 @@
         <module name="CustomImportOrder">
             <property name="sortImportsInGroupAlphabetically" value="true"/>
             <property name="separateLineBetweenGroups" value="true"/>
+            <property name="standardPackageRegExp" value="^java\."/>
+            <property name="specialImportsRegExp" value="^javax\."/>
             <!-- Sponge - Custom import order -->
             <property name="customImportOrderRules" value="STATIC###THIRD_PARTY_PACKAGE###STANDARD_JAVA_PACKAGE###SPECIAL_IMPORTS"/>
             <property name="tokens" value="IMPORT, STATIC_IMPORT, PACKAGE_DEF"/>

.editorconfig

@@ -0,0 +1,15 @@
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+indent_size = 4
+indent_style = space
+insert_final_newline = true
+max_line_length = 150
+tab_width = 4
+
+[*.java]
+ij_java_imports_layout = $*,|,*,|,java.**,|,javax.**
+ij_java_insert_inner_class_imports = false
+ij_java_layout_static_imports_separately = true

build.gradle.kts

@@ -244,7 +244,7 @@ spongeConvention {
 
 indra {
     val checkstyleVersion: String by project
-    
+
     javaVersions {
         testWith(8, 11, 17)
     }
@@ -263,6 +263,22 @@ indraCrossdoc {
     baseUrl(providers.gradleProperty("javadocPublishRoot"))
 }
 
+spotless {
+    java {
+        endWithNewline()
+        indentWithSpaces(4)
+        trimTrailingWhitespace()
+        toggleOffOn("@formatter:off", "@formatter:on")
+        formatAnnotations()
+        importOrderFile(rootProject.file("extra/eclipse/sponge_eclipse.importorder"))
+    }
+    kotlinGradle {
+        endWithNewline()
+        indentWithSpaces(4)
+        trimTrailingWhitespace()
+    }
+}
+
 val sortClasses = listOf(
         "org.spongepowered.api.advancement.AdvancementTypes",
         "org.spongepowered.api.advancement.criteria.trigger.Triggers",
@@ -389,4 +405,4 @@ val sortClasses = listOf(
         "org.spongepowered.api.world.schematic.PaletteTypes",
         "org.spongepowered.api.world.teleport.TeleportHelperFilters",
         "org.spongepowered.api.world.weather.WeatherTypes"
-)
+)

src/ap/java/org/spongepowered/plugin/processor/ListenerParameterAnnotation.java

@@ -35,6 +35,7 @@
 import java.util.HashMap;
 import java.util.Map;
 import java.util.Set;
+
 import javax.lang.model.element.AnnotationValue;
 import javax.lang.model.element.Element;
 import javax.lang.model.element.ElementKind;

src/ap/java/org/spongepowered/plugin/processor/ListenerProcessor.java

@@ -37,6 +37,7 @@
 import java.util.List;
 import java.util.Map;
 import java.util.Set;
+
 import javax.annotation.processing.AbstractProcessor;
 import javax.annotation.processing.RoundEnvironment;
 import javax.annotation.processing.SupportedAnnotationTypes;

src/ap/java/org/spongepowered/plugin/processor/ParameterContext.java

@@ -28,6 +28,7 @@
 
 import java.util.Objects;
 import java.util.Optional;
+
 import javax.annotation.processing.ProcessingEnvironment;
 import javax.lang.model.element.AnnotationMirror;
 import javax.lang.model.element.AnnotationValue;

src/ap/java/org/spongepowered/plugin/processor/ProcessorUtils.java

@@ -28,6 +28,7 @@
 
 import java.util.Collection;
 import java.util.List;
+
 import javax.lang.model.element.Element;
 import javax.lang.model.element.ElementKind;
 import javax.lang.model.element.TypeElement;

src/main/java/org/spongepowered/api/ResourceKey.java

@@ -74,8 +74,7 @@ public interface ResourceKey extends Key {
      * @param value The value
      * @return A new resource key
      */
-    @NonNull
-    static ResourceKey brigadier(final String value) {
+    static @NonNull ResourceKey brigadier(final String value) {
         return ResourceKey.of(ResourceKey.BRIGADIER_NAMESPACE, value);
     }
 
@@ -85,8 +84,7 @@ static ResourceKey brigadier(final String value) {
      * @param value The value
      * @return A new resource key
      */
-    @NonNull
-    static ResourceKey minecraft(final String value) {
+    static @NonNull ResourceKey minecraft(final String value) {
         return ResourceKey.of(ResourceKey.MINECRAFT_NAMESPACE, value);
     }
 
@@ -96,8 +94,7 @@ static ResourceKey minecraft(final String value) {
      * @param value The value
      * @return A new resource key
      */
-    @NonNull
-    static ResourceKey sponge(final String value) {
+    static @NonNull ResourceKey sponge(final String value) {
         return ResourceKey.of(ResourceKey.SPONGE_NAMESPACE, value);
     }
 
@@ -166,7 +163,7 @@ default String asString() {
     }
 
     @Override
-    default int compareTo(Key o) {
+    default int compareTo(final Key o) {
         return Key.super.compareTo(o);
     }
 
@@ -195,7 +192,7 @@ interface Builder extends org.spongepowered.api.util.Builder<ResourceKey, Builde
          * @param container The plugin container to fetch from
          * @return This builder, for chaining
          */
-        default Builder namespace(PluginContainer container) {
+        default Builder namespace(final PluginContainer container) {
             return this.namespace(container.metadata().id());
         }
 

src/main/java/org/spongepowered/api/block/entity/BlockEntityType.java

@@ -47,4 +47,3 @@ public interface BlockEntityType extends DefaultedRegistryValue {
      */
     boolean isValidBlock(BlockState block);
 }
-

src/main/java/org/spongepowered/api/command/parameter/CommonParameters.java

@@ -39,7 +39,7 @@
  * used when creating commands and retrieving elements. A general workflow for
  * defining a command with a {@link ServerPlayer} parameter may look like this:
  * </p>
- * 
+ *
  * <pre> {@code
  * final Parameter.Value<ServerPlayer> parameter = Parameter.player().setKey("player").build();
  * final Command.Parameterized builder = Command.builder()
@@ -51,9 +51,9 @@
  * // registration happens here.
  * }</pre>
  *
- * <p>While this is a totally valid approach, there are two particular 
+ * <p>While this is a totally valid approach, there are two particular
  * considerations that can be made:</p>
- * 
+ *
  * <ul>
  *     <li>Sponge provided {@link ValueParameter}s and, by extension,
  *     {@link Parameter.Value}s are stateless and so can be reused by multiple
@@ -67,7 +67,7 @@
  * </ul>
  *
  * <p>Given these two considerations, it generally makes sense to store one
- * {@link Parameter.Value} for a given {@link ValueParameter} and 
+ * {@link Parameter.Value} for a given {@link ValueParameter} and
  * {@link Parameter.Key} combination. Further, it is clear that plugins will
  * tend to use similar, if not the same, parameter/key combinations.</p>
  *

src/main/java/org/spongepowered/api/data/persistence/DataFormat.java

@@ -41,7 +41,7 @@ public interface DataFormat extends DefaultedRegistryValue {
     /**
      * Creates a new {@link DataContainer} from the contents of the given
      * {@link InputStream}.
-     * 
+     *
      * @param input The input stream
      * @return A data container representing the contents of the input stream
      * @throws InvalidDataFormatException If the data in the stream was not a
@@ -53,7 +53,7 @@ public interface DataFormat extends DefaultedRegistryValue {
     /**
      * Writes the given {@link DataView} to the given {@link OutputStream} using
      * the format specified by this {@link DataFormat}.
-     * 
+     *
      * @param output The output stream to write the data to
      * @param data The DataView to write to the stream
      * @throws IOException If there was an error writing to the stream

src/main/java/org/spongepowered/api/datapack/DataPackType.java

@@ -44,7 +44,7 @@ public interface DataPackType<T> {
      * is no longer present (or no longer performs a registration in {@link RegisterDataPackValueEvent}
      *
      * <p>Consult your implementation vendor for more details on exactly what resources are kept.</p>
-     * 
+     *
      * @return True if persistent, false if not
      */
     boolean persistent();

src/main/java/org/spongepowered/api/event/Cause.java

@@ -249,7 +249,7 @@ public Optional<?> after(final Class<?> clazz) {
 
     /**
      * Returns whether the target class matches any object of this {@link Cause}.
-     * 
+     *
      * @param target The class of the target type
      * @return True if found, false otherwise
      */

src/main/java/org/spongepowered/api/event/CauseStackManager.java

@@ -33,11 +33,11 @@
  * information for events being thrown. This allows plugins to attach more
  * contextual information to events which may be triggered from their api
  * interactions.
- * 
+ *
  * <p>For example a plugin may wish to push a player into the cause stack before
  * spawning an entity to expose to any plugin listening for SpawnEntityEvents
  * that the player is the reason that the entity was spawned.</p>
- * 
+ *
  * <p>This system will automatically handle associating a plugin with actions
  * performed inside of event listeners, command executors, and scheduled
  * tasks.</p>
@@ -46,23 +46,23 @@ public interface CauseStackManager {
 
     /**
      * Gets the current {@link Cause} object from the current cause stack.
-     * 
+     *
      * @return A cause of the current stack.
      */
     Cause currentCause();
 
     /**
      * Gets an {@link EventContext} object on the current contextual
      * information.
-     * 
+     *
      * @return The current event context
      */
     EventContext currentContext();
 
     /**
      * Pushes an object to the current cause stack which will associate it with
      * all events through from api actions until it is popped off again.
-     * 
+     *
      * @param obj The object to push to the stack
      * @return The cause stack manager, for chaining
      */
@@ -71,28 +71,28 @@ public interface CauseStackManager {
     /**
      * Pops the most recently pushed cause object off of the stack and returns
      * it.
-     * 
+     *
      * @return The last pushed object
      */
     Object popCause();
 
     /**
      * Pops the most recently <b>n</b> pushed cause objects off of the stack.
-     * 
+     *
      * @param n The number of causes to pop
      */
     void popCauses(int n);
 
     /**
      * Retrieves but does not remove the most recently pushed cause object.
-     * 
+     *
      * @return The last pushed object
      */
     Object peekCause();
 
     /**
      * Pushes a frame of the current cause stack and context state.
-     * 
+     *
      * @return A handle for the frame which must be passed back to pop the frame
      *         from the stack
      */
@@ -101,19 +101,19 @@ public interface CauseStackManager {
     /**
      * Replaces the current cause stack and context with the cause frame at the
      * top of the frame stack.
-     * 
+     *
      * <p>The frame handle is required to ensure that frames are popped of in
      * order and are not left in the stack. If an attempt is made to pop a frame
      * which is not the head of the frame stack then an error will be thrown as
      * this indicates that a frame was not popped properly.</p>
-     * 
+     *
      * @param handle The frame handle to pop
      */
     void popCauseFrame(StackFrame handle);
 
     /**
      * Adds the given object to the current context under the given key.
-     * 
+     *
      * @param key The context key
      * @param value The object
      * @param <T> The type of the value stored with the event context key
@@ -163,7 +163,7 @@ default <T> CauseStackManager addContext(Supplier<EventContextKey<T>> key, Suppl
 
     /**
      * Gets the context value with the given key.
-     * 
+     *
      * @param key The context key
      * @param <T> The type of the value stored with the event context key
      * @return The context object, if present
@@ -183,10 +183,10 @@ default <T> Optional<T> context(Supplier<EventContextKey<T>> key) {
 
     /**
      * Gets the context value with the given key.
-     * 
+     *
      * <p>If the key is not available, {@link NoSuchElementException} will be
      * thrown.</p>
-     * 
+     *
      * @param key The context key
      * @param <T> The type of the value stored with the event context key
      * @return The context object, if present
@@ -220,7 +220,7 @@ default <T> T requireContext(Supplier<EventContextKey<T>> key) {
 
     /**
      * Removes the given context key from the current context.
-     * 
+     *
      * @param key The key to clear
      * @param <T> The type of the value stored with the event context key
      * @return The existing context value, if it was present

src/main/java/org/spongepowered/api/event/Event.java

@@ -56,7 +56,7 @@ public interface Event {
 
     /**
      * Gets the source of the event (the first object in the cause).
-     * 
+     *
      * @return The event source
      */
     default Object source() {
@@ -65,7 +65,7 @@ default Object source() {
 
     /**
      * Gets the context of the event.
-     * 
+     *
      * @return The event context
      */
     default EventContext context() {