changelog & remove YACLConfigManager.java as it was actually pretty useless, document GsonConfigInstance as well

Author: isXander

changelogs/1.7.0.md

@@ -0,0 +1,13 @@
+## End-user changes
+
+- Smooth category scrolling
+- Individual reset buttons for every option
+- Fix bug where option lists that *just* went over into scrolling scrolled extremely slow.
+
+## Developer API changes
+
+- Actual Config API to save and load fields in a class automatically [(documentation)](https://github.com/isXander/YetAnotherConfigLib/wiki/config-api)
+- Separate `Dimension` into `Dimension` and `MutableDimension`
+- Make `dim` private in `AbstractWidget` so mods can't change the dimension without `setDimension`
+- New Option API method `isPendingValueDefault` to check if pending value is equal to default value of binding
+- Fix `Option#requestSetDefault` and `Option#forgetPendingValue` implementations weren't notifying listeners

src/main/java/dev/isxander/yacl/config/ConfigInstance.java

@@ -47,9 +47,7 @@ public Class<T> getConfigClass() {
     }
 
     public YetAnotherConfigLib buildConfig(BiFunction<ConfigInstance<T>, YetAnotherConfigLib.Builder, YetAnotherConfigLib.Builder> builder) {
-        return builder.apply(this, YetAnotherConfigLib.createBuilder())
-                .save(this::save)
-                .build();
+        return builder.apply(this, YetAnotherConfigLib.createBuilder().save(this::save)).build();
     }
 
     public abstract void save();

src/main/java/dev/isxander/yacl/config/GsonConfigInstance.java

@@ -14,10 +14,23 @@
 import java.nio.file.StandardOpenOption;
 import java.util.function.UnaryOperator;
 
+/**
+ * Uses GSON to serialize and deserialize config data from JSON to a file.
+ *
+ * You can exclude fields from serialization by marking them as transient.
+ * {@link Text}, {@link Style} and {@link Color} have default type adapters, so there is no need to provide them in your GSON instance.
+ * GSON is automatically configured to format fields as {@code lower_camel_case}.
+ *
+ * @param <T> config data type
+ */
 public class GsonConfigInstance<T> extends ConfigInstance<T> {
     private final Gson gson;
     private final Path path;
 
+    public GsonConfigInstance(Class<T> configClass, Path path) {
+        this(configClass, path, new GsonBuilder());
+    }
+
     public GsonConfigInstance(Class<T> configClass, Path path, Gson gson) {
         this(configClass, path, gson.newBuilder());
     }

src/main/java/dev/isxander/yacl/config/YACLConfigManager.java

@@ -3,17 +3,19 @@
 import com.google.gson.Gson;
 import dev.isxander.yacl.config.ConfigInstance;
 import dev.isxander.yacl.config.GsonConfigInstance;
-import dev.isxander.yacl.config.YACLConfigManager;
 import net.fabricmc.api.ClientModInitializer;
 import net.fabricmc.loader.api.FabricLoader;
 
 public class Entrypoint implements ClientModInitializer {
+    private static GsonConfigInstance<ConfigData> config;
+
     @Override
     public void onInitializeClient() {
-        YACLConfigManager.register(new GsonConfigInstance<>(ConfigData.class, FabricLoader.getInstance().getConfigDir().resolve("yacl-test.json"), new Gson()));
+        config = new GsonConfigInstance<>(ConfigData.class, FabricLoader.getInstance().getConfigDir().resolve("yacl-test.json"));
+        config.load();
     }
 
     public static ConfigInstance<ConfigData> getConfig() {
-        return YACLConfigManager.getConfigInstance(ConfigData.class);
+        return config;
     }
 }