Skip to content

Commit 7219c8b

Browse files
authored
Update README.md
1 parent 30393c4 commit 7219c8b

File tree

1 file changed

+8
-6
lines changed

1 file changed

+8
-6
lines changed

README.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,8 @@
11
# Swift Public API diff
22

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.
44

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).
86

97
## How it works
108

@@ -49,5 +47,9 @@ The `ChangeConsolidator` takes 2 independent changes (`addition` & `removal`) an
4947

5048
Receives a dictionary of `[{SCOPE_NAME}: [Change]]` and processes them into a human readable format.
5149

52-
## Inspiration
53-
- SwiftInterfaceParser: https://github.com/sdidla/Hatch/blob/main/Sources/Hatch/SymbolParser.swift
50+
# Alternatives
51+
- `xcrun swift-api-digester -dump-sdk` & `xcrun swift-api-digester -diagnose-sdk`
52+
53+
# Inspiration
54+
- https://github.com/sdidla/Hatch/blob/main/Sources/Hatch/SymbolParser.swift
55+
- 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

Comments
 (0)