Siphalor/tweed5
1
0
Fork 0
Code Issues 6 Pull Requests Packages Projects 1 Releases Wiki Activity

[default-extension,serde-hjson] Fix validation interfering with normal comments; improve HJSON comment writing

Browse Source
This commit is contained in:
Siphalor
2025-10-06 22:47:19 +02:00
parent 7c9d4a95bb
commit d06ac7cb7e
4 changed files with 38 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
tweed5-default-extensions/src/main/java/de/siphalor/tweed5/defaultextensions/validation/impl/ValidationExtensionImpl.java
View File

@@ -121,7 +121,7 @@ public class ValidationExtensionImpl implements ReadWriteRelatedExtension, Valid
if (baseComment.isEmpty()) {
return validationDescription;
} else {
return "\n\n" + validationDescription;
return baseComment + "\n\n" + validationDescription;
}
};
}

31
tweed5-default-extensions/src/test/java/de/siphalor/tweed5/defaultextensions/validation/impl/ValidationExtensionImplTest.java
View File

@@ -7,8 +7,10 @@ import de.siphalor.tweed5.core.impl.DefaultConfigContainer;
import de.siphalor.tweed5.core.impl.entry.SimpleConfigEntryImpl;
import de.siphalor.tweed5.core.impl.entry.StaticMapCompoundConfigEntryImpl;
import de.siphalor.tweed5.data.extension.api.ReadWriteExtension;
import de.siphalor.tweed5.data.hjson.HjsonCommentType;
import de.siphalor.tweed5.data.hjson.HjsonLexer;
import de.siphalor.tweed5.data.hjson.HjsonReader;
import de.siphalor.tweed5.data.hjson.HjsonWriter;
import de.siphalor.tweed5.defaultextensions.comment.api.CommentExtension;
import de.siphalor.tweed5.defaultextensions.validation.api.ValidationExtension;
import de.siphalor.tweed5.defaultextensions.validation.api.result.ValidationIssueLevel;
@@ -21,6 +23,7 @@ import org.junit.jupiter.params.ParameterizedTest;
import org.junit.jupiter.params.provider.CsvSource;
import java.io.StringReader;
import java.io.StringWriter;
import java.util.HashMap;
import java.util.LinkedHashMap;
import java.util.List;
@@ -28,8 +31,7 @@ import java.util.Map;
import java.util.concurrent.atomic.AtomicReference;
import java.util.function.Consumer;
import static de.siphalor.tweed5.data.extension.api.ReadWriteExtension.entryReaderWriter;
import static de.siphalor.tweed5.data.extension.api.ReadWriteExtension.read;
import static de.siphalor.tweed5.data.extension.api.ReadWriteExtension.*;
import static de.siphalor.tweed5.data.extension.api.readwrite.TweedEntryReaderWriters.*;
import static de.siphalor.tweed5.defaultextensions.comment.api.CommentExtension.baseComment;
import static de.siphalor.tweed5.defaultextensions.validation.api.ValidationExtension.validators;
@@ -186,6 +188,31 @@ class ValidationExtensionImplTest {
);
}
@Test
void writeWithComments() {
var stringWriter = new StringWriter();
var writer = new HjsonWriter(stringWriter, new HjsonWriter.Options().multilineCommentType(HjsonCommentType.SLASHES));
configContainer.rootEntry().apply(write(writer, Map.of(
"byte", (byte) 123,
"int", 456,
"double", 789.123
)));
assertThat(stringWriter.toString()).isEqualTo("""
{
// Must be inclusively between 11 and 100.
byte: 123
// This is the main comment!
//
// Must be less than or equal to 123.
int: 456
// Must be greater than or equal to 0.5.
double: 789.123
}
""");
}
private static void assertValidationIssue(
ValidationIssues issues,
String expectedPath,

2
tweed5-default-extensions/src/test/java/de/siphalor/tweed5/defaultextensions/validationfallback/impl/ValidationFallbackExtensionImplTest.java
View File

@@ -131,7 +131,7 @@ class ValidationFallbackExtensionImplTest {
"""
// Must not be null.
// Must be between 1 and 6
//\s
//
// Default/Fallback value: 3
5
""", stringWriter.toString());

11
tweed5-serde-hjson/src/main/java/de/siphalor/tweed5/data/hjson/HjsonWriter.java
View File

@@ -293,18 +293,21 @@ public class HjsonWriter implements TweedDataWriter {
private void writeCommentLine(HjsonCommentType commentType, CharSequence text, int begin, int end) {
writeCurrentIndentIfApplicable();
write(getCommentLineStart(commentType));
write(text, begin, end);
if (end > begin) {
write(" ");
write(text, begin, end);
}
writeLineFeed();
}
private CharSequence getCommentLineStart(HjsonCommentType commentType) {
switch (commentType) {
case HASH:
return "# ";
return "#";
case SLASHES:
return "// ";
return "//";
case BLOCK:
return " * ";
return " *";
default:
throw new IllegalStateException("Unknown comment type: " + commentType);
}