SwiftLint/Source/SwiftLintFramework/Rules/OperatorFunctionWhitespaceR...

53 lines
2.2 KiB
Swift

//
// OperatorWhitespaceRule.swift
// SwiftLint
//
// Created by Akira Hirakawa on 8/6/15.
// Copyright (c) 2015 Realm. All rights reserved.
//
import SourceKittenFramework
public struct OperatorFunctionWhitespaceRule: ConfigProviderRule {
public var config = SeverityConfig(.Warning)
public init() {}
public static let description = RuleDescription(
identifier: "operator_whitespace",
name: "Operator Function Whitespace",
description: "Operators should be surrounded by a single whitespace when defining them.",
nonTriggeringExamples: [
Trigger("func <| (lhs: Int, rhs: Int) -> Int {}\n"),
Trigger("func <|< <A>(lhs: A, rhs: A) -> A {}\n"),
Trigger("func abc(lhs: Int, rhs: Int) -> Int {}\n")
],
triggeringExamples: [
Trigger("↓func <|(lhs: Int, rhs: Int) -> Int {}\n"), // no spaces after
Trigger("↓func <|<<A>(lhs: A, rhs: A) -> A {}\n"), // no spaces after
Trigger("↓func <| (lhs: Int, rhs: Int) -> Int {}\n"), // 2 spaces after
Trigger("↓func <|< <A>(lhs: A, rhs: A) -> A {}\n"), // 2 spaces after
Trigger("↓func <| (lhs: Int, rhs: Int) -> Int {}\n"), // 2 spaces before
Trigger("↓func <|< <A>(lhs: A, rhs: A) -> A {}\n") // 2 spaces before
]
)
public func validateFile(file: File) -> [StyleViolation] {
let operators = ["/", "=", "-", "+", "!", "*", "|", "^", "~", "?", "."].map({"\\\($0)"}) +
["%", "<", ">", "&"]
let zeroOrManySpaces = "(\\s{0}|\\s{2,})"
let pattern1 = "func\\s+[" + operators.joinWithSeparator("") +
"]+\(zeroOrManySpaces)(<[A-Z]+>)?\\("
let pattern2 = "func\(zeroOrManySpaces)[" + operators.joinWithSeparator("") +
"]+\\s+(<[A-Z]+>)?\\("
return file.matchPattern("(\(pattern1)|\(pattern2))").filter { _, syntaxKinds in
return syntaxKinds.first == .Keyword
}.map { range, _ in
return StyleViolation(ruleDescription: self.dynamicType.description,
severity: config.severity,
location: Location(file: file, characterOffset: range.location))
}
}
}