Update how FoundationXML is imported

d-ronnqvist · d-ronnqvist · commit 7dd32d941c25 · 2025-11-28T19:20:30.000+01:00
diff --git a/Sources/DocCHTML/MarkdownRenderer.swift b/Sources/DocCHTML/MarkdownRenderer.swift
@@ -8,7 +8,13 @@
  See https://swift.org/CONTRIBUTORS.txt for Swift project authors
 */
 
+#if canImport(FoundationXML)
+// FIXME: See if we can avoid depending on XMLNode/XMLParser to avoid needing to import FoundationXML
+package import FoundationXML
+package import FoundationEssentials
+#else
 package import Foundation
+#endif
 package import Markdown
 
 /// The primary goal for the rendered HTML output.
diff --git a/Sources/DocCHTML/MarkupRenderer+Availability.swift b/Sources/DocCHTML/MarkupRenderer+Availability.swift
@@ -8,10 +8,11 @@
  See https://swift.org/CONTRIBUTORS.txt for Swift project authors
 */
 
-package import Foundation
 #if canImport(FoundationXML)
 // FIXME: See if we can avoid depending on XMLNode/XMLParser to avoid needing to import FoundationXML
 package import FoundationXML
+#else
+package import Foundation
 #endif
 
 package extension MarkdownRenderer {
diff --git a/Sources/DocCHTML/MarkupRenderer+Breadcrumbs.swift b/Sources/DocCHTML/MarkupRenderer+Breadcrumbs.swift
@@ -8,10 +8,12 @@
  See https://swift.org/CONTRIBUTORS.txt for Swift project authors
 */
 
-package import Foundation
 #if canImport(FoundationXML)
 // FIXME: See if we can avoid depending on XMLNode/XMLParser to avoid needing to import FoundationXML
 package import FoundationXML
+package import FoundationEssentials
+#else
+package import Foundation
 #endif
 
 package extension MarkdownRenderer {
diff --git a/Sources/DocCHTML/MarkupRenderer+Declaration.swift b/Sources/DocCHTML/MarkupRenderer+Declaration.swift
@@ -8,10 +8,11 @@
  See https://swift.org/CONTRIBUTORS.txt for Swift project authors
 */
 
-package import Foundation
 #if canImport(FoundationXML)
 // FIXME: See if we can avoid depending on XMLNode/XMLParser to avoid needing to import FoundationXML
 package import FoundationXML
+#else
+package import Foundation
 #endif
 
 package import DocCCommon
diff --git a/Sources/DocCHTML/MarkupRenderer+Parameters.swift b/Sources/DocCHTML/MarkupRenderer+Parameters.swift
@@ -8,10 +8,11 @@
  See https://swift.org/CONTRIBUTORS.txt for Swift project authors
 */
 
-package import Foundation
 #if canImport(FoundationXML)
 // FIXME: See if we can avoid depending on XMLNode/XMLParser to avoid needing to import FoundationXML
 package import FoundationXML
+#else
+package import Foundation
 #endif
 
 package import Markdown
diff --git a/Sources/DocCHTML/MarkupRenderer+Returns.swift b/Sources/DocCHTML/MarkupRenderer+Returns.swift
@@ -8,10 +8,12 @@
  See https://swift.org/CONTRIBUTORS.txt for Swift project authors
 */
 
-package import Foundation
 #if canImport(FoundationXML)
 // FIXME: See if we can avoid depending on XMLNode/XMLParser to avoid needing to import FoundationXML
 package import FoundationXML
+package import FoundationEssentials
+#else
+package import Foundation
 #endif
 
 package import Markdown
diff --git a/Sources/DocCHTML/MarkupRenderer+Topics.swift b/Sources/DocCHTML/MarkupRenderer+Topics.swift
@@ -8,10 +8,12 @@
  See https://swift.org/CONTRIBUTORS.txt for Swift project authors
 */
 
-package import Foundation
 #if canImport(FoundationXML)
 // FIXME: See if we can avoid depending on XMLNode/XMLParser to avoid needing to import FoundationXML
 package import FoundationXML
+package import FoundationEssentials
+#else
+package import Foundation
 #endif
 
 package import Markdown
diff --git a/Sources/DocCHTML/WordBreak.swift b/Sources/DocCHTML/WordBreak.swift
@@ -8,10 +8,11 @@
  See https://swift.org/CONTRIBUTORS.txt for Swift project authors
 */
 
-package import Foundation
 #if canImport(FoundationXML)
 // FIXME: See if we can avoid depending on XMLNode/XMLParser to avoid needing to import FoundationXML
 package import FoundationXML
+#else
+package import Foundation
 #endif
 
 package import DocCCommon
diff --git a/Sources/DocCHTML/XMLNode+element.swift b/Sources/DocCHTML/XMLNode+element.swift
@@ -8,10 +8,11 @@
  See https://swift.org/CONTRIBUTORS.txt for Swift project authors
 */
 
-package import Foundation
 #if canImport(FoundationXML)
 // FIXME: See if we can avoid depending on XMLNode/XMLParser to avoid needing to import FoundationXML
 package import FoundationXML
+#else
+package import Foundation
 #endif
 
 extension XMLNode {
diff --git a/Sources/SwiftDocC/Infrastructure/ConvertOutputConsumer.swift b/Sources/SwiftDocC/Infrastructure/ConvertOutputConsumer.swift
@@ -8,8 +8,6 @@
  See https://swift.org/CONTRIBUTORS.txt for Swift project authors
 */
 
-public import Foundation
-
 /// A consumer for output produced by a documentation conversion.
 ///
 /// Types that conform to this protocol manage what to do with documentation conversion products, for example persist them to disk
@@ -58,7 +56,6 @@ public extension ConvertOutputConsumer {
     func consume(renderReferenceStore: RenderReferenceStore) throws {}
     func consume(buildMetadata: BuildMetadata) throws {}
     func consume(linkResolutionInformation: SerializableLinkResolutionInformation) throws {}
-    func consume(page: XMLNode, for reference: ResolvedTopicReference) throws {}
 }
 
 // Default implementation so that conforming types don't need to implement deprecated API.
diff --git a/Sources/SwiftDocC/Model/Rendering/HTML/HTMLContentConsumer.swift b/Sources/SwiftDocC/Model/Rendering/HTML/HTMLContentConsumer.swift
@@ -8,10 +8,11 @@
  See https://swift.org/CONTRIBUTORS.txt for Swift project authors
 */
 
-package import Foundation
 #if canImport(FoundationXML)
 // FIXME: See if we can avoid depending on XMLNode/XMLParser to avoid needing to import FoundationXML
 package import FoundationXML
+#else
+package import Foundation
 #endif
 
 /// A consumer for HTML content produced during documentation conversion.
diff --git a/Sources/SwiftDocC/Model/Rendering/HTML/HTMLRenderer.swift b/Sources/SwiftDocC/Model/Rendering/HTML/HTMLRenderer.swift
@@ -8,10 +8,12 @@
  See https://swift.org/CONTRIBUTORS.txt for Swift project authors
 */
 
-import Foundation
 #if canImport(FoundationXML)
 // FIXME: See if we can avoid depending on XMLNode/XMLParser to avoid needing to import FoundationXML
 import FoundationXML
+import FoundationEssentials
+#else
+import Foundation
 #endif
 import DocCHTML
 import Markdown
@@ -407,12 +409,12 @@ struct HTMLRenderer {
         if !symbol.parametersSectionVariants.allValues.isEmpty {
             articleElement.addChildren(
                 renderer.parameters(
-                    .init(
+                    [SourceLanguage: [MarkdownRenderer<ContextLinkProvider>.ParameterInfo]](
                         symbol.parametersSectionVariants.allValues.map { trait, parameters in (
                             // FIXME: Use 'sourceLanguage' once https://github.com/swiftlang/swift-docc/pull/1355 is merged
                             key:   trait.interfaceLanguage.map { SourceLanguage(id: $0) } ?? .swift,
                             value: parameters.parameters.map {
-                                .init(name: $0.name, content: $0.contents)
+                                MarkdownRenderer<ContextLinkProvider>.ParameterInfo(name: $0.name, content: $0.contents)
                             }
                         )},
                         uniquingKeysWith: { _, new in new }
diff --git a/Sources/SwiftDocCUtilities/Action/Actions/Convert/FileWritingHTMLContentConsumer.swift b/Sources/SwiftDocCUtilities/Action/Actions/Convert/FileWritingHTMLContentConsumer.swift
@@ -8,7 +8,13 @@
  See https://swift.org/CONTRIBUTORS.txt for Swift project authors
 */
 
+#if canImport(FoundationXML)
+// FIXME: See if we can avoid depending on XMLNode/XMLParser to avoid needing to import FoundationXML
+import FoundationXML
+import FoundationEssentials
+#else
 import Foundation
+#endif
 import SwiftDocC
 import DocCHTML
 
diff --git a/Tests/DocCHTMLTests/MarkdownRenderer+PageElementsTests.swift b/Tests/DocCHTMLTests/MarkdownRenderer+PageElementsTests.swift
@@ -8,7 +8,14 @@
  See https://swift.org/CONTRIBUTORS.txt for Swift project authors
 */
 
+#if canImport(FoundationEssentials)
+// FIXME: See if we can avoid depending on XMLNode/XMLParser to avoid needing to import FoundationXML
+import FoundationXML
+import FoundationEssentials
+#else
 import Foundation
+#endif
+
 import Testing
 import DocCHTML
 @testable import SwiftDocC
diff --git a/Tests/DocCHTMLTests/MarkdownRendererTests.swift b/Tests/DocCHTMLTests/MarkdownRendererTests.swift
@@ -8,7 +8,14 @@
  See https://swift.org/CONTRIBUTORS.txt for Swift project authors
 */
 
+#if canImport(FoundationXML)
+// FIXME: See if we can avoid depending on XMLNode/XMLParser to avoid needing to import FoundationXML
+import FoundationXML
+import FoundationEssentials
+#else
 import Foundation
+#endif
+
 import Testing
 import DocCHTML
 @testable import SwiftDocC
diff --git a/Tests/DocCHTMLTests/WordBreakTests.swift b/Tests/DocCHTMLTests/WordBreakTests.swift
@@ -8,7 +8,14 @@
  See https://swift.org/CONTRIBUTORS.txt for Swift project authors
 */
 
+#if canImport(FoundationEssentials)
+// FIXME: See if we can avoid depending on XMLNode/XMLParser to avoid needing to import FoundationXML
+import FoundationXML
+import FoundationEssentials
+#else
 import Foundation
+#endif
+
 import Testing
 import DocCHTML
 
