Skip to content

Set the diagnostic code description on GHC diagnostics #4629

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Jun 9, 2025
Merged

Set the diagnostic code description on GHC diagnostics #4629

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
0eab739
Set the diagnostic code description on GHC diagnostics
michaelpj Jun 9, 2025
1b21aad
Merge branch 'master' into mpj/dignostic-code-description
mergify[bot] Jun 9, 2025
025e654
Merge branch 'master' into mpj/dignostic-code-description
mergify[bot] Jun 9, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 9 additions & 10 deletions ghcide/src/Development/IDE/Types/Diagnostics.hs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -102,20 +102,19 @@ ideErrorFromLspDiag lspDiag fdFilePath mbOrigMsg =
fdLspDiagnostic =
lspDiag
& attachReason (fmap (diagnosticReason . errMsgDiagnostic) mbOrigMsg)
& setGhcCode mbOrigMsg
& attachDiagnosticCode ((diagnosticCode . errMsgDiagnostic) =<< mbOrigMsg)
in
FileDiagnostic {..}

-- | Set the code of the 'LSP.Diagnostic' to the GHC diagnostic code which is linked
-- | Set the code of the 'LSP.Diagnostic' to the GHC diagnostic code, and include the link
-- to https://errors.haskell.org/.
setGhcCode :: Maybe (MsgEnvelope GhcMessage) -> LSP.Diagnostic -> LSP.Diagnostic
setGhcCode mbOrigMsg diag =
let mbGhcCode = do
origMsg <- mbOrigMsg
code <- diagnosticCode (errMsgDiagnostic origMsg)
pure (InR (showGhcCode code))
in
diag { _code = mbGhcCode <|> _code diag }
attachDiagnosticCode :: Maybe DiagnosticCode -> LSP.Diagnostic -> LSP.Diagnostic
attachDiagnosticCode Nothing diag = diag
attachDiagnosticCode (Just code) diag =
let
textualCode = showGhcCode code
codeDesc = LSP.CodeDescription{ _href = Uri $ "https://errors.haskell.org/messages/" <> textualCode }
in diag { _code = Just (InR textualCode), _codeDescription = Just codeDesc}

#if MIN_VERSION_ghc(9,9,0)
-- DiagnosticCode only got a show instance in 9.10.1
Expand Down
Loading