Add hover for global variables #2691
Open
+33
−0
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
andyw8
reviewed
Oct 8, 2024
| @@ -13,6 +13,7 @@ class Hover | |||
| Prism::ConstantReadNode, | |||
| Prism::ConstantWriteNode, | |||
| Prism::ConstantPathNode, | |||
| Prism::GlobalVariableReadNode, | |||
There was a problem hiding this comment.
We should also handle GlobalVariableWriteNode.
(there's also GlobalVariableAndWriteNode and a few others, but they are very rarely used).
There was a problem hiding this comment.
I'm wondering, after reading your feedback, if I missed this point with the indexer part as well.
# a new comment
$DEBUG = "foo"Here, on hover, if I'm not mistaken, we want to display both comments: the one from the RBS declarations and the one from our own implementation. If yes, then I need to handle all these kinds of nodes within RubyIndexer::DeclarationListener, not only on RBS side, which would also allow features to work for user global variable like:
# a comment
$foo = "bar"WDYT?
andyw8
added
enhancement
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
Iteration of #2644
Handle global variables in hover requests.
Implementation
Follow the existing pattern: first, listen to
on_global_variable_read_node_enter. Then, search for entries in the index with the variable name, and finally, push the documentation for entries to theresponse_builder.Automated Tests
A very basic test; I tried not to be too coupled to the RBS implementation, asserting only the first three words.
Manual Tests
Write
$DEBUGwithin a file, then hover over it. You should see documentation from the RBS declaration.Kapture.2024-10-08.at.21.44.12.mp4