Formatter keeps now blank lines per default, closes #110

Author: de-jcup

yamleditor-plugin/src/main/java-eclipse/de/jcup/yamleditor/YamlEditor.java

@@ -876,6 +876,7 @@ public void formatSourceCode() {
         config.setScalarStyle(scalarStyle);
         config.setPreventTypeConversion(getPreferences().isPreventingTypeConversionOnFormat());
         config.setRestoreCommentsEnabled(getPreferences().isSourceFormatterRescuingComments());
+        config.setKeepBlankLines(!getPreferences().isSourceFormatterClearingAllBlankLines());
 
         String output = new YamlSourceFormatter().format(code, config);
 

yamleditor-plugin/src/main/java-eclipse/de/jcup/yamleditor/preferences/YamlEditorFormatterPreferencePage.java

@@ -77,6 +77,12 @@ protected void createFieldEditors() {
                 + "(Full line comments will be at same line number as before, comments\n"
                 + "at end of a yaml line are tried to be added at end of those lines again)");
 
+        BooleanFieldEditor clearBlankLinesEditor = new BooleanFieldEditor(P_SOURCE_FORMAT_CLEAR_ALL_BLANK_LINES_ENABLED.getId(),
+                "Clear all blank lines", parent);
+        addField(clearBlankLinesEditor);
+        clearBlankLinesEditor.getDescriptionControl(parent).setToolTipText(
+                "When enabled blank lines will be removed.");
+        
         BooleanFieldEditor tcpOnFormatEditor = new BooleanFieldEditor(P_PREVENT_TYPE_CONVERSION_ON_FORMAT_ENABLED.getId(), "Prevent type conversion", parent);
         addField(tcpOnFormatEditor);
         tcpOnFormatEditor.getDescriptionControl(parent)

yamleditor-plugin/src/main/java-eclipse/de/jcup/yamleditor/preferences/YamlEditorPreferenceConstants.java

@@ -44,6 +44,7 @@ public enum YamlEditorPreferenceConstants implements PreferenceIdentifiable{
 	P_SOURCE_SCALAR_STYLE_ID("sourceFormatScalarStyleId"),
 
 	P_SOURCE_FORMAT_RESCUE_COMMENTS_ENABLED("sourceFormatRescueCommentsEnabled"),
+	P_SOURCE_FORMAT_CLEAR_ALL_BLANK_LINES_ENABLED("sourceFormatClearAllBlankLinesEnabled"),
 
 	P_GO_TEMPLATE_SUPPORT_ENABLED("goTemplateSupportEnabled"),
 

yamleditor-plugin/src/main/java-eclipse/de/jcup/yamleditor/preferences/YamlEditorPreferenceInitializer.java

@@ -65,6 +65,7 @@ public void initializeDefaultPreferences() {
 		store.setDefault(P_SOURCE_FORMAT_LINE_LENGTH.getId(),120);
 		store.setDefault(P_SOURCE_SCALAR_STYLE_ID.getId(), YamlEdtiorFormatterScalarStyle.PLAIN.getId());
 		store.setDefault(P_SOURCE_FORMAT_RESCUE_COMMENTS_ENABLED.getId(), true);
+		store.setDefault(P_SOURCE_FORMAT_CLEAR_ALL_BLANK_LINES_ENABLED.getId(), false);
 
 		store.setDefault(P_GO_TEMPLATE_SUPPORT_ENABLED.getId(), true);
 		store.setDefault(P_PREVENT_TYPE_CONVERSION_ON_FORMAT_ENABLED.getId(), true);

yamleditor-plugin/src/main/java-eclipse/de/jcup/yamleditor/preferences/YamlEditorPreferences.java

@@ -185,6 +185,10 @@ public String getSourceFormatterScalarStyleId() {
     public boolean isSourceFormatterRescuingComments() {
         return getPreferenceStore().getBoolean(P_SOURCE_FORMAT_RESCUE_COMMENTS_ENABLED.getId());
     }
+    
+    public boolean isSourceFormatterClearingAllBlankLines() {
+        return getPreferenceStore().getBoolean(P_SOURCE_FORMAT_CLEAR_ALL_BLANK_LINES_ENABLED.getId());
+    }
 
     public boolean isGoTemplateSupportEnabled() {
         return getPreferenceStore().getBoolean(P_GO_TEMPLATE_SUPPORT_ENABLED.getId());

yamleditor-plugin/src/main/java/de/jcup/yamleditor/script/formatter/DefaultYamlSourceFormatterConfig.java

@@ -21,12 +21,14 @@ public class DefaultYamlSourceFormatterConfig implements YamlSourceFormatterConf
     private static final int DEFAULT_MAX_LINE_LENGTH = 80;
     private static final int DEFAULT_INDENT = 2;
     private static final boolean DEFAULT_RESTORE_COMMENTS_ENABLED =true;
+    private static final boolean DEFAULT_RESTORE_BLANK_LINES_ENABLED =true;
 
     private int indent=DEFAULT_INDENT;
     private int maxLineLength=DEFAULT_MAX_LINE_LENGTH;
     private YamlEdtiorFormatterScalarStyle scalarStyle = DEFAULT_SCALAR_STYLE;
     private boolean restoreCommentsEnabled=DEFAULT_RESTORE_COMMENTS_ENABLED;
     private boolean preventTypeConversion;
+    private boolean keepBlankLines=DEFAULT_RESTORE_BLANK_LINES_ENABLED;
 
     public void setIndent(int indent) {
         this.indent = indent;
@@ -72,4 +74,12 @@ public boolean isPreventingTypeConversion() {
         return preventTypeConversion;
     }
 
+    public void setKeepBlankLines(boolean keep) {
+        this.keepBlankLines=keep;
+    }
+    
+    public boolean isKeepingBlankLines() {
+        return keepBlankLines;
+    }
+
 }

yamleditor-plugin/src/main/java/de/jcup/yamleditor/script/formatter/YamlSourceFormatter.java

@@ -29,10 +29,6 @@
 public class YamlSourceFormatter {
     private static final String START_BLOCK = "---";
 
-    public String format(String source) {
-        return format(source, null);
-    }
-
     public String format(String source, YamlSourceFormatterConfig config) {
         if (config == null) {
             config = new DefaultYamlSourceFormatterConfig();
@@ -41,13 +37,15 @@ public String format(String source, YamlSourceFormatterConfig config) {
 
         /* backup meta info */
         boolean restoreCommentsEnabled = config.isRestoreCommentsEnabled();
+        boolean restoreBlankLines = config.isKeepingBlankLines();
+
         CommentsRescueContext rescueContext = null;
-        if (restoreCommentsEnabled) {
+        if (restoreCommentsEnabled || restoreBlankLines) {
             rescueContext = backupCommentsAndMetaData(source, snakeConfig);
         }
 
         /* parse + pretty print */
-        Yaml yamlParser = createYaml(new DumperOptions(),snakeConfig);
+        Yaml yamlParser = createYaml(new DumperOptions(), snakeConfig);
         Iterable<Object> yamlDocuments = yamlParser.loadAll(source);
         String formatted = formatDocuments(yamlDocuments, snakeConfig);
 
@@ -68,8 +66,54 @@ public String format(String source, YamlSourceFormatterConfig config) {
 
             result = appendOrphanedComments(result, rescueContext, snakeConfig);
         }
-        return result.trim();
+        if (restoreBlankLines) {
+            result = restoreBlankLines(result, rescueContext, snakeConfig);
+        }
+        result = removeLastTrailingNewLine(result);
+        return result;
+
+    }
+
+    private String removeLastTrailingNewLine(String formatted) {
+        if (!formatted.endsWith("\n")) {
+            return formatted;
+        }
+        return formatted.substring(0, formatted.length() - 1);
+    }
+
+    private String restoreBlankLines(String formatted, CommentsRescueContext rescueContext, SnakeYamlConfig snakeConfig) {
+        String[] originLines = rescueContext.originSourceLines;
+        if (originLines == null || originLines.length == 0) {
+            return formatted;
+        }
+        List<Integer> numberListForBlankLines = new ArrayList<Integer>();
+        int i = -1; // -1 so we start inside with 0 when doing i++
+        for (String originLine : originLines) {
+            i++;
+            if (originLine.trim().length() > 0) {
+                continue;
+            }
+            numberListForBlankLines.add(Integer.valueOf(i));
+        }
+        if (numberListForBlankLines.isEmpty()) {
+            /* no blank lines detected... */
+            return formatted;
+        }
+
+        String[] linesFormatted = formatted.split("\n");
 
+        StringBuilder sb = new StringBuilder();
+        int lineNr = 0;
+        for (String line : linesFormatted) {
+            while (numberListForBlankLines.contains(Integer.valueOf(lineNr))) {
+                sb.append("\n");
+                lineNr++;
+            }
+            sb.append(line);
+            sb.append("\n");
+            lineNr++;
+        }
+        return sb.toString();
     }
 
     private String appendOrphanedComments(String result, CommentsRescueContext context, SnakeYamlConfig internalConfig) {
@@ -79,9 +123,9 @@ private String appendOrphanedComments(String result, CommentsRescueContext conte
         StringBuilder sb = new StringBuilder();
         sb.append(result.trim());
         sb.append("\n");
-        sb.append("# ----------------\n");
-        sb.append("# Orphan comments:\n");
-        sb.append("# ----------------\n");
+        sb.append("# ------------------\n");
+        sb.append("# Orphaned comments:\n");
+        sb.append("# ------------------\n");
         for (CommentMarker marker : context.commentMarkers) {
             if (marker.fullLine) {
                 sb.append("# Was at begin of line:" + marker.lineNr + " :");
@@ -351,7 +395,7 @@ private String formatDocuments(Iterable<Object> documents, SnakeYamlConfig confi
         options.setPrettyFlow(config.isPrettyFlow());
         options.setDefaultScalarStyle(config.getScalarStyle());
 
-        Yaml yaml = createYaml(options,config);
+        Yaml yaml = createYaml(options, config);
 
         StringBuilder sb = new StringBuilder();
 
@@ -368,13 +412,13 @@ private String formatDocuments(Iterable<Object> documents, SnakeYamlConfig confi
 
     private Yaml createYaml(DumperOptions options, SnakeYamlConfig config) {
         Resolver resolver = null;
-        
-        if (config!=null && config.isPreventingTypeConversionOnFormat()) {
+
+        if (config != null && config.isPreventingTypeConversionOnFormat()) {
             resolver = new TypeConversionPreventionSnakeYamlResolver();
-        }else {
+        } else {
             resolver = new Resolver();
         }
-        
+
         return new Yaml(new Constructor(), new Representer(), options, new LoaderOptions(), resolver);
     }
 

yamleditor-plugin/src/main/java/de/jcup/yamleditor/script/formatter/YamlSourceFormatterConfig.java

@@ -27,4 +27,6 @@ public interface YamlSourceFormatterConfig {
 
     boolean isPreventingTypeConversion();
 
+    boolean isKeepingBlankLines();
+    
 }