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
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
|
@_spi(Rules) import SwiftFormat
import _SwiftFormatTestSupport
final class AllPublicDeclarationsHaveDocumentationTests: LintOrFormatRuleTestCase {
func testPublicDeclsWithoutDocs() {
assertLint(
AllPublicDeclarationsHaveDocumentation.self,
"""
1️⃣public func lightswitchRave() {}
/// Comment.
public func lightswitchRave() {}
func lightswitchRave() {}
2️⃣public var isSblounskched: Int { return 0 }
/// Comment.
public var isSblounskched: Int { return 0 }
var isSblounskched: Int { return 0 }
3️⃣public struct Foo {}
/// Comment.
public struct Foo {}
struct Foo {}
4️⃣public actor Bar {}
/// Comment.
public actor Bar {}
actor Bar {}
5️⃣public class Baz {}
/// Comment.
public class Baz {}
class Baz {}
6️⃣public enum Qux {}
/// Comment.
public enum Qux {}
enum Qux {}
7️⃣public typealias MyType = Int
/// Comment.
public typealias MyType = Int
typealias MyType = Int
/**
* Determines if an email was delorted.
*/
public var isDelorted: Bool {
return false
}
""",
findings: [
FindingSpec("1️⃣", message: "add a documentation comment for 'lightswitchRave()'"),
FindingSpec("2️⃣", message: "add a documentation comment for 'isSblounskched'"),
FindingSpec("3️⃣", message: "add a documentation comment for 'Foo'"),
FindingSpec("4️⃣", message: "add a documentation comment for 'Bar'"),
FindingSpec("5️⃣", message: "add a documentation comment for 'Baz'"),
FindingSpec("6️⃣", message: "add a documentation comment for 'Qux'"),
FindingSpec("7️⃣", message: "add a documentation comment for 'MyType'"),
]
)
}
func testNestedDecls() {
assertLint(
AllPublicDeclarationsHaveDocumentation.self,
"""
/// Comment.
public struct MyContainer {
1️⃣public func lightswitchRave() {}
/// Comment.
public func lightswitchRave() {}
func lightswitchRave() {}
2️⃣public var isSblounskched: Int { return 0 }
/// Comment.
public var isSblounskched: Int { return 0 }
var isSblounskched: Int { return 0 }
3️⃣public struct Foo {}
/// Comment.
public struct Foo {}
struct Foo {}
4️⃣public actor Bar {}
/// Comment.
public actor Bar {}
actor Bar {}
5️⃣public class Baz {}
/// Comment.
public class Baz {}
class Baz {}
6️⃣public enum Qux {}
/// Comment.
public enum Qux {}
enum Qux {}
7️⃣public typealias MyType = Int
/// Comment.
public typealias MyType = Int
typealias MyType = Int
}
""",
findings: [
FindingSpec("1️⃣", message: "add a documentation comment for 'lightswitchRave()'"),
FindingSpec("2️⃣", message: "add a documentation comment for 'isSblounskched'"),
FindingSpec("3️⃣", message: "add a documentation comment for 'Foo'"),
FindingSpec("4️⃣", message: "add a documentation comment for 'Bar'"),
FindingSpec("5️⃣", message: "add a documentation comment for 'Baz'"),
FindingSpec("6️⃣", message: "add a documentation comment for 'Qux'"),
FindingSpec("7️⃣", message: "add a documentation comment for 'MyType'"),
]
)
}
func testNestedInStruct() {
assertLint(
AllPublicDeclarationsHaveDocumentation.self,
"""
/// Comment.
public struct MyContainer {
1️⃣public typealias MyType = Int
/// Comment.
public typealias MyType = Int
typealias MyType = Int
}
""",
findings: [
FindingSpec("1️⃣", message: "add a documentation comment for 'MyType'")
]
)
}
func testNestedInClass() {
assertLint(
AllPublicDeclarationsHaveDocumentation.self,
"""
/// Comment.
public class MyContainer {
1️⃣public typealias MyType = Int
/// Comment.
public typealias MyType = Int
typealias MyType = Int
}
""",
findings: [
FindingSpec("1️⃣", message: "add a documentation comment for 'MyType'")
]
)
}
func testNestedInEnum() {
assertLint(
AllPublicDeclarationsHaveDocumentation.self,
"""
/// Comment.
public enum MyContainer {
1️⃣public typealias MyType = Int
/// Comment.
public typealias MyType = Int
typealias MyType = Int
}
""",
findings: [
FindingSpec("1️⃣", message: "add a documentation comment for 'MyType'")
]
)
}
func testNestedInActor() {
assertLint(
AllPublicDeclarationsHaveDocumentation.self,
"""
/// Comment.
public actor MyContainer {
1️⃣public typealias MyType = Int
/// Comment.
public typealias MyType = Int
typealias MyType = Int
}
""",
findings: [
FindingSpec("1️⃣", message: "add a documentation comment for 'MyType'")
]
)
}
}
|
