import Foundation import SourceKittenFramework struct StatementPositionRule: CorrectableRule { var configuration = StatementPositionConfiguration() static let description = RuleDescription( identifier: "statement_position", name: "Statement Position", description: "Else and catch should be on the same line, one space after the previous declaration", kind: .style, nonTriggeringExamples: [ Example("} else if {"), Example("} else {"), Example("} catch {"), Example("\"}else{\""), Example("struct A { let catchphrase: Int }\nlet a = A(\n catchphrase: 0\n)"), Example("struct A { let `catch`: Int }\nlet a = A(\n `catch`: 0\n)"), ], triggeringExamples: [ Example("↓}else if {"), Example("↓} else {"), Example("↓}\ncatch {"), Example("↓}\n\t catch {"), ], corrections: [ Example("↓}\n else {"): Example("} else {"), Example("↓}\n else if {"): Example("} else if {"), Example("↓}\n catch {"): Example("} catch {"), ] ) static let uncuddledDescription = RuleDescription( identifier: "statement_position", name: "Statement Position", description: "Else and catch should be on the next line, with equal indentation to the " + "previous declaration", kind: .style, nonTriggeringExamples: [ Example(" }\n else if {"), Example(" }\n else {"), Example(" }\n catch {"), Example(" }\n\n catch {"), Example("\n\n }\n catch {"), Example("\"}\nelse{\""), Example("struct A { let catchphrase: Int }\nlet a = A(\n catchphrase: 0\n)"), Example("struct A { let `catch`: Int }\nlet a = A(\n `catch`: 0\n)"), ], triggeringExamples: [ Example("↓ }else if {"), Example("↓}\n else {"), Example("↓ }\ncatch {"), Example("↓}\n\t catch {"), ], corrections: [ Example(" }else if {"): Example(" }\n else if {"), Example("}\n else {"): Example("}\nelse {"), Example(" }\ncatch {"): Example(" }\n catch {"), Example("}\n\t catch {"): Example("}\ncatch {"), ] ) func validate(file: SwiftLintFile) -> [StyleViolation] { switch configuration.statementMode { case .default: return defaultValidate(file: file) case .uncuddledElse: return uncuddledValidate(file: file) } } func correct(file: SwiftLintFile) -> Int { switch configuration.statementMode { case .default: defaultCorrect(file: file) case .uncuddledElse: uncuddledCorrect(file: file) } } } // Default Behaviors private extension StatementPositionRule { // match literal '}' // followed by 1) nothing, 2) two+ whitespace/newlines or 3) newlines or tabs // followed by 'else' or 'catch' literals static let defaultPattern = "\\}(?:[\\s\\n\\r]{2,}|[\\n\\t\\r]+)?\\b(else|catch)\\b" func defaultValidate(file: SwiftLintFile) -> [StyleViolation] { defaultViolationRanges(in: file, matching: Self.defaultPattern).compactMap { range in StyleViolation(ruleDescription: Self.description, severity: configuration.severity, location: Location(file: file, characterOffset: range.location)) } } func defaultViolationRanges(in file: SwiftLintFile, matching pattern: String) -> [NSRange] { file.match(pattern: pattern).filter { _, syntaxKinds in syntaxKinds.starts(with: [.keyword]) }.compactMap { $0.0 } } func defaultCorrect(file: SwiftLintFile) -> Int { let violations = defaultViolationRanges(in: file, matching: Self.defaultPattern) let matches = file.ruleEnabled(violatingRanges: violations, for: self) if matches.isEmpty { return 0 } let regularExpression = regex(Self.defaultPattern) var contents = file.contents for range in matches.reversed() { contents = regularExpression.stringByReplacingMatches(in: contents, options: [], range: range, withTemplate: "} $1") } file.write(contents) return matches.count } } // Uncuddled Behaviors private extension StatementPositionRule { func uncuddledValidate(file: SwiftLintFile) -> [StyleViolation] { uncuddledViolationRanges(in: file).compactMap { range in StyleViolation(ruleDescription: Self.uncuddledDescription, severity: configuration.severity, location: Location(file: file, characterOffset: range.location)) } } // match literal '}' // preceded by whitespace (or nothing) // followed by 1) nothing, 2) two+ whitespace/newlines or 3) newlines or tabs // followed by newline and the same amount of whitespace then 'else' or 'catch' literals static let uncuddledPattern = "([ \t]*)\\}(\\n+)?([ \t]*)\\b(else|catch)\\b" static let uncuddledRegex = regex(uncuddledPattern, options: []) static func uncuddledMatchValidator(contents: StringView) -> ((NSTextCheckingResult) -> NSTextCheckingResult?) { { match in if match.numberOfRanges != 5 { return match } if match.range(at: 2).length == 0 { return match } let range1 = match.range(at: 1) let range2 = match.range(at: 3) let whitespace1 = contents.string.substring(from: range1.location, length: range1.length) let whitespace2 = contents.string.substring(from: range2.location, length: range2.length) if whitespace1 == whitespace2 { return nil } return match } } static func uncuddledMatchFilter(contents: StringView, syntaxMap: SwiftLintSyntaxMap) -> ((NSTextCheckingResult) -> Bool) { { match in let range = match.range guard let matchRange = contents.NSRangeToByteRange(start: range.location, length: range.length) else { return false } return syntaxMap.kinds(inByteRange: matchRange) == [.keyword] } } func uncuddledViolationRanges(in file: SwiftLintFile) -> [NSRange] { let contents = file.stringView let syntaxMap = file.syntaxMap let matches = Self.uncuddledRegex.matches(in: file) let validator = Self.uncuddledMatchValidator(contents: contents) let filterMatches = Self.uncuddledMatchFilter(contents: contents, syntaxMap: syntaxMap) return matches.compactMap(validator).filter(filterMatches).map(\.range) } func uncuddledCorrect(file: SwiftLintFile) -> Int { var contents = file.contents let syntaxMap = file.syntaxMap let matches = Self.uncuddledRegex.matches(in: file) let validator = Self.uncuddledMatchValidator(contents: file.stringView) let filterRanges = Self.uncuddledMatchFilter(contents: file.stringView, syntaxMap: syntaxMap) let validMatches = matches.compactMap(validator).filter(filterRanges) .filter { file.ruleEnabled(violatingRanges: [$0.range], for: self).isNotEmpty } if validMatches.isEmpty { return 0 } for match in validMatches.reversed() { let range1 = match.range(at: 1) let range2 = match.range(at: 3) let newlineRange = match.range(at: 2) var whitespace = contents.bridge().substring(with: range1) let newLines: String if newlineRange.location != NSNotFound { newLines = contents.bridge().substring(with: newlineRange) } else { newLines = "" } if !whitespace.hasPrefix("\n"), newLines != "\n" { whitespace.insert("\n", at: whitespace.startIndex) } contents = contents.bridge().replacingCharacters(in: range2, with: whitespace) } file.write(contents) return validMatches.count } }