From a4bcaa318e7322d12ee2b5f8a69db21525dee93f Mon Sep 17 00:00:00 2001 From: fendor Date: Fri, 26 Jul 2024 10:38:19 +0200 Subject: [PATCH] Add missing documentation for cabal formatters (#4322) * 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> --- docs/features.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/docs/features.md b/docs/features.md index a701a45b82..92594d2c69 100644 --- a/docs/features.md +++ b/docs/features.md @@ -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 | | --------------- | ---------------------------- | @@ -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