Files
SwiftLint/Source/SwiftLintFramework/Rules/Style/MultipleClosuresWithTrailingClosureRule.swift
T
2018-12-02 14:01:23 -08:00

89 lines
3.5 KiB
Swift

import Foundation
import SourceKittenFramework
public struct MultipleClosuresWithTrailingClosureRule: ASTRule, ConfigurationProviderRule, AutomaticTestableRule {
public var configuration = SeverityConfiguration(.warning)
public init() {}
public static let description = RuleDescription(
identifier: "multiple_closures_with_trailing_closure",
name: "Multiple Closures with Trailing Closure",
description: "Trailing closure syntax should not be used when passing more than one closure argument.",
kind: .style,
nonTriggeringExamples: [
"foo.map { $0 + 1 }\n",
"foo.reduce(0) { $0 + $1 }\n",
"if let foo = bar.map({ $0 + 1 }) {\n\n}\n",
"foo.something(param1: { $0 }, param2: { $0 + 1 })\n",
"UIView.animate(withDuration: 1.0) {\n" +
" someView.alpha = 0.0\n" +
"}"
],
triggeringExamples: [
"foo.something(param1: { $0 }) ↓{ $0 + 1 }",
"UIView.animate(withDuration: 1.0, animations: {\n" +
" someView.alpha = 0.0\n" +
"}) ↓{ _ in\n" +
" someView.removeFromSuperview()\n" +
"}"
]
)
public func validate(file: File, kind: SwiftExpressionKind,
dictionary: [String: SourceKitRepresentable]) -> [StyleViolation] {
guard kind == .call,
case let arguments = dictionary.enclosedArguments,
arguments.count > 1,
let lastArgument = arguments.last,
isTrailingClosure(argument: lastArgument, call: dictionary),
case let closureArguments = arguments.filterClosures(file: file),
closureArguments.count > 1,
let trailingClosureOffset = lastArgument.offset else {
return []
}
return [
StyleViolation(ruleDescription: type(of: self).description,
severity: configuration.severity,
location: Location(file: file, byteOffset: trailingClosureOffset))
]
}
private func isTrailingClosure(argument: [String: SourceKitRepresentable],
call: [String: SourceKitRepresentable]) -> Bool {
guard let callOffset = call.offset,
let callLength = call.length,
let argumentOffset = argument.offset,
let argumentLength = argument.length else {
return false
}
return callOffset + callLength == argumentOffset + argumentLength
}
}
private extension Array where Element == [String: SourceKitRepresentable] {
func filterClosures(file: File) -> [[String: SourceKitRepresentable]] {
if SwiftVersion.current < .fourDotTwo {
return filter { argument in
guard let offset = argument.bodyOffset,
let length = argument.bodyLength,
let range = file.contents.bridge().byteRangeToNSRange(start: offset, length: length),
let match = regex("^\\s*\\{").firstMatch(in: file.contents, options: [], range: range)?.range,
match.location == range.location else {
return false
}
return true
}
} else {
return filter { argument in
return argument.substructure.contains(where: { dictionary in
dictionary.kind.flatMap(SwiftExpressionKind.init(rawValue:)) == .closure
})
}
}
}
}