mirror of
https://github.com/realm/SwiftLint.git
synced 2026-05-07 20:12:49 +00:00
JP Simard
fa6bf50a22
A long-standing limitation with SourceKit's "editor open" request is
that we weren't able to get certain tokens, such as braces, brackets and
parentheses.
This meant that this code block would be counted as two lines:
```swift
print(
"hi"
)
```
because the trailing `)` would be treated as a whitespace line.
This meant that our "body length" family of rules that measure the
effective line count of declarations like functions, types or closures
would often significantly under-count the number of content lines in a
body.
Now with SwiftSyntax, we can get all tokens, including the ones
SourceKit was previously ignoring, so we can get much more accurate line
counts when ignoring whitespace and comments.
In addition, we weren't very thorough in how we measured body length.
As an exercise, how many lines long would you say the body of this
function is?
```swift
func hello() {
print("hello")
}
```
Does the body span one line or three lines?
I propose that we consistently ignore the left and right brace lines
when calculating the body line count of these scopes so that we measure
body line counts like this:
```swift
// 1 line
{ print("foo") }
// 1 line
{
}
// 1 line
{
print("foo")
}
// 2 lines
{
let sum = 1 + 2
print(sum)
}
```
Now with those changes in place, in order to keep the default
configuration thresholds to similar levels as before, we need to adjust
them slightly. Here's what I'm suggesting:
|Rule|Before|After|
|-|-|-|
|closure_body_length|20/100|30/100|
|function_body_length|40/100|50/100|
|type_body_length|200/350|250/350|
This is a pretty significant breaking change and I suspect we'll hear
from users who are surprised that some of their declarations now exceed
the rule limits, but I believe this new approach to calculating body
lines is more correct and intuitive compared to what we've had until
now.
OSSCheck is also going to report a bazillion changes with this, which is
expected given the scope of this change.
271 lines
7.9 KiB
Swift
271 lines
7.9 KiB
Swift
internal struct AccessibilityTraitForButtonRuleExamples {
|
|
static let nonTriggeringExamples = [
|
|
Example("""
|
|
struct MyView: View {
|
|
var body: some View {
|
|
Button {
|
|
print("tapped")
|
|
} label: {
|
|
Text("Learn more")
|
|
}
|
|
}
|
|
}
|
|
"""),
|
|
Example("""
|
|
struct MyView: View {
|
|
var body: some View {
|
|
Link("Open link", destination: myUrl)
|
|
}
|
|
}
|
|
"""),
|
|
Example("""
|
|
struct MyView: View {
|
|
var body: some View {
|
|
Text("Learn more")
|
|
.onTapGesture {
|
|
print("tapped - open URL")
|
|
}
|
|
.accessibility(addTraits: .isLink)
|
|
}
|
|
}
|
|
"""),
|
|
Example("""
|
|
struct MyView: View {
|
|
var body: some View {
|
|
Text("Learn more")
|
|
.accessibilityAddTraits(.isButton)
|
|
.onTapGesture {
|
|
print("tapped")
|
|
}
|
|
}
|
|
}
|
|
"""),
|
|
Example("""
|
|
struct MyView: View {
|
|
var body: some View {
|
|
Text("Learn more")
|
|
.accessibility(addTraits: [.isButton, .isHeader])
|
|
.onTapGesture {
|
|
print("tapped")
|
|
}
|
|
}
|
|
}
|
|
"""),
|
|
Example("""
|
|
struct MyView: View {
|
|
var body: some View {
|
|
Text("Learn more")
|
|
.onTapGesture {
|
|
print("tapped - open URL")
|
|
}
|
|
.accessibilityAddTraits([.isHeader, .isLink])
|
|
}
|
|
}
|
|
"""),
|
|
Example("""
|
|
struct MyView: View {
|
|
var body: some View {
|
|
Text("Learn more")
|
|
.onTapGesture(count: 1) {
|
|
print("tapped")
|
|
}
|
|
.accessibility(addTraits: .isButton)
|
|
}
|
|
}
|
|
"""),
|
|
Example("""
|
|
struct MyView: View {
|
|
var body: some View {
|
|
Text("Learn more")
|
|
.onTapGesture(count: 1, perform: {
|
|
print("tapped")
|
|
})
|
|
.accessibility(addTraits: .isButton)
|
|
}
|
|
}
|
|
"""),
|
|
Example("""
|
|
struct MyView: View {
|
|
var body: some View {
|
|
Text("Learn more")
|
|
// This rule does not include tap gestures with multiple taps for now.
|
|
// Custom gestures like this are also not very accessible, but require
|
|
// alternative ways to accomplish the same task with assistive tech.
|
|
.onTapGesture(count: 2) {
|
|
print("double-tapped")
|
|
}
|
|
}
|
|
}
|
|
"""),
|
|
Example("""
|
|
struct MyView: View {
|
|
var body: some View {
|
|
Label("Learn more", systemImage: "info.circle")
|
|
.onTapGesture(count: 1) {
|
|
print("tapped")
|
|
}
|
|
.accessibility(addTraits: .isButton)
|
|
}
|
|
}
|
|
"""),
|
|
Example("""
|
|
struct MyView: View {
|
|
var body: some View {
|
|
HStack {
|
|
Image(systemName: "info.circle")
|
|
Text("Learn more")
|
|
}
|
|
.onTapGesture {
|
|
print("tapped")
|
|
}
|
|
// This modifier is not strictly required — each subview will inherit the button trait.
|
|
// That said, grouping a tappable stack into a single element is a good way to reduce
|
|
// the number of swipes required for a VoiceOver user to navigate the page.
|
|
.accessibilityElement(children: .combine)
|
|
.accessibility(addTraits: .isButton)
|
|
}
|
|
}
|
|
"""),
|
|
Example("""
|
|
struct MyView: View {
|
|
var body: some View {
|
|
Text("Learn more")
|
|
.gesture(TapGesture().onEnded {
|
|
print("tapped")
|
|
})
|
|
.accessibilityAddTraits(.isButton)
|
|
}
|
|
}
|
|
"""),
|
|
Example("""
|
|
struct MyView: View {
|
|
var body: some View {
|
|
Text("Learn more")
|
|
.simultaneousGesture(TapGesture(count: 1).onEnded {
|
|
print("tapped - open URL")
|
|
})
|
|
.accessibilityAddTraits(.isLink)
|
|
}
|
|
}
|
|
"""),
|
|
Example("""
|
|
struct MyView: View {
|
|
var body: some View {
|
|
Text("Learn more")
|
|
.highPriorityGesture(TapGesture().onEnded {
|
|
print("tapped")
|
|
})
|
|
.accessibility(addTraits: [.isButton])
|
|
}
|
|
}
|
|
"""),
|
|
Example("""
|
|
struct MyView: View {
|
|
var body: some View {
|
|
Text("Learn more")
|
|
.gesture(TapGesture(count: 2).onEnded {
|
|
print("tapped")
|
|
})
|
|
}
|
|
}
|
|
""")
|
|
]
|
|
|
|
static let triggeringExamples = [
|
|
Example("""
|
|
struct MyView: View {
|
|
var body: some View {
|
|
↓Text("Learn more")
|
|
.onTapGesture {
|
|
print("tapped")
|
|
}
|
|
}
|
|
}
|
|
"""),
|
|
Example("""
|
|
struct MyView: View {
|
|
var body: some View {
|
|
↓Text("Learn more")
|
|
.accessibility(addTraits: .isHeader)
|
|
.onTapGesture {
|
|
print("tapped")
|
|
}
|
|
}
|
|
}
|
|
"""),
|
|
Example("""
|
|
struct MyView: View {
|
|
var body: some View {
|
|
↓Text("Learn more")
|
|
.onTapGesture(count: 1) {
|
|
print("tapped")
|
|
}
|
|
}
|
|
}
|
|
"""),
|
|
Example("""
|
|
struct MyView: View {
|
|
var body: some View {
|
|
↓Text("Learn more")
|
|
.onTapGesture(count: 1, perform: {
|
|
print("tapped")
|
|
})
|
|
}
|
|
}
|
|
"""),
|
|
Example("""
|
|
struct MyView: View {
|
|
var body: some View {
|
|
↓Label("Learn more", systemImage: "info.circle")
|
|
.onTapGesture(count: 1) {
|
|
print("tapped")
|
|
}
|
|
}
|
|
}
|
|
"""),
|
|
Example("""
|
|
struct MyView: View {
|
|
var body: some View {
|
|
↓HStack {
|
|
Image(systemName: "info.circle")
|
|
Text("Learn more")
|
|
}
|
|
.onTapGesture {
|
|
print("tapped")
|
|
}
|
|
}
|
|
}
|
|
"""),
|
|
Example("""
|
|
struct MyView: View {
|
|
var body: some View {
|
|
↓Text("Learn more")
|
|
.gesture(TapGesture().onEnded {
|
|
print("tapped")
|
|
})
|
|
}
|
|
}
|
|
"""),
|
|
Example("""
|
|
struct MyView: View {
|
|
var body: some View {
|
|
↓Text("Learn more")
|
|
.simultaneousGesture(TapGesture(count: 1).onEnded {
|
|
print("tapped")
|
|
})
|
|
}
|
|
}
|
|
"""),
|
|
Example("""
|
|
struct MyView: View {
|
|
var body: some View {
|
|
↓Text("Learn more")
|
|
.highPriorityGesture(TapGesture().onEnded {
|
|
print("tapped")
|
|
})
|
|
}
|
|
}
|
|
""")
|
|
]
|
|
}
|