default inlay hints to False

Author: Cassandra Comar

ghcide-test/exe/InlayHintTests.hs

@@ -119,6 +119,7 @@ editTest :: String -> TestTree
 editTest file =
   testWithDummyPlugin (file <> " (InlayHint EditText)") (mkIdeTestFs [copyDir "local-sig-inlay-hints"]) $ do
     doc <- openDoc (file ++ ".hs") "haskell"
+    setConfigSection "haskell" (createConfig True)
     executeAllHints doc globalRange
     real <- documentContents doc
     expectedDoc <- openDoc (file ++ ".expected.hs") "haskell"
@@ -129,6 +130,7 @@ hintTest :: String -> ([InlayHint] -> Assertion) -> TestTree
 hintTest file assert =
   testWithDummyPlugin (file <> " (InlayHint)") (mkIdeTestFs [copyDir "local-sig-inlay-hints"]) $ do
     doc <- openDoc (file ++ ".hs") "haskell"
+    setConfigSection "haskell" (createConfig True)
     hints <- getInlayHints doc globalRange
     liftIO $ assert hints
 

ghcide-test/exe/Main.hs

@@ -82,7 +82,7 @@ main = do
     , HighlightTests.tests
     , FindDefinitionAndHoverTests.tests
     , FindImplementationAndHoverTests.tests
-    , PluginSimpleTests.tests
+    -- , PluginSimpleTests.tests
     , PreprocessorTests.tests
     , THTests.tests
     , SymlinkTests.tests

ghcide/src/Development/IDE/Plugin/TypeLenses.hs

@@ -24,6 +24,7 @@ import           Control.Monad.IO.Class               (MonadIO (liftIO))
 import           Control.Monad.Trans.Class            (MonadTrans (lift))
 import           Data.Aeson.Types                     (toJSON)
 import qualified Data.Aeson.Types                     as A
+import qualified Data.Foldable                        as F
 import           Data.Generics                        (GenericQ, everything,
                                                        extQ, mkQ, something)
 import           Data.List                            (find)
@@ -89,6 +90,7 @@ import           Language.LSP.Protocol.Types          (ApplyWorkspaceEditParams
                                                        TextDocumentIdentifier (TextDocumentIdentifier),
                                                        TextEdit (TextEdit),
                                                        WorkspaceEdit (WorkspaceEdit),
+                                                       isSubrangeOf,
                                                        type (|?) (..))
 import           Text.Regex.TDFA                      ((=~))
 
@@ -127,7 +129,7 @@ properties = emptyProperties
     ] Always
   & defineBooleanProperty #localBindingInlayHintOn
     "Display inlay hints of local bindings"
-    True
+    False
 
 codeLensProvider :: PluginMethodHandler IdeState Method_TextDocumentCodeLens
 codeLensProvider ideState pId CodeLensParams{_textDocument = TextDocumentIdentifier uri} = do
@@ -538,7 +540,7 @@ generateWhereInlayHints name ty range offset =
           insertRange = Range startPos' startPos'
       in TextEdit insertRange (text <> "\n" <> T.replicate (fromIntegral insertChar) " ")
 
-generateWhereLens :: PluginId -> Uri -> Id -> T.Text -> Range -> Int -> CodeLens
+generateWhereLens :: PluginId -> Uri -> LocalBindingHintRenderer CodeLens
 generateWhereLens plId uri _ title range _ = CodeLens range (Just cmd) Nothing
     where
         cmd = mkLspCommand plId typeLensCommandId title (Just [A.toJSON (makeEdit range title)])
@@ -557,8 +559,8 @@ bindingToHints :: LocalBindingHintRenderer a -> Id -> Maybe String -> Range -> I
 bindingToHints render id (Just sig) range offset = Just $ render id (T.pack sig) range offset
 bindingToHints _ _ Nothing _ _              = Nothing
 
-renderLocalHints :: MonadIO m => LocalBindingHintRenderer a -> Uri -> IdeState -> ExceptT PluginError m ([a] |? b)
-renderLocalHints render uri state = do
+renderLocalHints :: MonadIO m => LocalBindingHintRenderer a -> Maybe Range -> Uri -> IdeState -> ExceptT PluginError m ([a] |? b)
+renderLocalHints render visibleRange uri state = do
     nfp <- getNormalizedFilePathE uri
     (LocalBindingTypeSigsResult (localBindings, sigMap), pm)
        <- runActionE "InlayHint.GetWhereBindingTypeSigs" state $ useWithStaleE GetLocalBindingTypeSigs nfp
@@ -576,8 +578,8 @@ renderLocalHints render uri state = do
                   , bindingSpan `notElem` sigSpans
                   , Just bindingRange <- maybeToList $ toCurrentRange pm <$> srcSpanToRange bindingLoc
                   -- Show inlay hints only within visible range
-                  -- TODO: there's no "visibleRange" on CodeLens'
-                  -- , isSubrangeOf bindingRange visibleRange
+                  -- CodeLenses don't have a visible range
+                  , maybe True (isSubrangeOf bindingRange) visibleRange
                   ]
     pure $ InL hints
 
@@ -587,12 +589,12 @@ localBindingCodeLens state plId (CodeLensParams{..})  = do
   let uri = _textDocument ^. L.uri
   if enabled
       then pure $ InL []
-      else renderLocalHints (generateWhereLens plId uri) uri state
+      else renderLocalHints (generateWhereLens plId uri) Nothing uri state
 
 -- | Provide inlay hints for local bindings
 localBindingInlayHints :: PluginMethodHandler IdeState Method_TextDocumentInlayHint
-localBindingInlayHints state plId (InlayHintParams _ (TextDocumentIdentifier uri) _)  = do
+localBindingInlayHints state plId (InlayHintParams _ (TextDocumentIdentifier uri) visibleRange)  = do
   enabled <- liftIO $ runAction "inlayHint.config" state $ usePropertyAction #localBindingInlayHintOn plId properties
   if not enabled
       then pure $ InL []
-      else renderLocalHints generateWhereInlayHints uri state
+      else renderLocalHints generateWhereInlayHints (Just visibleRange) uri state

haskell-language-server.cabal

@@ -1342,7 +1342,6 @@ test-suite hls-explicit-record-fields-plugin-tests
     , ghcide
     , haskell-language-server:hls-explicit-record-fields-plugin
     , hls-test-utils              == 2.11.0.0
-    , aeson
 
 -----------------------------
 -- overloaded record dot plugin

plugins/hls-explicit-record-fields-plugin/test/Main.hs

@@ -3,7 +3,6 @@
 
 module Main ( main ) where
 
-import qualified Data.Aeson                as A
 import           Data.Either               (rights)
 import           Data.Text                 (Text)
 import qualified Data.Text                 as T
@@ -301,7 +300,6 @@ mkInlayHintsTest fp postfix line assert =
   testCase (fp ++ concat postfix) $
     runSessionWithServer def plugin testDataDir $ do
       doc <- openDoc (fp ++ ".hs") "haskell"
-      setConfigSection "haskell" (createConfig False)
       inlayHints <- getInlayHints doc (lineRange line)
       liftIO $ assert inlayHints
   where
@@ -398,9 +396,3 @@ mkPragmaTextEdit line =
 
 testDataDir :: FilePath
 testDataDir = "plugins" </> "hls-explicit-record-fields-plugin" </> "test" </> "testdata"
-
-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 ]]]]