forked from realm/SwiftLint
-
Notifications
You must be signed in to change notification settings - Fork 0
/
VerticalWhitespaceRule.swift
158 lines (132 loc) · 5.57 KB
/
VerticalWhitespaceRule.swift
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
//
// VerticalWhitespaceRule.swift
// SwiftLint
//
// Created by J. Cheyo Jimenez on 5/16/15.
// Copyright © 2016 Realm. All rights reserved.
//
import Foundation
import SourceKittenFramework
private let descriptionReason = "Limit vertical whitespace to a single empty line."
public struct VerticalWhitespaceRule: CorrectableRule, ConfigurationProviderRule {
public var configuration = VerticalWhitespaceConfiguration(maxEmptyLines: 1)
public init() {}
public static let description = RuleDescription(
identifier: "vertical_whitespace",
name: "Vertical Whitespace",
description: descriptionReason,
kind: .style,
nonTriggeringExamples: [
"let abc = 0\n",
"let abc = 0\n\n",
"/* bcs \n\n\n\n*/",
"// bca \n\n"
],
triggeringExamples: [
"let aaaa = 0\n\n\n",
"struct AAAA {}\n\n\n\n",
"class BBBB {}\n\n\n"
],
corrections: [
"let b = 0\n\n\nclass AAA {}\n": "let b = 0\n\nclass AAA {}\n",
"let c = 0\n\n\nlet num = 1\n": "let c = 0\n\nlet num = 1\n",
"// bca \n\n\n": "// bca \n\n"
] // End of line autocorrections are handled by Trailing Newline Rule.
)
public func validate(file: File) -> [StyleViolation] {
let linesSections = violatingLineSections(in: file)
guard !linesSections.isEmpty else {
return []
}
var violations = [StyleViolation]()
for (eachLastLine, eachSectionCount) in linesSections {
// Skips violations for areas where the rule is disabled
if !file.ruleEnabled(violatingRanges: [eachLastLine.range], for: self).isEmpty {
violations.append(StyleViolation(
ruleDescription: type(of: self).description,
severity: configuration.severityConfiguration.severity,
location: Location(file: file.path, line: eachLastLine.index),
reason: descriptionReason + " Currently \(eachSectionCount + 1)."
))
}
}
return violations
}
private typealias LineSection = (lastLine: Line, linesToRemove: Int)
private func violatingLineSections(in file: File) -> [LineSection] {
let nonSpaceRegex = regex("\\S", options: [])
let filteredLines = file.lines.filter {
nonSpaceRegex.firstMatch(in: file.contents, options: [], range: $0.range) == nil
}
guard !filteredLines.isEmpty else {
return []
}
let blankLinesSections = extractSections(from: filteredLines)
// filtering out violations in comments and strings
let stringAndComments = Set(SyntaxKind.commentAndStringKinds())
let syntaxMap = file.syntaxMap
let result = blankLinesSections.flatMap { eachSection -> (lastLine: Line, linesToRemove: Int)? in
guard let lastLine = eachSection.last else {
return nil
}
let kindInSection = syntaxMap.kinds(inByteRange: lastLine.byteRange)
if stringAndComments.isDisjoint(with: kindInSection) {
return (lastLine, eachSection.count)
}
return nil
}
return result.filter { $0.linesToRemove >= configuration.maxEmptyLines }
}
private func extractSections(from lines: [Line]) -> [[Line]] {
var blankLinesSections = [[Line]]()
var lineSection = [Line]()
var previousIndex = 0
for (index, line) in lines.enumerated() {
if lines[previousIndex].index + 1 == line.index {
lineSection.append(line)
} else if !lineSection.isEmpty {
blankLinesSections.append(lineSection)
lineSection.removeAll()
}
previousIndex = index
}
if !lineSection.isEmpty {
blankLinesSections.append(lineSection)
}
return blankLinesSections
}
public func correct(file: File) -> [Correction] {
let linesSections = violatingLineSections(in: file)
if linesSections.isEmpty { return [] }
var indexOfLinesToDelete = [Int]()
for eachLine in linesSections {
let start = eachLine.lastLine.index - eachLine.linesToRemove
indexOfLinesToDelete.append(contentsOf: start..<eachLine.lastLine.index)
}
var correctedLines = [String]()
var corrections = [Correction]()
for currentLine in file.lines {
// Doesn't correct lines where rule is disabled
if file.ruleEnabled(violatingRanges: [currentLine.range], for: self).isEmpty {
correctedLines.append(currentLine.content)
continue
}
// removes lines by skipping them from correctedLines
if Set(indexOfLinesToDelete).contains(currentLine.index) {
let description = type(of: self).description
let location = Location(file: file.path, line: currentLine.index)
//reports every line that is being deleted
corrections.append(Correction(ruleDescription: description, location: location))
continue // skips line
}
// all lines that pass get added to final output file
correctedLines.append(currentLine.content)
}
// converts lines back to file and adds trailing line
if !corrections.isEmpty {
file.write(correctedLines.joined(separator: "\n") + "\n")
return corrections
}
return []
}
}