Build Tool Plugin Support #733
Conversation
…d be treated as a build tool plugin Signed-off-by: Johannes Ebeling <14994778+technocidal@users.noreply.github.com>
Signed-off-by: Johannes Ebeling <14994778+technocidal@users.noreply.github.com>
|
@marciniwanicki @adamkhazi Just a quick ping: Is there anything I can do to move this along? Do you've any questions or suggestions regarding this feature? I'd be very grateful for any feedback. |
There was a problem hiding this comment.
Thanks for contributing this @technocidal and for the investigation in yonaskolb/XcodeGen#1290 👍
It would be helpful if you're able to add a new fixture with the pbxproj file that contains a build plugin and have a a few tests read & write to allow verifying the serialisation and deserialisation works as expected.
Some examples of past fixtures https://github.com/tuist/XcodeProj/tree/main/Fixtures and associated tests https://github.com/tuist/XcodeProj/blob/main/Tests/XcodeProjTests/Scheme/XCSchemeTests.swift#L695
| package: XCRemoteSwiftPackageReference? = nil) { | ||
| self.productName = productName | ||
| package: XCRemoteSwiftPackageReference? = nil, | ||
| plugin: Bool) { |
There was a problem hiding this comment.
to make this change non source breaking, can I trouble you to default the plugin parameter value?
| plugin: Bool) { | |
| plugin: Bool = false) { |
| if let plugin = try container.decodeIfPresent(Bool.self, forKey: .plugin) { | ||
| self.plugin = plugin | ||
| } else { | ||
| plugin = false | ||
| } |
There was a problem hiding this comment.
if I followed along, there isn't a plugin attribute in the pbxproj file, rather the product name is prefixed with plugin: - in that case would this not require checking for that instead?
There was a problem hiding this comment.
@kwridan Good point! I just realized that I completely misunderstood what this initializer is for. My bad 🤦♂️
|
@all-contributors add @technocidal for code |
|
I've put up a pull request to add @technocidal! 🎉 |
|
Hey there! Any updates? |
|
Hey, anything we can do to help speed this along? Getting the plugin support done (and integrated in Xcodegen) would be a massive benefit to my team, and we'd be happy to contribute. Thanks! |
|
I've converted back draft while this is being worked on |
|
I think I dropped the ball on this one. Sorry. I'll try to summarise my thoughts which I should've done way earlier. I can totally understand that getting this done would be a great thing but I'm a bit worried that this will generate a lot of follow-up maintenance. I've also worked on the plugin support for SwiftLint which has turned into a massive headache for everyone involved. There are a lot of edge cases related to plugins that are not correctly handled by Xcode. This means that it is entirely possible that adding a plugin to your project breaks it. This happens with SwiftLint and it's dependency on swift-syntax quite a lot. You can find more details in this discussion. There are also some other weird linker issues that we've filed a Feedback (FB11877146) for but haven't heard from Apple yet. Regarding the actual implementation. I think I only need to update my fork and finish implementing the test suite/fixtures but I'm a bit disheartened due to the problems mentioned above. |
|
No worries at all and no rush. Thank you for sharing some of gotchas with plugins - sorry to hear about the hurdles you had to face with it. |
|
@technocidal any updates from Apple? |
|
Hola 👋, We want to let you know that your pull request has been marked as stale. It seems that there hasn't been any activity or updates on it for a while. If you're still interested in having this pull request merged or reviewed, please provide any necessary updates or address any feedback that may have been given. We would be happy to continue the review process and consider merging it into the However, if this pull request is no longer a priority or if you've decided to take a different approach, please let us know so we can close it accordingly. Thank you for your understanding and contribution. |
|
Hola 👋, We want to let you know that we have decided to close your pull request #456 due to prolonged inactivity. Despite the initial interest and efforts put into the pull request, we haven't seen any updates or responses for a considerable period of time. We understand that circumstances change and priorities shift, which may have led to this inactivity. If you still wish to contribute or have further discussions on this feature or bug fix, please don't hesitate to reopen the pull request and engage with the community. We appreciate your understanding and the time you invested in submitting the pull request. Your contributions are valuable, and we hope to collaborate with you on future endeavors. Thank you. |
- Updated `XCSwiftPackageProductDependency` to support parsing and creating build tool plugins Notes: - This is a continuation of #733, to support **Build Tool Plug-ins**. (Thanks to @technocidal)
Short description 📝
I'm an avid user of XcodeGen and would like to have Build Tool Plugin support. It's possible to implement this without having to change this project but it leads to temporary identifiers sticking around in the generated project.
More details can be found in the issue where I documented my research.
Solution 📦
Adds a flag to XCSwiftPackageProductDependency to indicate that it should be treated as a build tool plugin.
Implementation 👩💻👨💻