Initial work towards compiler plugin support: Update docs and add test placeholder and added the midterm evaluation post to README #1606
Conversation
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Initial work towards compiler plugin support
This PR lays the groundwork for adding compiler plugin support to Scaladex by improving documentation and setting up test placeholders.
Changes Made
Documentation Updates
Updated README.md:
Added comprehensive list of supported binary version formats
Added section about compiler plugin support
Provided guidance for users with compiler plugins
Improved binary version documentation
Enhanced BinaryVersion.scala:
Added detailed class documentation
Included examples of different binary version formats
Added TODO section outlining steps for compiler plugin support implementation
Documented required changes for full version number support
Added Test Infrastructure:
Created test placeholder in BinaryVersionTests.scala
Added example test cases for future implementation
Prepared test scenarios for compiler plugin version parsing
Implementation Plan
The following steps are planned for full compiler plugin support:
Extend the Platform type to include CompilerPlugin
Update the Parser to handle full version numbers (e.g., _2.13.10)
Modify the artifact indexing logic to recognize compiler plugin artifacts
Related Information
This work is part of a larger effort to improve Scaladex's support for compiler plugins, which currently use full Scala versions (e.g., _2.13.10) and require special handling.
Testing
No functionality changes in this PR
Added placeholder tests that will be implemented in future PRs
Documentation changes have been reviewed for accuracy
Checklist
Updated documentation
Added test placeholders
Maintained code formatting
No breaking changes
Also added the midterm evaluation post to README