wip

Author: stephencelis

Sources/SnapshotTesting/AssertSnapshot.swift

@@ -2,9 +2,6 @@ import XCTest
 
 /// Enhances failure messages with a command line diff tool expression that can be copied and pasted
 /// into a terminal.
-///
-/// This API has been deprecated in favor of
-/// ``withSnapshotTesting(diffTool:record:operation:)-7xmhk``.
 @available(*, deprecated, message: "Use 'withSnapshotTesting' to customize the diff tool. See the documentation for more information.")
 public var diffTool: SnapshotTestingConfiguration.DiffTool {
   get { _diffTool }
@@ -15,9 +12,6 @@ public var diffTool: SnapshotTestingConfiguration.DiffTool {
 public var _diffTool: SnapshotTestingConfiguration.DiffTool = .default
 
 /// Whether or not to record all new references.
-///
-/// This API has been deprecated in favor of
-/// ``withSnapshotTesting(diffTool:record:operation:)-7xmhk``.
 @available(*, deprecated, message: "Use 'withSnapshotTesting' to customize the record mode. See the documentation for more information.")
 public var isRecording: Bool {
   get { SnapshotTestingConfiguration.current?.record ?? _record == .all }

Sources/SnapshotTesting/Documentation.docc/Deprecations/diffTool-property-deprecation.md

@@ -0,0 +1,6 @@
+# ``SnapshotTesting/diffTool``
+
+@DeprecationSummary {
+  Use ``withSnapshotTesting(record:diffTool:operation:)-59u9g`` to customize the diff tool, instead.
+  See <doc:MigratingTo1.17> for more information.
+}

Sources/SnapshotTesting/Documentation.docc/Deprecations/isRecording-property-deprecation.md

@@ -0,0 +1,6 @@
+# ``SnapshotTesting/isRecording``
+
+@DeprecationSummary {
+  Use ``withSnapshotTesting(record:diffTool:operation:)-59u9g`` to customize the record mode,
+  instead. See <doc:MigratingTo1.17> for more information.
+}

Sources/SnapshotTesting/Documentation.docc/MigrationGuides/MigratingTo1.17.md

@@ -37,7 +37,7 @@ diffs of files, but only works when the command line tool accepts a very narrow
 _e.g._ `ksdiff /path/to/file1.png /path/to/file2.png`.
 
 We have greatly improved upon all of these problems by introducing the new 
-``withSnapshotTesting(diffTool:record:operation:)-7xmhk`` tool for customizing snapshots. It 
+``withSnapshotTesting(record:diffTool:operation:)-59u9g`` tool for customizing snapshots. It 
 allows you to customize how the `assertSnapshot` tool behaves for a well-defined scope.
 
 Rather than overriding `isRecording` or `diffTool` directly in your tests, you can wrap your test in

Sources/SnapshotTesting/Documentation.docc/SnapshotTesting.md

@@ -18,9 +18,9 @@ Powerfully flexible snapshot testing.
 
 ### Configuration
 
-- ``withSnapshotTesting(diffTool:record:operation:)-7xmhk``
+- ``withSnapshotTesting(record:diffTool:operation:)-59u9g``
 - ``SnapshotTestingConfiguration``
 
 ### Deprecations
 
-- <doc:Deprecations>
+- <doc:SnapshotTestingDeprecations>

Sources/SnapshotTesting/Documentation.docc/Deprecations.md renamed to Sources/SnapshotTesting/Documentation.docc/SnapshotTestingDeprecations.md

@@ -1,7 +1,7 @@
-# ``SnapshotTesting/withSnapshotTesting(diffTool:record:operation:)-7xmhk``
+# ``SnapshotTesting/withSnapshotTesting(record:diffTool:operation:)-59u9g``
 
 ## Topics
 
 ### Overloads
 
-- ``withSnapshotTesting(diffTool:record:operation:)-4s6ad``
+- ``withSnapshotTesting(record:diffTool:operation:)-b1i4``

Sources/SnapshotTesting/Documentation.docc/WithSnapshotTesting.md

@@ -20,12 +20,12 @@
 /// ```
 ///
 /// - Parameters:
-///   - diffTool: The diff tool to use while asserting snapshots.
 ///   - record: The record mode to use while asserting snapshots.
+///   - diffTool: The diff tool to use while asserting snapshots.
 ///   - operation: The operation to perform.
 public func withSnapshotTesting<R>(
-  diffTool: SnapshotTestingConfiguration.DiffTool? = nil,
   record: SnapshotTestingConfiguration.Record? = nil,
+  diffTool: SnapshotTestingConfiguration.DiffTool? = nil,
   operation: () throws -> R
 ) rethrows -> R {
   try SnapshotTestingConfiguration.$current.withValue(
@@ -40,10 +40,10 @@ public func withSnapshotTesting<R>(
 
 /// Customizes `assertSnapshot` for the duration of an asynchronous operation.
 ///
-/// See ``withSnapshotTesting(diffTool:record:operation:)-7xmhk`` for more information.
+/// See ``withSnapshotTesting(record:diffTool:operation:)-59u9g`` for more information.
 public func withSnapshotTesting<R>(
-  diffTool: SnapshotTestingConfiguration.DiffTool? = nil,
   record: SnapshotTestingConfiguration.Record? = nil,
+  diffTool: SnapshotTestingConfiguration.DiffTool? = nil,
   operation: () async throws -> R
 ) async rethrows -> R {
   try await SnapshotTestingConfiguration.$current.withValue(

Sources/SnapshotTesting/SnapshotTestingConfiguration.swift

@@ -33,8 +33,8 @@
       testCase: Test.Case?
     ) async throws {
       try await withSnapshotTesting(
-        diffTool: configuration.diffTool,
-        record: configuration.record
+        record: configuration.record,
+        diffTool: configuration.diffTool
       ) {
         try await function()
       }