add side comments

Author: J4C0B3Y

core/src/main/java/net/j4c0b3y/api/config/ConfigDocument.java

@@ -3,6 +3,8 @@
 import dev.dejvokep.boostedyaml.YamlDocument;
 import dev.dejvokep.boostedyaml.block.Block;
 import dev.dejvokep.boostedyaml.block.Comments;
+import dev.dejvokep.boostedyaml.block.Comments.Position;
+import dev.dejvokep.boostedyaml.libs.org.snakeyaml.engine.v2.comments.CommentLine;
 import dev.dejvokep.boostedyaml.route.Route;
 import dev.dejvokep.boostedyaml.settings.dumper.DumperSettings;
 import dev.dejvokep.boostedyaml.utils.format.NodeRole;
@@ -116,7 +118,7 @@ public void wipeComments(Block<?> block) {
      */
     protected void setComment(Block<?> block, StaticConfig.Comment comment) {
         if (comment != null) {
-            setComment(block, Arrays.asList(comment.value()));
+            setComment(block, Arrays.asList(comment.value()), comment.side());
         }
     }
 
@@ -126,12 +128,15 @@ protected void setComment(Block<?> block, StaticConfig.Comment comment) {
      * @param block The block to set the comment for.
      * @param comment The comment list.
      */
-    protected void setComment(Block<?> block, List<String> comment) {
-        List<String> lines = comment.stream()
-            .map(line -> " " + line)
+    protected void setComment(Block<?> block, List<String> comment, boolean side) {
+        Position position = side ? Position.INLINE : Position.BEFORE;
+        NodeRole role = side ? NodeRole.VALUE : NodeRole.KEY;
+
+        List<CommentLine> lines = comment.stream()
+            .map(line -> Comments.create(" " + line, position))
             .collect(Collectors.toList());
 
-        block.setComments(lines);
+        Comments.set(block, role, position, lines);
     }
 
     /**

core/src/main/java/net/j4c0b3y/api/config/StaticConfig.java

@@ -10,6 +10,7 @@
 import net.j4c0b3y.api.config.provider.context.LoadContext;
 import net.j4c0b3y.api.config.provider.context.SaveContext;
 import net.j4c0b3y.api.config.utils.ClassUtils;
+import net.j4c0b3y.api.config.utils.Pair;
 
 import java.io.File;
 import java.io.IOException;
@@ -71,7 +72,7 @@ public abstract class StaticConfig {
     /**
      * A map of custom comments to add to fields.
      */
-    private final Map<String, List<String>> comments = new HashMap<>();
+    private final Map<String, Pair<List<String>, Boolean>> comments = new HashMap<>();
 
     /**
      * If the last load operation was successful.
@@ -390,14 +391,25 @@ private void relocate() {
         });
     }
 
+    /**
+     * Adds a custom comment to a route in the document.
+     *
+     * @param route The route.
+     * @param side If the comment is on the side.
+     * @param comment The comment.
+     */
+    protected void setComment(String route, boolean side, String ...comment) {
+        comments.put(route, new Pair<>(Arrays.asList(comment), side));
+    }
+
     /**
      * Adds a custom comment to a route in the document.
      *
      * @param route The route.
      * @param comment The comment.
      */
     protected void setComment(String route, String ...comment) {
-        comments.put(route, Arrays.asList(comment));
+        setComment(route, false, comment);
     }
 
     /**
@@ -411,7 +423,7 @@ private void setComments() {
             List<String> comments = block.getComments();
             if (comments != null && !comments.isEmpty()) return;
 
-            document.setComment(block, comment);
+            document.setComment(block, comment.getLeft(), comment.getRight());
         });
     }
 
@@ -458,6 +470,7 @@ private String getRoute(Key key, String name) {
     @Target({ElementType.TYPE, ElementType.FIELD})
     protected @interface Comment {
         String[] value();
+        boolean side() default false;
     }
 
     /**

core/src/main/java/net/j4c0b3y/api/config/utils/Pair.java

@@ -0,0 +1,16 @@
+package net.j4c0b3y.api.config.utils;
+
+import lombok.Getter;
+import lombok.RequiredArgsConstructor;
+
+/**
+ * @author J4C0B3Y
+ * @version ConfigAPI
+ * @since 7/02/2025
+ */
+@Getter
+@RequiredArgsConstructor
+public class Pair<L, R> {
+    private final L left;
+    private final R right;
+}