-
Notifications
You must be signed in to change notification settings - Fork 2.2k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add ControlStatementRule #39
Merged
Merged
Changes from 1 commit
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
383bd3d
Add ControlStatementRule
andreamazz 86f5f85
Split regex for specific keywords.
andreamazz 8a6c5e7
Remove unused examples
andreamazz 9896857
Enable commentDoesntViolate
andreamazz 2a635c0
Merge conflict
andreamazz a425a36
Update CHANGELOG
andreamazz 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
62 changes: 62 additions & 0 deletions
62
Source/SwiftLintFramework/Rules/ControlStatementRule.swift
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,62 @@ | ||
// | ||
// ControlStatementRule.swift | ||
// SwiftLint | ||
// | ||
// Created by Andrea Mazzini on 26/05/15. | ||
// Copyright (c) 2015 Realm. All rights reserved. | ||
// | ||
|
||
import SourceKittenFramework | ||
|
||
public struct ControlStatementRule: Rule { | ||
public init() {} | ||
|
||
public let identifier = "control_statement" | ||
|
||
public func validateFile(file: File) -> [StyleViolation] { | ||
let statement = file.matchPattern("\\s{0,}(if|for|while)\\s{0,}\\(", | ||
withSyntaxKinds: [.Keyword]) | ||
return statement.map { range in | ||
return StyleViolation(type: .ControlStatement, | ||
location: Location(file: file, offset: range.location), | ||
severity: .Low, | ||
reason: "if,for,while,do statements shouldn't wrap their conditionals in parentheses.") | ||
} | ||
} | ||
|
||
public let example = RuleExample( | ||
ruleName: "Control Statement", | ||
ruleDescription: "if,for,while,do statements shouldn't wrap their conditionals in parentheses.", | ||
nonTriggeringExamples: [ | ||
"if condition {\n", | ||
"renderGif(data)\n", | ||
"// if (hasBetterSyntax) {\n", | ||
"// for (item in collection) {\n", | ||
"// for (var index = 0; index < 42; index++) {\n", | ||
"// for(item in collection) {\n", | ||
"// for(var index = 0; index < 42; index++) {\n", | ||
"for item in collection {\n", | ||
"for var index = 0; index < 42; index++ {\n", | ||
"// while (condition) {\n", | ||
"while condition {\n", | ||
"} while condition {\n", | ||
"// } while (condition {\n", | ||
"do { ; } while condition {\n" | ||
], | ||
triggeringExamples: [ | ||
"if (condition) {\n", | ||
"if(condition) {\n", | ||
"for (item in collection) {\n", | ||
"for (var index = 0; index < 42; index++) {\n", | ||
"for(item in collection) {\n", | ||
"for(var index = 0; index < 42; index++) {\n", | ||
"while (condition) {\n", | ||
"while(condition) {\n", | ||
"} while (condition) {\n", | ||
"} while(condition) {\n", | ||
"do { ; } while(condition) {\n", | ||
"do { ; } while (condition) {\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
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -16,6 +16,7 @@ public enum StyleViolationType: String, Printable { | |
case TODO = "TODO or FIXME" | ||
case Colon = "Colon" | ||
case Nesting = "Nesting" | ||
case ControlStatement = "Control Statement" | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
|
||
|
||
public var description: String { return rawValue } | ||
} |
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.
should probably use the regex match for the specific keyword instead of listing them all