Make redundant import removal work on PatSyn imports (#3377)

* Make redundant import removal work on patsyn imports

* Make stylish-haskell happy

Co-authored-by: Michael Peyton Jones <[email protected]>

Author: ozkutuk

plugins/hls-refactor-plugin/src/Development/IDE/Plugin/CodeAction.hs

@@ -1841,7 +1841,19 @@ smallerRangesForBindingExport lies b =
     ranges' _ = []
 
 rangesForBinding' :: String -> LIE GhcPs -> [SrcSpan]
-rangesForBinding' b (L (locA -> l) x@IEVar{}) | T.unpack (printOutputable x) == b = [l]
+#if !MIN_VERSION_ghc(9,2,0)
+rangesForBinding' b (L (locA -> l) (IEVar _ nm))
+  | L _ (IEPattern (L _ b')) <- nm
+  , T.unpack (printOutputable b') == b
+  = [l]
+#else
+rangesForBinding' b (L (locA -> l) (IEVar _ nm))
+  | L _ (IEPattern _ (L _ b')) <- nm
+  , T.unpack (printOutputable b') == b
+  = [l]
+#endif
+rangesForBinding' b (L (locA -> l) x@IEVar{})
+  | T.unpack (printOutputable x) == b = [l]
 rangesForBinding' b (L (locA -> l) x@IEThingAbs{}) | T.unpack (printOutputable x) == b = [l]
 rangesForBinding' b (L (locA -> l) (IEThingAll _ x)) | T.unpack (printOutputable x) == b = [l]
 #if !MIN_VERSION_ghc(9,2,0)

test/functional/FunctionalCodeAction.hs

@@ -176,16 +176,21 @@ redundantImportTests = testGroup "redundant import code actions" [
             doc <- openDoc "src/CodeActionRedundant.hs" "haskell"
 
             diags <- waitForDiagnosticsFromSource doc "typecheck"
-            liftIO $ expectDiagnostic diags ["The import of", "Data.List", "is redundant"]
+            liftIO $ expectDiagnostic diags [ "The import of", "Data.List", "is redundant" ]
+            liftIO $ expectDiagnostic diags [ "Empty", "from module", "Data.Sequence" ]
 
             mActions <- getAllCodeActions doc
 
             let allActions = map fromAction mActions
                 actionTitles = map (view L.title) allActions
 
-            liftIO $ actionTitles `shouldContain` ["Remove import", "Remove all redundant imports"]
+            liftIO $ actionTitles `shouldContain`
+              [ "Remove import"
+              , "Remove Empty from import"
+              , "Remove all redundant imports"
+              ]
 
-            let mbRemoveAction = find (\x -> x ^. L.title == "Remove import") allActions
+            let mbRemoveAction = find (\x -> x ^. L.title == "Remove all redundant imports") allActions
 
             case mbRemoveAction of
                 Just removeAction -> do
@@ -202,7 +207,17 @@ redundantImportTests = testGroup "redundant import code actions" [
             -- provides workspace edit property which skips round trip to
             -- the server
             contents <- documentContents doc
-            liftIO $ contents @?= "{-# OPTIONS_GHC -Wunused-imports #-}\nmodule CodeActionRedundant where\nmain :: IO ()\nmain = putStrLn \"hello\"\n"
+            liftIO $ contents @?= T.unlines
+              [ "{-# OPTIONS_GHC -Wunused-imports #-}"
+              , "{-# LANGUAGE PatternSynonyms #-}"
+              , "module CodeActionRedundant where"
+              , "-- We need a non-reduntant import in the import list"
+              , "-- to properly test the removal of the singular redundant item"
+              , "import Data.Sequence (singleton)"
+              , "main :: IO ()"
+              , "main = putStrLn \"hello\""
+              , "  where unused = Data.Sequence.singleton 42"
+              ]
 
     , testCase "doesn't touch other imports" $ runSession hlsCommand noLiteralCaps "test/testdata/redundantImportTest/" $ do
         doc <- openDoc "src/MultipleImports.hs" "haskell"

test/testdata/redundantImportTest/src/CodeActionRedundant.hs

@@ -1,5 +1,10 @@
 {-# OPTIONS_GHC -Wunused-imports #-}
+{-# LANGUAGE PatternSynonyms #-}
 module CodeActionRedundant where
 import Data.List
+-- We need a non-reduntant import in the import list
+-- to properly test the removal of the singular redundant item
+import Data.Sequence (pattern Empty, singleton)
 main :: IO ()
 main = putStrLn "hello"
+  where unused = Data.Sequence.singleton 42