Files
SwiftLint/Source/SwiftLintBuiltInRules/Rules/Style/SwitchCaseOnNewlineRule.swift
2024-12-26 20:40:29 +01:00

77 lines
3.4 KiB
Swift

import SwiftSyntax
private func wrapInSwitch(_ str: String, file: StaticString = #filePath, line: UInt = #line) -> Example {
Example("""
switch foo {
\(str)
}
""", file: file, line: line)
}
@SwiftSyntaxRule(optIn: true)
struct SwitchCaseOnNewlineRule: Rule {
var configuration = SeverityConfiguration<Self>(.warning)
static let description = RuleDescription(
identifier: "switch_case_on_newline",
name: "Cases on Newline",
description: "Cases inside a switch should always be on a newline",
kind: .style,
nonTriggeringExamples: [
Example("/*case 1: */return true"),
Example("//case 1:\n return true"),
Example("let x = [caseKey: value]"),
Example("let x = [key: .default]"),
Example("if case let .someEnum(value) = aFunction([key: 2]) { }"),
Example("guard case let .someEnum(value) = aFunction([key: 2]) { }"),
Example("for case let .someEnum(value) = aFunction([key: 2]) { }"),
Example("enum Environment {\n case development\n}"),
Example("enum Environment {\n case development(url: URL)\n}"),
Example("enum Environment {\n case development(url: URL) // staging\n}"),
wrapInSwitch("case 1:\n return true"),
wrapInSwitch("default:\n return true"),
wrapInSwitch("case let value:\n return true"),
wrapInSwitch("case .myCase: // error from network\n return true"),
wrapInSwitch("case let .myCase(value) where value > 10:\n return false"),
wrapInSwitch("case let .myCase(value)\n where value > 10:\n return false"),
wrapInSwitch("""
case let .myCase(code: lhsErrorCode, description: _)
where lhsErrorCode > 10:
return false
"""),
wrapInSwitch("case #selector(aFunction(_:)):\n return false"),
Example("""
do {
let loadedToken = try tokenManager.decodeToken(from: response)
return loadedToken
} catch { throw error }
"""),
],
triggeringExamples: [
wrapInSwitch("↓case 1: return true"),
wrapInSwitch("↓case let value: return true"),
wrapInSwitch("↓default: return true"),
wrapInSwitch("↓case \"a string\": return false"),
wrapInSwitch("↓case .myCase: return false // error from network"),
wrapInSwitch("↓case let .myCase(value) where value > 10: return false"),
wrapInSwitch("↓case #selector(aFunction(_:)): return false"),
wrapInSwitch("↓case let .myCase(value)\n where value > 10: return false"),
wrapInSwitch("↓case .first,\n .second: return false"),
]
)
}
private extension SwitchCaseOnNewlineRule {
final class Visitor: ViolationsSyntaxVisitor<ConfigurationType> {
override func visitPost(_ node: SwitchCaseSyntax) {
let caseEndLine = locationConverter.location(for: node.label.endPositionBeforeTrailingTrivia).line
let statementsPosition = node.statements.positionAfterSkippingLeadingTrivia
let statementStartLine = locationConverter.location(for: statementsPosition).line
if statementStartLine == caseEndLine {
violations.append(node.positionAfterSkippingLeadingTrivia)
}
}
}
}