Newly created build tool and command plugin templates should have conditional support for XcodeProjectPlugin #6446
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
abertelrud
requested review from
neonichu,
tomerd and
MaxDesiatov
as code owners
|
@swift-ci please smoke test |
neonichu
approved these changes
Apr 17, 2023
There was a problem hiding this comment.
LGTM.
I think this naturally poses the question why we don't have the simpler func createBuildCommand(for inputPath: Path, in outputDirectoryPath: Path, with generatorToolPath: Path) -> Command? as an API, but that shouldn't prevent us from improving the template.
Absolutely. There are a lot of refinements that can be made to the API, and it would still be interesting to see if there could be some kind of über-API that would be generic enough to cover most conceivable IDEs. That approach didn't seem possible for the general case given the differences between the data models of Xcode and Swift Package Manager, but for the common case of just wanting to create a command for every file of some type, it seems a shame to have to have the Xcode specialization. |
MaxDesiatov
reviewed
Apr 18, 2023
MaxDesiatov
reviewed
Apr 18, 2023
MaxDesiatov
reviewed
Apr 18, 2023
MaxDesiatov
approved these changes
Apr 18, 2023
…ional support for XcodeProjectPlugin Many package plugins are used from Xcode, so it makes sense for newly created ones to have that by default. If there is support for other IDEs in the future, it would make sense to add that as well. This support is currently always added but we could consider having options in the API for whether to add it. rdar://108166582
|
Thanks @MaxDesiatov those newlines were a mistake. I'll fix that. |
abertelrud
force-pushed
the
eng/plugin-template-xcodeproject
branch
from
bb96497
to
e4ef6b3
Compare
|
@swift-ci please smoke test |
|
@swift-ci please test windows platform |
abertelrud
added a commit
to abertelrud/swift-package-manager
that referenced
this pull request
Apr 18, 2023
This is a supplemental fix for apple#6446 that removes the `async` specifier and corrects the protocol conformance of the Xcode command plug-in. This change should have been part of that PR. - remove the `async` specifier since the entry point that XcodeProjectPlugin defines isn't async - correct the protocol conformance of the Xcode command plug-in - update the unit tests rdar://108166582
abertelrud
added a commit
that referenced
this pull request
Apr 18, 2023
…ate (#6451) This is a supplemental fix for #6446 that removes the `async` specifier and corrects the protocol conformance of the Xcode command plug-in. This change should have been part of that PR. - remove the `async` specifier since the entry point that XcodeProjectPlugin defines isn't async - correct the protocol conformance of the Xcode command plug-in - update the unit tests rdar://108166582
abertelrud
added a commit
to abertelrud/swift-package-manager
that referenced
this pull request
Apr 19, 2023
…ional support for XcodeProjectPlugin (apple#6446) Many package plugins are used from Xcode, so it makes sense for newly created ones to have that by default. If there is support for other IDEs in the future, it would make sense to add that as well. This support is currently always added but we could consider having options in the API for whether to add it. rdar://108166582 (cherry picked from commit f0eae33)
abertelrud
added a commit
to abertelrud/swift-package-manager
that referenced
this pull request
Apr 19, 2023
…ate (apple#6451) This is a supplemental fix for apple#6446 that removes the `async` specifier and corrects the protocol conformance of the Xcode command plug-in. This change should have been part of that PR. - remove the `async` specifier since the entry point that XcodeProjectPlugin defines isn't async - correct the protocol conformance of the Xcode command plug-in - update the unit tests rdar://108166582 (cherry picked from commit 87ecb5d)
abertelrud
added a commit
that referenced
this pull request
Apr 19, 2023
…ve conditional support for XcodeProjectPlugin #6446 (#6456) * New build tool plugin and command plugin templates should have conditional support for XcodeProjectPlugin (#6446) Many package plugins are used from Xcode, so it makes sense for newly created ones to have that by default. If there is support for other IDEs in the future, it would make sense to add that as well. This support is currently always added but we could consider having options in the API for whether to add it. rdar://108166582 (cherry picked from commit f0eae33) * Supplemental fix for XcodeProjectPlugin support in package init template (#6451) This is a supplemental fix for #6446 that removes the `async` specifier and corrects the protocol conformance of the Xcode command plug-in. This change should have been part of that PR. - remove the `async` specifier since the entry point that XcodeProjectPlugin defines isn't async - correct the protocol conformance of the Xcode command plug-in - update the unit tests rdar://108166582 (cherry picked from commit 87ecb5d)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Package plugins can be applied to packages in Xcode without any modification. But Xcode also has an additional
XcodeProjectPluginmodule that provides extra API for applying plugins to Xcode projects. Since this is a common use case, it makes sense for newly created plugins to have conditional use of that extra API by default. If there is support for applying plugins to the project formats of other IDEs in the future, it would make sense to add those to the templates as well.This support is currently always added but we could consider having options in the API for whether to add it.
Changes:
rdar://108166582