Skip to content

Fix issue: HLS HLint plugin doesn't preserve HLint's severities #3881 #3902

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 5 commits into from
Jan 22, 2024
Merged

Fix issue: HLS HLint plugin doesn't preserve HLint's severities #3881 #3902

Changes from 3 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
ba82b0c
Fix issue: HLS HLint plugin doesn't preserve HLint's severities #3881
IAmPara0x Dec 15, 2023
90615a4
Fix tests
IAmPara0x Dec 15, 2023
0fa9fbf
Only preserve error serverity from hlint
IAmPara0x Jan 20, 2024
b77c205
Add comment explaining the propogation of error level serverity
IAmPara0x Jan 21, 2024
81ef0eb
Merge branch 'master' into paradox/fix-3881
michaelpj Jan 22, 2024
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
46 changes: 28 additions & 18 deletions plugins/hls-hlint-plugin/src/Ide/Plugin/Hlint.hs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -125,8 +125,7 @@ import Ide.Plugin.Resolve
import Ide.PluginUtils
import Ide.Types hiding
(Config)
import Language.Haskell.HLint as Hlint hiding
(Error)
import Language.Haskell.HLint as Hlint
import qualified Language.LSP.Protocol.Lens as LSP
import Language.LSP.Protocol.Message
import Language.LSP.Protocol.Types hiding
Expand Down Expand Up @@ -241,25 +240,36 @@ rules recorder plugin = do

diagnostics :: NormalizedFilePath -> Either ParseError [Idea] -> [FileDiagnostic]
diagnostics file (Right ideas) =
[(file, ShowDiag, ideaToDiagnostic i) | i <- ideas, ideaSeverity i /= Ignore]
(file, ShowDiag,) <$> catMaybes [ideaToDiagnostic i | i <- ideas]
diagnostics file (Left parseErr) =
[(file, ShowDiag, parseErrorToDiagnostic parseErr)]

ideaToDiagnostic :: Idea -> Diagnostic
ideaToDiagnostic idea =
LSP.Diagnostic {
_range = srcSpanToRange $ ideaSpan idea
, _severity = Just LSP.DiagnosticSeverity_Information
-- we are encoding the fact that idea has refactorings in diagnostic code
, _code = Just (InR $ T.pack $ codePre ++ ideaHint idea)
, _source = Just "hlint"
, _message = idea2Message idea
, _relatedInformation = Nothing
, _tags = Nothing
, _codeDescription = Nothing
, _data_ = Nothing
}
where codePre = if null $ ideaRefactoring idea then "" else "refact:"

ideaToDiagnostic :: Idea -> Maybe Diagnostic
ideaToDiagnostic idea = do
diagnosticSeverity <- ideaSeverityToDiagnosticSeverity (ideaSeverity idea)
pure $
LSP.Diagnostic {
_range = srcSpanToRange $ ideaSpan idea
, _severity = Just diagnosticSeverity
-- we are encoding the fact that idea has refactorings in diagnostic code
, _code = Just (InR $ T.pack $ codePre ++ ideaHint idea)
, _source = Just "hlint"
, _message = idea2Message idea
, _relatedInformation = Nothing
, _tags = Nothing
, _codeDescription = Nothing
, _data_ = Nothing
}

where
codePre = if null $ ideaRefactoring idea then "" else "refact:"

ideaSeverityToDiagnosticSeverity :: Hlint.Severity -> Maybe LSP.DiagnosticSeverity
ideaSeverityToDiagnosticSeverity Hlint.Ignore = Nothing
ideaSeverityToDiagnosticSeverity Hlint.Suggestion = Just LSP.DiagnosticSeverity_Information
ideaSeverityToDiagnosticSeverity Hlint.Warning = Just LSP.DiagnosticSeverity_Information
ideaSeverityToDiagnosticSeverity Hlint.Error = Just LSP.DiagnosticSeverity_Error

idea2Message :: Idea -> T.Text
idea2Message idea = T.unlines $ [T.pack $ ideaHint idea, "Found:", " " <> T.pack (ideaFrom idea)]
Expand Down