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
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
|
/*
This source file is part of the Swift.org open source project
Copyright (c) 2021 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
import Markdown
@testable import SwiftDocC
class NonOverviewHeadingCheckerTests: XCTestCase {
func testFindNonOverviewH2() throws {
let source = """
# Title
Abstract
## Overview
An overview
## Discussion
A discussion
### Discussion subsection
A subsection
## Topics
- ``SymoblLink``
"""
let document = Document(parsing: source, options: [.parseBlockDirectives, .parseSymbolLinks])
var checker = NonOverviewHeadingChecker(sourceFile: URL(fileURLWithPath: "/dev/null"))
checker.visit(document)
XCTAssertEqual(checker.problems.count, 1)
let problem = try XCTUnwrap(checker.problems.first)
XCTAssertEqual(problem.diagnostic.notes.count, 1)
let note = try XCTUnwrap(problem.diagnostic.notes.first)
XCTAssertEqual(note.range.lowerBound.line, 4)
XCTAssertEqual(note.range.lowerBound.column, 1)
XCTAssertEqual(note.range.upperBound.line, 4)
XCTAssertEqual(note.range.upperBound.column, 12)
let range = problem.diagnostic.range
XCTAssertEqual(range?.lowerBound.line, 7)
XCTAssertEqual(problem.possibleSolutions.count, 1)
let solution = try XCTUnwrap(problem.possibleSolutions.first)
XCTAssertEqual(solution.replacements.count, 1)
let replacement = try XCTUnwrap(solution.replacements.first)
XCTAssertEqual(replacement.replacement, "### Discussion")
XCTAssertEqual(replacement.range.lowerBound.line, 7)
XCTAssertEqual(replacement.range.lowerBound.column, 1)
XCTAssertEqual(replacement.range.upperBound.line, 7)
XCTAssertEqual(replacement.range.upperBound.column, 14)
}
func testWithNoOverviewSection() throws {
let source = """
# Title
Abstract
## Discussion
A discussion
"""
let document = Document(parsing: source)
var checker = NonOverviewHeadingChecker(sourceFile: nil)
checker.visit(document)
XCTAssertEqual(checker.problems.count, 1)
let problem = try XCTUnwrap(checker.problems.first)
XCTAssert(problem.diagnostic.notes.isEmpty)
let range = problem.diagnostic.range
XCTAssertEqual(range?.lowerBound.line, 4)
XCTAssertEqual(problem.possibleSolutions.count, 1)
let solution = try XCTUnwrap(problem.possibleSolutions.first)
XCTAssertEqual(solution.replacements.count, 1)
let replacement = try XCTUnwrap(solution.replacements.first)
XCTAssertEqual(replacement.replacement, "## Overview")
XCTAssertEqual(replacement.range.lowerBound.line, 4)
XCTAssertEqual(replacement.range.lowerBound.column, 1)
XCTAssertEqual(replacement.range.upperBound.line, 4)
XCTAssertEqual(replacement.range.upperBound.column, 14)
}
}
|
