Use whitespace around operator definitions. #82
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,87 @@ | ||
| // | ||
| // OperatorWhitespaceRule.swift | ||
| // SwiftLint | ||
| // | ||
| // Created by Akira Hirakawa on 8/6/15. | ||
| // Copyright (c) 2015 Realm. All rights reserved. | ||
| // | ||
|
|
||
| import SourceKittenFramework | ||
| import SwiftXPC | ||
|
|
||
| public struct OperatorFunctionWhitespaceRule: ASTRule { | ||
| public init() {} | ||
|
|
||
| public let identifier = "operator_whitespace" | ||
|
|
||
| public func validateFile(file: File) -> [StyleViolation] { | ||
| return validateFile(file, dictionary: file.structure.dictionary) | ||
| } | ||
|
|
||
| public func validateFile(file: File, dictionary: XPCDictionary) -> [StyleViolation] { | ||
| return (dictionary["key.substructure"] as? XPCArray ?? []).flatMap { subItem in | ||
| var violations = [StyleViolation]() | ||
| if let subDict = subItem as? XPCDictionary, | ||
| let kindString = subDict["key.kind"] as? String, | ||
| let kind = flatMap(kindString, { SwiftDeclarationKind(rawValue: $0) }) { | ||
| violations.extend(validateFile(file, dictionary: subDict)) | ||
| violations.extend(validateFile(file, kind: kind, dictionary: subDict)) | ||
| } | ||
| return violations | ||
| } | ||
| } | ||
|
|
||
| public func validateFile(file: File, | ||
| kind: SwiftDeclarationKind, | ||
| dictionary: XPCDictionary) -> [StyleViolation] { | ||
| let functionKinds: [SwiftDeclarationKind] = [ | ||
| .FunctionFree, | ||
| ] | ||
| if !contains(functionKinds, kind) { | ||
| return [] | ||
| } | ||
| var violations = [StyleViolation]() | ||
| if let nameOffset = flatMap(dictionary["key.nameoffset"] as? Int64, { Int($0) }), | ||
| let nameLength = flatMap(dictionary["key.namelength"] as? Int64, { Int($0) }), | ||
| let offset = flatMap(dictionary["key.offset"] as? Int64, { Int($0) }) { | ||
|
|
||
| let location = Location(file: file, offset: offset) | ||
| let startAdvance = advance(file.contents.startIndex, nameOffset) | ||
| let endAdvance = advance(startAdvance, nameLength) | ||
| let range = Range<String.Index>(start: startAdvance, end: endAdvance) | ||
|
There was a problem hiding this comment.
There was a problem hiding this comment. ah yes, this is inferred:) I will remove it |
||
| let definition = file.contents.substringWithRange(range) | ||
|
|
||
| let ope1 = ["/", "=", "-", "+", "!", "*", "|", "^", "~", "?", "."].map({ "\\\($0)" }) | ||
|
There was a problem hiding this comment. nice use of There was a problem hiding this comment. it means .map({"($0)"}), doesn't it? |
||
| let ope2 = ["%", "<", ">", "&"] | ||
| let ope = "".join(ope1 + ope2) | ||
| let pattern = "^[\(ope)]+(<[A-Z]+>)?\\(" | ||
|
|
||
| if let regex = NSRegularExpression(pattern: pattern, options: nil, error: nil) { | ||
| let matchRange = NSRange(location: 0, length: count(definition.utf16)) | ||
| let matches = regex.matchesInString(definition, options: nil, range: matchRange) | ||
|
|
||
| if matches.count > 0 { | ||
| violations.append(StyleViolation(type: .OperatorFunctionWhitespace, | ||
| location: location, | ||
| severity: .Medium, | ||
| reason: "Use whitespace around operators when defining them")) | ||
| } | ||
| } | ||
| } | ||
| return violations | ||
| } | ||
|
|
||
| public let example = RuleExample( | ||
| ruleName: "Operator Function Whitespace Rule", | ||
| ruleDescription: "Use whitespace around operators when defining them.", | ||
| nonTriggeringExamples: [ | ||
| "func <| (lhs: Int, rhs: Int) -> Int {}\n", | ||
| "func <|< <A>(lhs: A, rhs: A) -> A {}\n", | ||
| "func abc(lhs: Int, rhs: Int) -> Int {}\n" | ||
| ], | ||
| triggeringExamples: [ | ||
| "func <|(lhs: Int, rhs: Int) -> Int {}\n", | ||
| "func <|<<A>(lhs: A, rhs: A) -> A {}\n" | ||
| ] | ||
| ) | ||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
😄