Display hint after when using ImportQualifiedPost

Author: wczyz

plugins/hls-explicit-imports-plugin/src/Ide/Plugin/ExplicitImports.hs

@@ -292,19 +292,26 @@ importPackageInlayHintProvider _ state _ InlayHintParams {_textDocument = TextDo
             isPackageImport ImportDecl{ideclPkgQual = NoRawPkgQual} = False
             isPackageImport _                                       = True
 
-            (L _ hsImports) = hsmodImports <$> pm_parsed_source parsedModule
+            L _ hsImports = hsmodImports <$> pm_parsed_source parsedModule
 
             srcSpanToPosition :: SrcSpan -> Position
             srcSpanToPosition srcSpan = (realSrcSpanToRange . realSrcSpan $ srcSpan) ^. L.end
 
-            annToPosition :: EpAnnImportDecl -> Position
-            annToPosition ann = case importDeclAnnQualified ann of
-                Just loc -> (srcSpanToPosition $ getHasLoc loc)
-                _ -> (srcSpanToPosition $ getHasLoc $ importDeclAnnImport ann)
+            hintPosition :: ImportDecl GhcPs -> Position
+            hintPosition importDecl =
+              let importAnn = anns $ ideclAnn $ ideclExt importDecl
+                  importPosition = srcSpanToPosition $ getHasLoc $ importDeclAnnImport $ importAnn
+                  moduleNamePosition = srcSpanToPosition $ getHasLoc $ ideclName importDecl
+                  maybeQualifiedPosition = srcSpanToPosition . getHasLoc <$> importDeclAnnQualified importAnn
+              in case maybeQualifiedPosition of
+                  Just qualifiedPosition -> if qualifiedPosition < moduleNamePosition
+                                            then qualifiedPosition
+                                            else importPosition
+                  Nothing -> importPosition
         in hsImports
             & filter (\(L _ importDecl) -> not $ isPackageImport importDecl)
             & map (\(L _ importDecl) ->
-              (annToPosition $ anns $ ideclAnn $ ideclExt importDecl, unLoc $ ideclName importDecl))
+              (hintPosition importDecl, unLoc $ ideclName importDecl))
 
 -- |For explicit imports: If there are any implicit imports, provide both one
 -- code action per import to make that specific import explicit, and one code

plugins/hls-explicit-imports-plugin/test/Main.hs

@@ -111,23 +111,39 @@ main = defaultTestRunner $ testGroup "import-actions"
   testGroup
     "Import package inlay hints"
     [ testGroup "Without package imports"
-      [ inlayHintsTestWithCap "ImportUsual" 2 $ (@=?)
-          [mkInlayHintNoTextEdit (Position 2 6) "\"base\""]
-      , inlayHintsTestWithCap "ImportUsual" 3 $ (@=?)
-          [mkInlayHintNoTextEdit (Position 3 16) "\"containers\""]
-      , inlayHintsTestWithCap "ImportUsual" 4 $ (@=?) []
-      , inlayHintsTestWithoutCap "ImportUsual" 2 $ (@=?) []
-      , inlayHintsTestWithoutCap "ImportUsual" 3 $ (@=?) []
-      , inlayHintsTestWithoutCap "ImportUsual" 4 $ (@=?) []
-    ], testGroup "With package imports"
-      [ inlayHintsTestWithCap "ImportWithPackageImport" 3 $ (@=?) []
-      , inlayHintsTestWithCap "ImportWithPackageImport" 4 $ (@=?)
-          [mkInlayHintNoTextEdit (Position 4 16) "\"containers\""]
-      , inlayHintsTestWithCap "ImportWithPackageImport" 5 $ (@=?) []
-      , inlayHintsTestWithoutCap "ImportWithPackageImport" 3 $ (@=?) []
-      , inlayHintsTestWithoutCap "ImportWithPackageImport" 4 $ (@=?) []
-      , inlayHintsTestWithoutCap "ImportWithPackageImport" 5 $ (@=?) []
-    ]]]
+      (let testWithCap = inlayHintsTestWithCap "ImportUsual"
+           testWithoutCap = inlayHintsTestWithoutCap "ImportUsual"
+      in
+        [ testWithCap 2 $ (@=?) [mkInlayHintNoTextEdit (Position 2 6) "\"base\""]
+        , testWithCap 3 $ (@=?) [mkInlayHintNoTextEdit (Position 3 16) "\"containers\""]
+        , testWithCap 4 $ (@=?) []
+        , testWithoutCap 2 $ (@=?) []
+        , testWithoutCap 3 $ (@=?) []
+        , testWithoutCap 4 $ (@=?) []
+        ])
+    , testGroup "With package imports"
+      (let testWithCap = inlayHintsTestWithCap "ImportWithPackageImport"
+           testWithoutCap = inlayHintsTestWithoutCap "ImportWithPackageImport"
+      in
+        [ testWithCap 3 $ (@=?) []
+        , testWithCap 4 $ (@=?) [mkInlayHintNoTextEdit (Position 4 16) "\"containers\""]
+        , testWithCap 5 $ (@=?) []
+        , testWithoutCap 3 $ (@=?) []
+        , testWithoutCap 4 $ (@=?) []
+        , testWithoutCap 5 $ (@=?) []
+        ])
+    , testGroup "When using ImportQualifiedPost"
+      (let testWithCap = inlayHintsTestWithCap "ImportWithQualifiedPost"
+           testWithoutCap = inlayHintsTestWithoutCap "ImportWithQualifiedPost"
+      in
+        [ testWithCap 3 $ (@=?) [mkInlayHintNoTextEdit (Position 3 6) "\"base\""]
+        , testWithCap 4 $ (@=?) [mkInlayHintNoTextEdit (Position 4 6) "\"containers\""]
+        , testWithCap 5 $ (@=?) []
+        , testWithoutCap 3 $ (@=?) []
+        , testWithoutCap 4 $ (@=?) []
+        , testWithoutCap 5 $ (@=?) []
+        ])
+    ]]
 
 -- code action tests
 

plugins/hls-explicit-imports-plugin/test/testdata/ImportWithQualifiedPost.hs

@@ -0,0 +1,16 @@
+{-# LANGUAGE ImportQualifiedPost #-}
+module ImportWithQualifiedPost where
+
+import Data.List (intersperse)
+import Data.Map qualified as Map
+import ExplicitA ( a1, a2 )
+
+ordinaryMap :: Map.Map String String
+ordinaryMap = Map.fromList [(a1, a2)]
+
+main :: IO ()
+main =
+    putStrLn (concat (intersperse " " ["hello", "world", name, "!"]))
+  where
+    name =
+      Map.findWithDefault "default" a1 ordinaryMap