1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
|
/*
This source file is part of the Swift.org open source project
Copyright (c) 2022-2023 Apple Inc. and the Swift project authors
Licensed under Apache License v2.0 with Runtime Library Exception
See https://swift.org/LICENSE.txt for license information
See https://swift.org/CONTRIBUTORS.txt for Swift project authors
*/
import XCTest
@testable import SwiftDocC
import Markdown
class MarkupReferenceResolverTests: XCTestCase {
func testArbitraryReferenceInComment() throws {
let (bundle, context) = try testBundleAndContext(named: "TestBundle")
let source = """
@Comment {
``hello`` and ``world`` are 2 arbitrary symbol links.
<doc:NOT-EXISTS-DESTINATION#UNKNOWN>
But since they are under a comment block, no reference resolve problem should be emitted.
}
"""
let document = Document(parsing: source, options: [.parseBlockDirectives, .parseSymbolLinks])
var resolver = MarkupReferenceResolver(context: context, bundle: bundle, rootReference: context.rootModules[0])
_ = resolver.visit(document)
XCTAssertEqual(0, resolver.problems.count)
}
func testDuplicatedDiagnosticForExtensionFile() throws {
let (_, context) = try testBundleAndContext(named: "ExtensionArticleBundle")
// Before #733, symbols with documentation extension files emitted duplicated problems:
// - one with a source location in the in-source documentation comment
// - one with a source location in the documentation extension file.
// The source range was only valid for one of these diagnostics. This resulted in an index out of range crash in DefaultDiagnosticConsoleFormatter when displaying line that caused the problem to the user
XCTAssertEqual(1, context.problems.count)
XCTAssertEqual("Server.md", context.problems.first?.diagnostic.source?.lastPathComponent)
}
}
|
