Ignore shebang in all rules

By making a creative use of regions. Fixes #1294.
realm · Jul 25, 2017 · 70fc1a1 · 70fc1a1
1 parent d6e7df2
commit 70fc1a1
Show file tree

Hide file tree

Showing 3 changed files with 19 additions and 1 deletion.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -83,6 +83,10 @@
   [Marcelo Fabri](https://github.com/marcelofabri)
   [#54](https://github.com/realm/SwiftLint/issues/54)
 
+* Shebang (`#!`) in the beginning of a file is now ignored by all rules.  
+  [Marcelo Fabri](https://github.com/marcelofabri)
+  [#1294](https://github.com/realm/SwiftLint/issues/1294)
+
 ##### Bug Fixes
 
 * Fix false positive on `redundant_discardable_let` rule when using

diff --git a/Source/SwiftLintFramework/Extensions/File+SwiftLint.swift b/Source/SwiftLintFramework/Extensions/File+SwiftLint.swift
@@ -52,13 +52,22 @@ extension File {
         }
         let contents = self.contents.bridge()
         let pattern = "swiftlint:(enable|disable)(:previous|:this|:next)?\\ [^\\n]+"
-        return match(pattern: pattern, with: [.comment]).flatMap { range in
+        return skipShebangCommands() + match(pattern: pattern, with: [.comment]).flatMap { range in
             return Command(string: contents, range: range)
         }.flatMap { command in
             return command.expand()
         }
     }
 
+    private func skipShebangCommands() -> [Command] {
+        guard contents.hasPrefix("#!") else {
+            return []
+        }
+
+        return Command(action: .disable, ruleIdentifiers: masterRuleList.allValidIdentifiers(),
+                       line: 0, modifier: .next).expand()
+    }
+
     fileprivate func endOf(next command: Command?) -> Location {
         guard let nextCommand = command else {
             return Location(file: path, line: .max, character: .max)

diff --git a/Tests/SwiftLintFrameworkTests/RulesTests.swift b/Tests/SwiftLintFrameworkTests/RulesTests.swift
@@ -198,6 +198,11 @@ class RulesTests: XCTestCase {
 
     func testOperatorUsageWhitespace() {
         verifyRule(OperatorUsageWhitespaceRule.description)
+
+        let description = OperatorUsageWhitespaceRule.description
+            .with(nonTriggeringExamples: ["#!/usr/bin/env swift\n"])
+            .with(triggeringExamples: []).with(corrections: [:])
+        verifyRule(description, skipCommentTests: true, skipStringTests: true, testMultiByteOffsets: false)
     }
 
     func testPrivateOverFilePrivate() {