Skip to content

add logic to properly handle cross-import overlay graphs #101

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

Merged
merged 3 commits into from
Aug 28, 2025
Merged

add logic to properly handle cross-import overlay graphs #101

Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
7244837
add logic to properly handle cross-import overlay graphs
heckj Aug 25, 2025
5accfa7
clean up comments
heckj Aug 25, 2025
1517432
adding test examples that use the graphs reflected from the overlay t…
heckj Aug 28, 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
12 changes: 10 additions & 2 deletions Sources/SymbolKit/UnifiedSymbolGraph/GraphCollector.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -139,8 +139,16 @@ extension GraphCollector {
let isMainSymbolGraph = !url.lastPathComponent.contains("@") && !graph.module.isVirtual

let moduleName: String
if isMainSymbolGraph {
// For main symbol graphs, get the module name from the symbol graph's data
if isMainSymbolGraph || graph.module.bystanders != nil {
// When bystander modules are present, the symbol graph is a cross-import overlay, and
// we need to preserve the original module name to properly render it. It is still
// kept with the extension symbols, due to the merging behavior of UnifiedSymbolGraph.

// A cross-import overlays is a distinct module that references a “declaring module”
// (the module it is considered to be a part of) and one or more “bystander modules”
// (modules that must be imported alongside the declaring module for the overlay to be available)

// For main symbol graphs (and cross-import overlays), get the module name from the symbol graph's data
moduleName = graph.module.name
return (moduleName, isMainSymbolGraph)
} else {
Expand Down