Add missing documentation for cabal formatters #4322
Conversation
| @@ -119,12 +120,17 @@ Format your code with various Haskell code formatters. | |||
| | Ormolu | `hls-ormolu-plugin` | | |||
| | Stylish Haskell | `hls-stylish-haskell-plugin` | | |||
|
|
|||
| --- | |||
There was a problem hiding this comment.
I think this markdown syntax is usually translated to <hr/> in html, so should be fine.
| Format your cabal files with a cabal code formatter. | ||
| The default cabal code formatter is `cabal-gild`, which needs to be available on the `$PATH`, |
There was a problem hiding this comment.
This isn't a great experience, actually. So the default behaviour will send people errors, since most people won't have installed this? I think our default behaviour shouldn't rely on any external programs, which makes me think we should set the default cabal formatter to "none".
There was a problem hiding this comment.
... do we have a "none" formatting provider option? We maybe should do.
There was a problem hiding this comment.
Hm, I thought we did. We definitely should have a "none" option.
There was a problem hiding this comment.
Yeah, the initial experience is not good. In the case of cabal-gild, we can likely ship it with all supported GHC versions.
However, perhaps we should start shipping the binaries instead of linking it into HLS directly. Then every HLS version would have the same formatter version. Let's give #411 another kick.
|
Seems like I forgot to add the |
fendor
force-pushed
the
enhance/cabal-formatters
branch
from
ef2758c
to
cf2b3b0
Compare
fendor
force-pushed
the
enhance/cabal-formatters
branch
from
cf2b3b0
to
0d5edd2
Compare
Co-authored-by: Jan Hrcek <[email protected]>
fendor
force-pushed
the
enhance/cabal-formatters
branch
from
0d5edd2
to
abbc35d
Compare
|
@michaelpj I think we should merge this as is, as it merely documents the status-quo |
Fixes #4313
Adds documentation about the default formatters. I am not sure that's the correct location, though, to document the defaults.