Ignore block comments in let_var_whitespace rule (realm#4889)

hiltonc · Apr 15, 2023 · f127ba1 · f127ba1
1 parent 74b82da
commit f127ba1
Show file tree

Hide file tree

Showing 2 changed files with 20 additions and 2 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -37,6 +37,10 @@
   [SimplyDanny](https://github.com/SimplyDanny)
   [#4860](https://github.com/realm/SwiftLint/issues/4860)
 
+* Ignore block comments in `let_var_whitespace` rule.  
+  [SimplyDanny](https://github.com/SimplyDanny)
+  [#4871](https://github.com/realm/SwiftLint/issues/4871)
+
 * Fix false positives in `indentation_width` rule.  
   [Sven Münnich](https://github.com/svenmuennich)
 

diff --git a/Source/SwiftLintFramework/Rules/Style/LetVarWhitespaceRule.swift b/Source/SwiftLintFramework/Rules/Style/LetVarWhitespaceRule.swift
@@ -40,7 +40,17 @@ struct LetVarWhitespaceRule: ConfigurationProviderRule, OptInRule {
                 @Attribute
                 func f() {}
             """),
-            Example("var x: Int {\n\tlet a = 0\n\treturn a\n}\n") // don't trigger on local vars
+            Example("var x: Int {\n\tlet a = 0\n\treturn a\n}\n"), // don't trigger on local vars
+            Example("""
+            struct S {
+                static var test: String { /* Comment block */
+                    let s = "!"
+                    return "Test" + s
+                }
+
+                func f() {}
+            }
+            """, excludeFromDocumentation: true)
         ],
         triggeringExamples: [
             Example("var x = 1\n↓x = 2\n"),
@@ -213,7 +223,11 @@ struct LetVarWhitespaceRule: ConfigurationProviderRule, OptInRule {
         for token in syntaxMap.tokens where token.kind == .comment ||
                                             token.kind == .docComment {
             let startLine = file.line(byteOffset: token.offset)
-            let endLine = file.line(byteOffset: token.offset + token.length)
+            var endLine = file.line(byteOffset: token.offset + token.length)
+
+            if file.contents(for: token)?.starts(with: "/*") == true {
+                endLine += 1
+            }
 
             if startLine <= endLine {
                 result.formUnion(Set(startLine...endLine))