Stop using Configurate interfaces due to issues

Author: RealTriassic

core/build.gradle.kts

@@ -5,9 +5,6 @@ plugins {
 }
 
 dependencies {
-    annotationProcessor(libs.configurate.`interface`.ap)
-    api(libs.configurate.`interface`)
-
     compileOnly(libs.adventure.api)
     compileOnly(libs.adventure.minimessage)
     implementation(libs.cloud.core)

core/src/main/java/dev/triassic/template/configuration/ConfigurationManager.java

@@ -20,7 +20,7 @@
 import java.util.concurrent.atomic.AtomicReference;
 import org.spongepowered.configurate.CommentedConfigurationNode;
 import org.spongepowered.configurate.ConfigurateException;
-import org.spongepowered.configurate.interfaces.InterfaceDefaultOptions;
+import org.spongepowered.configurate.objectmapping.ObjectMapper;
 import org.spongepowered.configurate.objectmapping.meta.Processor;
 import org.spongepowered.configurate.yaml.NodeStyle;
 import org.spongepowered.configurate.yaml.YamlConfigurationLoader;
@@ -33,7 +33,7 @@
  * @param <T> the type of the configuration object
  */
 public record ConfigurationManager<T>(
-    Class<T> clazz,
+    Class<T> configClass,
     YamlConfigurationLoader loader,
     AtomicReference<T> config
 ) {
@@ -50,52 +50,59 @@ public record ConfigurationManager<T>(
     /**
      * Loads the configuration from the path and
      * creates a new {@link ConfigurationManager} instance.
-     * If the configuration file does not exist, it will create a new one with default values.
      *
-     * @param path  the path to the directory containing the configuration file
-     * @param clazz the class type of the configuration object
-     * @param <T>   the type of the configuration object
+     * <p>If the configuration file does not exist, it'll create a new one with default values.</p>
+     *
+     * @param path        the path to the directory containing the configuration file
+     * @param configClass the class type of the configuration object
+     * @param <T>         the type of the configuration object
      * @return a {@link ConfigurationManager} instance containing the loaded configuration
      * @throws IOException if an error occurs while loading the configuration
      */
     public static <T> ConfigurationManager<T> load(
         Path path,
-        final Class<T> clazz,
-        final PlatformType platformType
+        Class<T> configClass,
+        PlatformType platformType
     ) throws IOException {
         path = path.resolve("config.yml");
 
-        final YamlConfigurationLoader loader = YamlConfigurationLoader.builder()
+        ObjectMapper.Factory mapperFactory = ObjectMapper.factoryBuilder()
+            .addProcessor(ExcludePlatform.class, excludePlatform(platformType))
+            .build();
+
+        YamlConfigurationLoader loader = YamlConfigurationLoader.builder()
             .path(path)
             .indent(2)
             .nodeStyle(NodeStyle.BLOCK)
-            .defaultOptions(opts -> InterfaceDefaultOptions.addTo(opts,
-                    builder -> builder.addProcessor(ExcludePlatform.class,
-                        excludePlatform(platformType)))
-                .header(HEADER))
+            .defaultOptions(options -> options
+                .header(HEADER)
+                .serializers(builder ->
+                    builder.registerAnnotatedObjects(mapperFactory))
+            )
             .build();
 
-        final CommentedConfigurationNode root = loader.load();
-        final T config = root.get(clazz);
+        CommentedConfigurationNode root = loader.load();
+        T config = root.get(configClass);
 
         if (Files.notExists(path)) {
             loader.save(root);
         }
 
-        return new ConfigurationManager<>(clazz, loader, new AtomicReference<>(config));
+        return new ConfigurationManager<>(configClass, loader, new AtomicReference<>(config));
     }
 
     /**
      * Asynchronously reloads the configuration from disk.
-     * The current configuration object is updated with the newly loaded data.
+     *
+     * <p>The current configuration object is updated with the newly loaded data.</p>
      *
      * @return a {@link CompletableFuture} that completes when the reload is complete
      */
     public CompletableFuture<Void> reload() {
         return CompletableFuture.runAsync(() -> {
             try {
-                final CommentedConfigurationNode root = loader.load();
-                config.set(root.get(clazz));
+                CommentedConfigurationNode root = loader.load();
+                config.set(root.get(configClass));
             } catch (ConfigurateException e) {
                 throw new CompletionException("Failed to load configuration", e);
             }
@@ -112,7 +119,7 @@ public T get() {
     }
 
     private static Processor.Factory<ExcludePlatform, Object> excludePlatform(
-        final PlatformType platformType
+        PlatformType platformType
     ) {
         return (annotation, fieldType) -> (value, destination) -> {
             for (PlatformType platform : annotation.value()) {

core/src/main/java/dev/triassic/template/configuration/TemplateConfiguration.java

@@ -11,33 +11,22 @@
 
 import dev.triassic.template.annotation.ExcludePlatform;
 import dev.triassic.template.util.PlatformType;
-import org.spongepowered.configurate.interfaces.meta.defaults.DefaultNumeric;
-import org.spongepowered.configurate.interfaces.meta.defaults.DefaultString;
+import lombok.Getter;
 import org.spongepowered.configurate.objectmapping.ConfigSerializable;
 import org.spongepowered.configurate.objectmapping.meta.Comment;
 
 /**
  * Represents the plugin's base configuration file.
  */
+@Getter
 @ConfigSerializable
-public interface TemplateConfiguration {
+@SuppressWarnings("FieldMayBeFinal")
+public class TemplateConfiguration {
 
-    /**
-     * An example string that showcases the usage of {@link ExcludePlatform}.
-     *
-     * <p>Take note of how the {@link ExcludePlatform} annotation goes after
-     * the {@link Comment} annotation, it is important to do it in this order,
-     * otherwise the node will be recreated empty to add the comment.</p>
-     */
     @Comment("This string should not appear on Velocity and Bungeecord platforms.")
-    @DefaultString("This is an example string!")
     @ExcludePlatform({PlatformType.BUNGEECORD, PlatformType.VELOCITY})
-    String exampleString();
+    private String exampleString = "This is an example string!";
 
-    /**
-     * The version of the configuration file.
-     */
     @Comment("Used internally, do not change.")
-    @DefaultNumeric(1)
-    int configVersion();
+    private int configVersion = 1;
 }

gradle/libs.versions.toml

@@ -45,9 +45,6 @@ cloud-neoforge = { group = "org.incendo", name = "cloud-neoforge", version.ref =
 cloud-paper = { group = "org.incendo", name = "cloud-paper", version.ref = "cloud-minecraft" }
 cloud-velocity = { group = "org.incendo", name = "cloud-velocity", version.ref = "cloud-minecraft" }
 
-# Config and YAML Libraries
-configurate-interface-ap = { group = "org.spongepowered", name = "configurate-extra-interface-ap", version.ref = "configurate" }
-configurate-interface = { group = "org.spongepowered", name = "configurate-extra-interface", version.ref = "configurate" }
 configurate-yaml = { group = "org.spongepowered", name = "configurate-yaml", version.ref = "configurate" }
 
 minecraft = { group = "net.minecraft", name = "minecraft", version.ref = "minecraft" }