Add AppendLineN for no string (#582)

SimonCropp · web-flow · commit 4d385fd9c97c · 2022-08-09T13:04:32.000+10:00
diff --git a/src/Directory.Build.props b/src/Directory.Build.props
@@ -2,7 +2,7 @@
 <Project>
   <PropertyGroup>
     <NoWarn>CS1591;CS0649;xUnit1026;xUnit1013;msb3277;CS0436</NoWarn>
-    <Version>17.8.0</Version>
+    <Version>17.8.1</Version>
     <ImplicitUsings>enable</ImplicitUsings>
     <LangVersion>preview</LangVersion>
     <SuppressTfmSupportBuildWarnings>true</SuppressTfmSupportBuildWarnings>
diff --git a/src/Verify/StringBuilderExtensions.cs b/src/Verify/StringBuilderExtensions.cs
@@ -11,7 +11,16 @@ public static void FixNewlines(this StringBuilder builder)
     /// <summary>
     /// Appends a line with a `\n` as the newline character.
     /// </summary>
-    public static StringBuilder AppendLineN(this StringBuilder builder, string value)
+    public static StringBuilder AppendLineN(this StringBuilder builder)
+    {
+        builder.Append('\n');
+        return builder;
+    }
+
+    /// <summary>
+    /// Appends a line with a `\n` as the newline character.
+    /// </summary>
+    public static StringBuilder AppendLineN(this StringBuilder builder, string? value)
     {
         builder.Append(value);
         builder.Append('\n');
diff --git a/src/Verify/Verifier/VerifyExceptionMessageBuilder.cs b/src/Verify/Verifier/VerifyExceptionMessageBuilder.cs
@@ -8,11 +8,11 @@ public static string Build(
         IReadOnlyCollection<FilePair> equal)
     {
         var builder = new StringBuilder($"Directory: {directory}");
-        builder.AppendLine();
+        builder.AppendLineN();
 
         if (@new.Any())
         {
-            builder.AppendLine("New:");
+            builder.AppendLineN("New:");
             foreach (var file in @new)
             {
                 AppendFile(builder, file.File);
@@ -21,7 +21,7 @@ public static string Build(
 
         if (notEquals.Any())
         {
-            builder.AppendLine("NotEqual:");
+            builder.AppendLineN("NotEqual:");
             foreach (var file in notEquals)
             {
                 AppendFile(builder, file.File);
@@ -30,16 +30,16 @@ public static string Build(
 
         if (delete.Any())
         {
-            builder.AppendLine("Delete:");
+            builder.AppendLineN("Delete:");
             foreach (var file in delete)
             {
-                builder.AppendLine($"  - {Path.GetFileName(file)}");
+                builder.AppendLineN($"  - {Path.GetFileName(file)}");
             }
         }
 
         if (equal.Any())
         {
-            builder.AppendLine("Equal:");
+            builder.AppendLineN("Equal:");
             foreach (var file in equal)
             {
                 AppendFile(builder, file);
@@ -53,8 +53,8 @@ public static string Build(
 
     static void AppendFile(StringBuilder builder, FilePair file)
     {
-        builder.AppendLine($"  - Received: {file.ReceivedName}");
-        builder.AppendLine($"    Verified: {file.VerifiedName}");
+        builder.AppendLineN($"  - Received: {file.ReceivedName}");
+        builder.AppendLineN($"    Verified: {file.VerifiedName}");
     }
 
     static void AppendContent(IReadOnlyCollection<NewResult> @new, IReadOnlyCollection<NotEqualResult> notEquals, StringBuilder builder)
@@ -73,32 +73,32 @@ static void AppendContent(IReadOnlyCollection<NewResult> @new, IReadOnlyCollecti
             return;
         }
 
-        builder.AppendLine();
-        builder.AppendLine("FileContent:");
-        builder.AppendLine();
+        builder.AppendLineN();
+        builder.AppendLineN("FileContent:");
+        builder.AppendLineN();
 
         if (newContentFiles.Any())
         {
-            builder.AppendLine("New:");
-            builder.AppendLine();
+            builder.AppendLineN("New:");
+            builder.AppendLineN();
             foreach (var item in newContentFiles)
             {
-                builder.AppendLine($"Received: {item.File.ReceivedName}");
-                builder.AppendLine(item.ReceivedText);
-                builder.AppendLine();
+                builder.AppendLineN($"Received: {item.File.ReceivedName}");
+                builder.AppendLineN(item.ReceivedText);
+                builder.AppendLineN();
             }
         }
 
         if (notEqualContentFiles.Any())
         {
-            builder.AppendLine("NotEqual:");
-            builder.AppendLine();
+            builder.AppendLineN("NotEqual:");
+            builder.AppendLineN();
             foreach (var notEqual in notEqualContentFiles)
             {
                 if (notEqual.File.IsText || notEqual.Message != null)
                 {
                     AppendNotEqualContent(builder, notEqual);
-                    builder.AppendLine();
+                    builder.AppendLineN();
                 }
             }
         }
@@ -110,7 +110,7 @@ static void AppendNotEqualContent(StringBuilder builder, NotEqualResult notEqual
         var message = notEqual.Message;
         if (message is null)
         {
-            builder.AppendLine(
+            builder.AppendLineN(
                 $"""
                 Received: {item.ReceivedName}
                 {notEqual.ReceivedText}
@@ -120,7 +120,7 @@ static void AppendNotEqualContent(StringBuilder builder, NotEqualResult notEqual
         }
         else
         {
-            builder.AppendLine(
+            builder.AppendLineN(
                 $"""
                 Received: {item.ReceivedName}
                 Verified: {item.VerifiedName}

Original file line number	Diff line number	Diff line change
`@@ -8,11 +8,11 @@ public static string Build(`
`8`	`8`	`IReadOnlyCollection<FilePair> equal)`
`9`	`9`	`{`
`10`	`10`	`var builder = new StringBuilder($"Directory: {directory}");`
`11`		`- builder.AppendLine();`
	`11`	`+ builder.AppendLineN();`
`12`	`12`
`13`	`13`	`if (@new.Any())`
`14`	`14`	`{`
`15`		`- builder.AppendLine("New:");`
	`15`	`+ builder.AppendLineN("New:");`
`16`	`16`	`foreach (var file in @new)`
`17`	`17`	`{`
`18`	`18`	`AppendFile(builder, file.File);`
`@@ -21,7 +21,7 @@ public static string Build(`
`21`	`21`
`22`	`22`	`if (notEquals.Any())`
`23`	`23`	`{`
`24`		`- builder.AppendLine("NotEqual:");`
	`24`	`+ builder.AppendLineN("NotEqual:");`
`25`	`25`	`foreach (var file in notEquals)`
`26`	`26`	`{`
`27`	`27`	`AppendFile(builder, file.File);`
`@@ -30,16 +30,16 @@ public static string Build(`
`30`	`30`
`31`	`31`	`if (delete.Any())`
`32`	`32`	`{`
`33`		`- builder.AppendLine("Delete:");`
	`33`	`+ builder.AppendLineN("Delete:");`
`34`	`34`	`foreach (var file in delete)`
`35`	`35`	`{`
`36`		`- builder.AppendLine($" - {Path.GetFileName(file)}");`
	`36`	`+ builder.AppendLineN($" - {Path.GetFileName(file)}");`
`37`	`37`	`}`
`38`	`38`	`}`
`39`	`39`
`40`	`40`	`if (equal.Any())`
`41`	`41`	`{`
`42`		`- builder.AppendLine("Equal:");`
	`42`	`+ builder.AppendLineN("Equal:");`
`43`	`43`	`foreach (var file in equal)`
`44`	`44`	`{`
`45`	`45`	`AppendFile(builder, file);`
`@@ -53,8 +53,8 @@ public static string Build(`
`53`	`53`
`54`	`54`	`static void AppendFile(StringBuilder builder, FilePair file)`
`55`	`55`	`{`
`56`		`- builder.AppendLine($" - Received: {file.ReceivedName}");`
`57`		`- builder.AppendLine($" Verified: {file.VerifiedName}");`
	`56`	`+ builder.AppendLineN($" - Received: {file.ReceivedName}");`
	`57`	`+ builder.AppendLineN($" Verified: {file.VerifiedName}");`
`58`	`58`	`}`
`59`	`59`
`60`	`60`	`static void AppendContent(IReadOnlyCollection<NewResult> @new, IReadOnlyCollection<NotEqualResult> notEquals, StringBuilder builder)`
`@@ -73,32 +73,32 @@ static void AppendContent(IReadOnlyCollection<NewResult> @new, IReadOnlyCollecti`
`73`	`73`	`return;`
`74`	`74`	`}`
`75`	`75`
`76`		`- builder.AppendLine();`
`77`		`- builder.AppendLine("FileContent:");`
`78`		`- builder.AppendLine();`
	`76`	`+ builder.AppendLineN();`
	`77`	`+ builder.AppendLineN("FileContent:");`
	`78`	`+ builder.AppendLineN();`
`79`	`79`
`80`	`80`	`if (newContentFiles.Any())`
`81`	`81`	`{`
`82`		`- builder.AppendLine("New:");`
`83`		`- builder.AppendLine();`
	`82`	`+ builder.AppendLineN("New:");`
	`83`	`+ builder.AppendLineN();`
`84`	`84`	`foreach (var item in newContentFiles)`
`85`	`85`	`{`
`86`		`- builder.AppendLine($"Received: {item.File.ReceivedName}");`
`87`		`- builder.AppendLine(item.ReceivedText);`
`88`		`- builder.AppendLine();`
	`86`	`+ builder.AppendLineN($"Received: {item.File.ReceivedName}");`
	`87`	`+ builder.AppendLineN(item.ReceivedText);`
	`88`	`+ builder.AppendLineN();`
`89`	`89`	`}`
`90`	`90`	`}`
`91`	`91`
`92`	`92`	`if (notEqualContentFiles.Any())`
`93`	`93`	`{`
`94`		`- builder.AppendLine("NotEqual:");`
`95`		`- builder.AppendLine();`
	`94`	`+ builder.AppendLineN("NotEqual:");`
	`95`	`+ builder.AppendLineN();`
`96`	`96`	`foreach (var notEqual in notEqualContentFiles)`
`97`	`97`	`{`
`98`	`98`	`if (notEqual.File.IsText \|\| notEqual.Message != null)`
`99`	`99`	`{`
`100`	`100`	`AppendNotEqualContent(builder, notEqual);`
`101`		`- builder.AppendLine();`
	`101`	`+ builder.AppendLineN();`
`102`	`102`	`}`
`103`	`103`	`}`
`104`	`104`	`}`
`@@ -110,7 +110,7 @@ static void AppendNotEqualContent(StringBuilder builder, NotEqualResult notEqual`
`110`	`110`	`var message = notEqual.Message;`
`111`	`111`	`if (message is null)`
`112`	`112`	`{`
`113`		`- builder.AppendLine(`
	`113`	`+ builder.AppendLineN(`
`114`	`114`	`$"""`
`115`	`115`	`Received: {item.ReceivedName}`
`116`	`116`	`{notEqual.ReceivedText}`
`@@ -120,7 +120,7 @@ static void AppendNotEqualContent(StringBuilder builder, NotEqualResult notEqual`
`120`	`120`	`}`
`121`	`121`	`else`
`122`	`122`	`{`
`123`		`- builder.AppendLine(`
	`123`	`+ builder.AppendLineN(`
`124`	`124`	`$"""`
`125`	`125`	`Received: {item.ReceivedName}`
`126`	`126`	`Verified: {item.VerifiedName}`