Skip to content

Commit fe72b85

Browse files
goergisngoergisn
authored
Adding multi line formatting (#70)
* Adding multi-line formatting to descriptions * fixing formatting --------- Co-authored-by: Alex Guretzki <alexander.guretzki@adyen.com>
1 parent 2652d78 commit fe72b85

20 files changed

+318
-322
lines changed

‎Package.resolved‎

Lines changed: 4 additions & 4 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎Sources/PublicModules/PADSwiftInterfaceDiff/SwiftInterfaceParser/SwiftInterfaceElement+Declaration/String+Convenience.swift‎

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
//
2+
// String+Convenience.swift
3+
// public-api-diff
4+
//
5+
// Created by Alexander Guretzki on 04/12/2024.
6+
//
7+
8+
import Foundation
9+
10+
internal extension String {
11+
12+
/// Appends a string using a separator
13+
///
14+
/// - Parameters:
15+
/// - element: The string to append
16+
/// - separator: The separator to use when appending the string
17+
/// - template: The template to use to build the string (Helpful when the element is optional)
18+
///
19+
/// - Important: The string is not added if it's nil or empty \
20+
/// If **self** is empty, the separator is ignored and **self** gets the value of the passed string
21+
mutating func append(
22+
_ element: String?,
23+
with separator: String,
24+
template: ((String) -> String) = { string in return string }
25+
) {
26+
guard let element, !element.isEmpty else { return }
27+
28+
let compiledElement = template(element)
29+
30+
if self.isEmpty {
31+
self = compiledElement
32+
return
33+
}
34+
35+
self = [self, compiledElement].joined(separator: separator)
36+
}
37+
}

‎Sources/PublicModules/PADSwiftInterfaceDiff/SwiftInterfaceParser/SwiftInterfaceElement+Declaration/SwiftInterfaceElement+Actor.swift‎

Lines changed: 10 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -76,28 +76,15 @@ extension SwiftInterfaceActor {
7676
private extension SwiftInterfaceActor {
7777

7878
func compileDescription() -> String {
79-
80-
var components = [String]()
81-
82-
components += attributes
83-
components += modifiers
84-
components += ["actor"]
85-
86-
components += [{
87-
var components = [
88-
name,
89-
genericParameterDescription
90-
].compactMap { $0 }.joined()
91-
92-
if let inheritance, !inheritance.isEmpty {
93-
components += ": \(inheritance.joined(separator: ", "))"
94-
}
95-
96-
return components
97-
}()]
98-
99-
genericWhereClauseDescription.map { components += [$0] }
100-
101-
return components.joined(separator: " ")
79+
var description = ""
80+
description.append(attributes.joined(separator: "\n"), with: "")
81+
description.append(modifiers.joined(separator: " "), with: "\n")
82+
if modifiers.isEmpty && !attributes.isEmpty { description.append("\n") }
83+
description.append("actor", with: modifiers.isEmpty ? "" : " ")
84+
description.append(name, with: " ")
85+
description.append(genericParameterDescription, with: "")
86+
description.append(inheritance?.joined(separator: ", "), with: "") { ": \($0)" }
87+
description.append(genericWhereClauseDescription, with: " ")
88+
return description
10289
}
10390
}

‎Sources/PublicModules/PADSwiftInterfaceDiff/SwiftInterfaceParser/SwiftInterfaceElement+Declaration/SwiftInterfaceElement+AssociatedType.swift‎

Lines changed: 10 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -73,23 +73,15 @@ extension SwiftInterfaceAssociatedType {
7373
private extension SwiftInterfaceAssociatedType {
7474

7575
func compileDescription() -> String {
76-
77-
var components = [String]()
78-
79-
components += attributes
80-
components += modifiers
81-
components += ["associatedtype"]
82-
83-
if let inheritance, !inheritance.isEmpty {
84-
components += ["\(name): \(inheritance.joined(separator: ", "))"]
85-
} else {
86-
components += [name]
87-
}
88-
89-
initializerValue.map { components += ["= \($0)"] }
90-
91-
genericWhereClauseDescription.map { components += [$0] }
92-
93-
return components.joined(separator: " ")
76+
var description = ""
77+
description.append(attributes.joined(separator: "\n"), with: "")
78+
description.append(modifiers.joined(separator: " "), with: "\n")
79+
if modifiers.isEmpty && !attributes.isEmpty { description.append("\n") }
80+
description.append("associatedtype", with: modifiers.isEmpty ? "" : " ")
81+
description.append(name, with: " ")
82+
description.append(inheritance?.joined(separator: ", "), with: "") { ": \($0)" }
83+
description.append(initializerValue, with: " ") { "= \($0)" }
84+
description.append(genericWhereClauseDescription, with: " ")
85+
return description
9486
}
9587
}

‎Sources/PublicModules/PADSwiftInterfaceDiff/SwiftInterfaceParser/SwiftInterfaceElement+Declaration/SwiftInterfaceElement+Class.swift‎

Lines changed: 10 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -76,28 +76,15 @@ extension SwiftInterfaceClass {
7676
private extension SwiftInterfaceClass {
7777

7878
func compileDescription() -> String {
79-
80-
var components = [String]()
81-
82-
components += attributes
83-
components += modifiers
84-
components += ["class"]
85-
86-
components += [{
87-
var components = [
88-
name,
89-
genericParameterDescription
90-
].compactMap { $0 }.joined()
91-
92-
if let inheritance, !inheritance.isEmpty {
93-
components += ": \(inheritance.joined(separator: ", "))"
94-
}
95-
96-
return components
97-
}()]
98-
99-
genericWhereClauseDescription.map { components += [$0] }
100-
101-
return components.joined(separator: " ")
79+
var description = ""
80+
description.append(attributes.joined(separator: "\n"), with: "")
81+
description.append(modifiers.joined(separator: " "), with: "\n")
82+
if modifiers.isEmpty && !attributes.isEmpty { description.append("\n") }
83+
description.append("class", with: modifiers.isEmpty ? "" : " ")
84+
description.append(name, with: " ")
85+
description.append(genericParameterDescription, with: "")
86+
description.append(inheritance?.joined(separator: ", "), with: "") { ": \($0)" }
87+
description.append(genericWhereClauseDescription, with: " ")
88+
return description
10289
}
10390
}

‎Sources/PublicModules/PADSwiftInterfaceDiff/SwiftInterfaceParser/SwiftInterfaceElement+Declaration/SwiftInterfaceElement+Enum.swift‎

Lines changed: 10 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -74,28 +74,15 @@ extension SwiftInterfaceEnum {
7474
private extension SwiftInterfaceEnum {
7575

7676
func compileDescription() -> String {
77-
78-
var components = [String]()
79-
80-
components += attributes
81-
components += modifiers
82-
components += ["enum"]
83-
84-
components += [{
85-
var components = [
86-
name,
87-
genericParameterDescription
88-
].compactMap { $0 }.joined()
89-
90-
if let inheritance, !inheritance.isEmpty {
91-
components += ": \(inheritance.joined(separator: ", "))"
92-
}
93-
94-
return components
95-
}()]
96-
97-
genericWhereClauseDescription.map { components += [$0] }
98-
99-
return components.joined(separator: " ")
77+
var description = ""
78+
description.append(attributes.joined(separator: "\n"), with: "")
79+
description.append(modifiers.joined(separator: " "), with: "\n")
80+
if modifiers.isEmpty && !attributes.isEmpty { description.append("\n") }
81+
description.append("enum", with: modifiers.isEmpty ? "" : " ")
82+
description.append(name, with: " ")
83+
description.append(genericParameterDescription, with: "")
84+
description.append(inheritance?.joined(separator: ", "), with: "") { ": \($0)" }
85+
description.append(genericWhereClauseDescription, with: " ")
86+
return description
10087
}
10188
}

‎Sources/PublicModules/PADSwiftInterfaceDiff/SwiftInterfaceParser/SwiftInterfaceElement+Declaration/SwiftInterfaceElement+EnumCase.swift‎

Lines changed: 13 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -96,20 +96,19 @@ extension SwiftInterfaceEnumCase {
9696

9797
private extension SwiftInterfaceEnumCase {
9898

99+
var parameterDescription: String? {
100+
guard let parameters else { return nil }
101+
return formattedParameterDescription(for: parameters.map(\.description))
102+
}
103+
99104
func compileDescription() -> String {
100-
101-
var components = [String]()
102-
103-
components += attributes
104-
components += modifiers
105-
components += ["case"]
106-
107-
if let parameters {
108-
components += ["\(name)(\(parameters.map(\.description).joined(separator: ", ")))"]
109-
} else {
110-
components += [name]
111-
}
112-
113-
return components.joined(separator: " ")
105+
var description = ""
106+
description.append(attributes.joined(separator: "\n"), with: "")
107+
description.append(modifiers.joined(separator: " "), with: "\n")
108+
if modifiers.isEmpty && !attributes.isEmpty { description.append("\n") }
109+
description.append("case", with: modifiers.isEmpty ? "" : " ")
110+
description.append(name, with: " ")
111+
description.append(parameterDescription, with: "") { "(\($0))" }
112+
return description
114113
}
115114
}

‎Sources/PublicModules/PADSwiftInterfaceDiff/SwiftInterfaceParser/SwiftInterfaceElement+Declaration/SwiftInterfaceElement+Extension.swift‎

Lines changed: 9 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -71,21 +71,14 @@ extension SwiftInterfaceExtension {
7171
private extension SwiftInterfaceExtension {
7272

7373
func compileDescription() -> String {
74-
75-
var components = [String]()
76-
77-
components += attributes
78-
components += modifiers
79-
components += ["extension"]
80-
81-
if let inheritance, !inheritance.isEmpty {
82-
components += ["\(extendedType): \(inheritance.joined(separator: ", "))"]
83-
} else {
84-
components += [extendedType]
85-
}
86-
87-
genericWhereClauseDescription.map { components += [$0] }
88-
89-
return components.joined(separator: " ")
74+
var description = ""
75+
description.append(attributes.joined(separator: "\n"), with: "")
76+
description.append(modifiers.joined(separator: " "), with: "\n")
77+
if modifiers.isEmpty && !attributes.isEmpty { description.append("\n") }
78+
description.append("extension", with: modifiers.isEmpty ? "" : " ")
79+
description.append(extendedType, with: " ")
80+
description.append(inheritance?.joined(separator: ", "), with: "") { ": \($0)" }
81+
description.append(genericWhereClauseDescription, with: " ")
82+
return description
9083
}
9184
}

‎Sources/PublicModules/PADSwiftInterfaceDiff/SwiftInterfaceParser/SwiftInterfaceElement+Declaration/SwiftInterfaceElement+Function.swift‎

Lines changed: 16 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -117,26 +117,22 @@ extension SwiftInterfaceFunction {
117117

118118
private extension SwiftInterfaceFunction {
119119

120+
var parameterDescription: String {
121+
formattedParameterDescription(for: parameters.map(\.description))
122+
}
123+
120124
func compileDescription() -> String {
121-
var components = [String]()
122-
123-
components += attributes
124-
components += modifiers
125-
components += ["func"]
126-
127-
components += [
128-
[
129-
name,
130-
genericParameterDescription,
131-
"(\(parameters.map(\.description).joined(separator: ", ")))"
132-
].compactMap { $0 }.joined()
133-
]
134-
135-
components += effectSpecifiers
136-
components += ["-> \(returnType)"]
137-
138-
genericWhereClauseDescription.map { components += [$0] }
139-
140-
return components.joined(separator: " ")
125+
var description = ""
126+
description.append(attributes.joined(separator: "\n"), with: "")
127+
description.append(modifiers.joined(separator: " "), with: "\n")
128+
if modifiers.isEmpty && !attributes.isEmpty { description.append("\n") }
129+
description.append("func", with: modifiers.isEmpty ? "" : " ")
130+
description.append(name, with: " ")
131+
description.append(genericParameterDescription, with: "")
132+
description.append("(\(parameterDescription))", with: "")
133+
description.append(effectSpecifiers.joined(separator: " "), with: " ")
134+
description.append(returnType, with: " ") { "-> \($0)" }
135+
description.append(genericWhereClauseDescription, with: " ")
136+
return description
141137
}
142138
}

‎Sources/PublicModules/PADSwiftInterfaceDiff/SwiftInterfaceParser/SwiftInterfaceElement+Declaration/SwiftInterfaceElement+Initializer.swift‎

Lines changed: 15 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -115,25 +115,21 @@ extension SwiftInterfaceInitializer {
115115

116116
private extension SwiftInterfaceInitializer {
117117

118+
var parameterDescription: String {
119+
formattedParameterDescription(for: parameters.map(\.description))
120+
}
121+
118122
func compileDescription() -> String {
119-
var components = [String]()
120-
121-
components += attributes
122-
components += modifiers
123-
124-
components += [
125-
[
126-
"init",
127-
optionalMark,
128-
genericParameterDescription,
129-
"(\(parameters.map(\.description).joined(separator: ", ")))"
130-
].compactMap { $0 }.joined()
131-
]
132-
133-
components += effectSpecifiers
134-
135-
genericWhereClauseDescription.map { components += [$0] }
136-
137-
return components.joined(separator: " ")
123+
var description = ""
124+
description.append(attributes.joined(separator: "\n"), with: "")
125+
description.append(modifiers.joined(separator: " "), with: "\n")
126+
if modifiers.isEmpty && !attributes.isEmpty { description.append("\n") }
127+
description.append("init", with: modifiers.isEmpty ? "" : " ")
128+
description.append(optionalMark, with: "")
129+
description.append(genericParameterDescription, with: "")
130+
description.append("(\(parameterDescription))", with: "")
131+
description.append(effectSpecifiers.joined(separator: " "), with: " ")
132+
description.append(genericWhereClauseDescription, with: " ")
133+
return description
138134
}
139135
}

0 commit comments

Comments
 (0)