haskell/haskell-language-server

Lack of documentation of cabal-fmt & cabal-gild

0rphee opened this issue · 1 comments

0rphee commented

Is your enhancement request related to a problem? Please describe.

I tried to format a cabal file with hls through the cabal-fmt plugin, but failed. Looking at the logs, I found that I needed cabal-gild:

Details 

2024-06-11T15:28:37.314 helix_term::application [WARN] unhandled window/showMessage: ShowMessageParams { typ: Error, message: "Error condition, please check your setup and/or the [issue tracker](https://github.com/haskell/haskell-language-server/issues): \ncabal-gild: Internal Error: No installation of cabal-gild could be found. Please install it globally, or provide the full path to the executable." }

I looked through the latest docs and didn't find anything...

(Looked here: https://haskell-language-server.readthedocs.io/en/latest/features.html#formatting and here: https://haskell-language-server.readthedocs.io/en/latest/support/plugin-support.html#current-plugin-support-tiers)

Describe the solution you'd like

Add documentation about:

  • cabal-gild (I didn't find any mention to it in the docs)
  • the default cabal formatter used
  • how to configure the cabal formatter used

Describe alternatives you've considered

Additional context

fendor commented

Thanks for the reminder! I will update the docs.

  • 😄1