First pass at Floskell and formatterProvider

Author: lukel97

.gitmodules

@@ -32,3 +32,6 @@
 	url = https://github.com/alanz/ghc-mod.git
 
 
+[submodule "submodules/floskell"]
+	path = submodules/floskell
+	url = https://github.com/bubba/floskell

app/MainHie.hs

@@ -36,6 +36,7 @@ import           Haskell.Ide.Engine.Plugin.HsImport
 import           Haskell.Ide.Engine.Plugin.Liquid
 import           Haskell.Ide.Engine.Plugin.Package
 import           Haskell.Ide.Engine.Plugin.Pragmas
+import           Haskell.Ide.Engine.Plugin.Floskell
 
 -- ---------------------------------------------------------------------
 
@@ -59,6 +60,7 @@ plugins includeExamples = pluginDescToIdePlugins allPlugins
       , liquidDescriptor      "liquid"
       , packageDescriptor     "package"
       , pragmasDescriptor     "pragmas"
+      , floskellDescriptor    "floskell"
       ]
     examplePlugins =
       [example2Descriptor "eg2"

cabal.project

@@ -7,3 +7,4 @@ packages:
          ./submodules/cabal-helper/
          ./submodules/ghc-mod/
          ./submodules/ghc-mod/core/
+         ./submodules/floskell

haskell-ide-engine.cabal

@@ -29,6 +29,7 @@ library
                        Haskell.Ide.Engine.Plugin.Brittany
                        Haskell.Ide.Engine.Plugin.Build
                        Haskell.Ide.Engine.Plugin.Example2
+                       Haskell.Ide.Engine.Plugin.Floskell
                        Haskell.Ide.Engine.Plugin.Fuzzy
                        Haskell.Ide.Engine.Plugin.GhcMod
                        Haskell.Ide.Engine.Plugin.HaRe
@@ -60,6 +61,7 @@ library
                      , data-default
                      , directory
                      , filepath
+                     , floskell
                      , fold-debounce
                      , ghc >= 8.0.1
                      , ghc-exactprint
@@ -96,6 +98,7 @@ library
   if flag(pedantic)
      ghc-options:      -Werror
   default-language:    Haskell2010
+  mixins:              floskell (Floskell as FloskellFloskell)
 
 executable hie
   hs-source-dirs:      app

hie-plugin-api/Haskell/Ide/Engine/Config.hs

@@ -26,6 +26,7 @@ data Config =
     , liquidOn                    :: Bool
     , completionSnippetsOn        :: Bool
     , formatOnImportOn            :: Bool
+    , formattingProvider          :: T.Text
     } deriving (Show,Eq)
 
 instance Default Config where
@@ -36,6 +37,7 @@ instance Default Config where
     , liquidOn                    = False
     , completionSnippetsOn        = True
     , formatOnImportOn            = True
+    , formattingProvider          = "brittany"
     }
 
 -- TODO: Add API for plugins to expose their own LSP config options
@@ -49,6 +51,7 @@ instance FromJSON Config where
       <*> o .:? "liquidOn"                    .!= liquidOn def
       <*> o .:? "completionSnippetsOn"        .!= completionSnippetsOn def
       <*> o .:? "formatOnImportOn"            .!= formatOnImportOn def 
+      <*> o .:? "formattingProvider"          .!= formattingProvider def 
 
 -- 2017-10-09 23:22:00.710515298 [ThreadId 11] - ---> {"jsonrpc":"2.0","method":"workspace/didChangeConfiguration","params":{"settings":{"languageServerHaskell":{"maxNumberOfProblems":100,"hlintOn":true}}}}
 -- 2017-10-09 23:22:00.710667381 [ThreadId 15] - reactor:got didChangeConfiguration notification:
@@ -60,12 +63,13 @@ instance FromJSON Config where
 --                                                                                          ,("maxNumberOfProblems",Number 100.0)]))])}}
 
 instance ToJSON Config where
-  toJSON (Config h m d l c f) = object [ "languageServerHaskell" .= r ]
+  toJSON (Config h m d l c f fp) = object [ "languageServerHaskell" .= r ]
     where
       r = object [ "hlintOn"                     .= h
                  , "maxNumberOfProblems"         .= m
                  , "diagnosticsDebounceDuration" .= d
                  , "liquidOn"                    .= l
                  , "completionSnippetsOn"        .= c
                  , "formatOnImportOn"            .= f
+                 , "formattingProvider"          .= fp
                  ]

hie-plugin-api/Haskell/Ide/Engine/PluginUtils.hs

@@ -17,6 +17,8 @@ module Haskell.Ide.Engine.PluginUtils
   , srcSpan2Loc
   , unpackRealSrcSpan
   , reverseMapFile
+  , extractRange
+  , fullRange
   , fileInfo
   , realSrcSpan2Range
   , canonicalizeUri
@@ -221,6 +223,27 @@ diffText' supports (f,fText) f2Text withDeletions  =
 
 -- ---------------------------------------------------------------------
 
+extractRange :: Range -> T.Text -> T.Text
+extractRange (Range (Position sl _) (Position el _)) s = newS
+  where focusLines = take (el-sl+1) $ drop sl $ T.lines s
+        newS = T.unlines focusLines
+
+-- | Gets the range that covers the entire text
+fullRange :: T.Text -> Range
+fullRange s = Range startPos endPos
+  where startPos = Position 0 0
+        endPos = Position lastLine 0
+        {-
+        In order to replace everything including newline characters,
+        the end range should extend below the last line. From the specification:
+        "If you want to specify a range that contains a line including
+        the line ending character(s) then use an end position denoting
+        the start of the next line"
+        -}
+        lastLine = length $ T.lines s
+
+-- ---------------------------------------------------------------------
+
 -- | Returns the directory and file name
 fileInfo :: T.Text -> (FilePath,FilePath)
 fileInfo tfileName =

hie-plugin-api/Haskell/Ide/Engine/PluginsIdeMonads.hs

@@ -39,6 +39,8 @@ module Haskell.Ide.Engine.PluginsIdeMonads
   , DiagnosticTrigger(..)
   , HoverProvider
   , SymbolProvider
+  , FormattingType(..)
+  , FormattingProvider
   , IdePlugins(..)
   , getDiagnosticProvidersConfig
   -- * IDE monads
@@ -66,11 +68,13 @@ module Haskell.Ide.Engine.PluginsIdeMonads
   , Location(..)
   , TextDocumentIdentifier(..)
   , TextDocumentPositionParams(..)
+  , TextEdit(..)
   , WorkspaceEdit(..)
   , Diagnostic(..)
   , DiagnosticSeverity(..)
   , PublishDiagnosticsParams(..)
   , List(..)
+  , FormattingOptions(..)
   )
 where
 
@@ -114,13 +118,15 @@ import           Language.Haskell.LSP.Types     ( Command(..)
                                                 , DiagnosticSeverity(..)
                                                 , DocumentSymbol(..)
                                                 , List(..)
+                                                , FormattingOptions(..)
                                                 , Hover(..)
                                                 , Location(..)
                                                 , Position(..)
                                                 , PublishDiagnosticsParams(..)
                                                 , Range(..)
                                                 , TextDocumentIdentifier(..)
                                                 , TextDocumentPositionParams(..)
+                                                , TextEdit(..)
                                                 , Uri(..)
                                                 , VersionedTextDocumentIdentifier(..)
                                                 , WorkspaceEdit(..)
@@ -202,6 +208,10 @@ type HoverProvider = Uri -> Position -> IdeM (IdeResult [Hover])
 
 type SymbolProvider = Uri -> IdeDeferM (IdeResult [DocumentSymbol])
 
+data FormattingType = FormatDocument
+                    | FormatRange Range
+type FormattingProvider = Uri -> FormattingType -> FormattingOptions -> IdeGhcM (IdeResult [TextEdit])
+
 data PluginDescriptor =
   PluginDescriptor { pluginId                 :: PluginId
                    , pluginName               :: T.Text
@@ -211,6 +221,7 @@ data PluginDescriptor =
                    , pluginDiagnosticProvider :: Maybe DiagnosticProvider
                    , pluginHoverProvider      :: Maybe HoverProvider
                    , pluginSymbolProvider     :: Maybe SymbolProvider
+                   , pluginFormattingProvider :: Maybe FormattingProvider
                    } deriving (Generic)
 
 instance Show PluginCommand where

src/Haskell/Ide/Engine/LSP/Reactor.hs

@@ -29,13 +29,14 @@ import qualified Language.Haskell.LSP.Types    as J
 -- ---------------------------------------------------------------------
 
 data REnv = REnv
-  { scheduler         :: Scheduler.Scheduler R
-  , lspFuncs          :: Core.LspFuncs Config
+  { scheduler           :: Scheduler.Scheduler R
+  , lspFuncs            :: Core.LspFuncs Config
   -- | The process ID of HIE. See 'HasPidCache'
-  , reactorPidCache   :: Int
-  , diagnosticSources :: Map.Map DiagnosticTrigger [(PluginId,DiagnosticProviderFunc)]
-  , hoverProviders    :: [HoverProvider]
-  , symbolProviders   :: [SymbolProvider]
+  , reactorPidCache     :: Int
+  , diagnosticSources   :: Map.Map DiagnosticTrigger [(PluginId,DiagnosticProviderFunc)]
+  , hoverProviders      :: [HoverProvider]
+  , symbolProviders     :: [SymbolProvider]
+  , formattingProviders :: Map.Map PluginId FormattingProvider
   -- TODO: Add code action providers here
   }
 
@@ -56,11 +57,12 @@ runReactor
   -> Map.Map DiagnosticTrigger [(PluginId, DiagnosticProviderFunc)]
   -> [HoverProvider]
   -> [SymbolProvider]
+  -> Map.Map PluginId FormattingProvider
   -> R a
   -> IO a
-runReactor lf sc dps hps sps f = do
+runReactor lf sc dps hps sps fps f = do
   pid <- getProcessID
-  runReaderT f (REnv sc lf pid dps hps sps)
+  runReaderT f (REnv sc lf pid dps hps sps fps)
 
 -- ---------------------------------------------------------------------
 

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

@@ -47,6 +47,7 @@ applyRefactDescriptor plId = PluginDescriptor
   , pluginDiagnosticProvider = Nothing
   , pluginHoverProvider = Nothing
   , pluginSymbolProvider = Nothing
+  , pluginFormattingProvider = Nothing
   }
 
 -- ---------------------------------------------------------------------

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

@@ -44,6 +44,7 @@ baseDescriptor plId = PluginDescriptor
   , pluginDiagnosticProvider = Nothing
   , pluginHoverProvider = Nothing
   , pluginSymbolProvider = Nothing
+  , pluginFormattingProvider = Nothing
   }
 
 -- ---------------------------------------------------------------------