forked from realm/SwiftLint
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add
DuplicateImportsRule
(realm#2004)
- Loading branch information
Showing
8 changed files
with
390 additions
and
1 deletion.
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
107 changes: 107 additions & 0 deletions
107
Source/SwiftLintFramework/Rules/Idiomatic/DuplicateImportsRule.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,107 @@ | ||
import Foundation | ||
import SourceKittenFramework | ||
|
||
public struct DuplicateImportsRule: ConfigurationProviderRule, AutomaticTestableRule { | ||
public var configuration = SeverityConfiguration(.warning) | ||
|
||
// List of all possible import kinds | ||
static let importKinds = [ | ||
"typealias", "struct", "class", | ||
"enum", "protocol", "let", | ||
"var", "func" | ||
] | ||
|
||
public init() {} | ||
|
||
public static let description = RuleDescription( | ||
identifier: "duplicate_imports", | ||
name: "Duplicate Imports", | ||
description: "Imports should be unique.", | ||
kind: .idiomatic, | ||
nonTriggeringExamples: DuplicateImportsRuleExamples.nonTriggeringExamples, | ||
triggeringExamples: DuplicateImportsRuleExamples.triggeringExamples | ||
) | ||
|
||
private func rangesInConditionalCompilation(file: File) -> [NSRange] { | ||
let contents = file.contents.bridge() | ||
|
||
let ranges = file.syntaxMap.tokens | ||
.filter { SyntaxKind(rawValue: $0.type) == .buildconfigKeyword } | ||
.map { NSRange(location: $0.offset, length: $0.length) } | ||
.filter { range in | ||
let keyword = contents.substringWithByteRange(start: range.location, length: range.length) | ||
return ["#if", "#endif"].contains(keyword) | ||
} | ||
|
||
return stride(from: 0, to: ranges.count, by: 2).reduce(into: []) { result, rangeIndex in | ||
result.append(NSUnionRange(ranges[rangeIndex], ranges[rangeIndex + 1])) | ||
} | ||
} | ||
|
||
public func validate(file: File) -> [StyleViolation] { | ||
let contents = file.contents.bridge() | ||
|
||
let ignoredRanges = self.rangesInConditionalCompilation(file: file) | ||
|
||
let importKinds = DuplicateImportsRule.importKinds.joined(separator: "|") | ||
|
||
// Grammar of import declaration | ||
// attributes(optional) import import-kind(optional) import-path | ||
let regex = "^(\\w\\s)?import(\\s(\(importKinds)))?\\s+[a-zA-Z0-9._]+$" | ||
let importRanges = file.match(pattern: regex) | ||
.filter { $0.1.allSatisfy { [.keyword, .identifier].contains($0) } } | ||
.compactMap { contents.NSRangeToByteRange(start: $0.0.location, length: $0.0.length) } | ||
.filter { importRange -> Bool in | ||
return !importRange.intersects(ignoredRanges) | ||
} | ||
|
||
let lines = contents.lines() | ||
|
||
let importLines: [Line] = importRanges.compactMap { range in | ||
guard let line = contents.lineAndCharacter(forByteOffset: range.location)?.line | ||
else { return nil } | ||
return lines[line - 1] | ||
} | ||
|
||
var violations = [StyleViolation]() | ||
|
||
for indexI in 0..<importLines.count { | ||
for indexJ in indexI + 1..<importLines.count { | ||
let firstLine = importLines[indexI] | ||
let secondLine = importLines[indexJ] | ||
|
||
guard firstLine.areImportsDuplicated(with: secondLine) | ||
else { continue } | ||
|
||
let lineWithDuplicatedImport: Line = { | ||
if firstLine.importIdentifier?.count ?? 0 <= secondLine.importIdentifier?.count ?? 0 { | ||
return secondLine | ||
} else { | ||
return firstLine | ||
} | ||
}() | ||
|
||
let location = Location(file: file, characterOffset: lineWithDuplicatedImport.range.location) | ||
let violation = StyleViolation(ruleDescription: type(of: self).description, location: location) | ||
violations.append(violation) | ||
} | ||
} | ||
|
||
return violations | ||
} | ||
} | ||
|
||
private extension Line { | ||
/// Returns name of the module being imported. | ||
var importIdentifier: Substring? { | ||
return self.content.split(separator: " ").last | ||
} | ||
|
||
func areImportsDuplicated(with otherLine: Line) -> Bool { | ||
guard let firstImportIdentifiers = self.importIdentifier?.split(separator: "."), | ||
let secondImportIdentifiers = otherLine.importIdentifier?.split(separator: ".") | ||
else { return false } | ||
|
||
return zip(firstImportIdentifiers, secondImportIdentifiers).allSatisfy { $0 == $1 } | ||
} | ||
} |
56 changes: 56 additions & 0 deletions
56
Source/SwiftLintFramework/Rules/Idiomatic/DuplicateImportsRuleExamples.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,56 @@ | ||
internal struct DuplicateImportsRuleExamples { | ||
static let nonTriggeringExamples: [String] = [ | ||
"import A\nimport B\nimport C", | ||
"import A.B\nimport A.C", | ||
""" | ||
#if DEBUG | ||
@testable import KsApi | ||
#else | ||
import KsApi | ||
#endif | ||
""", | ||
"import A // module\nimport B // module" | ||
] | ||
|
||
static let triggeringExamples: [String] = { | ||
var list: [String] = [ | ||
"import Foundation\nimport Dispatch\n↓import Foundation", | ||
"import Foundation\n↓import Foundation.NSString", | ||
"↓import Foundation.NSString\nimport Foundation", | ||
"↓import A.B.C\nimport A.B", | ||
"import A.B\n↓import A.B.C", | ||
""" | ||
import A | ||
#if DEBUG | ||
@testable import KsApi | ||
#else | ||
import KsApi | ||
#endif | ||
↓import A | ||
""" | ||
] | ||
|
||
list += DuplicateImportsRule.importKinds.map { importKind in | ||
return """ | ||
import A | ||
↓import \(importKind) A.Foo | ||
""" | ||
} | ||
|
||
list += DuplicateImportsRule.importKinds.map { importKind in | ||
return """ | ||
import A | ||
↓import \(importKind) A.B.Foo | ||
""" | ||
} | ||
|
||
list += DuplicateImportsRule.importKinds.map { importKind in | ||
return """ | ||
import A.B | ||
↓import \(importKind) A.B.Foo | ||
""" | ||
} | ||
|
||
return list | ||
}() | ||
} |
Oops, something went wrong.