Skip to content

Initial work towards compiler plugin support: Update docs and add test placeholder - #1573

Closed
vidishagawas121 wants to merge 2 commits into
scalacenter:mainfrom
vidishagawas121:add-compiler-plugin-support
Closed

Initial work towards compiler plugin support: Update docs and add test placeholder#1573
vidishagawas121 wants to merge 2 commits into
scalacenter:mainfrom
vidishagawas121:add-compiler-plugin-support

Conversation

@vidishagawas121

Copy link
Copy Markdown
Contributor

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

  1. 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
  2. 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
  3. 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:

  1. Extend the Platform type to include CompilerPlugin
  2. Update the Parser to handle full version numbers (e.g., _2.13.10)
  3. 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

@vidishagawas121

Copy link
Copy Markdown
Contributor Author

@adpi2 @kannukalra this is a small initial PR to help understand the codebase for GSoC 2025 project idea (https://github.com/scalacenter/scaladex/)

@adpi2 adpi2 left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Overall, it looks good. I see that you found your way in the codebase.

Before merging, I would like you to revert the change from ssh to https in git modules.

Comment thread .gitmodules Outdated
Comment on lines +3 to +6
url = git@github.com:scalacenter/scaladex-small-index.git
url = https://github.com/scalacenter/scaladex-small-index.git
[submodule "contrib"]
path = contrib
url = git@github.com:scalacenter/scaladex-contrib.git
url = https://github.com/scalacenter/scaladex-contrib.git

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ssh and https are both valid and I prefer to keep ssh, as it was before. If you don't know how to set up ssh you can read this Github documentation page. Alternatively, you can configure a replacement of the ssh url to the https url in your configuration, as explained here.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thank you! I will look into it and make the changes

Comment on lines +61 to +65
// val cases = Table(
// ("input", "target"),
// ("_2.13.10", BinaryVersion(CompilerPlugin, Scala(Version(2, 13, 10)))),
// ("_3.3.1", BinaryVersion(CompilerPlugin, Scala(Version(3, 3, 1))))
// )

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That looks great

@vidishagawas121

Copy link
Copy Markdown
Contributor Author

@adpi2 reverted the changes that you had said

@adpi2

adpi2 commented Jul 14, 2025

Copy link
Copy Markdown
Member

@vidishagawas121 thank you for the revert.

Unfortunately the CI fails because of formatting. Could you run scalafmt and push the changes?

@vidishagawas121

Copy link
Copy Markdown
Contributor Author

sure! I will do it

@vidishagawas121 vidishagawas121 closed this by deleting the head repository Aug 5, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants