add LegacyConstantRule #344
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,80 @@ | ||
| // | ||
| // LegacyConstantRule.swift | ||
| // SwiftLint | ||
| // | ||
| // Created by Aaron McTavish on 12/01/2016. | ||
| // Copyright © 2016 Realm. All rights reserved. | ||
| // | ||
|
|
||
| import SourceKittenFramework | ||
| import CoreGraphics | ||
|
There was a problem hiding this comment. I don't think you need this import. |
||
|
|
||
| public struct LegacyConstantRule: CorrectableRule { | ||
| public static let description = RuleDescription( | ||
| identifier: "legacy_constant", | ||
| name: "Legacy Constant", | ||
| description: "Struct-scoped constants are preferred over legacy global constants.", | ||
| nonTriggeringExamples: [ | ||
| "CGRect.infinite", | ||
| "CGPoint.zero", | ||
| "CGRect.zero", | ||
| "CGSize.zero", | ||
| "CGRect.null" | ||
| ], | ||
| triggeringExamples: [ | ||
| "↓CGRectInfinite", | ||
| "↓CGPointZero", | ||
| "↓CGRectZero", | ||
| "↓CGSizeZero", | ||
| "↓CGRectNull" | ||
| ], | ||
| corrections: [ | ||
| "CGRectInfinite\n": "CGRect.infinite\n", | ||
| "CGPointZero\n": "CGPoint.zero\n", | ||
| "CGRectZero\n": "CGRect.zero\n", | ||
| "CGSizeZero\n": "CGSize.zero\n", | ||
| "CGRectNull\n": "CGRect.null\n" | ||
| ] | ||
| ) | ||
|
|
||
| public func validateFile(file: File) -> [StyleViolation] { | ||
| let constants = ["CGRectInfinite", "CGPointZero", "CGRectZero", "CGSizeZero", | ||
| "CGRectNull"] | ||
|
|
||
| let pattern = "\\b(" + constants.joinWithSeparator("|") + ")\\b" | ||
|
|
||
| return file.matchPattern(pattern, withSyntaxKinds: [.Identifier]).map { | ||
| StyleViolation(ruleDescription: self.dynamicType.description, | ||
| location: Location(file: file, characterOffset: $0.location)) | ||
| } | ||
| } | ||
|
|
||
| public func correctFile(file: File) -> [Correction] { | ||
| let patterns = [ | ||
| "CGRectInfinite": "CGRect.infinite", | ||
| "CGPointZero": "CGPoint.zero", | ||
| "CGRectZero": "CGRect.zero", | ||
| "CGSizeZero": "CGSize.zero", | ||
| "CGRectNull": "CGRect.null" | ||
| ] | ||
|
|
||
| let description = self.dynamicType.description | ||
| var corrections = [Correction]() | ||
| var contents = file.contents | ||
|
|
||
| for (pattern, template) in patterns { | ||
| let matches = file.matchPattern(pattern, excludingSyntaxKinds: [.Comment]) | ||
|
There was a problem hiding this comment. Why not filter on And here you're scanning the entire file for each pattern, whereas |
||
|
|
||
| let regularExpression = regex(pattern) | ||
| for range in matches.reverse() { | ||
| contents = regularExpression.stringByReplacingMatchesInString(contents, | ||
| options: [], range: range, withTemplate: template) | ||
| let location = Location(file: file, characterOffset: range.location) | ||
| corrections.append(Correction(ruleDescription: description, location: location)) | ||
| } | ||
| } | ||
|
|
||
| file.write(contents) | ||
| return corrections | ||
| } | ||
| } | ||
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.
missing 2 trailing spaces as described in https://github.com/realm/SwiftLint/blob/master/CONTRIBUTING.md#tracking-changes.