Skip to content

Parameter diffing #112

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Parameter diffing #112

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
77f4fb1
Consolidating changes on function/enum parameters
goergisn Apr 30, 2025
409b408
Merge branch 'main' into parameter-diff
goergisn Apr 30, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions ...ff/SwiftInterfaceParser/DeclSyntax+SwiftInterface/EnumCaseDeclSyntax+SwiftInterface.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ extension EnumCaseDeclSyntax {
name: $0.name.trimmedDescription,
parameters: $0.parameterClause?.parameters.map {
.init(
attributes: [],
firstName: $0.firstName?.trimmedDescription,
secondName: $0.secondName?.trimmedDescription,
type: $0.type.trimmedDescription,
Expand Down
2 changes: 1 addition & 1 deletion ...ff/SwiftInterfaceParser/DeclSyntax+SwiftInterface/FunctionDeclSyntax+SwiftInterface.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ extension FunctionDeclSyntax {
}
}

let parameters: [SwiftInterfaceFunction.Parameter] = self.signature.parameterClause.parameters.map {
let parameters: [SwiftInterfaceElementParameter] = self.signature.parameterClause.parameters.map {
.init(
attributes: $0.attributes.sanitizedList,
firstName: $0.firstName.trimmedDescription,
Expand Down
2 changes: 1 addition & 1 deletion ...SwiftInterfaceParser/DeclSyntax+SwiftInterface/InitializerDeclSyntax+SwiftInterface.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ extension InitializerDeclSyntax {
}
}

let parameters: [SwiftInterfaceFunction.Parameter] = self.signature.parameterClause.parameters.map {
let parameters: [SwiftInterfaceElementParameter] = self.signature.parameterClause.parameters.map {
.init(
attributes: $0.attributes.sanitizedList,
firstName: $0.firstName.trimmedDescription,
Expand Down
3 changes: 2 additions & 1 deletion ...f/SwiftInterfaceParser/DeclSyntax+SwiftInterface/SubscriptDeclSyntax+SwiftInterface.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,9 @@ extension SubscriptDeclSyntax {

func toInterfaceElement() -> SwiftInterfaceSubscript {

let parameters: [SwiftInterfaceSubscript.Parameter] = self.parameterClause.parameters.map {
let parameters: [SwiftInterfaceElementParameter] = self.parameterClause.parameters.map {
.init(
attributes: $0.attributes.sanitizedList,
firstName: $0.firstName.trimmedDescription,
secondName: $0.secondName?.trimmedDescription,
type: $0.type.trimmedDescription,
Expand Down
39 changes: 3 additions & 36 deletions ...iftInterfaceParser/SwiftInterfaceElement+Declaration/SwiftInterfaceElement+EnumCase.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,39 +6,6 @@

import Foundation

extension SwiftInterfaceEnumCase {

struct Parameter {

let firstName: String?

let secondName: String?

let type: String

let defaultValue: String?

var description: String {
var description = [
firstName,
secondName
].compactMap { $0 }.joined(separator: " ")

if description.isEmpty {
description += "\(type)"
} else {
description += ": \(type)"
}

if let defaultValue {
description += " = \(defaultValue)"
}

return description
}
}
}

class SwiftInterfaceEnumCase: SwiftInterfaceElement {

/// e.g. @discardableResult, @MainActor, @objc, @_spi(...), ...
Expand All @@ -49,7 +16,7 @@ class SwiftInterfaceEnumCase: SwiftInterfaceElement {

let name: String

let parameters: [Parameter]?
let parameters: [SwiftInterfaceElementParameter]?

let rawValue: String?

Expand All @@ -72,7 +39,7 @@ class SwiftInterfaceEnumCase: SwiftInterfaceElement {
attributes: [String],
modifiers: [String],
name: String,
parameters: [Parameter]?,
parameters: [SwiftInterfaceElementParameter]?,
rawValue: String?
) {
self.attributes = attributes
Expand All @@ -90,7 +57,7 @@ extension SwiftInterfaceEnumCase {
guard let other = otherElement as? Self else { return [] }
changes += diffDescription(propertyType: "attribute", oldValues: other.attributes, newValues: attributes)
changes += diffDescription(propertyType: "modifier", oldValues: other.modifiers, newValues: modifiers)
changes += diffDescription(propertyType: "parameter", oldValues: other.parameters?.map(\.description), newValues: parameters?.map(\.description))
changes += diffDescription(oldParameters: other.parameters, newParameters: parameters)
changes += diffDescription(propertyType: "raw value", oldValue: other.rawValue, newValue: rawValue)
return changes.compactMap { $0 }
}
Expand Down
47 changes: 4 additions & 43 deletions ...iftInterfaceParser/SwiftInterfaceElement+Declaration/SwiftInterfaceElement+Function.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,45 +6,6 @@

import Foundation

extension SwiftInterfaceFunction {

struct Parameter {

/// e.g. @discardableResult, @MainActor, @objc, @_spi(...), ...
let attributes: [String]

let firstName: String

/// optional second "internal" name - can be ignored
let secondName: String?

let type: String

let defaultValue: String?

var description: String {
let names = [
firstName,
secondName
].compactMap { $0 }

var description = (attributes + names).joined(separator: " ")

if description.isEmpty {
description += "\(type)"
} else {
description += ": \(type)"
}

if let defaultValue {
description += " = \(defaultValue)"
}

return description
}
}
}

class SwiftInterfaceFunction: SwiftInterfaceElement {

/// e.g. @discardableResult, @MainActor, @objc, @_spi(...), ...
Expand All @@ -55,7 +16,7 @@ class SwiftInterfaceFunction: SwiftInterfaceElement {
/// e.g. <T>
let genericParameterDescription: String?

let parameters: [Parameter]
let parameters: [SwiftInterfaceElementParameter]

/// e.g. async, throws, rethrows
let effectSpecifiers: [String]
Expand All @@ -76,7 +37,7 @@ class SwiftInterfaceFunction: SwiftInterfaceElement {
var parent: (any SwiftInterfaceElement)?

var diffableSignature: String {
"\(name)(\(parameters.map { "\($0.firstName):" }.joined()))"
"\(name)(\(parameters.map(\.valueForDiffableSignature).joined()))"
}

var consolidatableName: String { name }
Expand All @@ -90,7 +51,7 @@ class SwiftInterfaceFunction: SwiftInterfaceElement {
modifiers: [String],
name: String,
genericParameterDescription: String?,
parameters: [Parameter],
parameters: [SwiftInterfaceElementParameter],
effectSpecifiers: [String],
returnType: String?,
genericWhereClauseDescription: String?
Expand All @@ -114,7 +75,7 @@ extension SwiftInterfaceFunction {
changes += diffDescription(propertyType: "attribute", oldValues: other.attributes, newValues: attributes)
changes += diffDescription(propertyType: "modifier", oldValues: other.modifiers, newValues: modifiers)
changes += diffDescription(propertyType: "generic parameter description", oldValue: other.genericParameterDescription, newValue: genericParameterDescription)
changes += diffDescription(propertyType: "parameter", oldValues: other.parameters.map(\.description), newValues: parameters.map(\.description)) // TODO: Maybe have a better way to show changes
changes += diffDescription(oldParameters: other.parameters, newParameters: parameters)
changes += diffDescription(propertyType: "effect", oldValues: other.effectSpecifiers, newValues: effectSpecifiers)
changes += diffDescription(propertyType: "return type", oldValue: other.returnType, newValue: returnType)
changes += diffDescription(propertyType: "generic where clause", oldValue: other.genericWhereClauseDescription, newValue: genericWhereClauseDescription)
Expand Down
8 changes: 4 additions & 4 deletions ...InterfaceParser/SwiftInterfaceElement+Declaration/SwiftInterfaceElement+Initializer.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ class SwiftInterfaceInitializer: SwiftInterfaceElement {
/// e.g. <T>
let genericParameterDescription: String?

let parameters: [SwiftInterfaceFunction.Parameter]
let parameters: [SwiftInterfaceElementParameter]

/// e.g. async, throws, rethrows
let effectSpecifiers: [String]
Expand All @@ -35,7 +35,7 @@ class SwiftInterfaceInitializer: SwiftInterfaceElement {
var parent: (any SwiftInterfaceElement)?

var diffableSignature: String {
"init(\(parameters.map { "\($0.firstName):" }.joined()))"
"init(\(parameters.map { $0.valueForDiffableSignature }.joined()))"
}

var consolidatableName: String { "init" }
Expand All @@ -49,7 +49,7 @@ class SwiftInterfaceInitializer: SwiftInterfaceElement {
modifiers: [String],
optionalMark: String?,
genericParameterDescription: String?,
parameters: [SwiftInterfaceFunction.Parameter],
parameters: [SwiftInterfaceElementParameter],
effectSpecifiers: [String],
genericWhereClauseDescription: String?
) {
Expand All @@ -72,7 +72,7 @@ extension SwiftInterfaceInitializer {
changes += diffDescription(propertyType: "modifier", oldValues: other.modifiers, newValues: modifiers)
changes += diffDescription(propertyType: "optional mark", oldValue: other.optionalMark, newValue: optionalMark)
changes += diffDescription(propertyType: "generic parameter description", oldValue: other.genericParameterDescription, newValue: genericParameterDescription)
changes += diffDescription(propertyType: "parameter", oldValues: other.parameters.map(\.description), newValues: parameters.map(\.description)) // TODO: Maybe have a better way to show changes
changes += diffDescription(oldParameters: other.parameters, newParameters: parameters)
changes += diffDescription(propertyType: "effect", oldValues: other.effectSpecifiers, newValues: effectSpecifiers)
changes += diffDescription(propertyType: "generic where clause", oldValue: other.genericWhereClauseDescription, newValue: genericWhereClauseDescription)
return changes.compactMap { $0 }
Expand Down
42 changes: 4 additions & 38 deletions ...ftInterfaceParser/SwiftInterfaceElement+Declaration/SwiftInterfaceElement+Subscript.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,40 +6,6 @@

import Foundation

extension SwiftInterfaceSubscript {

struct Parameter {

let firstName: String

/// optional second "internal" name - can be ignored
let secondName: String?

let type: String

let defaultValue: String?

var description: String {
var description = [
firstName,
secondName
].compactMap { $0 }.joined(separator: " ")

if description.isEmpty {
description += "\(type)"
} else {
description += ": \(type)"
}

if let defaultValue {
description += " = \(defaultValue)"
}

return description
}
}
}

class SwiftInterfaceSubscript: SwiftInterfaceElement {

let name: String = "subscript"
Expand All @@ -53,7 +19,7 @@ class SwiftInterfaceSubscript: SwiftInterfaceElement {
/// e.g. <T>
let genericParameterDescription: String?

let parameters: [Parameter]
let parameters: [SwiftInterfaceElementParameter]

let returnType: String

Expand All @@ -69,7 +35,7 @@ class SwiftInterfaceSubscript: SwiftInterfaceElement {
var parent: (any SwiftInterfaceElement)?

var diffableSignature: String {
"\(name)(\(parameters.map { "\($0.firstName):" }.joined()))"
"\(name)(\(parameters.map(\.valueForDiffableSignature).joined()))"
}

var consolidatableName: String { name }
Expand All @@ -82,7 +48,7 @@ class SwiftInterfaceSubscript: SwiftInterfaceElement {
attributes: [String],
modifiers: [String],
genericParameterDescription: String?,
parameters: [Parameter],
parameters: [SwiftInterfaceElementParameter],
returnType: String,
genericWhereClauseDescription: String?,
accessors: String?
Expand All @@ -105,7 +71,7 @@ extension SwiftInterfaceSubscript {
changes += diffDescription(propertyType: "attribute", oldValues: other.attributes, newValues: attributes)
changes += diffDescription(propertyType: "modifier", oldValues: other.modifiers, newValues: modifiers)
changes += diffDescription(propertyType: "generic parameter description", oldValue: other.genericParameterDescription, newValue: genericParameterDescription)
changes += diffDescription(propertyType: "parameter", oldValues: other.parameters.map(\.description), newValues: parameters.map(\.description)) // TODO: Maybe have a better way to show changes
changes += diffDescription(oldParameters: other.parameters, newParameters: parameters)
changes += diffDescription(propertyType: "return type", oldValue: other.returnType, newValue: returnType)
changes += diffDescription(propertyType: "generic where clause", oldValue: other.genericWhereClauseDescription, newValue: genericWhereClauseDescription)
changes += diffDescription(propertyType: "accessors", oldValue: other.accessors, newValue: accessors)
Expand Down
Loading
Loading