[json] Allow comments to json formatter (all styles)

hazendaz · May 29, 2024 · 0eb933b · 0eb933b
1 parent 97825d4
commit 0eb933b
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 0 deletions.
diff --git a/src/main/java/net/revelc/code/formatter/json/JsonFormatter.java b/src/main/java/net/revelc/code/formatter/json/JsonFormatter.java
@@ -52,6 +52,7 @@ public void init(final Map<String, String> options, final ConfigurationSource cf
         final var lineEnding = options.getOrDefault("lineending", System.lineSeparator());
         final var spaceBeforeSeparator = Boolean.parseBoolean(options.getOrDefault("spaceBeforeSeparator", "true"));
         final var useAlphabeticalOrder = Boolean.parseBoolean(options.getOrDefault("alphabeticalOrder", "false"));
+        final var allowComments = Boolean.parseBoolean(options.getOrDefault("allowComments", "false"));
 
         // Setup a pretty printer with an indenter (indenter has 4 spaces in this case)
         final DefaultPrettyPrinter.Indenter indenter = new DefaultIndenter(" ".repeat(indent), lineEnding);
@@ -78,6 +79,10 @@ public DefaultPrettyPrinter withSeparators(final Separators separators) {
         this.formatter = new ObjectMapper();
         this.formatter.setDefaultPrettyPrinter(printer);
         this.formatter.enable(SerializationFeature.INDENT_OUTPUT);
+        if (allowComments) {
+            this.formatter.enable(JsonParser.Feature.ALLOW_COMMENTS);
+            this.formatter.enable(JsonParser.Feature.ALLOW_YAML_COMMENTS);
+        }
         this.formatter.configure(SerializationFeature.ORDER_MAP_ENTRIES_BY_KEYS, useAlphabeticalOrder);
         this.options = options;
     }

diff --git a/src/main/resources/formatter-maven-plugin/jackson/json.properties b/src/main/resources/formatter-maven-plugin/jackson/json.properties
@@ -15,3 +15,4 @@
 indent=4
 spaceBeforeSeparator=true
 alphabeticalOrder=false
+allowComments=false