Filter gem RBIs by version during annotations command
#1585
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
0635c79
to
b21d9bd
Compare
annotations commandannotations command
b21d9bd
to
ca863df
Compare
d8ed7fe
to
0ccc549
Compare
paracycle
reviewed
Feb 26, 2024
0ccc549
to
b7f4fe5
Compare
annotations commandannotations command
b7f4fe5
to
690e6ad
Compare
Morriar
reviewed
Jun 26, 2024
Morriar
approved these changes
Jun 26, 2024
690e6ad
to
9a3bcc5
Compare
egiurleo
commented
Jun 26, 2024
| @@ -12,6 +12,7 @@ class AnnotationsTest < SpecWithProject | |||
|
|
|||
| after do | |||
| @project.remove!("sorbet/rbi/annotations") | |||
| @project.write!("Gemfile", @project.tapioca_gemfile) | |||
There was a problem hiding this comment.
This is necessary to prevent leaking Gemfile changes between tests
The `GemInfo` class is a wrapper around a gem name and verison. This will make it easier to pass a gem version around, allowing us to filter RBI annotations by version.
9a3bcc5
to
ece4a72
Compare
3 tasks
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.
Motivation
This PR aims to solve the problem of versioning RBIs. Up until now, there is no default way to write RBI for different versions of the same gem. This can lead to confusing issues for Sorbet users where RBIs don't match the version of a gem they're using, and they have to spend time figuring out whether their gem is out of date, whether the RBI is wrong, or if it's even both! Having a way to specify RBI for multiple versions of the same gem would allow people to adopt and use Sorbet without having to go through this hassle.
Implementation
The actual RBI filtering behavior is implemented in the RBI repo. This uses the
FilterVersionsrewriter during the annotations command to remove parts of the annotation RBI that aren't relevant to a certain gem version.Tests
I have added a test for this functionality.