You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+8-6Lines changed: 8 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,10 +1,8 @@
1
1
# Swift Public API diff
2
2
3
-
This tool allows comparing 2 versions of a swift package project and lists all changes in a human readable way.
3
+
This tool allows comparing 2 versions of a swift (sdk) project and lists all changes in a human readable way.
4
4
5
-
It makes use of `xcrun swift-api-digester -dump-sdk` to create a dump of the public api of your swift package and then runs it through a custom parser to process them.
6
-
7
-
Alternatively you could use `xcrun swift-api-digester -diagnose-sdk` and pass the abi dumps into it.
5
+
It makes use of `.swiftinterface` files that get produced during the archiving of a swift project and parses them using [`swift-syntax`](https://github.com/swiftlang/swift-syntax).
8
6
9
7
## How it works
10
8
@@ -49,5 +47,9 @@ The `ChangeConsolidator` takes 2 independent changes (`addition` & `removal`) an
49
47
50
48
Receives a dictionary of `[{SCOPE_NAME}: [Change]]` and processes them into a human readable format.
- For parsing swift files using [swift-syntax](https://github.com/swiftlang/swift-syntax)'s [`SyntaxVisitor`](https://github.com/swiftlang/swift-syntax/blob/main/Sources/SwiftSyntax/generated/SyntaxVisitor.swift)
0 commit comments