Skip to content

Commit 5e1fba0

Browse files
committed
Add missing documentation for cabal formatters
1 parent cde9d78 commit 5e1fba0

File tree

2 files changed

+8
-1
lines changed

2 files changed

+8
-1
lines changed

docs/features.md

+7-1
Original file line numberDiff line numberDiff line change
@@ -111,6 +111,7 @@ Completions for language pragmas.
111111
## Formatting
112112

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

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

123+
---
124+
122125
Format your cabal files with a cabal code formatter.
126+
The default cabal code formatter is `cabal-gild`, which needs to be available on the `$PATH`,
127+
or the location needs to be explicitly provided.
128+
To change the cabal formatter, edit the `cabalFormattingProvider` option.
123129

124130
| Formatter | Provided by |
125131
|-----------------|------------------------------|
126132
| cabal-fmt | `hls-cabal-fmt-plugin` |
127-
133+
| cabal-gild | `hls-cabal-gild-plugin` |
128134

129135
## Document symbols
130136

docs/support/plugin-support.md

+1
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,7 @@ For example, a plugin to provide a formatter which has itself been abandoned has
4747
| `hls-refactor-plugin` | 1 | |
4848
| `hls-alternate-number-plugin` | 2 | |
4949
| `hls-cabal-fmt-plugin` | 2 | |
50+
| `hls-cabal-gild-plugin` | 2 | |
5051
| `hls-class-plugin` | 2 | |
5152
| `hls-change-type-signature-plugin` | 2 | |
5253
| `hls-eval-plugin` | 2 | |

0 commit comments

Comments
 (0)