Turn maxCompletions into config

Author: pepeiborra

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

@@ -6,7 +6,6 @@ module Development.IDE.Plugin.Completions
     (
       plugin
     , getCompletionsLSP
-    , maxCompletions
     ) where
 
 import Language.Haskell.LSP.Messages
@@ -31,7 +30,7 @@ import Development.IDE.GHC.Util
 import Development.IDE.LSP.Server
 import TcRnDriver (tcRnImportDecls)
 import Data.Maybe
-import Ide.Plugin.Config (Config(completionSnippetsOn))
+import Ide.Plugin.Config (Config (completionSnippetsOn, maxCompletions))
 import Ide.PluginUtils (getClientConfig)
 
 #if defined(GHC_LIB)
@@ -116,13 +115,6 @@ data NonLocalCompletions = NonLocalCompletions
 instance Hashable NonLocalCompletions
 instance NFData   NonLocalCompletions
 instance Binary   NonLocalCompletions
-
--- | 40 may seem conservative but note that most editors limit how many completions
---   are displayed in the screen, and most users rarely scroll.
---   For instance, VSCode only shows 12 completions in its popup, and Emacs has a similar limit.
-maxCompletions :: Int
-maxCompletions = 40
-
 -- | Generate code actions.
 getCompletionsLSP
     :: LSP.LspFuncs Config
@@ -151,9 +143,10 @@ getCompletionsLSP lsp ide
                 -> return (Completions $ List [])
               (Just pfix', _) -> do
                 let clientCaps = clientCapabilities $ shakeExtras ide
-                snippets <- WithSnippets . completionSnippetsOn <$> getClientConfig lsp
+                config <- getClientConfig lsp
+                let snippets = WithSnippets . completionSnippetsOn $ config
                 allCompletions <- getCompletions ideOpts cci' parsedMod bindMap pfix' clientCaps snippets
-                let (topCompletions, rest) = splitAt maxCompletions allCompletions
+                let (topCompletions, rest) = splitAt (maxCompletions config) allCompletions
                 pure $ CompletionList (CompletionListType (null rest) (List topCompletions))
               _ -> return (Completions $ List [])
           _ -> return (Completions $ List [])

ghcide/test/exe/Main.hs

@@ -64,7 +64,6 @@ import Development.IDE.Plugin.Test (WaitForIdeRuleResult(..), TestRequest(BlockS
 import Control.Monad.Extra (whenJust)
 import qualified Language.Haskell.LSP.Types.Lens as L
 import Control.Lens ((^.))
-import Development.IDE.Plugin.Completions (maxCompletions)
 
 main :: IO ()
 main = do
@@ -3224,7 +3223,7 @@ otherCompletionTests = [
             ]
         _ <- waitForDiagnostics
         compls <- getCompletions  doc (Position 3 13)
-        liftIO $ length compls @?= maxCompletions
+        liftIO $ length compls @?= maxCompletions def
   ]
 
 highlightTests :: TestTree

hls-plugin-api/src/Ide/Plugin/Config.hs

@@ -69,6 +69,7 @@ data Config =
     , completionSnippetsOn        :: !Bool
     , formatOnImportOn            :: !Bool
     , formattingProvider          :: !T.Text
+    , maxCompletions              :: !Int
     , plugins                     :: !(Map.Map T.Text PluginConfig)
     } deriving (Show,Eq)
 
@@ -87,6 +88,7 @@ instance Default Config where
     , formattingProvider          = "ormolu"
     -- , formattingProvider          = "floskell"
     -- , formattingProvider          = "stylish-haskell"
+    , maxCompletions              = 40
     , plugins                     = Map.empty
     }
 
@@ -107,6 +109,7 @@ instance A.FromJSON Config where
       <*> o .:? "completionSnippetsOn"                    .!= completionSnippetsOn def
       <*> o .:? "formatOnImportOn"                        .!= formatOnImportOn def
       <*> o .:? "formattingProvider"                      .!= formattingProvider def
+      <*> o .:? "maxCompletions"                          .!= maxCompletions def
       <*> o .:? "plugin"                                  .!= plugins def
 
 -- 2017-10-09 23:22:00.710515298 [ThreadId 11] - ---> {"jsonrpc":"2.0","method":"workspace/didChangeConfiguration","params":{"settings":{"haskell":{"maxNumberOfProblems":100,"hlintOn":true}}}}