Fix notes plugin: avoid crashes on missing note definitions and improve lookup handling #4773
+84
−38
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
…ndle lookups safely
jvanbruegge
requested changes
Dec 6, 2025
Collaborator
jvanbruegge
left a comment
jvanbruegge
left a comment
There was a problem hiding this comment.
It is really hard to tell what the actual changes are here. Please do not do any reformatting in the same commit as you do functional changes. That is even ignoring that the changed formatting does not even pass the pre-commit hook from the project.
Please remove all reformatting from this PR, or at least split it into a separate commit
| matchAllText noteRefRegex ln | ||
| where | ||
| atPos c arr = case arr A.! 0 of | ||
| -- We check if the line we are currently at contains a note |
Collaborator
There was a problem hiding this comment.
Why delete this comment?
| mContents <- liftIO (runAction "notes.getfileContents" state (getFileContents nfp)) | ||
| case mContents of | ||
| Nothing -> | ||
|
|
Collaborator
There was a problem hiding this comment.
Why the extra newlines?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Fixes #4763
This PR updates the Notes plugin to safely handle cases where note definitions or references are missing.
So, Instead of throwing internal errors, the plugin now returns
Nullresults as expected by the LSP specs.Changes include:
Graceful handling of missing notes in jump-to-definition and references.
Replacing unsafe lookups with
fromMaybe.Cleaning up unused imports.
Functionality tested with a simple example; jump-to-definition works correctly and missing notes no longer cause errors.