Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Showing
5 changed files
with
79 additions
and
0 deletions.
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,63 @@ | ||
| // | ||
| // NimbleOperatorRule.swift | ||
| // SwiftLint | ||
| // | ||
| // Created by Marcelo Fabri on 20/11/16. | ||
| // Copyright © 2016 Realm. All rights reserved. | ||
| // | ||
|
|
||
| import SourceKittenFramework | ||
|
|
||
| public struct NimbleOperatorRule: ConfigurationProviderRule, OptInRule { | ||
| public var configuration = SeverityConfiguration(.Warning) | ||
|
|
||
| public init() {} | ||
|
|
||
| public static let description = RuleDescription( | ||
| identifier: "nimble_operator", | ||
| name: "Nimble Operator", | ||
| description: "Prefer Nimble operator overloads over free matcher functions.", | ||
| nonTriggeringExamples: [ | ||
| "expect(seagull.squawk) != \"Hi!\"\n", | ||
| "expect(\"Hi!\") == \"Hi!\"\n", | ||
| "expect(10) > 2\n", | ||
| "expect(10) >= 10\n", | ||
| "expect(10) < 11\n", | ||
| "expect(10) <= 10\n", | ||
| "expect(x) === x", | ||
| "expect(10) == 10", | ||
| "expect(object.asyncFunction()).toEventually(equal(1))\n", | ||
| "expect(actual).to(haveCount(expected))\n" | ||
| ], | ||
| triggeringExamples: [ | ||
| "↓expect(seagull.squawk).toNot(equal(\"Hi\"))\n", | ||
| "↓expect(12).toNot(equal(10))\n", | ||
| "↓expect(10).to(equal(10))\n", | ||
| "↓expect(10).to(beGreaterThan(8))\n", | ||
| "↓expect(10).to(beGreaterThanOrEqualTo(10))\n", | ||
| "↓expect(10).to(beLessThan(11))\n", | ||
| "↓expect(10).to(beLessThanOrEqualTo(10))\n", | ||
| "↓expect(x).to(beIdenticalTo(x))\n", | ||
| "expect(10) > 2\n ↓expect(10).to(beGreaterThan(2))\n", | ||
| ] | ||
| ) | ||
|
|
||
| public func validateFile(file: File) -> [StyleViolation] { | ||
| let operators = ["equal", "beIdenticalTo", "beGreaterThan", | ||
| "beGreaterThanOrEqualTo", "beLessThan", "beLessThanOrEqualTo"] | ||
| let operatorsPattern = "(" + operators.joinWithSeparator("|") + ")" | ||
| let pattern = "expect\\((.(?!expect\\())+?\\)\\.to(Not)?\\(\(operatorsPattern)\\(" | ||
| let excludingKinds = SyntaxKind.commentKinds() | ||
|
|
||
| let matches = file.matchPattern(pattern).filter { | ||
| // excluding comment kinds and making sure first token (`expect`) is an identifier | ||
| $0.1.filter(excludingKinds.contains).isEmpty && $0.1.first == .Identifier | ||
| } | ||
|
|
||
| return matches.map { | ||
| StyleViolation(ruleDescription: self.dynamicType.description, | ||
| severity: configuration.severity, | ||
| location: Location(file: file, byteOffset: $0.0.location)) | ||
| } | ||
| } | ||
| } |
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