Skip to content
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

Jump to bottom

gracefully handle errors for unsupported cabal version #4425

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
Open

gracefully handle errors for unsupported cabal version #4425

Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
3e4ce99
Safely handle linenumbering for errors in the first line of cabal files
fridewald Oct 12, 2024
9460d61
add integration test for unsupported cabal version
fridewald Oct 12, 2024
40173f4
cast unsupported cabal version as warning
fridewald Oct 13, 2024
5d7eb82
add better warning text
fridewald Oct 13, 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
3 changes: 2 additions & 1 deletion plugins/hls-cabal-plugin/src/Ide/Plugin/Cabal.hs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -252,12 +252,13 @@ cabalRules recorder plId = do
-- We don't support the cabal version, this should not be an error, as the
-- user did not do anything wrong. Instead we cast it to a warning
regex = "Unsupported cabal-version [0-9]+.[0-9]*"
unsupportedCabalHelpText = "\nThe used cabal version is not fully supported by hls. This means that some functionallity might not work as expected.\nIf you face any issues try to downgrade to a supported cabal version."
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We can get the set of supported versions from https://github.com/haskell/haskell-language-server/blob/master/plugins/hls-cabal-plugin/src/Ide/Plugin/Cabal/Completion/Data.hs#L33 and display it here for the best UX.

You can pull out the lower bound into its own dedicated variable, e.g.

lowestSupportedCabalVersion = CabalSpecV2_2

and then use that. Or pull out the list of supported cabal versions... Either way is fine.

errorDiags =
NE.toList $
NE.map
( \pe@(PError pos text) ->
if text =~ regex
then Diagnostics.warningDiagnostic file (Syntax.PWarning Syntax.PWTOther pos text)
then Diagnostics.warningDiagnostic file (Syntax.PWarning Syntax.PWTOther pos (text <> unsupportedCabalHelpText))
else Diagnostics.errorDiagnostic file pe
)
pErrorNE
Expand Down
Loading