Make 'header' parameter nullable in combination ap is (#1682)

* Make 'header' parameter nullable in Combination APIs

Change the header parameter from bool header = false to nullable bool? header = null across Verifier Combination methods and VerifyBase wrappers. Files updated: src/Verify.Expecto/Verifier_Combination.cs, src/Verify.Fixie/Verifier_Combination.cs, src/Verify.MSTest/Verifier_Combination.cs, src/Verify.MSTest/VerifyBase_Combination.cs, src/Verify.TUnit/Verifier_Combination.cs, src/Verify.XunitV3/Verifier_Combination.cs, src/Verify.XunitV3/VerifyBase_Combination.cs. This makes the header argument tri-state (true/false/unspecified) and keeps signature forwarding consistent.

* .

Author: SimonCropp

src/Verify.Expecto/Verifier_Combination.cs

@@ -8,7 +8,7 @@ public static Combination Combination(
         string name,
         bool? captureExceptions = null,
         VerifySettings? settings = null,
-        bool header = false,
+        bool? header = null,
         [CallerFilePath] string sourceFile = "")
     {
         var assembly = Assembly.GetCallingAssembly()!;

src/Verify.Fixie.Tests/CombinationTests.WithHeader.verified.txt

@@ -0,0 +1,21 @@
+{
+  a, b, c    : Result,
+  A, 1, True : a1True,
+  A, 1, False: a1False,
+  A, 2, True : a2True,
+  A, 2, False: a2False,
+  A, 3, True : a3True,
+  A, 3, False: a3False,
+  b, 1, True : b1True,
+  b, 1, False: b1False,
+  b, 2, True : b2True,
+  b, 2, False: b2False,
+  b, 3, True : b3True,
+  b, 3, False: b3False,
+  C, 1, True : c1True,
+  C, 1, False: c1False,
+  C, 2, True : c2True,
+  C, 2, False: c2False,
+  C, 3, True : c3True,
+  C, 3, False: c3False
+}

src/Verify.Fixie.Tests/CombinationTests.cs

@@ -73,6 +73,17 @@ public Task MixedLengths()
                 a, b, c);
     }
 
+    public Task WithHeader()
+    {
+        string[] a = ["A", "b", "C"];
+        int[] b = [1, 2, 3];
+        bool[] c = [true, false];
+        return Combination(header: true)
+            .Verify(
+                (a, b, c) => a.ToLower() + b + c,
+                a, b, c);
+    }
+
     public Task WithException()
     {
         string[] a = ["A", "b", "C"];

src/Verify.Fixie/Verifier_Combination.cs

@@ -6,7 +6,7 @@ public static partial class Verifier
     public static Combination Combination(
         bool? captureExceptions = null,
         VerifySettings? settings = null,
-        bool header = false,
+        bool? header = null,
         [CallerFilePath] string sourceFile = "") =>
         new(
             captureExceptions,

src/Verify.MSTest.Tests/CombinationTests.WithHeader.verified.txt

@@ -0,0 +1,21 @@
+{
+  a, b, c    : Result,
+  A, 1, True : a1True,
+  A, 1, False: a1False,
+  A, 2, True : a2True,
+  A, 2, False: a2False,
+  A, 3, True : a3True,
+  A, 3, False: a3False,
+  b, 1, True : b1True,
+  b, 1, False: b1False,
+  b, 2, True : b2True,
+  b, 2, False: b2False,
+  b, 3, True : b3True,
+  b, 3, False: b3False,
+  C, 1, True : c1True,
+  C, 1, False: c1False,
+  C, 2, True : c2True,
+  C, 2, False: c2False,
+  C, 3, True : c3True,
+  C, 3, False: c3False
+}

src/Verify.MSTest.Tests/CombinationTests.cs

@@ -81,6 +81,18 @@ public Task MixedLengths()
                 a, b, c);
     }
 
+    [TestMethod]
+    public Task WithHeader()
+    {
+        string[] a = ["A", "b", "C"];
+        int[] b = [1, 2, 3];
+        bool[] c = [true, false];
+        return Combination(header: true)
+            .Verify(
+                (a, b, c) => a.ToLower() + b + c,
+                a, b, c);
+    }
+
     [TestMethod]
     public Task WithException()
     {

src/Verify.MSTest/Verifier_Combination.cs

@@ -6,7 +6,7 @@ public static partial class Verifier
     public static Combination Combination(
         bool? captureExceptions = null,
         VerifySettings? settings = null,
-        bool header = false,
+        bool? header = null,
         [CallerFilePath] string sourceFile = "") =>
         new(
             captureExceptions,

src/Verify.MSTest/VerifyBase_Combination.cs

@@ -8,7 +8,7 @@ public partial class VerifyBase
     public Combination Combination(
         bool? captureExceptions = null,
         VerifySettings? settings = null,
-        bool header = false,
+        bool? header = null,
         [CallerFilePath] string sourceFile = "") =>
         Verifier.Combination(captureExceptions, settings ?? settings, header, sourceFile);
 }

src/Verify.NUnit.Tests/CombinationTests.WithHeader.verified.txt

@@ -0,0 +1,21 @@
+{
+  a, b, c    : Result,
+  A, 1, True : a1True,
+  A, 1, False: a1False,
+  A, 2, True : a2True,
+  A, 2, False: a2False,
+  A, 3, True : a3True,
+  A, 3, False: a3False,
+  b, 1, True : b1True,
+  b, 1, False: b1False,
+  b, 2, True : b2True,
+  b, 2, False: b2False,
+  b, 3, True : b3True,
+  b, 3, False: b3False,
+  C, 1, True : c1True,
+  C, 1, False: c1False,
+  C, 2, True : c2True,
+  C, 2, False: c2False,
+  C, 3, True : c3True,
+  C, 3, False: c3False
+}

src/Verify.NUnit.Tests/CombinationTests.cs

@@ -81,6 +81,18 @@ public Task MixedLengths()
                 a, b, c);
     }
 
+    [Test]
+    public Task WithHeader()
+    {
+        string[] a = ["A", "b", "C"];
+        int[] b = [1, 2, 3];
+        bool[] c = [true, false];
+        return Combination(header: true)
+            .Verify(
+                (a, b, c) => a.ToLower() + b + c,
+                a, b, c);
+    }
+
     [Test]
     public Task WithException()
     {