Rename module from FrameworkAgnostic to Generic

Author: ahoppen

Package.swift

@@ -28,8 +28,8 @@ let package = Package(
     .library(name: "SwiftSyntaxMacroExpansion", targets: ["SwiftSyntaxMacroExpansion"]),
     .library(name: "SwiftSyntaxMacrosTestSupport", targets: ["SwiftSyntaxMacrosTestSupport"]),
     .library(
-      name: "SwiftSyntaxMacrosTestSupportFrameworkAgnostic",
-      targets: ["SwiftSyntaxMacrosTestSupportFrameworkAgnostic"]
+      name: "SwiftSyntaxMacrosGenericTestSupport",
+      targets: ["SwiftSyntaxMacrosGenericTestSupport"]
     ),
   ],
   targets: [
@@ -45,7 +45,7 @@ let package = Package(
     .target(
       name: "_SwiftSyntaxTestSupport",
       dependencies: [
-        "_SwiftSyntaxTestSupportFrameworkAgnostic",
+        "_SwiftSyntaxGenericTestSupport",
         "SwiftBasicFormat",
         "SwiftSyntax",
         "SwiftSyntaxBuilder",
@@ -54,7 +54,7 @@ let package = Package(
     ),
 
     .target(
-      name: "_SwiftSyntaxTestSupportFrameworkAgnostic",
+      name: "_SwiftSyntaxGenericTestSupport",
       dependencies: []
     ),
 
@@ -227,17 +227,17 @@ let package = Package(
         "SwiftIDEUtils",
         "SwiftParser",
         "SwiftSyntaxMacros",
-        "SwiftSyntaxMacrosTestSupportFrameworkAgnostic",
+        "SwiftSyntaxMacrosGenericTestSupport",
         "SwiftSyntaxMacroExpansion",
       ]
     ),
 
-    // MARK: SwiftSyntaxMacrosTestSupportFrameworkAgnostic
+    // MARK: SwiftSyntaxMacrosGenericTestSupport
 
     .target(
-      name: "SwiftSyntaxMacrosTestSupportFrameworkAgnostic",
+      name: "SwiftSyntaxMacrosGenericTestSupport",
       dependencies: [
-        "_SwiftSyntaxTestSupportFrameworkAgnostic",
+        "_SwiftSyntaxGenericTestSupport",
         "SwiftDiagnostics",
         "SwiftIDEUtils",
         "SwiftParser",

Release Notes/600.md

@@ -95,7 +95,7 @@
   - Description: `Range<AbsolutePosition>` gained a few convenience functions inspired from `ByteSourceRange`: `init(position:length:)`,  `length`, `overlapsOrTouches`
   - Pull request: https://github.com/apple/swift-syntax/pull/2587
 
-- `SwiftSyntaxMacrosTestSupportFrameworkAgnostic`
+- `SwiftSyntaxMacrosGenericTestSupport`
   - Description: A version of the `SwiftSyntaxMacrosTestSupport` module that doesn't depend on `Foundation` or `XCTest` and can thus be used to write macro tests using `swift-testing`. Since swift-syntax can't depend on swift-testing (which would incur a circular dependency since swift-testing depends on swift-syntax), users need to manually specify a failure handler like the following, that fails the swift-testing test: `Issue.record("\($0.message)", fileID: $0.location.fileID, filePath: $0.location.filePath, line: $0.location.line, column: $0.location.column)`
   - Pull request: https://github.com/apple/swift-syntax/pull/2647
 

Sources/SwiftSyntaxMacrosTestSupportFrameworkAgnostic/Assertions.swift renamed to Sources/SwiftSyntaxMacrosGenericTestSupport/Assertions.swift

@@ -19,7 +19,7 @@ import SwiftParserDiagnostics
 public import SwiftSyntax
 public import SwiftSyntaxMacroExpansion
 private import SwiftSyntaxMacros
-private import _SwiftSyntaxTestSupportFrameworkAgnostic
+private import _SwiftSyntaxGenericTestSupport
 #else
 import SwiftBasicFormat
 import SwiftDiagnostics
@@ -29,7 +29,7 @@ import SwiftParserDiagnostics
 import SwiftSyntax
 import SwiftSyntaxMacroExpansion
 import SwiftSyntaxMacros
-import _SwiftSyntaxTestSupportFrameworkAgnostic
+import _SwiftSyntaxGenericTestSupport
 #endif
 
 /// Defines the location at which the a test failure should be anchored. This is typically the location where the
@@ -59,7 +59,7 @@ public struct TestFailureLocation {
     self.unsignedColumn = column
   }
 
-  fileprivate init(underlying: _SwiftSyntaxTestSupportFrameworkAgnostic.TestFailureLocation) {
+  fileprivate init(underlying: _SwiftSyntaxGenericTestSupport.TestFailureLocation) {
     self.init(
       fileID: underlying.fileID,
       filePath: underlying.filePath,
@@ -68,10 +68,10 @@ public struct TestFailureLocation {
     )
   }
 
-  /// This type is intentionally different to `_SwiftSyntaxTestSupportFrameworkAgnostic.TestFailureLocation` so we can
-  /// import `_SwiftSyntaxTestSupportFrameworkAgnostic` privately and don't expose its internal types.
-  fileprivate var underlying: _SwiftSyntaxTestSupportFrameworkAgnostic.TestFailureLocation {
-    _SwiftSyntaxTestSupportFrameworkAgnostic.TestFailureLocation(
+  /// This type is intentionally different to `_SwiftSyntaxGenericTestSupport.TestFailureLocation` so we can
+  /// import `_SwiftSyntaxGenericTestSupport` privately and don't expose its internal types.
+  fileprivate var underlying: _SwiftSyntaxGenericTestSupport.TestFailureLocation {
+    _SwiftSyntaxGenericTestSupport.TestFailureLocation(
       fileID: self.staticFileID,
       filePath: self.staticFilePath,
       line: self.unsignedLine,
@@ -91,7 +91,7 @@ public struct TestFailureSpec {
     self.location = location
   }
 
-  fileprivate init(underlying: _SwiftSyntaxTestSupportFrameworkAgnostic.TestFailureSpec) {
+  fileprivate init(underlying: _SwiftSyntaxGenericTestSupport.TestFailureSpec) {
     self.init(
       message: underlying.message,
       location: TestFailureLocation(underlying: underlying.location)

Sources/SwiftSyntaxMacrosTestSupport/Assertions.swift

@@ -14,20 +14,20 @@
 public import SwiftSyntax
 public import SwiftSyntaxMacroExpansion
 public import SwiftSyntaxMacros
-@_spi(XCTestFailureLocation) public import SwiftSyntaxMacrosTestSupportFrameworkAgnostic
+@_spi(XCTestFailureLocation) public import SwiftSyntaxMacrosGenericTestSupport
 private import XCTest
 #else
 import SwiftSyntax
 import SwiftSyntaxMacroExpansion
 import SwiftSyntaxMacros
-@_spi(XCTestFailureLocation) import SwiftSyntaxMacrosTestSupportFrameworkAgnostic
+@_spi(XCTestFailureLocation) import SwiftSyntaxMacrosGenericTestSupport
 import XCTest
 #endif
 
-// Re-export the spec types from `SwiftSyntaxMacrosTestSupportFrameworkAgnostic`.
-public typealias NoteSpec = SwiftSyntaxMacrosTestSupportFrameworkAgnostic.NoteSpec
-public typealias FixItSpec = SwiftSyntaxMacrosTestSupportFrameworkAgnostic.FixItSpec
-public typealias DiagnosticSpec = SwiftSyntaxMacrosTestSupportFrameworkAgnostic.DiagnosticSpec
+// Re-export the spec types from `SwiftSyntaxMacrosGenericTestSupport`.
+public typealias NoteSpec = SwiftSyntaxMacrosGenericTestSupport.NoteSpec
+public typealias FixItSpec = SwiftSyntaxMacrosGenericTestSupport.FixItSpec
+public typealias DiagnosticSpec = SwiftSyntaxMacrosGenericTestSupport.DiagnosticSpec
 
 /// Assert that expanding the given macros in the original source produces
 /// the given expanded source code.
@@ -107,7 +107,7 @@ public func assertMacroExpansion(
   file: StaticString = #filePath,
   line: UInt = #line
 ) {
-  SwiftSyntaxMacrosTestSupportFrameworkAgnostic.assertMacroExpansion(
+  SwiftSyntaxMacrosGenericTestSupport.assertMacroExpansion(
     originalSource,
     expandedSource: expectedExpandedSource,
     diagnostics: diagnostics,

Sources/_SwiftSyntaxTestSupportFrameworkAgnostic/AssertEqualWithDiff.swift renamed to Sources/_SwiftSyntaxGenericTestSupport/AssertEqualWithDiff.swift

@@ -13,11 +13,11 @@
 #if swift(>=6)
 public import Foundation
 private import XCTest
-private import _SwiftSyntaxTestSupportFrameworkAgnostic
+private import _SwiftSyntaxGenericTestSupport
 #else
 import Foundation
 import XCTest
-import _SwiftSyntaxTestSupportFrameworkAgnostic
+import _SwiftSyntaxGenericTestSupport
 #endif
 
 /// Asserts that the two strings are equal, providing Unix `diff`-style output if they are not.
@@ -45,7 +45,7 @@ public func assertStringsEqualWithDiff(
     line: line,
     column: 0  // Not used in the failure handler
   )
-  return _SwiftSyntaxTestSupportFrameworkAgnostic.assertStringsEqualWithDiff(
+  return _SwiftSyntaxGenericTestSupport.assertStringsEqualWithDiff(
     actual,
     expected,
     message,