Merge pull request #747 from polterguy/issue-746

Allow setting the newline character when serializing +semver:feature
aaubry · Dec 1, 2022 · 48466e7 · 48466e7
2 parents eb821bf + a989db3
commit 48466e7
Show file tree

Hide file tree

Showing 5 changed files with 102 additions and 8 deletions.
diff --git a/YamlDotNet.Test/Serialization/SerializationTests.cs b/YamlDotNet.Test/Serialization/SerializationTests.cs
@@ -272,6 +272,60 @@ public void SerializeCustomTags()
             result.Should().Be(expectedResult);
         }
 
+        [Fact]
+        public void SerializeWithCRLFNewLine()
+        {
+            var expectedResult = Yaml
+                .ReaderFrom("list.yaml")
+                .ReadToEnd()
+                .NormalizeNewLines()
+                .Replace(Environment.NewLine, "\r\n");
+
+            var list = new string[] {"one", "two", "three"};
+            var result = SerializerBuilder
+                .WithNewLine("\r\n")
+                .Build()
+                .Serialize(list);
+
+            result.Should().Be(expectedResult);
+        }
+
+        [Fact]
+        public void SerializeWithLFNewLine()
+        {
+            var expectedResult = Yaml
+                .ReaderFrom("list.yaml")
+                .ReadToEnd()
+                .NormalizeNewLines()
+                .Replace(Environment.NewLine, "\n");
+
+            var list = new string[] {"one", "two", "three"};
+            var result = SerializerBuilder
+                .WithNewLine("\n")
+                .Build()
+                .Serialize(list);
+
+            result.Should().Be(expectedResult);
+        }
+
+        [Fact]
+        public void SerializeWithCRNewLine()
+        {
+            var expectedResult = Yaml
+                .ReaderFrom("list.yaml")
+                .ReadToEnd()
+                .NormalizeNewLines()
+                .Replace(Environment.NewLine, "\r");
+
+            var list = new string[] {"one", "two", "three"};
+            var result = SerializerBuilder
+                .WithNewLine("\r")
+                .Build()
+                .Serialize(list);
+
+            result.Should().Be(expectedResult);
+        }
+
         [Fact]
         public void DeserializeExplicitType()
         {

diff --git a/YamlDotNet.Test/files/list.yaml b/YamlDotNet.Test/files/list.yaml
@@ -1,3 +1,3 @@
 - one
 - two
-- three
+- three
diff --git a/YamlDotNet/Core/Emitter.cs b/YamlDotNet/Core/Emitter.cs
@@ -66,6 +66,7 @@ public class Emitter : IEmitter
         private bool isWhitespace;
         private bool isIndentation;
         private readonly bool forceIndentLess;
+        private readonly string newLine;
 
         private bool isDocumentEndWritten;
 
@@ -147,6 +148,7 @@ public Emitter(TextWriter output, EmitterSettings settings)
             this.maxSimpleKeyLength = settings.MaxSimpleKeyLength;
             this.skipAnchorName = settings.SkipAnchorName;
             this.forceIndentLess = !settings.IndentSequences;
+            this.newLine = settings.NewLine;
 
             this.output = output;
             this.outputUsesUnicodeEncoding = IsUnicode(output.Encoding);
@@ -1917,7 +1919,7 @@ private void WriteBreak(char breakCharacter = '\n')
         {
             if (breakCharacter == '\n')
             {
-                output.WriteLine();
+                output.Write(newLine);
             }
             else
             {

diff --git a/YamlDotNet/Core/EmitterSettings.cs b/YamlDotNet/Core/EmitterSettings.cs
@@ -35,6 +35,11 @@ public sealed class EmitterSettings
         /// </summary>
         public int BestWidth { get; } = int.MaxValue;
 
+        /// <summary>
+        /// New line characters.
+        /// </summary>
+        public string NewLine { get; } = Environment.NewLine;
+
         /// <summary>
         /// If true, write the output in canonical form.
         /// </summary>
@@ -64,7 +69,7 @@ public EmitterSettings()
         {
         }
 
-        public EmitterSettings(int bestIndent, int bestWidth, bool isCanonical, int maxSimpleKeyLength, bool skipAnchorName = false, bool indentSequences = false)
+        public EmitterSettings(int bestIndent, int bestWidth, bool isCanonical, int maxSimpleKeyLength, bool skipAnchorName = false, bool indentSequences = false, string? newLine = null)
         {
             if (bestIndent < 2 || bestIndent > 9)
             {
@@ -87,6 +92,7 @@ public EmitterSettings(int bestIndent, int bestWidth, bool isCanonical, int maxS
             MaxSimpleKeyLength = maxSimpleKeyLength;
             SkipAnchorName = skipAnchorName;
             IndentSequences = indentSequences;
+            NewLine = newLine ?? Environment.NewLine;
         }
 
         public EmitterSettings WithBestIndent(int bestIndent)
@@ -96,7 +102,9 @@ public EmitterSettings WithBestIndent(int bestIndent)
                 BestWidth,
                 IsCanonical,
                 MaxSimpleKeyLength,
-                SkipAnchorName
+                SkipAnchorName,
+                IndentSequences,
+                NewLine
             );
         }
 
@@ -107,7 +115,9 @@ public EmitterSettings WithBestWidth(int bestWidth)
                 bestWidth,
                 IsCanonical,
                 MaxSimpleKeyLength,
-                SkipAnchorName
+                SkipAnchorName,
+                IndentSequences,
+                NewLine
             );
         }
 
@@ -118,7 +128,22 @@ public EmitterSettings WithMaxSimpleKeyLength(int maxSimpleKeyLength)
                 BestWidth,
                 IsCanonical,
                 maxSimpleKeyLength,
-                SkipAnchorName
+                SkipAnchorName,
+                IndentSequences,
+                NewLine
+            );
+        }
+
+        public EmitterSettings WithNewLine(string newLine)
+        {
+            return new EmitterSettings(
+                BestIndent,
+                BestWidth,
+                IsCanonical,
+                MaxSimpleKeyLength,
+                SkipAnchorName,
+                IndentSequences,
+                newLine
             );
         }
 
@@ -140,7 +165,9 @@ public EmitterSettings WithoutAnchorName()
                 BestWidth,
                 IsCanonical,
                 MaxSimpleKeyLength,
-                true
+                true,
+                IndentSequences,
+                NewLine
             );
         }
 
@@ -152,7 +179,8 @@ public EmitterSettings WithIndentedSequences()
                 IsCanonical,
                 MaxSimpleKeyLength,
                 SkipAnchorName,
-                true
+                true,
+                NewLine
             );
         }
     }

diff --git a/YamlDotNet/Serialization/SerializerBuilder.cs b/YamlDotNet/Serialization/SerializerBuilder.cs
@@ -309,6 +309,16 @@ public SerializerBuilder JsonCompatible()
                 .WithEventEmitter(inner => new JsonEventEmitter(inner), loc => loc.InsteadOf<TypeAssigningEventEmitter>());
         }
 
+        /// <summary>
+        /// Allows you to override the new line character to use when serializing to YAML.
+        /// </summary>
+        /// <param name="newLine">NewLine character(s) to use when serializing to YAML.</param>
+        public SerializerBuilder WithNewLine(string newLine)
+        {
+            this.emitterSettings = this.emitterSettings.WithNewLine(newLine);
+            return this;
+        }
+
         /// <summary>
         /// Registers an additional <see cref="IObjectGraphVisitor{Nothing}" /> to be used by the serializer
         /// before emitting an object graph.
-Original file line number
+Diff line change
@@ -1,3 +1,3 @@
     - one
     - two
-    - three
+    - three