Draft: Migrate hls-class-plugin to use structured diagnostics
#4472
+1,137
−435
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
We're leaving the TODOs for either later in this PR or in another PR
This reverts commit 4fed987.
Had to move `attachReason` between modules to achieve this, which is fine because it was never exported from its own module.
This reverts commit 0776c65.
Implement 'rangesOverlap' function which checks whether two 'Range's overlap in any way. Implement two new plugin utility functions which allow to conveniently get all currently displayed diagnostics for a given 'Range'.
Add compatibility module for GHC's structured error messages. Introduce 'Prism's and 'Lens's to easily access nested structures. Expand documentation for 'StructuredMessage'
Fixes haskell#4440 Fixes test for disabling deferred-type-errors.
Co-authored-by: Mergify <37929162+mergify[bot]@users.noreply.github.com>
* new tests * change codeAction title * more tests and docs --------- Co-authored-by: fendor <[email protected]>
Allows HLS to 'Goto Definition' for Note references.
fendor
requested review from
michaelpj,
0rphee,
santiweight,
eddiemundo and
wz1000
as code owners
fendor
changed the title
hls-class-plugin to use structured diagnosticshls-class-plugin to use structured diagnostics
michaelpj
approved these changes
Dec 24, 2024
There was a problem hiding this comment.
Looks nice! It's a shame about not everything being structured. I wonder if we should just do an inventory of the places where we use GHC's diagnostics and check manually that they've been made structured? Maybe that's cheaper than doing all the PRs and either letting them get stale or adding a bunch of CPP?
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.
Split off from #4433, this PR moves the
hls-class-pluginto use the structured diagnostics.It worked well in my tests, but unfortunately it is incompatible with GHC 9.4, because the error message the plugin cares about is not structured in 9.4.
We can either wait until we drop support for 9.4 or maintain both paths until we drop support for 9.4.
Unfortunately, the only way to push GHC into the direction we want, is to do the latter and report any lacking error messages to GHC ASAP.
FYI, only the last commit matters.