- Rename SnapshotHelper to SnapshotTest

- Add SnapshotTestBuilder
- Update file header

Author: xaviersolau

README.md

@@ -494,7 +494,7 @@ var response = await httpClient.GetFromJsonAsync<Person>("target");
 
 ### Snapshot testing
 
-Snapshot testing is a powerful technique for testing text and image outputs. The `SnapshotHelper` class provided in
+Snapshot testing is a powerful technique for testing text and image outputs. The `SnapshotTestBuilder` class provided in
 `SoloX.CodeQuality.Test.Helpers` makes it easy to create and maintain snapshot tests.
 
 Snapshots are stored on disk and compared against test outputs. This is useful for testing scenarios such as:
@@ -504,32 +504,30 @@ Snapshots are stored on disk and compared against test outputs. This is useful f
 
 #### Basic usage
 
-To use the `SnapshotHelper` in your tests, simply create an instance and use its methods to verify outputs:
+To use the `SnapshotTest` in your tests, simply use the `SnapshotTestBuilder` to get an instance and use its methods to verify outputs:
 
 ```csharp
 using SoloX.CodeQuality.Test.Helpers.Snapshot;
 
-var snapshotHelper = new SnapshotHelper();
-
 // For text snapshots
+var snapshotTest = SnapshotTestBuilder
+    .Create()
+    .WithThisFilePathLocation()
+    .WithTextStrategy()
+    .Build();
+
 string generatedOutput = GenerateContent();
-await snapshotHelper.CompareTextSnapshotAsync(nameof(MyTest), generatedOutput);
+await snapshotTest.CompareSnapshotAsync(nameof(MyTest), generatedOutput);
 
 // For image snapshots
-Stream generatedPngImage = GeneratePngImage();
-await snapshotHelper.ComparePngSnapshotAsync(nameof(MyTest), generatedImage);
-```
-
-#### Configuration
-
-You can configure the `SnapshotHelper` with custom options:
+var snapshotTest = SnapshotTestBuilder
+    .Create()
+    .WithThisFilePathLocation()
+    .WithPngStrategy()
+    .Build();
 
-```csharp
-var snapshotHelper = new SnapshotHelper(options =>
-{
-    options.IntermediateFolder = "CustomSnapshotsFolder";
-    options.RootPath = "/path/to/test/project";
-});
+Stream generatedPngImage = GeneratePngImage();
+await snapshotTest.CompareSnapshotAsync(nameof(MyTest), generatedImage);
 ```
 
 The snapshots are stored in a `Snapshots` folder by default and can be reviewed and updated when the expected output changes.

documents/BreakingChanges.md

@@ -9,23 +9,21 @@ The `SnapshotHelper` API has been significantly reworked with breaking changes t
 #### Key Changes
 - **Moved** from `SoloX.CodeQuality.Test.Helpers.XUnit` to `SoloX.CodeQuality.Test.Helpers` project and namespace.
 
-- **Dependency change**: The `SnapshotHelper` class no longer depends on xUnit-specific types, making it more flexible and reusable
+- **Renamed** from `SnapshotHelper` to `SnapshotTest`.
+
+- **Dependency change**: The snapshot test classes no longer depends on xUnit-specific types, making it more flexible and reusable
 across different testing frameworks.
 
-- **Static to instance**: The `SnapshotHelper` class is no longer static. You must create an instance of `SnapshotHelper` to use its methods.
+- **Static to builder**: The `SnapshotHelper` class is no longer static. You must use the builder to get an instance of `SnapshotTest` to use its methods.
 
 - **New asynchronous API**: All snapshot methods are now async (`Task`-based) and must be awaited.
   - Old: `AssertSnapshot(string generated, string snapshotName, string location)`
-  - New: `await CompareTextSnapshotAsync(string name, string content)`
+  - New: `await CompareSnapshotAsync(string name, string content)`
 
-- **PNG file snapshot support**: New support for comparing PNG image snapshots has been added via `ComparePngSnapshotAsync()`.
+- **PNG file snapshot support**: New support for comparing PNG image snapshots has been added via a Png Snapshot strategy.
   - Includes configurable `differencesThreshold` parameter for image comparison tolerance.
 
-- **Configuration-based initialization**: The constructor now uses a fluent configuration pattern.
-  - Old: location was specified as parameter of the static AssertSnapshot method.
-  - New: `new SnapshotHelper(options => options.IntermediateFolder = intermediateFolder)`
-
-- **Force replace capability**: All comparison methods now support a `forceReplaceSnapshot` parameter to update existing snapshots.
+- **Force replace capability**: The comparison methods now support a `forceReplaceSnapshot` parameter to update existing snapshots.
 
 #### Migration Example
 
@@ -35,17 +33,28 @@ var location = "Path where to read/write snapshot files";
 SnapshotHelper.AssertSnapshot("Some text to match against the snapshot", snapshotName, location);
 
 // New code
-var helper = new SnapshotHelper(options => options.RootPath = "Root path where to read/write snapshot files");
-await helper.CompareTextSnapshotAsync(snapshotName, "Some text to match against the snapshot");
+var snapshotTest= SnapshotTestBuilder
+    .Create()
+    .WithLocation("Root path where to read/write snapshot files")
+    .WithTextStrategy()
+    .Build();
+
+await snapshotTest.CompareSnapshotAsync(snapshotName, "Some text to match against the snapshot");
 
 // For PNG snapshots (new capability)
-await helper.ComparePngSnapshotAsync(snapshotName, pngStream, differencesThreshold: 0.01);
+var snapshotTest= SnapshotTestBuilder
+    .Create()
+    .WithLocation("Root path where to read/write snapshot files")
+    .WithPngStrategy(differencesThreshold: 0.01)
+    .Build();
+
+await snapshotTest.CompareSnapshotAsync(snapshotName, pngStream);
 ```
 
 #### Migration Steps
 
-1. Setup with `SnapshotHelper` instantiation and use the configuration action.
-2. Change all `SnapshotHelper.AssertSnapshot()` calls to `CompareTextSnapshotAsync()` and add `await`.
+1. Setup with `SnapshotTestBuilder` instantiation and use the configuration action.
+2. Change all `SnapshotHelper.AssertSnapshot()` calls to `CompareSnapshotAsync()` and add `await`.
 3. Review snapshot test methods and mark them as `async Task`.
 4. Existing snapshot text files (`.snapshot`) are compatible; you just need to rename with (`.snapshot.ref.txt`).
 

src/SharedProperties.props

@@ -3,7 +3,7 @@
   <PropertyGroup>
     <Version>3.0.0-preview.1</Version>
     <Authors>Xavier Solau</Authors>
-    <Copyright>Copyright © 2021 Xavier Solau</Copyright>
+    <Copyright>Copyright © 2021-2026 Xavier Solau</Copyright>
     <PackageLicenseExpression>MIT</PackageLicenseExpression>
     <PackageProjectUrl>https://github.com/xaviersolau/CodeQuality</PackageProjectUrl>
     <RepositoryUrl>https://github.com/xaviersolau/CodeQuality.git</RepositoryUrl>

src/examples/SoloX.CodeQuality.Prod.Example/AClass2.cs

@@ -1,6 +1,6 @@
 // ----------------------------------------------------------------------
 // <copyright file="AClass2.cs" company="Xavier Solau">
-// Copyright © 2021 Xavier Solau.
+// Copyright © 2021-2026 Xavier Solau.
 // Licensed under the MIT license.
 // See LICENSE file in the project root for full license information.
 // </copyright>

src/examples/SoloX.CodeQuality.Prod.Example/Class1.cs

@@ -1,6 +1,6 @@
 // ----------------------------------------------------------------------
 // <copyright file="Class1.cs" company="Xavier Solau">
-// Copyright © 2021 Xavier Solau.
+// Copyright © 2021-2026 Xavier Solau.
 // Licensed under the MIT license.
 // See LICENSE file in the project root for full license information.
 // </copyright>

src/examples/SoloX.CodeQuality.Prod.Example/Class3.g.cs

@@ -1,6 +1,6 @@
 // ----------------------------------------------------------------------
 // <copyright file="Class3.g.cs" company="Xavier Solau">
-// Copyright © 2021 Xavier Solau.
+// Copyright © 2021-2026 Xavier Solau.
 // Licensed under the MIT license.
 // See LICENSE file in the project root for full license information.
 // </copyright>

src/examples/SoloX.CodeQuality.Prod.Example/IInterface1.cs

@@ -1,6 +1,6 @@
 // ----------------------------------------------------------------------
 // <copyright file="IInterface1.cs" company="Xavier Solau">
-// Copyright © 2021 Xavier Solau.
+// Copyright © 2021-2026 Xavier Solau.
 // Licensed under the MIT license.
 // See LICENSE file in the project root for full license information.
 // </copyright>

src/examples/SoloX.CodeQuality.Prod.Example/Test.cs

@@ -1,6 +1,6 @@
 // ----------------------------------------------------------------------
 // <copyright file="Test.cs" company="Xavier Solau">
-// Copyright © 2021 Xavier Solau.
+// Copyright © 2021-2026 Xavier Solau.
 // Licensed under the MIT license.
 // See LICENSE file in the project root for full license information.
 // </copyright>

src/examples/SoloX.CodeQuality.Test.Example/Class1.cs

@@ -1,6 +1,6 @@
 // ----------------------------------------------------------------------
 // <copyright file="Class1.cs" company="Xavier Solau">
-// Copyright © 2021 Xavier Solau.
+// Copyright © 2021-2026 Xavier Solau.
 // Licensed under the MIT license.
 // See LICENSE file in the project root for full license information.
 // </copyright>

src/examples/SoloX.CodeQuality.Test.Example/Class3.g.cs

@@ -1,6 +1,6 @@
 // ----------------------------------------------------------------------
 // <copyright file="Class3.g.cs" company="Xavier Solau">
-// Copyright © 2021 Xavier Solau.
+// Copyright © 2021-2026 Xavier Solau.
 // Licensed under the MIT license.
 // See LICENSE file in the project root for full license information.
 // </copyright>