Add Mark rule for triple slash Mark comments (#2868)

* Add Mark rule for triple slash Mark comments * Move changelog entry to appropriate section * Re-add Package.resolved * Fix trailing comma * Rebuild Rules.md using Xcode 10.3 * Combine two regexes into one
realm · Sep 19, 2019 · 406a8f2 · 406a8f2
1 parent d5f37ca
commit 406a8f2
Show file tree

Hide file tree

Showing 6 changed files with 30 additions and 5 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -19,6 +19,10 @@
 * Make `contains_over_first_not_nil` rule also match `first(where:) == nil`.  
   [Colton Schlosser](https://github.com/cltnschlosser)
 
+* Add two new cases to the Mark rule to detect a Mark using three slashes.  
+  [nvanfleet](https://github.com/nvanfleet)
+  [#2866](https://github.com/realm/SwiftLint/issues/2866)
+
 #### Bug Fixes
 
 * None.

diff --git a/Rules.md b/Rules.md
@@ -12062,6 +12062,14 @@ MARK comment should be in valid format. e.g. '// MARK: ...' or '// MARK: - ...'
 ↓// MARKK -
 ```
 
+```swift
+↓/// MARK:
+```
+
+```swift
+↓/// MARK bad
+```
+
 ```swift
 ↓//MARK:- Top-Level bad mark
 ↓//MARK:- Another bad mark

diff --git a/Source/SwiftLintFramework/Models/MasterRuleList.swift b/Source/SwiftLintFramework/Models/MasterRuleList.swift
@@ -1,4 +1,4 @@
-// Generated using Sourcery 0.16.2 — https://github.com/krzysztofzablocki/Sourcery
+// Generated using Sourcery 0.17.0 — https://github.com/krzysztofzablocki/Sourcery
 // DO NOT EDIT
 
 public let masterRuleList = RuleList(rules: [

diff --git a/Source/SwiftLintFramework/Rules/Lint/MarkRule.swift b/Source/SwiftLintFramework/Rules/Lint/MarkRule.swift
@@ -41,6 +41,8 @@ public struct MarkRule: CorrectableRule, ConfigurationProviderRule {
             "↓// MARKL:",
             "↓// MARKR ",
             "↓// MARKK -",
+            "↓/// MARK:",
+            "↓/// MARK bad",
             issue1029Example
         ],
         corrections: [
@@ -60,6 +62,8 @@ public struct MarkRule: CorrectableRule, ConfigurationProviderRule {
             "↓// MARKL: -": "// MARK: -",
             "↓// MARKK ": "// MARK: ",
             "↓// MARKK -": "// MARK: -",
+            "↓/// MARK:": "// MARK:",
+            "↓/// MARK comment": "// MARK: comment",
             issue1029Example: issue1029Correction
         ]
     )
@@ -83,14 +87,16 @@ public struct MarkRule: CorrectableRule, ConfigurationProviderRule {
     private let oneOrMoreSpacesBeforeColonPattern = "(?:// ?MARK +:)"
     private let nonWhitespaceBeforeColonPattern = "(?:// ?MARK\\S+:)"
     private let nonWhitespaceNorColonBeforeSpacesPattern = "(?:// ?MARK[^\\s:]* +)"
+    private let threeSlashesInsteadOfTwo = "/// MARK:?"
 
     private var pattern: String {
         return [
             spaceStartPattern,
             invalidEndSpacesPattern,
             invalidSpacesAfterHyphenPattern,
             invalidLowercasePattern,
-            missingColonPattern
+            missingColonPattern,
+            threeSlashesInsteadOfTwo
         ].joined(separator: "|")
     }
 
@@ -146,6 +152,10 @@ public struct MarkRule: CorrectableRule, ConfigurationProviderRule {
                                           pattern: invalidLowercasePattern,
                                           replaceString: "// MARK:"))
 
+        result.append(contentsOf: correct(file: file,
+                                          pattern: threeSlashesInsteadOfTwo,
+                                          replaceString: "// MARK:"))
+
         return result.unique
     }
 
@@ -175,7 +185,10 @@ public struct MarkRule: CorrectableRule, ConfigurationProviderRule {
     private func violationRanges(in file: File, matching pattern: String) -> [NSRange] {
         let nsstring = file.contents.bridge()
         return file.rangesAndTokens(matching: pattern).filter { _, syntaxTokens in
-            return !syntaxTokens.isEmpty && SyntaxKind(rawValue: syntaxTokens[0].type) == .comment
+            guard let syntaxKind = SyntaxKind(rawValue: syntaxTokens[0].type) else {
+                return false
+            }
+            return !syntaxTokens.isEmpty && SyntaxKind.commentKinds.contains(syntaxKind)
         }.compactMap { range, syntaxTokens in
             let identifierRange = nsstring
                 .byteRangeToNSRange(start: syntaxTokens[0].offset, length: 0)

diff --git a/Tests/LinuxMain.swift b/Tests/LinuxMain.swift
@@ -1,4 +1,4 @@
-// Generated using Sourcery 0.16.2 — https://github.com/krzysztofzablocki/Sourcery
+// Generated using Sourcery 0.17.0 — https://github.com/krzysztofzablocki/Sourcery
 // DO NOT EDIT
 
 @testable import SwiftLintFrameworkTests

diff --git a/Tests/SwiftLintFrameworkTests/AutomaticRuleTests.generated.swift b/Tests/SwiftLintFrameworkTests/AutomaticRuleTests.generated.swift
@@ -1,4 +1,4 @@
-// Generated using Sourcery 0.16.2 — https://github.com/krzysztofzablocki/Sourcery
+// Generated using Sourcery 0.17.0 — https://github.com/krzysztofzablocki/Sourcery
 // DO NOT EDIT
 
 import SwiftLintFramework