wip

pointfreeco · Jul 4, 2024 · f98a7e7 · f98a7e7
1 parent aaf6ce4
commit f98a7e7
Show file tree

Hide file tree

Showing 3 changed files with 40 additions and 27 deletions.
diff --git a/.../SnapshotTesting/Documentation.docc/Articles/MigrationGuides/MigratingTo1.17.md b/.../SnapshotTesting/Documentation.docc/Articles/MigrationGuides/MigratingTo1.17.md
@@ -34,7 +34,11 @@ These customization options have a few downsides currently.
 
 And the ``diffTool`` variable allows one to specify a command line tool to use for visualizing
 diffs of files, but only works when the command line tool accepts a very narrow set of arguments, 
-_e.g._ `ksdiff /path/to/file1.png /path/to/file2.png`.
+_e.g._:
+
+```sh
+$ ksdiff /path/to/file1.png /path/to/file2.png
+```
 
 We have greatly improved upon all of these problems by introducing the new 
 ``withSnapshotTesting(record:diffTool:operation:)-2kuyr`` tool for customizing snapshots. It 
@@ -51,7 +55,7 @@ Rather than overriding `isRecording` or `diffTool` directly in your tests, you c
     func testFeature() {
       isRecording = true 
       diffTool = "ksdiff"
-      assertSnapshot(…)
+      assertSnapshot(/* ... */)
     }
     ```
   }
@@ -60,8 +64,11 @@ Rather than overriding `isRecording` or `diffTool` directly in your tests, you c
     // After
 
     func testFeature() {
-      withSnapshotTesting(record: .all, diffTool: .ksdiff) {
-        assertSnapshot(…)
+      withSnapshotTesting(
+        record: .all,
+        diffTool: .ksdiff
+      ) {
+        assertSnapshot(/* ... */)
       }
     }
     ```
@@ -95,7 +102,10 @@ method of `XCTestCase`:
 
     class FeatureTests: XCTestCase {
       override func invokeTest() {
-        withSnapshotTesting(diffTool: .ksdiff, record: .all) {
+        withSnapshotTesting(
+          record: .all,
+          diffTool: .ksdiff
+        ) {
           super.invokeTest()
         }
       }
@@ -124,15 +134,15 @@ Further, the `diffTool` and `record` arguments have extra customization capabili
 
   * `record` is now a [type](<doc:SnapshotTestingConfiguration/Record-swift.struct>) with 4
     choices: `all`, `missing`, `never`, `failed`:
-    * `all`: All snapshots will be generated and saved to disk. 
-    * `missing`: only the snapshots that are missing from the disk will be generated
-    and saved. 
-    * `never`: No snapshots will be generated, even if they are missing. This option is appropriate
-    when running tests on CI so that re-tries of tests do not surprisingly pass after snapshots are
-    unexpectedly generated.
-    * `failed`: Snapshots only for failing tests will be generated. This can be useful for tests
-    that use precision thresholds so that passing tests do not re-record snapshots that are 
-    subtly different but still within the threshold.
+      * `all`: All snapshots will be generated and saved to disk.
+      * `missing`: only the snapshots that are missing from the disk will be generated
+        and saved.
+      * `never`: No snapshots will be generated, even if they are missing. This option is
+        appropriate when running tests on CI so that re-tries of tests do not surprisingly pass
+        after snapshots are unexpectedly generated.
+      * `failed`: Snapshots only for failing tests will be generated. This can be useful for tests
+        that use precision thresholds so that passing tests do not re-record snapshots that are
+        subtly different but still within the threshold.
 
 ## Beta support for Swift Testing
 
@@ -157,7 +167,7 @@ you to customize snapshots for a `@Test` or `@Suite`, but to get access to it yo
 ```swift
 @_spi(Experimental) import SnapshotTesting
 
-@Suite(.snapshots(diffTool: .ksdiff, record: .all))
+@Suite(.snapshots(record: .all, diffTool: .ksdiff))
 struct FeatureTests {
   …
 }

diff --git a/Sources/SnapshotTesting/SnapshotTestingConfiguration.swift b/Sources/SnapshotTesting/SnapshotTestingConfiguration.swift
@@ -30,8 +30,9 @@ public func withSnapshotTesting<R>(
 ) rethrows -> R {
   try SnapshotTestingConfiguration.$current.withValue(
     SnapshotTestingConfiguration(
-      diffTool: diffTool ?? SnapshotTestingConfiguration.current?.diffTool ?? SnapshotTesting._diffTool,
-      record: record ?? SnapshotTestingConfiguration.current?.record ?? _record
+      record: record ?? SnapshotTestingConfiguration.current?.record ?? _record,
+      diffTool: diffTool ?? SnapshotTestingConfiguration.current?.diffTool
+        ?? SnapshotTesting._diffTool
     )
   ) {
     try operation()
@@ -48,8 +49,8 @@ public func withSnapshotTesting<R>(
 ) async rethrows -> R {
   try await SnapshotTestingConfiguration.$current.withValue(
     SnapshotTestingConfiguration(
-      diffTool: diffTool ?? SnapshotTestingConfiguration.current?.diffTool ?? _diffTool,
-      record: record ?? SnapshotTestingConfiguration.current?.record ?? _record
+      record: record ?? SnapshotTestingConfiguration.current?.record ?? _record,
+      diffTool: diffTool ?? SnapshotTestingConfiguration.current?.diffTool ?? _diffTool
     )
   ) {
     try await operation()
@@ -72,11 +73,11 @@ public struct SnapshotTestingConfiguration: Sendable {
   public var record: Record
 
   public init(
-    diffTool: DiffTool = .default,
-    record: Record = .missing
+    record: Record = .missing,
+    diffTool: DiffTool = .default
   ) {
-    self.diffTool = diffTool
     self.record = record
+    self.diffTool = diffTool
   }
 
   /// The record mode of the snapshot test.

diff --git a/Sources/SnapshotTesting/SnapshotsTestTrait.swift b/Sources/SnapshotTesting/SnapshotsTestTrait.swift
@@ -4,22 +4,24 @@
   @_spi(Experimental)
   extension Trait where Self == _SnapshotsTestTrait {
     /// Configure snapshot testing in a suite or test.
+    ///
     /// - Parameters:
-    ///   - diffTool: The diff tool to use in failure messages.
     ///   - record: The record mode of the test.
+    ///   - diffTool: The diff tool to use in failure messages.
     public static func snapshots(
-      diffTool: SnapshotTestingConfiguration.DiffTool = .default,
-      record: SnapshotTestingConfiguration.Record = .missing
+      record: SnapshotTestingConfiguration.Record = .missing,
+      diffTool: SnapshotTestingConfiguration.DiffTool = .default
     ) -> Self {
       _SnapshotsTestTrait(
         configuration: SnapshotTestingConfiguration(
-          diffTool: diffTool,
-          record: record
+          record: record,
+          diffTool: diffTool
         )
       )
     }
 
     /// Configure snapshot testing in a suite or test.
+    ///
     /// - Parameter configuration: The configuration to use.
     public static func snapshots(
       _ configuration: SnapshotTestingConfiguration