Add go-to-symbol and open-symbol-by-name features #8
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
lydell
commented
Jul 21, 2023
|
|
||
| You can navigate symbols inside a file. This is helpful for quickly navigating among functions, values and types in a file. | ||
|
|
||
|  |
There was a problem hiding this comment.
TODO for Ryan: Create this gif
There was a problem hiding this comment.
TODO for Ryan: Update the performance tables further below
(should probably be done on the same computer as the other features?)
lydell
commented
Jul 22, 2023
lydell
changed the title
lydell
commented
Jul 22, 2023
|
|
||
| You can navigate to any top-level declaration in any file, which is a quick way of getting to the right file. | ||
|
|
||
|  |
There was a problem hiding this comment.
TODO for Ryan: And this one
Conflicts: src/features/jump-to-definition.ts
|
any update on this? |
|
I’ve been running a build based on this PR + #21 on my computer for a while now, and it’s working well! @ryan-haskell Do you have time to merge? (And do the two readme tasks.) |
# for free
to join this conversation on GitHub.
Already have an account?
# 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.
Status: This seems to work well for me. I just need Ryan’s help with the docs stuff (we talked about it IRL a while ago).
This implements Go to Symbol and the Outline view (they go together), as well as Open symbol by name (which is a bit hacky, but I think it provides a lot of value even if it’s not 100 % pedantically correct). That’s what VSCode calls those features (see the links), but personally I think it’s not super clear what is what. Open to name changes if you want!
At first, on a large file it was too slow (when typing, the UI locked up and the characters appeared too late). It turned out 99.9 % of the time was spent parsing. I solved this by parsing in a Worker Thread. So now it never blocks the main thread. For small files, the outline feels instant (like 15 ms), and for big files I notice a ~0.5 second delay for it sometimes.
Note that the worker stuff is a bit tricky, so some extra testing might be good – this affects all features that parses using elm-syntax.