Files
SwiftLint/Source/SwiftLintFramework/Rules/PatternMatchingKeywordsRule.swift
T
JP Simard b83e0991b9 Remove all file headers
The MIT license doesn't require that all files be prepended with this
licensing or copyright information. Realm confirmed that they're ok with this
change. This will enable some companies to contribute to SwiftLint and the
date & authorship information will remain accessible via git source control.
2018-05-04 13:42:02 -07:00

77 lines
2.8 KiB
Swift

import Foundation
import SourceKittenFramework
public struct PatternMatchingKeywordsRule: ASTRule, ConfigurationProviderRule, OptInRule {
public var configuration = SeverityConfiguration(.warning)
public init() {}
public static let description = RuleDescription(
identifier: "pattern_matching_keywords",
name: "Pattern Matching Keywords",
description: "Combine multiple pattern matching bindings by moving keywords out of tuples.",
kind: .idiomatic,
nonTriggeringExamples: [
"default",
"case 1",
"case bar",
"case let (x, y)",
"case .foo(let x)",
"case let .foo(x, y)",
"case .foo(let x), .bar(let x)",
"case .foo(let x, var y)",
"case var (x, y)",
"case .foo(var x)",
"case var .foo(x, y)"
].map(wrapInSwitch),
triggeringExamples: [
"case (↓let x, ↓let y)",
"case .foo(↓let x, ↓let y)",
"case (.yamlParsing(↓let x), .yamlParsing(↓let y))",
"case (↓var x, ↓var y)",
"case .foo(↓var x, ↓var y)",
"case (.yamlParsing(↓var x), .yamlParsing(↓var y))"
].map(wrapInSwitch)
)
public func validate(file: File, kind: StatementKind,
dictionary: [String: SourceKitRepresentable]) -> [StyleViolation] {
guard kind == .case else {
return []
}
let contents = file.contents.bridge()
return dictionary.elements.flatMap { subDictionary -> [StyleViolation] in
guard subDictionary.kind == "source.lang.swift.structure.elem.pattern",
let offset = subDictionary.offset,
let length = subDictionary.length,
let caseRange = contents.byteRangeToNSRange(start: offset, length: length) else {
return []
}
let letMatches = file.match(pattern: "\\blet\\b", with: [.keyword], range: caseRange)
let varMatches = file.match(pattern: "\\bvar\\b", with: [.keyword], range: caseRange)
if !letMatches.isEmpty && !varMatches.isEmpty {
return []
}
guard letMatches.count > 1 || varMatches.count > 1 else {
return []
}
return (letMatches + varMatches).map {
StyleViolation(ruleDescription: type(of: self).description,
severity: configuration.severity,
location: Location(file: file, characterOffset: $0.location))
}
}
}
}
private func wrapInSwitch(_ str: String) -> String {
return "switch foo {\n" +
" \(str): break\n" +
"}"
}