Added new formatting option to remove successive blank lines.

Author: JeevanJames

src/IniFile/Ini.cs

@@ -354,13 +354,7 @@ public void Format(IniFormatOptions options = null)
                 Section section = this[s];
 
                 // Reset padding for each minor item in the section
-                foreach (MinorIniItem minorItem in section.Items)
-                {
-                    if (minorItem is BlankLine blankLine)
-                        blankLine.Padding.Reset();
-                    else if (minorItem is Comment comment)
-                        comment.Padding.Reset();
-                }
+                FormatMinorItems(section.Items, options.RemoveSuccessiveBlankLines);
 
                 // Insert blank line between sections, if specified by options
                 if (options.EnsureBlankLineBetweenSections)
@@ -377,13 +371,7 @@ public void Format(IniFormatOptions options = null)
                     Property property = section[p];
 
                     // Reset padding for each minor item in the property
-                    foreach (MinorIniItem minorItem in property.Items)
-                    {
-                        if (minorItem is BlankLine blankLine)
-                            blankLine.Padding.Reset();
-                        else if (minorItem is Comment comment)
-                            comment.Padding.Reset();
-                    }
+                    FormatMinorItems(property.Items, options.RemoveSuccessiveBlankLines);
 
                     // Insert blank line between properties, if specified
                     if (options.EnsureBlankLineBetweenProperties)
@@ -409,13 +397,24 @@ public void Format(IniFormatOptions options = null)
             }
 
             // Format any remaining trailing items
-            foreach (MinorIniItem trailingItem in TrailingItems)
+            FormatMinorItems(TrailingItems, options.RemoveSuccessiveBlankLines);
+        }
+
+        private static void FormatMinorItems(IList<MinorIniItem> minorItems, bool removeSuccessiveBlankLines)
+        {
+            foreach (MinorIniItem minorItem in minorItems)
             {
-                if (trailingItem is BlankLine blankLine)
+                if (minorItem is BlankLine blankLine)
                     blankLine.Padding.Reset();
-                else if (trailingItem is Comment comment)
+                else if (minorItem is Comment comment)
                     comment.Padding.Reset();
             }
+
+            for (int i = minorItems.Count - 1; i > 0; i--)
+            {
+                if (minorItems[i] is BlankLine && minorItems[i - 1] is BlankLine)
+                    minorItems.RemoveAt(i);
+            }
         }
     }
 

src/IniFile/IniFile.xml

@@ -35,6 +35,11 @@ public sealed class IniFormatOptions
         /// </summary>
         public bool EnsureBlankLineBetweenProperties { get; set; }
 
+        /// <summary>
+        ///     Removes successive blank lines
+        /// </summary>
+        public bool RemoveSuccessiveBlankLines { get; set; }
+
         /// <summary>
         ///     Default formatting options for INI content.
         /// </summary>

src/IniFile/IniFormatOptions.cs

@@ -0,0 +1,18 @@
+
+
+; This is a comment
+; This is another comment
+
+[Section One]    
+
+Key1 = Value1
+Key2 = Value Two
+
+Key3 = Value Three
+
+
+[Section Two]
+
+Key4 = Value Four
+
+; Trailing comment

tests/IniFile.Tests/Data/Formatted.ini

@@ -0,0 +1,22 @@
+
+
+   ;    This is a comment    
+;This is another comment          
+
+   [  Section One    ]    
+
+Key1   =       Value1   
+      Key2=     Value Two
+
+	Key3   = Value Three  
+
+      
+[ Section Two]
+
+Key4 = Value Four
+
+
+  ; Trailing comment
+
+
+

tests/IniFile.Tests/Data/Unformatted.ini

@@ -19,7 +19,9 @@
   <ItemGroup>
     <None Remove="Data\EmptyProperties.ini" />
     <None Remove="Data\EmptySections.ini" />
+    <None Remove="Data\Formatted.ini" />
     <None Remove="Data\PropertyWithoutSection.ini" />
+    <None Remove="Data\Unformatted.ini" />
     <None Remove="Data\UnrecognizedLine.ini" />
     <None Remove="Players.ini" />
     <None Remove="Sample.json" />
@@ -28,7 +30,9 @@
   <ItemGroup>
     <EmbeddedResource Include="Data\EmptyProperties.ini" />
     <EmbeddedResource Include="Data\EmptySections.ini" />
+    <EmbeddedResource Include="Data\Formatted.ini" />
     <EmbeddedResource Include="Data\PropertyWithoutSection.ini" />
+    <EmbeddedResource Include="Data\Unformatted.ini" />
     <EmbeddedResource Include="Data\UnrecognizedLine.ini" />
     <EmbeddedResource Include="Players.ini" />
   </ItemGroup>

tests/IniFile.Tests/IniFile.Tests.csproj

@@ -90,5 +90,17 @@ public void Empty_properties_are_allowed(string iniContent)
             ini["Section1"]["Key2"].ShouldBe(string.Empty);
             ini["Section2"]["Key4"].ShouldBe(string.Empty);
         }
+
+        [Theory]
+        [EmbeddedResourceContent("IniFile.Tests.Data.Unformatted.ini")]
+        public void Format_ini(string iniContent)
+        {
+            Ini ini = Ini.Load(iniContent);
+
+            ini.Format(new IniFormatOptions { RemoveSuccessiveBlankLines = true });
+            string formatted = ini.ToString();
+
+            formatted.ShouldNotBeNull();
+        }
     }
 }