mirror of
https://github.com/nicklockwood/SwiftFormat.git
synced 2026-05-17 10:30:35 +00:00
Copilot
452 lines
13 KiB
Swift
452 lines
13 KiB
Swift
//
|
|
// ConsistentSwitchCaseSpacingTests.swift
|
|
// SwiftFormatTests
|
|
//
|
|
// Created by Cal Stephens on 2/1/24.
|
|
// Copyright © 2024 Nick Lockwood. All rights reserved.
|
|
//
|
|
|
|
import XCTest
|
|
@testable import SwiftFormat
|
|
|
|
final class ConsistentSwitchCaseSpacingTests: XCTestCase {
|
|
func testInsertsBlankLinesToMakeSwitchStatementSpacingConsistent1() {
|
|
let input = """
|
|
switch action {
|
|
case .engageWarpDrive:
|
|
navigationComputer.destination = targetedDestination
|
|
await warpDrive.spinUp()
|
|
warpDrive.activate()
|
|
|
|
case .enableArtificialGravity:
|
|
artificialGravityEngine.enable(strength: .oneG)
|
|
case let .scanPlanet(planet):
|
|
scanner.target = planet
|
|
scanner.scanAtmosphere()
|
|
scanner.scanBiosphere()
|
|
scanner.scanForArtificialLife()
|
|
|
|
case .handleIncomingEnergyBlast:
|
|
energyShields.engage()
|
|
}
|
|
"""
|
|
|
|
let output = """
|
|
switch action {
|
|
case .engageWarpDrive:
|
|
navigationComputer.destination = targetedDestination
|
|
await warpDrive.spinUp()
|
|
warpDrive.activate()
|
|
|
|
case .enableArtificialGravity:
|
|
artificialGravityEngine.enable(strength: .oneG)
|
|
|
|
case let .scanPlanet(planet):
|
|
scanner.target = planet
|
|
scanner.scanAtmosphere()
|
|
scanner.scanBiosphere()
|
|
scanner.scanForArtificialLife()
|
|
|
|
case .handleIncomingEnergyBlast:
|
|
energyShields.engage()
|
|
}
|
|
"""
|
|
testFormatting(for: input, output, rule: .consistentSwitchCaseSpacing)
|
|
}
|
|
|
|
func testInsertsBlankLinesToMakeSwitchStatementSpacingConsistent2() {
|
|
let input = """
|
|
switch action {
|
|
case .engageWarpDrive:
|
|
navigationComputer.destination = targetedDestination
|
|
await warpDrive.spinUp()
|
|
warpDrive.activate()
|
|
|
|
case .enableArtificialGravity:
|
|
artificialGravityEngine.enable(strength: .oneG)
|
|
case .handleIncomingEnergyBlast:
|
|
energyShields.engage()
|
|
}
|
|
"""
|
|
|
|
let output = """
|
|
switch action {
|
|
case .engageWarpDrive:
|
|
navigationComputer.destination = targetedDestination
|
|
await warpDrive.spinUp()
|
|
warpDrive.activate()
|
|
|
|
case .enableArtificialGravity:
|
|
artificialGravityEngine.enable(strength: .oneG)
|
|
|
|
case .handleIncomingEnergyBlast:
|
|
energyShields.engage()
|
|
}
|
|
"""
|
|
testFormatting(for: input, output, rule: .consistentSwitchCaseSpacing)
|
|
}
|
|
|
|
func testInsertsBlankLinesToMakeSwitchStatementSpacingConsistent3() {
|
|
let input = """
|
|
var name: PlanetType {
|
|
switch self {
|
|
// The planet closest to the sun
|
|
case .mercury:
|
|
"Mercury"
|
|
// Similar to Earth but way more deadly
|
|
case .venus:
|
|
"Venus"
|
|
|
|
// The best planet, where everything cool happens
|
|
case .earth:
|
|
"Earth"
|
|
|
|
// This planet is entirely inhabited by robots.
|
|
// There are cool landers, rovers, and even a helicopter.
|
|
case .mars:
|
|
"Mars"
|
|
|
|
// The biggest planet with the most moons
|
|
case .jupiter:
|
|
"Jupiter"
|
|
|
|
// Other planets have rings, but satun's are the best.
|
|
case .saturn:
|
|
"Saturn"
|
|
case .uranus:
|
|
"Uranus"
|
|
case .neptune:
|
|
"Neptune"
|
|
}
|
|
}
|
|
"""
|
|
|
|
let output = """
|
|
var name: PlanetType {
|
|
switch self {
|
|
// The planet closest to the sun
|
|
case .mercury:
|
|
"Mercury"
|
|
|
|
// Similar to Earth but way more deadly
|
|
case .venus:
|
|
"Venus"
|
|
|
|
// The best planet, where everything cool happens
|
|
case .earth:
|
|
"Earth"
|
|
|
|
// This planet is entirely inhabited by robots.
|
|
// There are cool landers, rovers, and even a helicopter.
|
|
case .mars:
|
|
"Mars"
|
|
|
|
// The biggest planet with the most moons
|
|
case .jupiter:
|
|
"Jupiter"
|
|
|
|
// Other planets have rings, but satun's are the best.
|
|
case .saturn:
|
|
"Saturn"
|
|
|
|
case .uranus:
|
|
"Uranus"
|
|
|
|
case .neptune:
|
|
"Neptune"
|
|
}
|
|
}
|
|
"""
|
|
testFormatting(for: input, output, rule: .consistentSwitchCaseSpacing)
|
|
}
|
|
|
|
func testRemovesBlankLinesToMakeSwitchStatementConsistent() {
|
|
let input = """
|
|
var name: PlanetType {
|
|
switch self {
|
|
// The planet closest to the sun
|
|
case .mercury:
|
|
"Mercury"
|
|
|
|
case .venus:
|
|
"Venus"
|
|
// The best planet, where everything cool happens
|
|
case .earth:
|
|
"Earth"
|
|
// This planet is entirely inhabited by robots.
|
|
// There are cool landers, rovers, and even a helicopter.
|
|
case .mars:
|
|
"Mars"
|
|
case .jupiter:
|
|
"Jupiter"
|
|
// Other planets have rings, but satun's are the best.
|
|
case .saturn:
|
|
"Saturn"
|
|
case .uranus:
|
|
"Uranus"
|
|
case .neptune:
|
|
"Neptune"
|
|
}
|
|
}
|
|
"""
|
|
|
|
let output = """
|
|
var name: PlanetType {
|
|
switch self {
|
|
// The planet closest to the sun
|
|
case .mercury:
|
|
"Mercury"
|
|
case .venus:
|
|
"Venus"
|
|
// The best planet, where everything cool happens
|
|
case .earth:
|
|
"Earth"
|
|
// This planet is entirely inhabited by robots.
|
|
// There are cool landers, rovers, and even a helicopter.
|
|
case .mars:
|
|
"Mars"
|
|
case .jupiter:
|
|
"Jupiter"
|
|
// Other planets have rings, but satun's are the best.
|
|
case .saturn:
|
|
"Saturn"
|
|
case .uranus:
|
|
"Uranus"
|
|
case .neptune:
|
|
"Neptune"
|
|
}
|
|
}
|
|
"""
|
|
|
|
testFormatting(for: input, output, rule: .consistentSwitchCaseSpacing)
|
|
}
|
|
|
|
func testSingleLineAndMultiLineSwitchCase1() {
|
|
let input = """
|
|
switch planetType {
|
|
case .terrestrial:
|
|
if options.treatPlutoAsPlanet {
|
|
[.mercury, .venus, .earth, .mars, .pluto]
|
|
} else {
|
|
[.mercury, .venus, .earth, .mars]
|
|
}
|
|
case .gasGiant:
|
|
[.jupiter, .saturn, .uranus, .neptune]
|
|
}
|
|
"""
|
|
|
|
let output = """
|
|
switch planetType {
|
|
case .terrestrial:
|
|
if options.treatPlutoAsPlanet {
|
|
[.mercury, .venus, .earth, .mars, .pluto]
|
|
} else {
|
|
[.mercury, .venus, .earth, .mars]
|
|
}
|
|
|
|
case .gasGiant:
|
|
[.jupiter, .saturn, .uranus, .neptune]
|
|
}
|
|
"""
|
|
|
|
testFormatting(for: input, [output], rules: [.blankLineAfterSwitchCase, .consistentSwitchCaseSpacing])
|
|
}
|
|
|
|
func testSingleLineAndMultiLineSwitchCase2() {
|
|
let input = """
|
|
switch planetType {
|
|
case .gasGiant:
|
|
[.jupiter, .saturn, .uranus, .neptune]
|
|
case .terrestrial:
|
|
if options.treatPlutoAsPlanet {
|
|
[.mercury, .venus, .earth, .mars, .pluto]
|
|
} else {
|
|
[.mercury, .venus, .earth, .mars]
|
|
}
|
|
}
|
|
"""
|
|
|
|
testFormatting(for: input, rule: .consistentSwitchCaseSpacing)
|
|
}
|
|
|
|
func testSwitchStatementWithSingleMultilineCase_blankLineAfterSwitchCaseEnabled() {
|
|
let input = """
|
|
switch action {
|
|
case .enableArtificialGravity:
|
|
artificialGravityEngine.enable(strength: .oneG)
|
|
case .engageWarpDrive:
|
|
navigationComputer.destination = targetedDestination
|
|
await warpDrive.spinUp()
|
|
warpDrive.activate()
|
|
case let .scanPlanet(planet):
|
|
scanner.scan(planet)
|
|
case .handleIncomingEnergyBlast:
|
|
energyShields.engage()
|
|
}
|
|
"""
|
|
|
|
let output = """
|
|
switch action {
|
|
case .enableArtificialGravity:
|
|
artificialGravityEngine.enable(strength: .oneG)
|
|
|
|
case .engageWarpDrive:
|
|
navigationComputer.destination = targetedDestination
|
|
await warpDrive.spinUp()
|
|
warpDrive.activate()
|
|
|
|
case let .scanPlanet(planet):
|
|
scanner.scan(planet)
|
|
|
|
case .handleIncomingEnergyBlast:
|
|
energyShields.engage()
|
|
}
|
|
"""
|
|
|
|
testFormatting(for: input, [output], rules: [.consistentSwitchCaseSpacing, .blankLineAfterSwitchCase])
|
|
}
|
|
|
|
func testSwitchStatementWithSingleMultilineCase_blankLineAfterSwitchCaseDisabled() {
|
|
let input = """
|
|
switch action {
|
|
case .enableArtificialGravity:
|
|
artificialGravityEngine.enable(strength: .oneG)
|
|
case .engageWarpDrive:
|
|
navigationComputer.destination = targetedDestination
|
|
await warpDrive.spinUp()
|
|
warpDrive.activate()
|
|
case let .scanPlanet(planet):
|
|
scanner.scan(planet)
|
|
case .handleIncomingEnergyBlast:
|
|
energyShields.engage()
|
|
}
|
|
"""
|
|
|
|
testFormatting(for: input, rule: .consistentSwitchCaseSpacing, exclude: [.blankLineAfterSwitchCase])
|
|
}
|
|
|
|
func testConsistentSpacingWithIfdefWrappedCase() {
|
|
// When the case inside #if already has a blank line after #endif (matching the
|
|
// other cases), consistentSwitchCaseSpacing should make no changes.
|
|
let input = """
|
|
switch action {
|
|
case .engageWarpDrive:
|
|
warpDrive.activate()
|
|
|
|
#if CLOAKING
|
|
case .engageCloakingDevice:
|
|
cloakingDevice.activate()
|
|
#endif
|
|
|
|
case .handleIncomingEnergyBlast:
|
|
energyShields.engage()
|
|
}
|
|
"""
|
|
|
|
testFormatting(for: input, rule: .consistentSwitchCaseSpacing)
|
|
}
|
|
|
|
func testConsistentSpacingWithMultilineIfdefWrappedCase() {
|
|
// When the case inside #if doesn't have a blank line after #endif but all
|
|
// other cases do, consistentSwitchCaseSpacing should insert the blank line after #endif.
|
|
let input = """
|
|
switch action {
|
|
case .engageWarpDrive:
|
|
navigationComputer.destination = targetedDestination
|
|
await warpDrive.spinUp()
|
|
warpDrive.activate()
|
|
|
|
#if CLOAKING
|
|
case .engageCloakingDevice:
|
|
await cloakingDevice.spinUp()
|
|
cloakingDevice.activate()
|
|
#endif
|
|
case .handleIncomingEnergyBlast:
|
|
await energyShields.prepare()
|
|
energyShields.engage()
|
|
}
|
|
"""
|
|
|
|
let output = """
|
|
switch action {
|
|
case .engageWarpDrive:
|
|
navigationComputer.destination = targetedDestination
|
|
await warpDrive.spinUp()
|
|
warpDrive.activate()
|
|
|
|
#if CLOAKING
|
|
case .engageCloakingDevice:
|
|
await cloakingDevice.spinUp()
|
|
cloakingDevice.activate()
|
|
#endif
|
|
|
|
case .handleIncomingEnergyBlast:
|
|
await energyShields.prepare()
|
|
energyShields.engage()
|
|
}
|
|
"""
|
|
|
|
testFormatting(for: input, output, rule: .consistentSwitchCaseSpacing)
|
|
}
|
|
|
|
func testConsistentSpacingWithCasesInIfElseBlock() {
|
|
// Cases in #if/#else branches are mutually exclusive, so no blank lines are
|
|
// added between them regardless of the other cases' spacing.
|
|
let input = """
|
|
switch action {
|
|
case .engageWarpDrive:
|
|
warpDrive.activate()
|
|
|
|
#if CLOAKING
|
|
case .engageCloakingDevice:
|
|
cloakingDevice.activate()
|
|
#else
|
|
case .handleIncomingEnergyBlast:
|
|
energyShields.engage()
|
|
#endif
|
|
}
|
|
"""
|
|
|
|
testFormatting(for: input, rule: .consistentSwitchCaseSpacing)
|
|
}
|
|
|
|
func testConsistentSpacingWithIfdefInsideSwitchCase() {
|
|
let input = """
|
|
switch foo {
|
|
case .bar:
|
|
#if DEBUG
|
|
print("foo")
|
|
#endif
|
|
print("bar")
|
|
|
|
case .baaz:
|
|
print("baaz")
|
|
}
|
|
"""
|
|
|
|
testFormatting(for: input, rule: .consistentSwitchCaseSpacing)
|
|
}
|
|
|
|
func testConsistentSpacingWithIfdefContainingNestedSwitchInsideCase() {
|
|
let input = """
|
|
switch foo {
|
|
case .bar:
|
|
#if DEBUG
|
|
switch nested {
|
|
case .a:
|
|
print("a")
|
|
case .b:
|
|
print("b")
|
|
}
|
|
#endif
|
|
print("bar")
|
|
|
|
case .baaz:
|
|
print("baaz")
|
|
}
|
|
"""
|
|
|
|
testFormatting(for: input, rule: .consistentSwitchCaseSpacing)
|
|
}
|
|
}
|