Skip to content

Populate symbol kind in external render nodes #1251

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Populate symbol kind in external render nodes #1251

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d95e720
Add mapping from documentation kind to symbol kind
anferbui Jul 21, 2025
7a3603b
Capture documentation kind as part of external entity
anferbui Jul 21, 2025
8173968
Propagate symbol kind to navigator for external nodes
anferbui Jul 21, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 5 additions & 4 deletions Sources/SwiftDocC/Infrastructure/Link Resolution/LinkResolver+NavigatorIndex.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,9 +39,10 @@ package struct ExternalRenderNode {
}

/// The symbol kind of this documentation node.
///
/// This value is `nil` if the referenced page is not a symbol.
var symbolKind: SymbolGraph.Symbol.KindIdentifier? {
// Symbol kind information is not available for external entities
return nil
DocumentationNode.symbolKind(for: externalEntity.documentationKind)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this value different from externalEntity.topicRenderReference.role.map { init(rawValue: $0) }?

}

/// The additional "role" assigned to the symbol, if any
Expand Down Expand Up @@ -116,7 +117,7 @@ struct NavigatorExternalRenderNode: NavigatorIndexableRenderNodeRepresentation {
navigatorTitle: renderNode.navigatorTitleVariants.value(for: traits),
externalID: renderNode.externalIdentifier.identifier,
role: renderNode.role,
symbolKind: renderNode.symbolKind?.identifier,
symbolKind: renderNode.symbolKind?.renderingIdentifier,
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

From

swift-docc/Sources/SwiftDocC/Semantics/Graph/SymbolKind.Swift.swift

Line 27 in 1b4a185

var renderingIdentifier: String {
it seems like ideally we don't want to use the renderingIdentifier.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

renderingIdentifier is what we use for deriving the navigator symbol kind for local items -- for consistency I think we should use the same.

swift-docc/Sources/SwiftDocC/Model/Rendering/RenderNodeTranslator.swift

Lines 1299 to 1301 in 65aaf92

node.metadata.symbolKindVariants = VariantCollection<String?>(from: symbol.kindVariants) { _, kindVariants in
kindVariants.identifier.renderingIdentifier
} ?? .init(defaultValue: nil)

images: renderNode.images
)
}
Expand Down Expand Up @@ -145,4 +146,4 @@ struct ExternalRenderNodeMetadataRepresentation: NavigatorIndexableRenderMetadat
var fragments: [DeclarationRenderSection.Token]? = nil
var roleHeading: String? = nil
var platforms: [AvailabilityRenderItem]? = nil
}
}
11 changes: 8 additions & 3 deletions Tests/SwiftDocCTests/Indexing/ExternalRenderNodeTests.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,7 @@ class ExternalRenderNodeTests: XCTestCase {

XCTAssertEqual(externalRenderNodes[1].identifier.absoluteString, "doc://org.swift.MixedLanguageFramework/example/path/to/external/objCSymbol")
XCTAssertEqual(externalRenderNodes[1].kind, .symbol)
XCTAssertEqual(externalRenderNodes[1].symbolKind, nil)
XCTAssertEqual(externalRenderNodes[1].symbolKind, .func)
XCTAssertEqual(externalRenderNodes[1].role, "symbol")
XCTAssertEqual(externalRenderNodes[1].externalIdentifier.identifier, "doc://com.test.external/path/to/external/objCSymbol")

Expand All @@ -104,7 +104,7 @@ class ExternalRenderNodeTests: XCTestCase {

XCTAssertEqual(externalRenderNodes[3].identifier.absoluteString, "doc://org.swift.MixedLanguageFramework/example/path/to/external/swiftSymbol")
XCTAssertEqual(externalRenderNodes[3].kind, .symbol)
XCTAssertEqual(externalRenderNodes[3].symbolKind, nil)
XCTAssertEqual(externalRenderNodes[3].symbolKind, .class)
XCTAssertEqual(externalRenderNodes[3].role, "symbol")
XCTAssertEqual(externalRenderNodes[3].externalIdentifier.identifier, "doc://com.test.external/path/to/external/swiftSymbol")
}
Expand Down Expand Up @@ -135,7 +135,8 @@ class ExternalRenderNodeTests: XCTestCase {
navigatorTitleVariants: .init(defaultValue: navigatorTitle, objectiveCValue: occNavigatorTitle)
),
renderReferenceDependencies: .init(),
sourceLanguages: [SourceLanguage(name: "swift"), SourceLanguage(name: "objc")])
sourceLanguages: [SourceLanguage(name: "swift"), SourceLanguage(name: "objc")],
documentationKind: .function)
let externalRenderNode = ExternalRenderNode(
externalEntity: externalEntity,
bundleIdentifier: "com.test.external"
Expand Down Expand Up @@ -208,6 +209,8 @@ class ExternalRenderNodeTests: XCTestCase {
XCTAssertEqual(occExternalNodes.map(\.title), ["ObjCArticle", "ObjCSymbol"])
XCTAssert(swiftExternalNodes.allSatisfy(\.isExternal))
XCTAssert(occExternalNodes.allSatisfy(\.isExternal))
XCTAssertEqual(swiftExternalNodes.map(\.type), ["article", "class"])
XCTAssertEqual(occExternalNodes.map(\.type), ["article", "func"])
}

func testNavigatorWithExternalNodesOnlyAddsCuratedNodesToNavigator() throws {
Expand Down Expand Up @@ -268,5 +271,7 @@ class ExternalRenderNodeTests: XCTestCase {
XCTAssertEqual(occExternalNodes.map(\.title), ["ObjCSymbol"])
XCTAssert(swiftExternalNodes.allSatisfy(\.isExternal))
XCTAssert(occExternalNodes.allSatisfy(\.isExternal))
XCTAssertEqual(swiftExternalNodes.map(\.type), ["article"])
XCTAssertEqual(occExternalNodes.map(\.type), ["func"])
}
}