GemPins pin merging improvements #946
Open
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
Put responsibility for intelligently merging multiple pins for the same underlying item (e.g. from different sources like YARD and RBS) into the Pin class hierarchy.
12 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.
Put responsibility for intelligently merging multiple pins for the same underlying item (e.g. from different sources like YARD and RBS) into the Pin class hierarchy.
Changes were driven by using rbs_collection to gather more types for solargraph-rails. This resulted in the Rails gems having pins with up to four sources each - the .rb files themselves, the annotations in solargraph-rails, the auto-generated RBS files (with no types) in rbs_collection, and explicit types from solargraph-rails. Quality of types and signatures varied wildly, leading to logic to make a more informed decision on how to merge pins.
There's probably a future where some of the rbs_collection-driven heuristics inside move to a default config file that can be extended or maybe overridden by users.
Regression tests for these are the definition files in solargraph-rails: https://github.com/iftheshoefritz/solargraph-rails/tree/main/spec/definitions/rails7 - after #892 is merged, that will become part of our regression suite as well.