Improve support for navigating to definitions in external modules #3263
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
ghost
added
the
|
cc @kritzcreek |
kritzcreek
reviewed
May 24, 2022
|
Hi Ryan, thanks for the PR(s)! I'm in the middle of a family emergency so won't get a chance to review today. Hopefully someone else can oblige or I'll get to it in the next few days |
crusso
approved these changes
May 27, 2022
|
(merging with master to kick off another build) |
|
@rvanasa if you cannot merge, try adding the |
|
@ggreif it looks like I would need write permissions to add a label to the PR. Thanks for merging when you get the chance! |
|
Fab! Thanks again! |
mergify bot
pushed a commit
that referenced
this pull request
Jun 4, 2022
This PR adds straightforward "go to definition" support for Motoko's pattern-style import syntax.
For example, `import { v|als } "mo:base/Array"` and `v|als(x)` (where `|` represents the cursor) will correctly navigate to the corresponding `Array.vals` declaration.
As with existing language server functionality, these changes do not yet account for variable shadowing. However, the updated `parse_module_header` function already parses import patterns such as (`import {alias = field} "..."`) based on the proposed generalized import syntax (#3076).
Please let me know if additional explanation would be helpful for any of these changes. I also included four test cases to cover the newly expected behavior of `definition_handler` and `parse_module_header`.
Tested in VSCode on WSL using the official Motoko extension.
Fixes #3078
Supersedes #3263
CC @kritzcreek, @crusso, @matthewhammer
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.
I rewrote most of
definition_handlerto account for edge cases related to finding definitions in external files.It's now possible to jump to the definition of an import identifier (rather than having to click on a qualified member name). For example,
import M|ap "HashMap"(where|is the cursor) jumps to the top ofHashMap.moinstead of doing nothing (fixes Buggy behaviour with go to definition vscode-motoko#17).The new implementation also has a more permissive default behavior for missing declarations. In cases where the module path is known but the qualified symbol is unknown, the language server attempts to direct the user to the relevant module. This is mostly intended as a fallback for situations where the index is missing an expected declaration, such as when the other file has a syntax error.
Possible future improvements:
moduleor equivalent keyword (when possible) rather than the top of the fileimportkeyword)languageServersupport for explicit symbolimports #3078 (currently experimenting with this)Passes all tests on my WSL setup and works as expected in VSCode with the official Motoko extension.
(@matthewhammer)