[WIP] stylish-haskell plugin

app/MainHie.hs

@@ -51,6 +51,7 @@ import           Haskell.Ide.Engine.Plugin.Liquid
 import           Haskell.Ide.Engine.Plugin.Ormolu
 import           Haskell.Ide.Engine.Plugin.Package
 import           Haskell.Ide.Engine.Plugin.Pragmas
+import           Haskell.Ide.Engine.Plugin.Stylish     (stylishDescriptor)
 
 -- ---------------------------------------------------------------------
 
@@ -74,6 +75,7 @@ plugins includeExamples = pluginDescToIdePlugins allPlugins
       , genericDescriptor     "generic"
       , ghcmodDescriptor      "ghcmod"
       , ormoluDescriptor      "ormolu"
+      , stylishDescriptor     "stylish"
       ]
     examplePlugins =
       [example2Descriptor "eg2"

haskell-ide-engine.cabal

@@ -38,6 +38,7 @@ library
                        Haskell.Ide.Engine.Plugin.Package
                        Haskell.Ide.Engine.Plugin.Package.Compat
                        Haskell.Ide.Engine.Plugin.Pragmas
+                       Haskell.Ide.Engine.Plugin.Stylish
                        Haskell.Ide.Engine.Plugin.Generic
                        Haskell.Ide.Engine.Plugin.GhcMod
                        Haskell.Ide.Engine.Scheduler
@@ -90,6 +91,7 @@ library
                      , safe
                      , sorted-list >= 0.2.1.0
                      , stm
+                     , stylish-haskell
                      , syb
                      , tagsoup
                      , text

src/Haskell/Ide/Engine/Plugin/Stylish.hs

@@ -0,0 +1,43 @@
+{-# LANGUAGE OverloadedStrings #-}
+module Haskell.Ide.Engine.Plugin.Stylish where
+
+import           Control.Monad.IO.Class         (liftIO)
+import           Data.Aeson                     (Value (Null))
+import           Data.List                      (intercalate)
+import qualified Data.Text                      as T
+import           Haskell.Ide.Engine.MonadTypes
+import           Haskell.Ide.Engine.PluginUtils (fullRange, pluginGetFile)
+import           Language.Haskell.Stylish       (ConfigPath (..), format)
+
+
+stylishDescriptor :: PluginId -> PluginDescriptor
+stylishDescriptor plId = PluginDescriptor
+  { pluginId                 = plId
+  , pluginName               = "Stylish"
+  , pluginDesc               = "Stylish is a tool to format source code."
+  , pluginCommands           = []
+  , pluginCodeActionProvider = Nothing
+  , pluginDiagnosticProvider = Nothing
+  , pluginHoverProvider      = Nothing
+  , pluginSymbolProvider     = Nothing
+  , pluginFormattingProvider = Just provider
+  }
+
+provider :: FormattingProvider
+provider contents uri typ _ =
+  case typ of
+    FormatRange _ ->
+      return $ IdeResultFail (IdeError PluginError (T.pack "Selection formatting for Stylish is not currently supported.") Null)
+    FormatText -> pluginGetFile "stylish:" uri $ \file -> do
+      res <- liftIO $ runStylish Nothing file contents
+      case res of
+        Left err  -> return $ IdeResultFail
+          (IdeError PluginError
+                  (T.pack $ "stylish: " ++ err)
+                  Null
+          )
+        Right new -> return $ IdeResultOk [TextEdit (fullRange contents) (T.pack $ ((intercalate "\n" new) <> "\n"))]
+
+
+runStylish :: Maybe ConfigPath -> FilePath -> T.Text -> IO (Either String [String])
+runStylish config file contents = format config (Just file) (T.unpack contents)

stack.yaml

@@ -26,9 +26,12 @@ extra-deps:
 - hie-bios-0.3.2
 - hlint-2.2.8
 - hsimport-0.11.0
+- HsYAML-0.2.1.0@sha256:e4677daeba57f7a1e9a709a1f3022fe937336c91513e893166bd1f023f530d68,5311
+- HsYAML-aeson-0.2.0.0@sha256:04796abfc01cffded83f37a10e6edba4f0c0a15d45bef44fc5bb4313d9c87757,1791
 - lsp-test-0.10.0.0
 - monad-dijkstra-0.1.1.2@rev:1
 - parser-combinators-1.2.1
+- stylish-haskell-0.10.0.0
 - ormolu-0.0.3.1
 - syz-0.2.0.0
 - temporary-1.2.1.1

test/functional/FormatSpec.hs

@@ -32,9 +32,7 @@ spec = do
       documentContents doc >>= liftIO . (`shouldBe` formattedRangeTabSize5)
 
   describe "formatting provider" $ do
-    let formatLspConfig provider =
-          object [ "languageServerHaskell" .= object ["formattingProvider" .= (provider :: Value)] ]
-        formatConfig provider = defaultConfig { lspConfig = Just (formatLspConfig provider) }
+    let formatConfig provider = defaultConfig { lspConfig = Just (formatLspConfig provider) }
 
     it "respects none" $ runSessionWithConfig (formatConfig "none") hieCommand fullCaps "test/testdata" $ do
       doc <- openDoc "Format.hs" "haskell"
@@ -93,9 +91,7 @@ spec = do
                                     "foo x y = do\n    print x\n    return 42\n"]
 
   describe "ormolu" $ do
-    let formatLspConfig provider =
-          object [ "languageServerHaskell" .= object ["formattingProvider" .= (provider :: Value)] ]
-
+
     it "formats correctly" $ runSession hieCommand fullCaps "test/testdata" $ do
       sendNotification WorkspaceDidChangeConfiguration (DidChangeConfigurationParams (formatLspConfig "ormolu"))
       doc <- openDoc "Format.hs" "haskell"
@@ -107,6 +103,9 @@ spec = do
         GHC86 -> formatted
         _ -> liftIO $ docContent `shouldBe` unchangedOrmolu
 
+formatLspConfig :: Value -> Value
+formatLspConfig provider =
+  object [ "languageServerHaskell" .= object ["formattingProvider" .= provider] ]
 
 formattedDocTabSize2 :: T.Text
 formattedDocTabSize2 =

test/unit/HsImportSpec.hs

@@ -2,15 +2,16 @@
 module HsImportSpec where
 
 import           Control.Monad.IO.Class
-import qualified Data.Text as T
-import qualified Data.HashMap.Strict as Map
+import qualified Data.HashMap.Strict                as Map
+import qualified Data.Text                          as T
+import qualified Haskell.Ide.Engine.Config          as Config
 import           Haskell.Ide.Engine.MonadTypes
-import           Haskell.Ide.Engine.PluginUtils
-import           Haskell.Ide.Engine.Plugin.HsImport
-import qualified Haskell.Ide.Engine.Config as Config
 import qualified Haskell.Ide.Engine.Plugin.Brittany as Brittany
-import qualified Haskell.Ide.Engine.Plugin.Ormolu   as Ormolu
 import qualified Haskell.Ide.Engine.Plugin.Floskell as Floskell
+import           Haskell.Ide.Engine.Plugin.HsImport
+import qualified Haskell.Ide.Engine.Plugin.Ormolu   as Ormolu
+import qualified Haskell.Ide.Engine.Plugin.Stylish  as Stylish
+import           Haskell.Ide.Engine.PluginUtils
 import           System.Directory
 import           System.FilePath
 import           Test.Hspec
@@ -31,6 +32,7 @@ testPlugins = pluginDescToIdePlugins
     [ Brittany.brittanyDescriptor "brittany"
     , Floskell.floskellDescriptor "floskell"
     , Ormolu.ormoluDescriptor "ormolu"
+    , Stylish.stylishDescriptor "stylish"
     ]
 
 codeActionImportList :: FilePath
@@ -126,7 +128,27 @@ hsImportSpec = do
         ]
       _ -> it "is NOP formatter" $
             pendingWith "Ormolu only supported by GHC >= 8.6. Need to restore this."
-
+  describe "formats with stylish" $ hsImportSpecRunner "stylish"
+    [ -- Expected output for simple format.
+      [ TextEdit (Range (toPos (2, 1)) (toPos (2, 1))) "import           Control.Monad\n"
+      ]
+    , [ TextEdit (Range (toPos (2, 1)) (toPos (2, 1))) "import           Control.Monad (when)\n"
+      ]
+    , [ TextEdit (Range (toPos (2, 1)) (toPos (2, 1))) "import           Data.Maybe (Maybe)\n"
+      ]
+    , [ TextEdit (Range (toPos (2, 1)) (toPos (2, 1))) "import           Data.Maybe (Maybe (..))\n"
+      ]
+    , [ TextEdit (Range (toPos (2, 1)) (toPos (2, 1))) "import           Data.Maybe (Maybe (Nothing))\n"
+      ]
+    , [ TextEdit (Range (toPos (2, 1)) (toPos (2, 1))) "import           Data.Function (($))\n"
+      ]
+    , [ TextEdit (Range (toPos (2, 1)) (toPos (2, 32))) "import           System.IO (IO, hPutStrLn)"
+      ]
+    , [ TextEdit (Range (toPos (3, 1)) (toPos (3, 99))) $
+        "import           Data.List (cons, find, head, init, last, length, null, reverse,\n" <>
+        "                            tail, uncons, union, (\\\\))"
+      ]
+    ]
 -- ---------------------------------------------------------------------
 -- Parameterized HsImport Spec.
 -- ---------------------------------------------------------------------
@@ -196,4 +218,4 @@ expectHsImportResult formatterName fp uri expectedChanges act = do
   IdeResultOk (WorkspaceEdit (Just changes) _) <- runSingle' (setFormatter formatterName) testPlugins fp act
   case Map.lookup uri changes of
       Just (List val) -> val `shouldBe` expectedChanges
-      Nothing -> fail "No Change found"
+      Nothing         -> fail "No Change found"