Add sig inlay hints for where clause

ghcide/test/data/local-sig-inlay-hints/Infix.expected.hs

@@ -0,0 +1,7 @@
+module Infix where
+
+f :: a
+f = undefined
+    where
+        g :: p1 -> p -> p1
+        a `g` b = a

ghcide/test/data/local-sig-inlay-hints/Infix.hs

@@ -0,0 +1,6 @@
+module Infix where
+
+f :: a
+f = undefined
+    where
+        a `g` b = a

ghcide/test/data/local-sig-inlay-hints/Inline.expected.hs

@@ -0,0 +1,6 @@
+module Inline where
+
+f :: a
+f = undefined
+    where g :: Bool
+          g = True

ghcide/test/data/local-sig-inlay-hints/Inline.hs

@@ -0,0 +1,5 @@
+module Inline where
+
+f :: a
+f = undefined
+    where g = True

ghcide/test/data/local-sig-inlay-hints/Nest.expected.hs

@@ -0,0 +1,10 @@
+module Nest where
+
+f :: Int
+f = g
+    where
+        g :: Int
+        g = h
+        h :: Int
+        h = k where k :: Int
+                    k = 3

ghcide/test/data/local-sig-inlay-hints/Nest.hs

@@ -0,0 +1,7 @@
+module Nest where
+
+f :: Int
+f = g
+    where
+        g = h
+        h = k where k = 3

ghcide/test/data/local-sig-inlay-hints/NoLens.expected.hs

@@ -0,0 +1,13 @@
+module NoLens where
+
+f :: a
+f = undefined
+    where
+        g = 3
+
+
+
+
+
+
+        g :: Int

ghcide/test/data/local-sig-inlay-hints/NoLens.hs

@@ -0,0 +1,13 @@
+module NoLens where
+
+f :: a
+f = undefined
+    where
+        g = 3
+
+
+
+
+
+
+        g :: Int

ghcide/test/data/local-sig-inlay-hints/Operator.expected.hs

@@ -0,0 +1,7 @@
+module Operator where
+
+f :: a
+f = undefined
+    where
+        g :: (a -> b) -> a -> b
+        g = ($)

ghcide/test/data/local-sig-inlay-hints/Operator.hs

@@ -0,0 +1,6 @@
+module Operator where
+
+f :: a
+f = undefined
+    where
+        g = ($)

ghcide/test/data/local-sig-inlay-hints/Qualified.expected.hs

@@ -0,0 +1,9 @@
+module Qualified where
+
+import qualified Data.Map as Map
+
+f :: a
+f = undefined
+    where
+         g :: Map.Map Bool Char
+         g = Map.singleton True 'c'

ghcide/test/data/local-sig-inlay-hints/Qualified.hs

@@ -0,0 +1,8 @@
+module Qualified where
+
+import qualified Data.Map as Map
+
+f :: a
+f = undefined
+    where
+         g = Map.singleton True 'c'

ghcide/test/data/local-sig-inlay-hints/ScopedTypeVariables.expected.hs

@@ -0,0 +1,8 @@
+{-# LANGUAGE ExplicitForAll #-}
+module ScopedTypeVariables where
+
+f :: forall a b. a -> b -> (a, b)
+f aa bb = (aa, ida bb)
+    where
+        ida :: b -> b
+        ida = id

ghcide/test/data/local-sig-inlay-hints/ScopedTypeVariables.hs

@@ -0,0 +1,7 @@
+{-# LANGUAGE ExplicitForAll #-}
+module ScopedTypeVariables where
+
+f :: forall a b. a -> b -> (a, b)
+f aa bb = (aa, ida bb)
+    where
+        ida = id

ghcide/test/data/local-sig-inlay-hints/Simple.expected.hs

@@ -0,0 +1,7 @@
+module Simple where
+
+f :: a
+f = undefined
+    where
+        g :: Bool
+        g = True

ghcide/test/data/local-sig-inlay-hints/Simple.hs

@@ -0,0 +1,6 @@
+module Simple where
+
+f :: a
+f = undefined
+    where
+        g = True

ghcide/test/data/local-sig-inlay-hints/Tuple.expected.hs

@@ -0,0 +1,8 @@
+module Typle where
+
+f :: a
+f = undefined
+    where
+        g :: Integer
+        h :: Bool
+        (g, h) = (1, True)

ghcide/test/data/local-sig-inlay-hints/Tuple.hs

@@ -0,0 +1,6 @@
+module Typle where
+
+f :: a
+f = undefined
+    where
+        (g, h) = (1, True)

ghcide/test/data/local-sig-inlay-hints/Typeclass.expected.hs

@@ -0,0 +1,7 @@
+module Typeclass where
+
+f :: a
+f = undefined
+    where
+        g :: Num a => a -> a -> a
+        g a b = a + b

ghcide/test/data/local-sig-inlay-hints/Typeclass.hs

@@ -0,0 +1,6 @@
+module Typeclass where
+
+f :: a
+f = undefined
+    where
+        g a b = a + b

ghcide/test/exe/InlayHintTests.hs

@@ -0,0 +1,179 @@
+{-# LANGUAGE ExplicitNamespaces #-}
+
+module InlayHintTests (tests) where
+
+import           Config                      (mkIdeTestFs, testWithDummyPlugin,
+                                              testWithDummyPluginEmpty)
+import           Control.Monad               (void)
+import           Control.Monad.IO.Class      (MonadIO (liftIO))
+import qualified Data.Aeson                  as A
+import           Data.Maybe                  (mapMaybe)
+import qualified Data.Text                   as T
+import           Language.LSP.Protocol.Types (InlayHint (..),
+                                              Position (Position),
+                                              Range (Range, _end, _start),
+                                              TextDocumentIdentifier (TextDocumentIdentifier),
+                                              TextEdit (TextEdit, _newText, _range),
+                                              UInt,
+                                              VersionedTextDocumentIdentifier (_uri),
+                                              type (|?) (..))
+import           Language.LSP.Test           (applyEdit, createDoc,
+                                              documentContents, getInlayHints,
+                                              openDoc, setConfigSection)
+import           Test.Hls                    (Assertion, Session, expectFail,
+                                              waitForTypecheck)
+import           Test.Hls.FileSystem         (copyDir)
+import           Test.Tasty                  (TestTree, testGroup)
+import           Test.Tasty.HUnit            ((@=?), (@?=))
+
+tests :: TestTree
+tests = testGroup "inlay hints"
+  [ whereInlayHintsTests
+  ]
+
+whereInlayHintsTests :: TestTree
+whereInlayHintsTests = testGroup "add signature for where clauses"
+  [ testWithDummyPluginEmpty "No where inlay hints if disabled" $ do
+      let content = T.unlines
+            [ "module Sigs where"
+            , "f :: b"
+            , "f = undefined"
+            , "  where"
+            , "    g = True"
+            ]
+          range = Range { _start = Position 4 0
+                        , _end = Position 4 1000
+                        }
+      doc <- createDoc "Sigs.hs" "haskell" content
+      setConfigSection "haskell" (createConfig False)
+      inlayHints <- getInlayHints doc range
+      liftIO $ length inlayHints @?= 0
+  , testGroup "apply EditText"
+    [ editTest "Simple"
+    , editTest "Tuple"
+    , editTest "Inline"
+    , editTest "Infix"
+    , editTest "Operator"
+    , expectFail $ editTest "ScopedTypeVariables"
+    , editTest "Nest"
+    , editTest "NoLens"
+    , expectFail $ editTest "Typeclass"
+    , editTest "Qualified"
+    ]
+  , testGroup "apply EditText"
+    [ hintTest "Simple" $ (@=?)
+      [defInlayHint { _position = Position 5 9
+                    , _label = InL ":: Bool"
+                    , _textEdits = Just [mkTextEdit 5 8 "g :: Bool\n        "]
+                    }]
+    , hintTest "Tuple" $ (@=?)
+      [ defInlayHint { _position = Position 5 10
+                     , _label = InL ":: Integer"
+                     , _textEdits = Just [mkTextEdit 5 8 "g :: Integer\n        "]
+                     }
+      , defInlayHint { _position = Position 5 13
+                     , _label = InL ":: Bool"
+                     , _textEdits = Just [mkTextEdit 5 8 "h :: Bool\n        "]
+                     }
+      ]
+    , hintTest "Inline" $ (@=?)
+      [defInlayHint { _position = Position 4 11
+                    , _label = InL ":: Bool"
+                    , _textEdits = Just [mkTextEdit 4 10 "g :: Bool\n          "]
+                    }]
+    , hintTest "Infix" $ (@=?)
+      [defInlayHint { _position = Position 5 13
+                    , _label = InL ":: p1 -> p -> p1"
+                    , _textEdits = Just [mkTextEdit 5 8 "g :: p1 -> p -> p1\n        "]
+                    }]
+    , hintTest "Operator" $ (@=?)
+      [defInlayHint { _position = Position 5 9
+                    , _label = InL ":: (a -> b) -> a -> b"
+                    , _textEdits = Just [mkTextEdit 5 8 "g :: (a -> b) -> a -> b\n        "]
+                    }]
+    , hintTest "Nest" $ (@=?)
+      [ defInlayHint { _position = Position 6 9
+                     , _label = InL ":: Int"
+                     , _textEdits = Just [mkTextEdit 6 8 "h :: Int\n        "]
+                     }
+      , defInlayHint { _position = Position 5 9
+                     , _label = InL ":: Int"
+                     , _textEdits = Just [mkTextEdit 5 8 "g :: Int\n        "]
+                     }
+      , defInlayHint { _position = Position 6 21
+                     , _label = InL ":: Int"
+                     , _textEdits = Just [mkTextEdit 6 20 "k :: Int\n                    "]
+                     }
+      ]
+    , hintTest "NoLens" $ (@=?) []
+    , hintTest "Qualified" $ (@=?)
+      [ defInlayHint { _position = Position 7 10
+                     , _label = InL ":: Map.Map Bool Char"
+                     , _textEdits = Just [mkTextEdit 7 9 "g :: Map.Map Bool Char\n         "]
+                     }
+      ]
+    ]
+  ]
+
+editTest :: String -> TestTree
+editTest file =
+  testWithDummyPlugin (file <> " (InlayHint EditText)") (mkIdeTestFs [copyDir "local-sig-inlay-hints"]) $ do
+    doc <- openDoc (file ++ ".hs") "haskell"
+    executeAllHints doc globalRange
+    real <- documentContents doc
+    expectedDoc <- openDoc (file ++ ".expected.hs") "haskell"
+    expected <- documentContents expectedDoc
+    liftIO $ real @?= expected
+
+hintTest :: String -> ([InlayHint] -> Assertion) -> TestTree
+hintTest file assert =
+  testWithDummyPlugin (file <> " (InlayHint)") (mkIdeTestFs [copyDir "local-sig-inlay-hints"]) $ do
+    doc <- openDoc (file ++ ".hs") "haskell"
+    hints <- getInlayHints doc globalRange
+    liftIO $ assert hints
+
+
+createConfig :: Bool -> A.Value
+createConfig on =
+  A.object [ "plugin"
+    A..= A.object [ "ghcide-type-lenses"
+      A..= A.object [ "config"
+        A..= A.object [ "localBindingInlayHintOn" A..= A.Bool on ]]]]
+
+
+executeAllHints :: TextDocumentIdentifier -> Range -> Session ()
+executeAllHints doc range = do
+    void $ waitForTypecheck doc
+    hints <- getInlayHints doc range
+    let edits = concat $ mapMaybe _textEdits hints
+    case edits of
+      [] -> pure ()
+      edit : _ -> do
+        newDoc <- applyEdit doc edit
+        executeAllHints (TextDocumentIdentifier $ _uri newDoc) range
+
+defInlayHint :: InlayHint
+defInlayHint =
+  InlayHint { _position = Position 0 0
+            , _label = InL ""
+            , _kind = Nothing
+            , _textEdits = Nothing
+            , _tooltip = Nothing
+            , _paddingLeft = Just True
+            , _paddingRight = Nothing
+            , _data_ = Nothing
+            }
+
+mkTextEdit :: UInt -> UInt -> T.Text -> TextEdit
+mkTextEdit x y text =
+  TextEdit { _range = pointRange x y
+           , _newText = text
+           }
+
+pointRange :: UInt -> UInt -> Range
+pointRange x y = Range (Position x y) (Position x y)
+
+globalRange :: Range
+globalRange = Range { _start = Position 0 0
+                    , _end = Position 1000 0
+                    }

ghcide/test/exe/Main.hs

@@ -50,6 +50,7 @@ import           HaddockTests
 import           HighlightTests
 import           IfaceTests
 import           InitializeResponseTests
+import           InlayHintTests
 import           LogType                      ()
 import           NonLspCommandLine
 import           OpenCloseTest
@@ -99,4 +100,5 @@ main = do
     , GarbageCollectionTests.tests
     , HieDbRetry.tests
     , ExceptionTests.tests
+    , InlayHintTests.tests
     ]

haskell-language-server.cabal

@@ -2195,6 +2195,7 @@ test-suite ghcide-tests
     THTests
     UnitTests
     WatchedFileTests
+    InlayHintTests
 
   -- Tests that have been pulled out of the main file
   default-extensions:

test/testdata/schema/ghc94/default-config.golden.json

@@ -85,10 +85,12 @@
             "symbolsOn": true
         },
         "ghcide-type-lenses": {
+            "codeLensOn": true,
             "config": {
+                "localBindingInlayHintOn": true,
                 "mode": "always"
             },
-            "globalOn": true
+            "inlayHintsOn": true
         },
         "hlint": {
             "codeActionsOn": true,