mirror of
https://github.com/realm/SwiftLint.git
synced 2026-06-06 20:18:40 +00:00
Zev Eisenberg
fcf848608e
* Add Example wrapper in order to display test failures inline when running in Xcode. * Stop using Swift 5.1-only features so we can compile on Xcode 10.2. * Wrap strings in Example. * Add Changelog entry. * Wrap all examples in Example struct. * Better and more complete capturing of line numbers. * Fix broken test. * Better test traceability. * Address or disable linting warnings. * Add documentation comments. * Disable linter for a few cases. * Limit mutability and add copy-and-mutate utility functions. * Limit scope of mutability.
89 lines
3.9 KiB
Swift
89 lines
3.9 KiB
Swift
import SwiftLintFramework
|
|
import XCTest
|
|
|
|
class TrailingCommaRuleTests: XCTestCase {
|
|
func testTrailingCommaRuleWithDefaultConfiguration() {
|
|
// Verify TrailingCommaRule with test values for when mandatory_comma is false (default).
|
|
if SwiftVersion.current >= .fourDotOne {
|
|
let triggeringExamples = TrailingCommaRule.description.triggeringExamples +
|
|
[Example("class C {\n #if true\n func f() {\n let foo = [1, 2, 3↓,]\n }\n #endif\n}")]
|
|
verifyRule(TrailingCommaRule.description.with(triggeringExamples: triggeringExamples))
|
|
} else {
|
|
verifyRule(TrailingCommaRule.description)
|
|
}
|
|
|
|
// Ensure the rule produces the correct reason string.
|
|
let failingCase = Example("let array = [\n\t1,\n\t2,\n]\n")
|
|
XCTAssertEqual(trailingCommaViolations(failingCase), [
|
|
StyleViolation(
|
|
ruleDescription: TrailingCommaRule.description,
|
|
location: Location(file: nil, line: 3, character: 3),
|
|
reason: "Collection literals should not have trailing commas."
|
|
)
|
|
])
|
|
}
|
|
|
|
private static let triggeringExamples = [
|
|
Example("let foo = [1, 2,\n 3↓]\n"),
|
|
Example("let foo = [1: 2,\n 2: 3↓]\n"),
|
|
Example("let foo = [1: 2,\n 2: 3↓ ]\n"),
|
|
Example("struct Bar {\n let foo = [1: 2,\n 2: 3↓]\n}\n"),
|
|
Example("let foo = [1, 2,\n 3↓] + [4,\n 5, 6↓]\n"),
|
|
Example("let foo = [\"אבג\", \"αβγ\",\n\"🇺🇸\"↓]\n")
|
|
]
|
|
|
|
private static let nonTriggeringExamples = [
|
|
Example("let foo = []\n"),
|
|
Example("let foo = [:]\n"),
|
|
Example("let foo = [1, 2, 3,]\n"),
|
|
Example("let foo = [1, 2, 3, ]\n"),
|
|
Example("let foo = [1, 2, 3 ,]\n"),
|
|
Example("let foo = [1: 2, 2: 3, ]\n"),
|
|
Example("struct Bar {\n let foo = [1: 2, 2: 3,]\n}\n"),
|
|
Example("let foo = [Void]()\n"),
|
|
Example("let foo = [(Void, Void)]()\n"),
|
|
Example("let foo = [1, 2, 3]\n"),
|
|
Example("let foo = [1: 2, 2: 3]\n"),
|
|
Example("let foo = [1: 2, 2: 3 ]\n"),
|
|
Example("struct Bar {\n let foo = [1: 2, 2: 3]\n}\n"),
|
|
Example("let foo = [1, 2, 3] + [4, 5, 6]\n")
|
|
]
|
|
|
|
private static let corrections: [Example: Example] = {
|
|
let fixed = triggeringExamples.map { $0.with(code: $0.code.replacingOccurrences(of: "↓", with: ",")) }
|
|
var result: [Example: Example] = [:]
|
|
for (triggering, correction) in zip(triggeringExamples, fixed) {
|
|
result[triggering] = correction
|
|
}
|
|
return result
|
|
}()
|
|
|
|
private let mandatoryCommaRuleDescription = TrailingCommaRule.description
|
|
.with(nonTriggeringExamples: TrailingCommaRuleTests.nonTriggeringExamples)
|
|
.with(triggeringExamples: TrailingCommaRuleTests.triggeringExamples)
|
|
.with(corrections: TrailingCommaRuleTests.corrections)
|
|
|
|
func testTrailingCommaRuleWithMandatoryComma() {
|
|
// Verify TrailingCommaRule with test values for when mandatory_comma is true.
|
|
let ruleDescription = mandatoryCommaRuleDescription
|
|
let ruleConfiguration = ["mandatory_comma": true]
|
|
|
|
verifyRule(ruleDescription, ruleConfiguration: ruleConfiguration)
|
|
|
|
// Ensure the rule produces the correct reason string.
|
|
let failingCase = Example("let array = [\n\t1,\n\t2\n]\n")
|
|
XCTAssertEqual(trailingCommaViolations(failingCase, ruleConfiguration: ruleConfiguration), [
|
|
StyleViolation(
|
|
ruleDescription: TrailingCommaRule.description,
|
|
location: Location(file: nil, line: 3, character: 3),
|
|
reason: "Multi-line collection literals should have trailing commas."
|
|
)
|
|
])
|
|
}
|
|
|
|
private func trailingCommaViolations(_ example: Example, ruleConfiguration: Any? = nil) -> [StyleViolation] {
|
|
let config = makeConfig(ruleConfiguration, TrailingCommaRule.description.identifier)!
|
|
return violations(example, config: config)
|
|
}
|
|
}
|