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
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
|
import _SwiftFormatTestSupport
@_spi(Rules) import SwiftFormat
// FIXME: We should place the diagnostic somewhere in the comment, not on the declaration.
final class BeginDocumentationCommentWithOneLineSummaryTests: LintOrFormatRuleTestCase {
override func setUp() {
// Reset this to false by default. Specific tests may override it.
BeginDocumentationCommentWithOneLineSummary._forcesFallbackModeForTesting = false
super.setUp()
}
func testDocLineCommentsWithoutOneSentenceSummary() {
assertLint(
BeginDocumentationCommentWithOneLineSummary.self,
"""
/// Returns a bottle of Dr Pepper from the vending machine.
public func drPepper(from vendingMachine: VendingMachine) -> Soda {}
/// Contains a comment as description that needs a sentence
/// of two lines of code.
public var twoLinesForOneSentence = "test"
/// The background color of the view.
var backgroundColor: UIColor
/// Returns the sum of the numbers.
///
/// - Parameter numbers: The numbers to sum.
/// - Returns: The sum of the numbers.
func sum(_ numbers: [Int]) -> Int {
// ...
}
/// This docline should not succeed.
/// There are two sentences without a blank line between them.
1️⃣struct Test {}
/// This docline should not succeed. There are two sentences.
2️⃣public enum Token { case comma, semicolon, identifier }
/// Should fail because it doesn't have a period
3️⃣public class testNoPeriod {}
""",
findings: [
FindingSpec("1️⃣", message: #"add a blank comment line after this sentence: "This docline should not succeed.""#),
FindingSpec("2️⃣", message: #"add a blank comment line after this sentence: "This docline should not succeed.""#),
FindingSpec("3️⃣", message: #"terminate this sentence with a period: "Should fail because it doesn't have a period""#),
]
)
}
func testBlockLineCommentsWithoutOneSentenceSummary() {
assertLint(
BeginDocumentationCommentWithOneLineSummary.self,
"""
/**
* Returns the numeric value.
*
* - Parameters:
* - digit: The Unicode scalar whose numeric value should be returned.
* - radix: The radix, between 2 and 36, used to compute the numeric value.
* - Returns: The numeric value of the scalar.*/
func numericValue(of digit: UnicodeScalar, radix: Int = 10) -> Int {}
/**
* This block comment contains a sentence summary
* of two lines of code.
*/
public var twoLinesForOneSentence = "test"
/**
* This block comment should not succeed, struct.
* There are two sentences without a blank line between them.
*/
1️⃣struct TestStruct {}
/**
This block comment should not succeed, class.
Add a blank comment after the first line.
*/
2️⃣public class TestClass {}
/** This block comment should not succeed, enum. There are two sentences. */
3️⃣public enum testEnum {}
/** Should fail because it doesn't have a period */
4️⃣public class testNoPeriod {}
""",
findings: [
FindingSpec("1️⃣", message: #"add a blank comment line after this sentence: "This block comment should not succeed, struct.""#),
FindingSpec("2️⃣", message: #"add a blank comment line after this sentence: "This block comment should not succeed, class.""#),
FindingSpec("3️⃣", message: #"add a blank comment line after this sentence: "This block comment should not succeed, enum.""#),
FindingSpec("4️⃣", message: #"terminate this sentence with a period: "Should fail because it doesn't have a period""#),
]
)
}
func testApproximationsOnMacOS() {
#if os(macOS)
// Let macOS also verify that the fallback mode works, which gives us signal about whether it
// will also succeed on Linux (where the linguistic APIs are not currently available).
BeginDocumentationCommentWithOneLineSummary._forcesFallbackModeForTesting = true
assertLint(
BeginDocumentationCommentWithOneLineSummary.self,
"""
/// Returns a bottle of Dr Pepper from the vending machine.
public func drPepper(from vendingMachine: VendingMachine) -> Soda {}
/// Contains a comment as description that needs a sentence
/// of two lines of code.
public var twoLinesForOneSentence = "test"
/// The background color of the view.
var backgroundColor: UIColor
/// Returns the sum of the numbers.
///
/// - Parameter numbers: The numbers to sum.
/// - Returns: The sum of the numbers.
func sum(_ numbers: [Int]) -> Int {
// ...
}
/// This docline should not succeed.
/// There are two sentences without a blank line between them.
1️⃣struct Test {}
/// This docline should not succeed. There are two sentences.
2️⃣public enum Token { case comma, semicolon, identifier }
/// Should fail because it doesn't have a period
3️⃣public class testNoPeriod {}
""",
findings: [
FindingSpec("1️⃣", message: #"add a blank comment line after this sentence: "This docline should not succeed.""#),
FindingSpec("2️⃣", message: #"add a blank comment line after this sentence: "This docline should not succeed.""#),
FindingSpec("3️⃣", message: #"terminate this sentence with a period: "Should fail because it doesn't have a period""#),
]
)
#endif
}
func testSentenceTerminationInsideQuotes() {
assertLint(
BeginDocumentationCommentWithOneLineSummary.self,
"""
/// Creates an instance with the same raw value as `x` failing iff `x.kind != Subject.kind`.
struct TestBackTick {}
/// A set of `Diagnostic` that can answer the question ‘was there an error?’ in O(1).
struct TestSingleSmartQuotes {}
/// A set of `Diagnostic` that can answer the question 'was there an error?' in O(1).
struct TestSingleStraightQuotes {}
/// A set of `Diagnostic` that can answer the question “was there an error?” in O(1).
struct TestDoubleSmartQuotes {}
/// A set of `Diagnostic` that can answer the question "was there an error?" in O(1).
struct TestDoubleStraightQuotes {}
/// A set of `Diagnostic` that can answer the question “was there
/// an error?” in O(1).
struct TestTwoLinesDoubleSmartQuotes {}
/// A set of `Diagnostic` that can answer the question "was there
/// an error?" in O(1).
struct TestTwoLinesDoubleStraightQuotes {}
"""
)
}
}
|
