Skip to content

Commit

Permalink
Add missing documentation for cabal formatters (haskell#4322)
Browse files Browse the repository at this point in the history
* Add missing documentation for cabal formatters

* Update docs/features.md

Co-authored-by: Jan Hrcek <2716069+jhrcek@users.noreply.github.com>

---------

Co-authored-by: Jan Hrcek <2716069+jhrcek@users.noreply.github.com>
  • Loading branch information
fendor and jhrcek authored Jul 26, 2024
1 parent ce486f7 commit a4bcaa3
Showing 1 changed file with 7 additions and 1 deletion.
8 changes: 7 additions & 1 deletion docs/features.md
Original file line number Diff line number Diff line change
Expand Up @@ -111,6 +111,7 @@ Completions for language pragmas.
## Formatting

Format your code with various Haskell code formatters.
The default Haskell code formatter is `ormolu`, and the Haskell formatter can be configured via the `formattingProvider` option.

| Formatter | Provided by |
| --------------- | ---------------------------- |
Expand All @@ -119,12 +120,17 @@ Format your code with various Haskell code formatters.
| Ormolu | `hls-ormolu-plugin` |
| Stylish Haskell | `hls-stylish-haskell-plugin` |

---

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`,
or the location needs to be explicitly provided.
To change the cabal formatter, edit the `cabalFormattingProvider` option.

| Formatter | Provided by |
|-----------------|------------------------------|
| cabal-fmt | `hls-cabal-fmt-plugin` |

| cabal-gild | `hls-cabal-gild-plugin` |

## Document symbols

Expand Down

0 comments on commit a4bcaa3

Please sign in to comment.