Replace Commandant with swift-argument-parser

IBDecodable / IBLinter

A linter tool for Interface Builder

MIT License

950 stars 40 forks source link

Closed KS1019 closed 2 years ago

KS1019 commented 2 years ago

This PR removes Commandant in favor of swift-argument-parser.

This introduces breaking changes to the CLI interface because of some default flags ArgumentParser provides (ex: --version instead of version).
swift-argument-parser uses // swift-tools-version:5.2 in Package.swift. This might cause some problems considering this library uses lower swift-tools-version
Commandant is not automatically removed from Package.resolved. I am not sure if I should do it by myself.

phimage commented 2 years ago

This introduces breaking changes to the CLI interface because of some default flags ArgumentParser provides (ex: --version instead of version).

for --version yes its a feature of swift-argument parser we could support a subcommand version to keep compatibility but maybe not

if any other change, maybe we could just document it in doc or release

Commandant is not automatically removed from Package.resolved. I am not sure if I should do it by myself.

Sometimes I remove it and see what has been modified to have a clear situation

Build issue but maybe to swift version change and old Xcode https://github.com/IBDecodable/IBLinter/runs/5092948870?check_suite_focus=true (maybe a self.reporter could help, I do not read full code)

KS1019 commented 2 years ago

Some updates:

For the CLI interface changes, I will go for using ArgumentParser's default flags for now. If there is a strong need to keep compatibility, please let me know so that I can make the necessary changes.
It seems that Commandant was not removed from Package.resolved because SourceKitten uses it for its executable target so I think I don't have to do anything.
When I tested, only the Linux builds are failing and showing the error below.
```
error: the package dependency graph could not be resolved; unable to find any available tag for the following requirements:
17
https://github.com/apple/swift-argument-parser @ 1.0.0..<2.0.0
```
I am guessing that this is due to the mismatch of swift-tools-version but I am not totally sure so I will look into this further.

kateinoigakukun commented 2 years ago

Please feel free to remove 5.1 job from ci. It's too old and not worth supporting it 😅