Implement comments for maps and collections with snakeyaml

core/pom.xml

@@ -6,9 +6,9 @@
     <parent>
         <groupId>eu.okaeri</groupId>
         <artifactId>okaeri-configs</artifactId>
-        <version>4.0.6</version>
+        <version>4.0.7-SNAPSHOT</version>
     </parent>
     <artifactId>okaeri-configs-core</artifactId>
-    <version>4.0.6</version>
+    <version>4.0.7-SNAPSHOT</version>
 
 </project>

core/src/main/java/eu/okaeri/configs/postprocessor/ConfigPostprocessor.java

@@ -128,6 +128,15 @@ public ConfigPostprocessor updateLinesKeys(@NonNull ConfigSectionWalker walker)
         for (String line : lines) {
 
             int indent = countIndent(line);
+
+            int collectionsStartCount = 0;
+            while (walker.isKeyCollectionStart(line)) {
+                collectionsStartCount++;
+                int collectionStartCharIndex = line.indexOf(walker.getCollectionStartChar());
+                line = line.substring(0, collectionStartCharIndex) + ' ' + line.substring(collectionStartCharIndex + 1);
+                indent += 2;
+            }
+
             int change = indent - lastIndent;
             String key = walker.readName(line);
 
@@ -169,6 +178,12 @@ public ConfigPostprocessor updateLinesKeys(@NonNull ConfigSectionWalker walker)
 
             lastIndent = indent;
             String updatedLine = walker.update(line, currentPath.get(currentPath.size() - 1), currentPath);
+
+            while (collectionsStartCount != 0) {
+                updatedLine = updatedLine.substring(0, indent - collectionsStartCount * 2) + walker.getCollectionStartChar() + updatedLine.substring(indent - collectionsStartCount * 2 + 1);
+                collectionsStartCount--;
+            }
+
             newContext.append(updatedLine).append("\n");
         }
 

core/src/main/java/eu/okaeri/configs/postprocessor/ConfigSectionWalker.java

@@ -8,6 +8,10 @@ public interface ConfigSectionWalker {
 
     boolean isKeyMultilineStart(String line);
 
+    boolean isKeyCollectionStart(String line);
+
+    char getCollectionStartChar();
+
     String readName(String line);
 
     String update(String line, ConfigLineInfo lineInfo, List<ConfigLineInfo> path);

core/src/main/java/eu/okaeri/configs/postprocessor/format/YamlSectionWalker.java

@@ -49,6 +49,17 @@ public boolean isKey(String line) {
         return !name.isEmpty() && (name.charAt(0) != '-') && (name.charAt(0) != '#');
     }
 
+    @Override
+    public boolean isKeyCollectionStart(final String line) {
+        String name = this.readName(line);
+        return name.charAt(0) == '-';
+    }
+
+    @Override
+    public char getCollectionStartChar() {
+        return '-';
+    }
+
     @Override
     public String readName(String line) {
         return line.split(":", 2)[0].trim();

core/src/main/java/eu/okaeri/configs/schema/GenericsDeclaration.java

@@ -145,6 +145,14 @@ public boolean isPrimitive() {
         return this.type.isPrimitive();
     }
 
+    public boolean isMap() {
+        return Map.class.isAssignableFrom(this.type);
+    }
+
+    public boolean isCollection() {
+        return Collection.class.isAssignableFrom(this.type);
+    }
+
     public boolean isPrimitiveWrapper() {
         return PRIMITIVE_WRAPPERS.contains(this.type);
     }
@@ -156,4 +164,11 @@ public boolean isConfig() {
     public boolean hasSubtypes() {
         return (this.subtype != null) && !this.subtype.isEmpty();
     }
+
+    public GenericsDeclaration getSubtype(int index) {
+        if (subtype.size() <= index) {
+            throw new IllegalArgumentException("Cannot find subtype at position " + index);
+        }
+        return subtype.get(index);
+    }
 }

hjson/pom.xml

@@ -6,16 +6,16 @@
     <parent>
         <artifactId>okaeri-configs</artifactId>
         <groupId>eu.okaeri</groupId>
-        <version>4.0.6</version>
+        <version>4.0.7-SNAPSHOT</version>
     </parent>
     <artifactId>okaeri-configs-hjson</artifactId>
-    <version>4.0.6</version>
+    <version>4.0.7-SNAPSHOT</version>
 
     <dependencies>
         <dependency>
             <groupId>eu.okaeri</groupId>
             <artifactId>okaeri-configs-core</artifactId>
-            <version>4.0.6</version>
+            <version>4.0.7-SNAPSHOT</version>
             <scope>compile</scope>
         </dependency>
 

hocon-lightbend/pom.xml

@@ -6,16 +6,16 @@
     <parent>
         <artifactId>okaeri-configs</artifactId>
         <groupId>eu.okaeri</groupId>
-        <version>4.0.6</version>
+        <version>4.0.7-SNAPSHOT</version>
     </parent>
     <artifactId>okaeri-configs-hocon-lightbend</artifactId>
-    <version>4.0.6</version>
+    <version>4.0.7-SNAPSHOT</version>
 
     <dependencies>
         <dependency>
             <groupId>eu.okaeri</groupId>
             <artifactId>okaeri-configs-core</artifactId>
-            <version>4.0.6</version>
+            <version>4.0.7-SNAPSHOT</version>
             <scope>compile</scope>
         </dependency>
 

json-gson/pom.xml

@@ -6,16 +6,16 @@
     <parent>
         <artifactId>okaeri-configs</artifactId>
         <groupId>eu.okaeri</groupId>
-        <version>4.0.6</version>
+        <version>4.0.7-SNAPSHOT</version>
     </parent>
     <artifactId>okaeri-configs-json-gson</artifactId>
-    <version>4.0.6</version>
+    <version>4.0.7-SNAPSHOT</version>
 
     <dependencies>
         <dependency>
             <groupId>eu.okaeri</groupId>
             <artifactId>okaeri-configs-core</artifactId>
-            <version>4.0.6</version>
+            <version>4.0.7-SNAPSHOT</version>
             <scope>compile</scope>
         </dependency>
 

json-simple/pom.xml

@@ -6,16 +6,16 @@
     <parent>
         <artifactId>okaeri-configs</artifactId>
         <groupId>eu.okaeri</groupId>
-        <version>4.0.6</version>
+        <version>4.0.7-SNAPSHOT</version>
     </parent>
     <artifactId>okaeri-configs-json-simple</artifactId>
-    <version>4.0.6</version>
+    <version>4.0.7-SNAPSHOT</version>
 
     <dependencies>
         <dependency>
             <groupId>eu.okaeri</groupId>
             <artifactId>okaeri-configs-core</artifactId>
-            <version>4.0.6</version>
+            <version>4.0.7-SNAPSHOT</version>
             <scope>compile</scope>
         </dependency>
 

pom.xml

@@ -6,7 +6,7 @@
 
     <groupId>eu.okaeri</groupId>
     <artifactId>okaeri-configs</artifactId>
-    <version>4.0.6</version>
+    <version>4.0.7-SNAPSHOT</version>
     <packaging>pom</packaging>
 
     <properties>

serdes-bucket4j/pom.xml

@@ -5,7 +5,7 @@
     <parent>
         <artifactId>okaeri-configs</artifactId>
         <groupId>eu.okaeri</groupId>
-        <version>4.0.6</version>
+        <version>4.0.7-SNAPSHOT</version>
     </parent>
     <modelVersion>4.0.0</modelVersion>
 
@@ -15,7 +15,7 @@
         <dependency>
             <groupId>eu.okaeri</groupId>
             <artifactId>okaeri-configs-core</artifactId>
-            <version>4.0.6</version>
+            <version>4.0.7-SNAPSHOT</version>
         </dependency>
 
         <dependency>

serdes-bukkit/pom.xml

@@ -6,16 +6,16 @@
     <parent>
         <groupId>eu.okaeri</groupId>
         <artifactId>okaeri-configs</artifactId>
-        <version>4.0.6</version>
+        <version>4.0.7-SNAPSHOT</version>
     </parent>
     <artifactId>okaeri-configs-serdes-bukkit</artifactId>
-    <version>4.0.6</version>
+    <version>4.0.7-SNAPSHOT</version>
 
     <dependencies>
         <dependency>
             <groupId>eu.okaeri</groupId>
             <artifactId>okaeri-configs-core</artifactId>
-            <version>4.0.6</version>
+            <version>4.0.7-SNAPSHOT</version>
             <scope>compile</scope>
         </dependency>
 

serdes-bungee/pom.xml

@@ -6,16 +6,16 @@
     <parent>
         <groupId>eu.okaeri</groupId>
         <artifactId>okaeri-configs</artifactId>
-        <version>4.0.6</version>
+        <version>4.0.7-SNAPSHOT</version>
     </parent>
     <artifactId>okaeri-configs-serdes-bungee</artifactId>
-    <version>4.0.6</version>
+    <version>4.0.7-SNAPSHOT</version>
 
     <dependencies>
         <dependency>
             <groupId>eu.okaeri</groupId>
             <artifactId>okaeri-configs-core</artifactId>
-            <version>4.0.6</version>
+            <version>4.0.7-SNAPSHOT</version>
             <scope>compile</scope>
         </dependency>
 

serdes-commons/pom.xml

@@ -5,7 +5,7 @@
     <parent>
         <artifactId>okaeri-configs</artifactId>
         <groupId>eu.okaeri</groupId>
-        <version>4.0.6</version>
+        <version>4.0.7-SNAPSHOT</version>
     </parent>
     <modelVersion>4.0.0</modelVersion>
 
@@ -15,7 +15,7 @@
         <dependency>
             <groupId>eu.okaeri</groupId>
             <artifactId>okaeri-configs-core</artifactId>
-            <version>4.0.6</version>
+            <version>4.0.7-SNAPSHOT</version>
         </dependency>
     </dependencies>
 

serdes-okaeri/pom.xml

@@ -5,7 +5,7 @@
     <parent>
         <artifactId>okaeri-configs</artifactId>
         <groupId>eu.okaeri</groupId>
-        <version>4.0.6</version>
+        <version>4.0.7-SNAPSHOT</version>
     </parent>
     <modelVersion>4.0.0</modelVersion>
 
@@ -15,7 +15,7 @@
         <dependency>
             <groupId>eu.okaeri</groupId>
             <artifactId>okaeri-configs-core</artifactId>
-            <version>4.0.6</version>
+            <version>4.0.7-SNAPSHOT</version>
         </dependency>
 
         <dependency>

validator-jakartaee/pom.xml

@@ -5,7 +5,7 @@
     <parent>
         <artifactId>okaeri-configs</artifactId>
         <groupId>eu.okaeri</groupId>
-        <version>4.0.6</version>
+        <version>4.0.7-SNAPSHOT</version>
     </parent>
     <modelVersion>4.0.0</modelVersion>
 
@@ -15,7 +15,7 @@
         <dependency>
             <groupId>eu.okaeri</groupId>
             <artifactId>okaeri-configs-core</artifactId>
-            <version>4.0.6</version>
+            <version>4.0.7-SNAPSHOT</version>
         </dependency>
 
         <dependency>

validator-okaeri/pom.xml

@@ -5,7 +5,7 @@
     <parent>
         <artifactId>okaeri-configs</artifactId>
         <groupId>eu.okaeri</groupId>
-        <version>4.0.6</version>
+        <version>4.0.7-SNAPSHOT</version>
     </parent>
     <modelVersion>4.0.0</modelVersion>
 
@@ -15,7 +15,7 @@
         <dependency>
             <groupId>eu.okaeri</groupId>
             <artifactId>okaeri-configs-core</artifactId>
-            <version>4.0.6</version>
+            <version>4.0.7-SNAPSHOT</version>
         </dependency>
 
         <dependency>

yaml-bukkit/README.md

@@ -50,10 +50,6 @@ Add dependency to the `maven` section:
 implementation 'eu.okaeri:okaeri-configs-yaml-bukkit:4.0.6'
 ```
 
-## Limitations
-
-- Comments do not work on the elements of Collection or Map.
-
 ## Usage
 
 Please use YamlBukkitConfigurer as your configurer:

yaml-bukkit/pom.xml

@@ -6,16 +6,16 @@
     <parent>
         <groupId>eu.okaeri</groupId>
         <artifactId>okaeri-configs</artifactId>
-        <version>4.0.6</version>
+        <version>4.0.7-SNAPSHOT</version>
     </parent>
     <artifactId>okaeri-configs-yaml-bukkit</artifactId>
-    <version>4.0.6</version>
+    <version>4.0.7-SNAPSHOT</version>
 
     <dependencies>
         <dependency>
             <groupId>eu.okaeri</groupId>
             <artifactId>okaeri-configs-core</artifactId>
-            <version>4.0.6</version>
+            <version>4.0.7-SNAPSHOT</version>
             <scope>compile</scope>
         </dependency>
 

yaml-bukkit/src/main/java/eu/okaeri/configs/yaml/bukkit/YamlBukkitConfigurer.java

@@ -142,6 +142,14 @@ public String update(String line, ConfigLineInfo lineInfo, List<ConfigLineInfo>
                                 return line;
                             }
                             GenericsDeclaration fieldType = field.get().getType();
+                            while (fieldType.isMap() || fieldType.isCollection()) {
+                                if (fieldType.isMap()) {
+                                    fieldType = fieldType.getSubtype(1);
+                                    i++;
+                                } else {
+                                    fieldType = fieldType.getSubtype(0);
+                                }
+                            }
                             if (!fieldType.isConfig()) {
                                 return line;
                             }

yaml-bungee/README.md

@@ -39,10 +39,6 @@ Add dependency to the `maven` section:
 implementation 'eu.okaeri:okaeri-configs-yaml-bungee:4.0.6'
 ```
 
-## Limitations
-
-- Comments do not work on the elements of Collection or Map.
-
 ## Usage
 
 Please use YamlBungeeConfigurer as your configurer:

yaml-bungee/pom.xml

@@ -6,16 +6,16 @@
     <parent>
         <groupId>eu.okaeri</groupId>
         <artifactId>okaeri-configs</artifactId>
-        <version>4.0.6</version>
+        <version>4.0.7-SNAPSHOT</version>
     </parent>
     <artifactId>okaeri-configs-yaml-bungee</artifactId>
-    <version>4.0.6</version>
+    <version>4.0.7-SNAPSHOT</version>
 
     <dependencies>
         <dependency>
             <groupId>eu.okaeri</groupId>
             <artifactId>okaeri-configs-core</artifactId>
-            <version>4.0.6</version>
+            <version>4.0.7-SNAPSHOT</version>
             <scope>compile</scope>
         </dependency>