CLI tool that provides information about a given Swift Package product, such as a measurament of its binary size impact. It's built on top of Swift Argument Parser.
OVERVIEW: A tool for analyzing Swift Packages
Provides valuable information about a given Swift Package,
that can be used in your favor when deciding whether to
adopt or not a Swift Package as a dependency on your app.
USAGE: swift-package-info <subcommand>
OPTIONS:
--version Show the version.
-h, --help Show help information.
SUBCOMMANDS:
binary-size Estimated binary size of a Swift Package product.
platforms Shows platforms supported b a Package product.
dependencies List dependencies of a Package product.
full-analyzes (default) All available information about a Swift Package product.
See 'swift-package-info help <subcommand>' for detailed help.
- Run a full analyzes
swift-package-info --for https://github.com/ReactiveX/RxSwift -v 6.0.0 --product RxSwift
- Check supported platforms (sub command)
swift-package-info platforms --for https://github.com/krzyzanowskim/CryptoSwift -v 1.3.8 --product CryptoSwift
- See binary size of a local pacakge (e.g. under development framework)
swift-package-info binary-size --path ../project/my-framework
swift-package-info --for https://github.com/ReactiveX/RxSwift -v 6.0.0 --product RxSwift
+------------------------------------------------+
| Swift Package Info |
| |
| RxSwift, 6.0.0 |
+--------------+---------------------------------+
| Provider | Results |
+--------------+---------------------------------+
| Binary Size | Binary size increases by 963 KB |
| Platforms | System default |
| Dependencies | No third-party dependencies :) |
+--------------+---------------------------------+
> Total of 3 providers used.
A custom report strategy can be passed via the report argument (check --help for supported values)
swift-package-info --for https://github.com/ReactiveX/RxSwift -v 6.0.0 --product RxSwift --report jsonDump
{
"binarySize" : {
"amount" : 962560,
"formatted" : "963 KB"
},
"dependencies" : [
],
"platforms" : {
}
}- Install mint.
- Optionally run
export MINT_LINK_PATH="/usr/local/bin"to symlink it - Run:
mint install marinofelipe/swift-package-info
mint run swift-package-info- or simply,
swift-package-infoin case it was symliked
Build from Swift Package Manager
swift buildin the top level directory- The built utility can be found in
.build/debug/swift-package-info - Run with
swift run
Run from Xcode
- Add the project directory to
swift-package-infoscheme customWorkingDirectory - Run the tests
Run from command line
swift test --build-path PROJECT_DIR
- CombineHTTPClient from HTTPClient
- Swift Argument Parser
- swift-tools-support-core from SwiftToolsSupport-auto
- XcodeProj
Its methodology is inspired by cocoapods-size, and thus works by comparing archives with no bitcode and ARM64 arch. Such strategy has proven to be consistent with the size added to iOS apps downloaded and installed via TestFlight.
Special thanks to @unnamedd for sharing his experience with swift-tools-support-core and on how to build a pretty 👌 report.
Swift Package Info is fully open and your contributions are more than welcome.