Adopt the upcoming feature SE-0274 (concise magic file name) (#1180)

* Enable SE-0274 (concise magic file name) upcoming feature

* Use absolute file paths in generate-symbol-graph tool

Author: d-ronnqvist

Package.swift

@@ -15,6 +15,7 @@ import class Foundation.ProcessInfo
 let swiftSettings: [SwiftSetting] = [
     .unsafeFlags(["-Xfrontend", "-warn-long-expression-type-checking=1000"], .when(configuration: .debug)),
 
+    .enableUpcomingFeature("ConciseMagicFile"), // SE-0274: https://github.com/swiftlang/swift-evolution/blob/main/proposals/0274-magic-file.md
     .enableUpcomingFeature("ExistentialAny"), // SE-0335: https://github.com/swiftlang/swift-evolution/blob/main/proposals/0335-existential-any.md
 ]
 

Sources/generate-symbol-graph/main.swift

@@ -199,7 +199,7 @@ let supportedDirectives: [Directive] = [
     }
 
 func generateSwiftDocCFrameworkSymbolGraph() throws -> SymbolGraph {
-    let packagePath = URL(fileURLWithPath: #file)
+    let packagePath = URL(fileURLWithPath: #filePath) // Absolute path to this file
         .deletingLastPathComponent() // generate-symbol-graph
         .deletingLastPathComponent() // Sources
         .deletingLastPathComponent() // swift-docc
@@ -680,7 +680,7 @@ private struct SortedSymbolGraph: Codable {
     }
 }
 
-let output = URL(fileURLWithPath: #file)
+let output = URL(fileURLWithPath: #filePath) // Absolute path to this file
     .deletingLastPathComponent()
     .deletingLastPathComponent()
     .appendingPathComponent("docc/DocCDocumentation.docc/docc.symbols.json")

Tests/SwiftDocCTests/DocumentationService/ConvertService/ConvertServiceTests.swift

@@ -2396,7 +2396,7 @@ class ConvertServiceTests: XCTestCase {
         source: URL,
         title: String?,
         isDocumentationExtensionContent: Bool,
-        file: StaticString = #file,
+        file: StaticString = #filePath,
         line: UInt = #line
     ) throws {
         let topicContentKey = try XCTUnwrap(referenceStore.topics.keys.first { $0.path == topicPath })

Tests/SwiftDocCTests/Indexing/NavigatorIndexTests.swift

@@ -2052,7 +2052,7 @@ fileprivate func validateTree(node: NavigatorTree.Node, validator: (NavigatorTre
     return true
 }
 
-fileprivate func assertUniqueIDs(node: NavigatorTree.Node, message: String = "The tree has duplicated IDs.", file: StaticString = #file, line: UInt = #line) {
+fileprivate func assertUniqueIDs(node: NavigatorTree.Node, message: String = "The tree has duplicated IDs.", file: StaticString = #filePath, line: UInt = #line) {
     var collector = Set<UInt32>()
     var brokenItemTitle = ""
 

Tests/SwiftDocCTests/Infrastructure/AutomaticCurationTests.swift

@@ -95,7 +95,7 @@ class AutomaticCurationTests: XCTestCase {
         containsAutomaticTopicSectionFor kind: SymbolGraph.Symbol.KindIdentifier,
         context: DocumentationContext,
         bundle: DocumentationBundle,
-        file: StaticString = #file,
+        file: StaticString = #filePath,
         line: UInt = #line
     ) throws {
         let node = try context.entity(with: ResolvedTopicReference(bundleID: bundle.id, path: path, sourceLanguage: .swift))
@@ -771,7 +771,7 @@ class AutomaticCurationTests: XCTestCase {
 
         func assertAutomaticCuration(
             variants: Set<DocumentationDataVariantsTrait>,
-            file: StaticString = #file,
+            file: StaticString = #filePath,
             line: UInt = #line
         ) throws {
             let topics = try AutomaticCuration.topics(

Tests/SwiftDocCTests/Infrastructure/BundleDiscoveryTests.swift

@@ -136,13 +136,13 @@ class BundleDiscoveryTests: XCTestCase {
 
         let expectedBundle = try parsedBundle(from: CopyOfFolder(original: testBundleLocation))
 
-        func checkExpectedFilesFoundIn(_ folder: any File, file: StaticString = #file, line: UInt = #line) throws {
+        func checkExpectedFilesFoundIn(_ folder: any File, file: StaticString = #filePath, line: UInt = #line) throws {
             let bundle = try parsedBundle(from: folder)
 
             XCTAssertEqual(bundle.id, expectedBundle.id)
             XCTAssertEqual(bundle.displayName, expectedBundle.displayName)
 
-            func assertEqualFiles(_ got: [URL], _ expected: [URL], file: StaticString = #file, line: UInt = #line) {
+            func assertEqualFiles(_ got: [URL], _ expected: [URL], file: StaticString = #filePath, line: UInt = #line) {
                 let gotFileNames = Set(got.map { $0.lastPathComponent })
                 let expectedFileNames = Set(expected.map { $0.lastPathComponent })
 

Tests/SwiftDocCTests/Infrastructure/DataAssetManagerTests.swift

@@ -14,7 +14,7 @@ import XCTest
 
 class DataAssetManagerTests: XCTestCase {
 
-    func assertIsRegistered(named name: String, trait: DataTraitCollection, expectedURL: URL, manager: DataAssetManager, file: StaticString = #file, line: UInt = #line) {
+    func assertIsRegistered(named name: String, trait: DataTraitCollection, expectedURL: URL, manager: DataAssetManager, file: StaticString = #filePath, line: UInt = #line) {
         let data = manager.data(named: name, bestMatching: trait)!
         XCTAssertEqual(data.url, expectedURL)
         XCTAssertEqual(data.traitCollection, trait)

Tests/SwiftDocCTests/Infrastructure/DocumentationContext/DocumentationContext+MixedLanguageLinkResolutionTests.swift

@@ -24,7 +24,7 @@ class DocumentationContext_MixedLanguageLinkResolutionTests: XCTestCase {
         func assertCanResolveSymbolLinks(
             symbolPaths: String...,
             parentPath: String,
-            file: StaticString = #file,
+            file: StaticString = #filePath,
             line: UInt = #line
         ) {
             for symbolPath in symbolPaths {

Tests/SwiftDocCTests/Infrastructure/DocumentationContext/DocumentationContext+MixedLanguageSourceLanguagesTests.swift

@@ -36,7 +36,7 @@ class DocumentationContext_MixedLanguageSourceLanguagesTests: XCTestCase {
     func assertArticleAvailableSourceLanguages(
         moduleAvailableLanguages: Set<SourceLanguage>,
         expectedArticleDefaultLanguage: SourceLanguage,
-        file: StaticString = #file,
+        file: StaticString = #filePath,
         line: UInt = #line
     ) throws {
         precondition(

Tests/SwiftDocCTests/Infrastructure/DocumentationContext/DocumentationContextTests.swift

@@ -5568,7 +5568,7 @@ let expected = """
 
 }
 
-func assertEqualDumps(_ lhs: String, _ rhs: String, file: StaticString = #file, line: UInt = #line) {
+func assertEqualDumps(_ lhs: String, _ rhs: String, file: StaticString = #filePath, line: UInt = #line) {
     // The default message by XCTAssertEqual isn't helpful in this case as it dumps both values in the console
     // and is difficult to track any changes
     guard lhs.removingLeadingSpaces == rhs.removingLeadingSpaces else {