Remove Floskell support (#4838)

* Remove Floskell support

* Fix failing test (use 4-space for Fourmolu)

Author: omarjatoi

.github/workflows/test.yml

@@ -151,11 +151,6 @@ jobs:
         name: Test hls-refactor-plugin
         run: cabal test ${CABAL_ARGS} hls-refactor-plugin-tests || cabal test ${CABAL_ARGS} hls-refactor-plugin-tests
 
-      # TODO enable when it supports 9.10
-      - if: matrix.test && matrix.ghc != '9.10' && matrix.ghc != '9.12' && matrix.ghc != '9.14' && matrix.ghc != '9.10.2'
-        name: Test hls-floskell-plugin
-        run: cabal test ${CABAL_ARGS} hls-floskell-plugin-tests || cabal test ${CABAL_ARGS} hls-floskell-plugin-tests
-
       - if: matrix.test
         name: Test hls-class-plugin
         run: cabal test ${CABAL_ARGS} hls-class-plugin-tests || cabal test ${CABAL_ARGS} hls-class-plugin-tests

CODEOWNERS

@@ -21,9 +21,8 @@
 /plugins/hls-code-range-plugin @kokobd
 /plugins/hls-eval-plugin
 /plugins/hls-explicit-fixity-plugin
-/plugins/hls-explicit-imports-plugin 
+/plugins/hls-explicit-imports-plugin
 /plugins/hls-explicit-record-fields-plugin @ozkutuk
-/plugins/hls-floskell-plugin @peterbecich
 /plugins/hls-fourmolu-plugin @georgefst
 /plugins/hls-gadt-plugin @July541
 /plugins/hls-hlint-plugin @eddiemundo
@@ -43,8 +42,8 @@
 /plugins/hls-stylish-haskell-plugin @michaelpj
 
 # Benchmarking
-/shake-bench 
-/bench 
+/shake-bench
+/bench
 
 # Docs
 /docs @michaelpj

bench/config.yaml

@@ -180,7 +180,6 @@ configurations:
   - codeRange
   - eval
   - explicitFixity
-  - floskell
   - fourmolu
   - gadt
   - ghcide-code-actions-bindings
@@ -205,7 +204,6 @@ configurations:
 # - codeRange
 # - eval
 # - explicitFixity
-# # - floskell
 # # - fourmolu
 # - gadt
 # - ghcide-code-actions-bindings

docs/configuration.md

@@ -40,7 +40,7 @@ This option obviously would not make sense for language servers for other langua
 
 Here is a list of the additional settings currently supported by `haskell-language-server`, along with their setting key (you may not need to know this) and default:
 
-- Formatting provider (`haskell.formattingProvider`, default `ormolu`): what formatter to use; one of `floskell`, `ormolu`, `fourmolu`, or `stylish-haskell`.
+- Formatting provider (`haskell.formattingProvider`, default `ormolu`): what formatter to use; one of `ormolu`, `fourmolu`, or `stylish-haskell`.
 - Cabal formatting provider (`haskell.cabalFormattingProvider`, default `cabal-gild`): what formatter to use for cabal files; one of `cabal-gild` or `cabal-fmt`.
 - Max completions (`haskell.maxCompletions`, default 40): maximum number of completions sent to the LSP client.
 - Check project (`haskell.checkProject`, default true): whether to typecheck the entire project on initial load. As it is activated by default could drive to bad performance in large projects.

docs/contributing/plugin-tutorial.md

@@ -75,7 +75,7 @@ import GHC.Generics (Generic)
 
 The HLS codebase includes several plugins (found in `./plugins`). For example:
 
-- The `ormolu`, `fourmolu`, `floskell` and `stylish-haskell` plugins used to format code
+- The `ormolu`, `fourmolu`, and `stylish-haskell` plugins used to format code
 - The `eval` plugin, a code lens provider to evaluate code in comments
 - The `retrie` plugin, a code action provider to execute retrie commands
 
@@ -95,7 +95,6 @@ I recommend looking at the existing plugins for inspiration and reference. A few
       allPlugins =
         [ GhcIde.descriptor "ghcide"
         , Pragmas.descriptor "pragmas"
-        , Floskell.descriptor "floskell"
         , Fourmolu.descriptor "fourmolu"
         , Ormolu.descriptor "ormolu"
         , StylishHaskell.descriptor "stylish-haskell"

docs/features.md

@@ -132,7 +132,6 @@ The default Haskell code formatter is `ormolu`, and the Haskell formatter can be
 
 | Formatter       | Provided by                  |
 | --------------- | ---------------------------- |
-| Floskell        | `hls-floskell-plugin`        |
 | Fourmolu        | `hls-fourmolu-plugin`        |
 | Ormolu          | `hls-ormolu-plugin`          |
 | Stylish Haskell | `hls-stylish-haskell-plugin` |

docs/support/plugin-support.md

@@ -65,7 +65,6 @@ For example, a plugin to provide a formatter which has itself been abandoned has
 | `hls-stylish-haskell-plugin`         | 2    | 9.14.1                   |
 | `hls-overloaded-record-dot-plugin`   | 2    |                          |
 | `hls-semantic-tokens-plugin`         | 2    |                          |
-| `hls-floskell-plugin`                | 3    | 9.10.1, 9.12.2, 9.14.1   |
 | `hls-stan-plugin`                    | 3    | 9.12.2, 9.14.1           |
 | `hls-retrie-plugin`                  | 3    | 9.10.1, 9.12.2, 9.14.1   |
 | `hls-splice-plugin`                  | 3    | 9.10.1, 9.12.2, 9.14.1   |

haskell-language-server.cabal

@@ -1469,48 +1469,6 @@ test-suite hls-overloaded-record-dot-plugin-tests
     , hls-test-utils              == 2.13.0.0
 
 
------------------------------
--- floskell plugin
------------------------------
-
-flag floskell
-  description: Enable floskell plugin
-  default:     True
-  manual:      True
-
-common floskell
-  if flag(floskell) && (impl(ghc < 9.10) || flag(ignore-plugins-ghc-bounds))
-    build-depends: haskell-language-server:hls-floskell-plugin
-    cpp-options: -Dhls_floskell
-
-library hls-floskell-plugin
-  import:           defaults, pedantic, warnings
-  -- https://github.com/ennocramer/floskell/pull/82
-  if !(flag(floskell) && (impl(ghc < 9.10) || flag(ignore-plugins-ghc-bounds)))
-    buildable: False
-  exposed-modules:  Ide.Plugin.Floskell
-  hs-source-dirs:   plugins/hls-floskell-plugin/src
-  build-depends:
-    , floskell        ^>=0.11.0
-    , ghcide          == 2.13.0.0
-    , hls-plugin-api  == 2.13.0.0
-    , lsp-types       ^>=2.3
-    , mtl
-    , text
-
-
-test-suite hls-floskell-plugin-tests
-  import:           defaults, pedantic, test-defaults, warnings
-  if !(flag(floskell) && (impl(ghc < 9.10) || flag(ignore-plugins-ghc-bounds)))
-    buildable: False
-  type:             exitcode-stdio-1.0
-  hs-source-dirs:   plugins/hls-floskell-plugin/test
-  main-is:          Main.hs
-  build-depends:
-    , filepath
-    , haskell-language-server:hls-floskell-plugin
-    , hls-test-utils       == 2.13.0.0
-
 -----------------------------
 -- fourmolu plugin
 -----------------------------
@@ -1940,7 +1898,6 @@ library
                   , gadt
                   , explicitFixity
                   , explicitFields
-                  , floskell
                   , fourmolu
                   , ormolu
                   , stylishHaskell
@@ -2097,8 +2054,6 @@ test-suite func-test
   if flag(eval)
     cpp-options: -Dhls_eval
 -- formatters
-  if flag(floskell) && (impl(ghc < 9.10) || flag(ignore-plugins-ghc-bounds))
-    cpp-options: -Dhls_floskell
   if flag(fourmolu) && (impl(ghc < 9.14) || flag(ignore-plugins-ghc-bounds))
     cpp-options: -Dhls_fourmolu
   if flag(ormolu) && (impl(ghc < 9.14) || flag(ignore-plugins-ghc-bounds))

hls-plugin-api/src/Ide/Types.hs

@@ -197,7 +197,6 @@ instance Default Config where
     { checkParents                = CheckOnSave
     , checkProject                = True
     , formattingProvider          = "ormolu"
-    -- , formattingProvider          = "floskell"
     -- , formattingProvider          = "stylish-haskell"
     , cabalFormattingProvider     = "cabal-gild"
     -- , cabalFormattingProvider     = "cabal-fmt"