Add SPM config support #1184
Merged
Add SPM config support #1184
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
|
This is great, could you add some docs for the new config? |
|
I've added some docs in |
art-divin
reviewed
Jul 27, 2023
| @@ -100,6 +100,22 @@ project: | |||
| - <path to xcframework file> | |||
| ``` | |||
|
|
|||
| You can also provide a Swift Package which will be scanned. Source files will be scanned based on the package's `path` and `exclude` options. | |||
There was a problem hiding this comment.
I must say, this would be such a nice feature 👍🏻
|
thanks for contributing 🙇 |
|
@krzysztofzablocki @art-divin I'm sorry to bother you but do you have any plans for a new release in the near future? Having these changes would help me massively. |
|
Thanks for asking, @jimmya 👋 I am all for the new release, @krzysztofzablocki what do you say? How to proceed? |
|
@art-divin there is |
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.
This PR adds support for Swift Packages in the config. This allows Sourcery to determine the module name of the scanned sources.
It depends on https://github.com/apple/swift-package-manager which is quite a big dependency (binary size also almost doubled after adding it). It is however the easiest way to read the contents of the package. Other method could be use the JSON output from
swift package dump-packageand parsing that ourselves. The upside to this is that we're not dependent on this big dependency and we're less attached to local Xcode version vs shipped SPM version. Downside is we have to parse stuff ourselves.I'd love to hear your thoughts on that.