-
Notifications
You must be signed in to change notification settings - Fork 2.2k
New issue
Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? # to your account
Add First where rule #1012
Merged
Merged
Add First where rule #1012
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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
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,97 @@ | ||
| // | ||
| // FirstWhereRule.swift | ||
| // SwiftLint | ||
| // | ||
| // Created by Marcelo Fabri on 12/20/16. | ||
| // Copyright © 2016 Realm. All rights reserved. | ||
| // | ||
|
|
||
| import Foundation | ||
| import SourceKittenFramework | ||
|
|
||
| public struct FirstWhereRule: OptInRule, ConfigurationProviderRule { | ||
| public var configuration = SeverityConfiguration(.warning) | ||
|
|
||
| public init() {} | ||
|
|
||
| public static let description = RuleDescription( | ||
| identifier: "first_where", | ||
| name: "First Where", | ||
| description: "Prefer using `.first(where:)` over `.filter { }.first` in collections.", | ||
| nonTriggeringExamples: [ | ||
| "kinds.filter(excludingKinds.contains).isEmpty && kinds.first == .identifier\n", | ||
| "myList.first(where: { $0 % 2 == 0 })\n", | ||
| "matchPattern(pattern).filter { $0.first == .identifier }\n" | ||
| ], | ||
| triggeringExamples: [ | ||
| "↓myList.filter { $0 % 2 == 0 }.first\n", | ||
| "↓myList.filter({ $0 % 2 == 0 }).first\n", | ||
| "↓myList.map { $0 + 1 }.filter({ $0 % 2 == 0 }).first\n", | ||
| "↓myList.map { $0 + 1 }.filter({ $0 % 2 == 0 }).first?.something()\n", | ||
| "↓myList.filter(someFunction).first\n" | ||
| ] | ||
| ) | ||
|
|
||
| public func validateFile(_ file: File) -> [StyleViolation] { | ||
| let pattern = "[\\s\\}\\)]*\\.first" | ||
| let firstRanges = file.matchPattern(pattern, withSyntaxKinds: [.identifier]) | ||
| let contents = file.contents.bridge() | ||
| let structure = file.structure | ||
|
|
||
| let violatingLocations: [Int] = firstRanges.flatMap { | ||
| guard let bodyByteRange = contents.NSRangeToByteRange(start: $0.location, | ||
| length: $0.length), | ||
| case let firstLocation = $0.location + $0.length - 1, | ||
| let firstByteRange = contents.NSRangeToByteRange(start: firstLocation, | ||
| length: 1) else { | ||
| return nil | ||
| } | ||
|
|
||
| return methodCallFor(bodyByteRange.location - 1, | ||
| excludingOffset: firstByteRange.location, | ||
| dictionary: structure.dictionary, predicate: { dictionary in | ||
| guard let name = dictionary["key.name"] as? String else { | ||
| return false | ||
| } | ||
|
|
||
| return name.hasSuffix(".filter") | ||
| }) | ||
| } | ||
|
|
||
| return violatingLocations.map { | ||
| StyleViolation(ruleDescription: type(of: self).description, | ||
| severity: configuration.severity, | ||
| location: Location(file: file, byteOffset: $0)) | ||
| } | ||
| } | ||
|
|
||
| private func methodCallFor(_ byteOffset: Int, | ||
| excludingOffset: Int, | ||
| dictionary: [String: SourceKitRepresentable], | ||
| predicate: ([String: SourceKitRepresentable]) -> Bool) -> Int? { | ||
|
|
||
| if let kindString = (dictionary["key.kind"] as? String), | ||
| SwiftExpressionKind(rawValue: kindString) == .call, | ||
| let bodyOffset = (dictionary["key.bodyoffset"] as? Int64).flatMap({ Int($0) }), | ||
| let bodyLength = (dictionary["key.bodylength"] as? Int64).flatMap({ Int($0) }), | ||
| let offset = (dictionary["key.offset"] as? Int64).flatMap({ Int($0) }) { | ||
| let byteRange = NSRange(location: bodyOffset, length: bodyLength) | ||
|
|
||
| if NSLocationInRange(byteOffset, byteRange) && | ||
| !NSLocationInRange(excludingOffset, byteRange) && predicate(dictionary) { | ||
| return offset | ||
| } | ||
| } | ||
|
|
||
| if let subStructure = dictionary["key.substructure"] as? [SourceKitRepresentable] { | ||
| for case let dictionary as [String: SourceKitRepresentable] in subStructure { | ||
| if let offset = methodCallFor(byteOffset, excludingOffset: excludingOffset, | ||
| dictionary: dictionary, predicate: predicate) { | ||
| return offset | ||
| } | ||
| } | ||
| } | ||
|
|
||
| return nil | ||
| } | ||
| } |
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.
oops, bad rebase 😅