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
95
96
97
98
99
100
101
|
/*
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
@testable import SwiftDocC
import Markdown
class HasOnlySequentialHeadingsTests: XCTestCase {
private let containerDirective = BlockDirective(name: "TestContainer")
func testNoHeadings() throws {
let source = """
asdf
another para
@ADirective
some more *stuff*
"""
let document = Document(parsing: source, options: .parseBlockDirectives)
let (bundle, context) = try testBundleAndContext(named: "TestBundle")
var problems: [Problem] = []
Semantic.Analyses.HasOnlySequentialHeadings<TutorialArticle>(severityIfFound: .warning, startingFromLevel: 2).analyze(containerDirective, children: document.children, source: nil, for: bundle, in: context, problems: &problems)
XCTAssertTrue(problems.isEmpty)
}
func testValidHeadings() throws {
let source = """
## H2
### H3
#### H4
## H2
### H3
## H2
### H3
#### H4
### H3
## H2
"""
let document = Document(parsing: source, options: .parseBlockDirectives)
let (bundle, context) = try testBundleAndContext(named: "TestBundle")
var problems: [Problem] = []
Semantic.Analyses.HasOnlySequentialHeadings<TutorialArticle>(severityIfFound: .warning, startingFromLevel: 2).analyze(containerDirective, children: document.children, source: nil, for: bundle, in: context, problems: &problems)
XCTAssertTrue(problems.isEmpty)
}
func testHeadingLevelTooLow() throws {
let source = """
# H1
# H1
"""
let document = Document(parsing: source, options: .parseBlockDirectives)
let (bundle, context) = try testBundleAndContext(named: "TestBundle")
var problems: [Problem] = []
Semantic.Analyses.HasOnlySequentialHeadings<TutorialArticle>(severityIfFound: .warning, startingFromLevel: 2).analyze(containerDirective, children: document.children, source: nil, for: bundle, in: context, problems: &problems)
XCTAssertEqual(problems.map { $0.diagnostic.summary },
[
"This heading doesn't meet or exceed the minimum allowed heading level (2)",
"This heading doesn't meet or exceed the minimum allowed heading level (2)",
])
}
func testHeadingSkipsLevel() throws {
let source = """
## H2
#### H4
###### H6
##### H5
"""
let document = Document(parsing: source, options: .parseBlockDirectives)
let (bundle, context) = try testBundleAndContext(named: "TestBundle")
var problems: [Problem] = []
Semantic.Analyses.HasOnlySequentialHeadings<TutorialArticle>(severityIfFound: .warning, startingFromLevel: 2).analyze(containerDirective, children: document.children, source: nil, for: bundle, in: context, problems: &problems)
XCTAssertEqual(problems.map { $0.diagnostic.summary },
[
"This heading doesn't sequentially follow the previous heading",
"This heading doesn't sequentially follow the previous heading",
"This heading doesn't sequentially follow the previous heading",
])
}
}
|
