Merge pull request #257 from sureyeaah/ormolu-fix

Ormolu fix

Author: lukel97

src/Ide/Plugin/Ormolu.hs

@@ -64,19 +64,16 @@ provider lf ideState typ contents fp _ = withIndefiniteProgress lf title Cancell
 
   let
     fullRegion = RegionIndices Nothing Nothing
-    rangeRegion s e = RegionIndices (Just s) (Just e)
+    rangeRegion s e = RegionIndices (Just $ s + 1) (Just $ e + 1)
     mkConf o region = defaultConfig { cfgDynOptions = o,  cfgRegion = region }
     fmt :: T.Text -> Config RegionIndices -> IO (Either OrmoluException T.Text)
     fmt cont conf =
       try @OrmoluException (ormolu conf (fromNormalizedFilePath fp) $ T.unpack cont)
 
   case typ of
     FormatText -> ret <$> fmt contents (mkConf fileOpts fullRegion)
-    FormatRange r ->
-      let
-        Range (Position sl _) (Position el _) = normalize r
-      in
-        ret <$> fmt contents (mkConf fileOpts (rangeRegion sl el))
+    FormatRange (Range (Position sl _) (Position el _)) ->
+      ret <$> fmt contents (mkConf fileOpts (rangeRegion sl el))
  where
   title = T.pack $ "Formatting " <> takeFileName (fromNormalizedFilePath fp)
   ret :: Either OrmoluException T.Text -> Either ResponseError (List TextEdit)

src/Ide/PluginUtils.hs

@@ -67,13 +67,11 @@ diffTextEdit fText f2Text withDeletions = J.List r
                         (J.Position el 0)
 
     diffOperationToTextEdit (Addition fm l) = J.TextEdit range nt
-    -- fm has a range wrt to the changed file, which starts in the current file at l
-    -- So the range has to be shifted to start at l
+    -- fm has a range wrt to the changed file, which starts in the current file at l + 1
+    -- So the range has to be shifted to start at l + 1
       where
-        range = J.Range (J.Position (l' - 1) 0)
-                        (J.Position (l' - 1) 0)
-        l' = max l sl -- Needed to add at the end of the file
-        sl = fst $ lrNumbers fm
+        range = J.Range (J.Position l 0)
+                        (J.Position l 0)
         nt = T.pack $ unlines $ lrContents fm
 
 
@@ -109,4 +107,4 @@ clientSupportsDocumentChanges caps =
         WorkspaceEditClientCapabilities mDc <- _workspaceEdit wCaps
         mDc
   in
-    fromMaybe False supports
+    fromMaybe False supports

test/functional/Format.hs

@@ -42,11 +42,11 @@ rangeTests :: TestTree
 rangeTests = testGroup "format range" [
     goldenVsStringDiff "works" goldenGitDiff "test/testdata/Format.formatted_range.hs" $ runSession hieCommand fullCaps "test/testdata" $ do
         doc <- openDoc "Format.hs" "haskell"
-        formatRange doc (FormattingOptions 2 True) (Range (Position 1 0) (Position 3 10))
+        formatRange doc (FormattingOptions 2 True) (Range (Position 5 0) (Position 7 10))
         BS.fromStrict . T.encodeUtf8 <$> documentContents doc
     , goldenVsStringDiff "works with custom tab size" goldenGitDiff "test/testdata/Format.formatted_range_with_tabsize.hs" $ runSession hieCommand fullCaps "test/testdata" $ do
         doc <- openDoc "Format.hs" "haskell"
-        formatRange doc (FormattingOptions 5 True) (Range (Position 4 0) (Position 7 19))
+        formatRange doc (FormattingOptions 5 True) (Range (Position 8 0) (Position 11 19))
         BS.fromStrict . T.encodeUtf8 <$> documentContents doc
     ]
 
@@ -143,19 +143,18 @@ brittanyTests = testGroup "brittany" [
     ]
 
 ormoluTests :: TestTree
-ormoluTests = testGroup "ormolu" [
-    goldenVsStringDiff "formats correctly" goldenGitDiff ("test/testdata/Format.ormolu." ++ ormoluGoldenSuffix ++ ".hs") $ runSession hieCommand fullCaps "test/testdata" $ do
-        sendNotification WorkspaceDidChangeConfiguration (DidChangeConfigurationParams (formatLspConfig "ormolu"))
-        doc <- openDoc "Format.hs" "haskell"
-        formatDoc doc (FormattingOptions 2 True)
-        BS.fromStrict . T.encodeUtf8 <$> documentContents doc
-    ]
-  where
-    ormoluGoldenSuffix = case ghcVersion of
-      GHC88 -> "formatted"
-      GHC86 -> "formatted"
-      _ -> "unchanged"
-
+ormoluTests = testGroup "ormolu"
+  [ goldenVsStringDiff "formats correctly" goldenGitDiff "test/testdata/Format.ormolu.formatted.hs" $ runSession hieCommand fullCaps "test/testdata" $ do
+      sendNotification WorkspaceDidChangeConfiguration (DidChangeConfigurationParams (formatLspConfig "ormolu"))
+      doc <- openDoc "Format.hs" "haskell"
+      formatDoc doc (FormattingOptions 2 True)
+      BS.fromStrict . T.encodeUtf8 <$> documentContents doc
+  , goldenVsStringDiff "formats imports correctly" goldenGitDiff "test/testdata/Format2.ormolu.formatted.hs" $ runSession hieCommand fullCaps "test/testdata" $ do
+      sendNotification WorkspaceDidChangeConfiguration (DidChangeConfigurationParams (formatLspConfig "ormolu"))
+      doc <- openDoc "Format2.hs" "haskell"
+      formatDoc doc (FormattingOptions 2 True)
+      BS.fromStrict . T.encodeUtf8 <$> documentContents doc
+  ]
 
 formatLspConfig :: Value -> Value
 formatLspConfig provider = object [ "haskell" .= object ["formattingProvider" .= (provider :: Value)] ]

test/testdata/Format.brittany.formatted.hs

@@ -1,4 +1,8 @@
 module Format where
+import           Data.List
+
+import           Prelude
+import           Data.Int
 foo :: Int -> Int
 foo 3 = 2
 foo x = x

test/testdata/Format.brittany_post_floskell.formatted.hs

@@ -1,5 +1,9 @@
 module Format where
 
+import           Data.List
+import           Prelude
+import           Data.Int
+
 foo :: Int -> Int
 foo 3 = 2
 foo x = x

test/testdata/Format.floskell.formatted.hs

@@ -1,5 +1,9 @@
 module Format where
 
+import           Data.List
+import           Prelude
+import           Data.Int
+
 foo :: Int -> Int
 foo 3 = 2
 foo x = x

test/testdata/Format.formatted_document.hs

@@ -1,12 +1,16 @@
 module Format where
 
+import Data.Int
+import Data.List
+import Prelude
+
 foo :: Int -> Int
 foo 3 = 2
 foo x = x
+
 bar :: String -> IO String
 bar s = do
   x <- return "hello"
   return "asdf"
 
 data Baz = Baz {a :: Int, b :: String}
-

test/testdata/Format.formatted_document_with_tabsize.hs

@@ -1,12 +1,16 @@
 module Format where
 
+import Data.Int
+import Data.List
+import Prelude
+
 foo :: Int -> Int
 foo 3 = 2
 foo x = x
+
 bar :: String -> IO String
 bar s = do
   x <- return "hello"
   return "asdf"
 
 data Baz = Baz {a :: Int, b :: String}
-

test/testdata/Format.formatted_range.hs

@@ -1,5 +1,8 @@
-module Format where
+module    Format where
+import Data.List
 
+import Prelude
+import Data.Int
 foo :: Int -> Int
 foo 3 = 2
 foo x = x

test/testdata/Format.formatted_range_with_tabsize.hs

@@ -1,12 +1,15 @@
 module    Format where
+import Data.List
+
+import Prelude
+import Data.Int
 foo   :: Int ->  Int
 foo  3 = 2
-foo x = x
+foo    x  = x
 bar :: String -> IO String
 bar s = do
   x <- return "hello"
   return "asdf"
 
-
 data Baz = Baz { a :: Int, b :: String }
 

test/testdata/Format.hs

@@ -1,4 +1,8 @@
 module    Format where
+import Data.List
+
+import Prelude
+import Data.Int
 foo   :: Int ->  Int
 foo  3 = 2
 foo    x  = x

test/testdata/Format.ormolu.formatted.hs

@@ -1,12 +1,16 @@
 module Format where
 
+import Data.Int
+import Data.List
+import Prelude
+
 foo :: Int -> Int
 foo 3 = 2
 foo x = x
+
 bar :: String -> IO String
 bar s = do
   x <- return "hello"
   return "asdf"
 
 data Baz = Baz {a :: Int, b :: String}
-

test/testdata/Format.ormolu.unchanged.hs

@@ -0,0 +1,5 @@
+import Data.Char
+import Data.Either
+import Data.Int
+import Data.Data
+import Data.Bool

test/testdata/Format2.hs

@@ -0,0 +1,5 @@
+import Data.Bool
+import Data.Char
+import Data.Data
+import Data.Either
+import Data.Int