Skip to content

Commit 0dc3482

Browse files
authored
Remove diagnostic for use of "topic://" links (#9)
SR-15319 rdar://71579947
1 parent ff972f1 commit 0dc3482

File tree

2 files changed

+0
-41
lines changed

2 files changed

+0
-41
lines changed

Sources/SwiftDocC/Semantics/MarkupReferenceResolver.swift

Lines changed: 0 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -101,15 +101,6 @@ struct MarkupReferenceResolver: MarkupRewriter {
101101
return link
102102
}
103103
guard url.components.scheme == ResolvedTopicReference.urlScheme else {
104-
if url.components.scheme == "topic", let linkRange = link.range {
105-
var components = url.components
106-
components.scheme = ResolvedTopicReference.urlScheme
107-
let diagnostic = Diagnostic(source: source, severity: .warning, range: link.range, identifier: "org.swift.docc.deprecatedSchemaReference", summary: "'topic' reference scheme is deprecated in favor of the 'doc' sheme")
108-
let solution = Solution(summary: "Replace 'topic' reference scheme with 'doc' scheme.", replacements: [
109-
Replacement(range: linkRange, replacement: "<\(components.url!.absoluteString)>")
110-
])
111-
problems.append(Problem(diagnostic: diagnostic, possibleSolutions: [solution]))
112-
}
113104
return link // Create a non-topic link
114105
}
115106
let unresolved = TopicReference.unresolved(.init(topicURL: url))

Tests/SwiftDocCTests/Infrastructure/ReferenceResolverTests.swift

Lines changed: 0 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -380,38 +380,6 @@ class ReferenceResolverTests: XCTestCase {
380380
}
381381
}
382382

383-
func testWarnsForDeprecatedTopicScheme() throws {
384-
let source = """
385-
@Intro(title: "Technology X") {
386-
Info at: <topic:documentation/TechnologyX/MyArticle>.
387-
}
388-
"""
389-
let document = Document(parsing: source, options: .parseBlockDirectives)
390-
let directive = document.child(at: 0)! as! BlockDirective
391-
let (bundle, context) = try testBundleAndContext(named: "TestBundle")
392-
var problems = [Problem]()
393-
let intro = Intro(from: directive, source: nil, for: bundle, in: context, problems: &problems)!
394-
395-
var resolver = ReferenceResolver(context: context, bundle: bundle, source: nil)
396-
397-
guard let container = resolver.visit(intro).children.first as? MarkupContainer,
398-
let firstElement = container.elements.first,
399-
firstElement.childCount > 2 else {
400-
XCTFail("Unexpected markup result")
401-
return
402-
}
403-
404-
// Verify the link is unchanged (aka topic:// is deprecated)
405-
XCTAssertEqual((firstElement.child(at: 1) as? Link)?.destination, "topic:documentation/TechnologyX/MyArticle")
406-
407-
// Verify the correct fix-it for the link
408-
XCTAssertEqual(resolver.problems.count, 1)
409-
XCTAssertEqual(resolver.problems.first?.diagnostic.identifier, "org.swift.docc.deprecatedSchemaReference")
410-
XCTAssertEqual(resolver.problems.first?.possibleSolutions.first?.replacements.first.map({ replacement in
411-
return "\(replacement.range.lowerBound.line):\(replacement.range.lowerBound.column) - \(replacement.range.upperBound.line):\(replacement.range.upperBound.column) \(replacement.replacement.singleQuoted)"
412-
}), "2:13 - 2:56 '<doc:documentation/TechnologyX/MyArticle>'")
413-
}
414-
415383
func testUnresolvedTutorialReferenceIsWarning() throws {
416384
let source = """
417385
@Chapter(name: "SwiftUI Essentials") {

0 commit comments

Comments
 (0)