287 lines
9.4 KiB
Swift
287 lines
9.4 KiB
Swift
import SourceKittenFramework
|
|
|
|
public struct CollectionAlignmentRule: ASTRule, ConfigurationProviderRule {
|
|
public var configuration = CollectionAlignmentConfiguration()
|
|
|
|
public init() {}
|
|
|
|
public static var description = RuleDescription(
|
|
identifier: "collection_alignment",
|
|
name: "Collection Element Alignment",
|
|
description: "All elements in a collection literal should be vertically aligned",
|
|
kind: .style,
|
|
isOptIn: true,
|
|
nonTriggeringExamples: Examples(alignColons: false).nonTriggeringExamples,
|
|
triggeringExamples: Examples(alignColons: false).triggeringExamples
|
|
)
|
|
|
|
public func validate(file: File, kind: SwiftExpressionKind,
|
|
dictionary: [String: SourceKitRepresentable]) -> [StyleViolation] {
|
|
guard kind == .dictionary || kind == .array else { return [] }
|
|
|
|
let keyLocations: [Location]
|
|
if kind == .array {
|
|
keyLocations = arrayElementLocations(with: file, dictionary: dictionary)
|
|
} else {
|
|
keyLocations = dictionaryKeyLocations(with: file, dictionary: dictionary)
|
|
}
|
|
|
|
guard keyLocations.count >= 2 else {
|
|
return []
|
|
}
|
|
|
|
let firstKeyLocation = keyLocations[0]
|
|
let remainingKeyLocations = keyLocations[1...]
|
|
let violationLocations = zip(remainingKeyLocations.indices, remainingKeyLocations)
|
|
.compactMap { index, location -> Location? in
|
|
let previousLocation = keyLocations[index - 1]
|
|
guard let previousLine = previousLocation.line,
|
|
let locationLine = location.line,
|
|
let firstKeyCharacter = firstKeyLocation.character,
|
|
let locationCharacter = location.character,
|
|
previousLine < locationLine,
|
|
firstKeyCharacter != locationCharacter else { return nil }
|
|
|
|
return location
|
|
}
|
|
|
|
return violationLocations.map {
|
|
StyleViolation(ruleDescription: type(of: self).description,
|
|
severity: configuration.severityConfiguration.severity,
|
|
location: $0)
|
|
}
|
|
}
|
|
|
|
private func arrayElementLocations(with file: File, dictionary: [String: SourceKitRepresentable]) -> [Location] {
|
|
return dictionary.elements.compactMap { element -> Location? in
|
|
element.offset.map { Location(file: file, byteOffset: $0) }
|
|
}
|
|
}
|
|
|
|
private func dictionaryKeyLocations(with file: File,
|
|
dictionary: [String: SourceKitRepresentable]) -> [Location] {
|
|
var keys: [[String: SourceKitRepresentable]] = []
|
|
var values: [[String: SourceKitRepresentable]] = []
|
|
dictionary.elements.enumerated().forEach { index, element in
|
|
// in a dictionary, the even elements are keys, and the odd elements are values
|
|
if index % 2 == 0 {
|
|
keys.append(element)
|
|
} else {
|
|
values.append(element)
|
|
}
|
|
}
|
|
|
|
return zip(keys, values).compactMap { key, value -> Location? in
|
|
guard let keyOffset = key.offset,
|
|
let valueOffset = value.offset,
|
|
let keyLength = key.length else { return nil }
|
|
|
|
if configuration.alignColons {
|
|
return colonLocation(with: file,
|
|
keyOffset: keyOffset,
|
|
keyLength: keyLength,
|
|
valueOffset: valueOffset)
|
|
} else {
|
|
return Location(file: file, byteOffset: keyOffset)
|
|
}
|
|
}
|
|
}
|
|
|
|
private func colonLocation(with file: File, keyOffset: Int, keyLength: Int, valueOffset: Int) -> Location? {
|
|
let contents = file.contents.bridge()
|
|
let matchStart = keyOffset + keyLength
|
|
let matchLength = valueOffset - matchStart
|
|
let range = contents.byteRangeToNSRange(start: matchStart, length: matchLength)
|
|
|
|
let matches = file.match(pattern: ":", excludingSyntaxKinds: [.comment], range: range)
|
|
return matches.first.map { Location(file: file, characterOffset: $0.location) }
|
|
}
|
|
}
|
|
|
|
extension CollectionAlignmentRule {
|
|
struct Examples {
|
|
private let alignColons: Bool
|
|
|
|
init(alignColons: Bool) {
|
|
self.alignColons = alignColons
|
|
}
|
|
|
|
var triggeringExamples: [String] {
|
|
let examples = alignColons ? alignColonsTriggeringExamples : alignLeftTriggeringExamples
|
|
return examples + sharedTriggeringExamples
|
|
}
|
|
|
|
var nonTriggeringExamples: [String] {
|
|
let examples = alignColons ? alignColonsNonTriggeringExamples : alignLeftNonTriggeringExamples
|
|
return examples + sharedNonTriggeringExamples
|
|
}
|
|
|
|
private var alignColonsTriggeringExamples: [String] {
|
|
return [
|
|
"""
|
|
doThings(arg: [
|
|
"foo": 1,
|
|
"bar": 2,
|
|
"fizz"↓: 2,
|
|
"buzz"↓: 2
|
|
])
|
|
""",
|
|
"""
|
|
let abc = [
|
|
"alpha": "a",
|
|
"beta"↓: "b",
|
|
"gamma": "c",
|
|
"delta": "d",
|
|
"epsilon"↓: "e"
|
|
]
|
|
""",
|
|
"""
|
|
var weirdColons = [
|
|
"a" : 1,
|
|
"b" ↓:2,
|
|
"c" : 3
|
|
]
|
|
"""
|
|
]
|
|
}
|
|
|
|
private var alignColonsNonTriggeringExamples: [String] {
|
|
return [
|
|
"""
|
|
doThings(arg: [
|
|
"foo": 1,
|
|
"bar": 2,
|
|
"fizz": 2,
|
|
"buzz": 2
|
|
])
|
|
""",
|
|
"""
|
|
let abc = [
|
|
"alpha": "a",
|
|
"beta": "b",
|
|
"gamma": "g",
|
|
"delta": "d",
|
|
"epsilon": "e"
|
|
]
|
|
""",
|
|
"""
|
|
var weirdColons = [
|
|
"a" : 1,
|
|
"b" :2,
|
|
"c" : 3
|
|
]
|
|
"""
|
|
]
|
|
}
|
|
|
|
private var alignLeftTriggeringExamples: [String] {
|
|
return [
|
|
"""
|
|
doThings(arg: [
|
|
"foo": 1,
|
|
"bar": 2,
|
|
↓"fizz": 2,
|
|
↓"buzz": 2
|
|
])
|
|
""",
|
|
"""
|
|
let abc = [
|
|
"alpha": "a",
|
|
↓"beta": "b",
|
|
"gamma": "g",
|
|
"delta": "d",
|
|
↓"epsilon": "e"
|
|
]
|
|
""",
|
|
"""
|
|
let meals = [
|
|
"breakfast": "oatmeal",
|
|
"lunch": "sandwich",
|
|
↓"dinner": "burger"
|
|
]
|
|
"""
|
|
]
|
|
}
|
|
|
|
private var alignLeftNonTriggeringExamples: [String] {
|
|
return [
|
|
"""
|
|
doThings(arg: [
|
|
"foo": 1,
|
|
"bar": 2,
|
|
"fizz": 2,
|
|
"buzz": 2
|
|
])
|
|
""",
|
|
"""
|
|
let abc = [
|
|
"alpha": "a",
|
|
"beta": "b",
|
|
"gamma": "g",
|
|
"delta": "d",
|
|
"epsilon": "e"
|
|
]
|
|
""",
|
|
"""
|
|
let meals = [
|
|
"breakfast": "oatmeal",
|
|
"lunch": "sandwich",
|
|
"dinner": "burger"
|
|
]
|
|
"""
|
|
]
|
|
}
|
|
|
|
private var sharedTriggeringExamples: [String] {
|
|
return [
|
|
"""
|
|
let coordinates = [
|
|
CLLocationCoordinate2D(latitude: 0, longitude: 33),
|
|
↓CLLocationCoordinate2D(latitude: 0, longitude: 66),
|
|
CLLocationCoordinate2D(latitude: 0, longitude: 99)
|
|
]
|
|
""",
|
|
"""
|
|
var evenNumbers: Set<Int> = [
|
|
2,
|
|
↓4,
|
|
6
|
|
]
|
|
"""
|
|
]
|
|
}
|
|
|
|
private var sharedNonTriggeringExamples: [String] {
|
|
return [
|
|
"""
|
|
let coordinates = [
|
|
CLLocationCoordinate2D(latitude: 0, longitude: 33),
|
|
CLLocationCoordinate2D(latitude: 0, longitude: 66),
|
|
CLLocationCoordinate2D(latitude: 0, longitude: 99)
|
|
]
|
|
""",
|
|
"""
|
|
var evenNumbers: Set<Int> = [
|
|
2,
|
|
4,
|
|
6
|
|
]
|
|
""",
|
|
"""
|
|
let abc = [1, 2, 3, 4]
|
|
""",
|
|
"""
|
|
let abc = [
|
|
1, 2, 3, 4
|
|
]
|
|
""",
|
|
"""
|
|
let abc = [
|
|
"foo": "bar", "fizz": "buzz"
|
|
]
|
|
"""
|
|
]
|
|
}
|
|
}
|
|
}
|