Move lspLogger to the ghcide library

Author: pepeiborra

ghcide/ghcide.cabal

@@ -188,6 +188,7 @@ library
         Development.IDE.Plugin.CodeAction.ExactPrint
         Development.IDE.Plugin.HLS
         Development.IDE.Plugin.HLS.GhcIde
+        Development.IDE.Plugin.LspLogger
         Development.IDE.Plugin.Test
         Development.IDE.Plugin.TypeLenses
 

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

@@ -0,0 +1,25 @@
+module Development.IDE.Plugin.LspLogger (lspLogger) where
+
+import           Control.Monad.Extra          (whenJust)
+import           Control.Monad.IO.Class
+import qualified Data.Aeson                   as A
+import           Data.IORef
+import           Development.IDE.Types.Logger
+import           Ide.Types
+import qualified Language.LSP.Server          as LSP
+import           Language.LSP.Types
+
+-- | A logger that sends messages to the LSP client
+lspLogger :: IO (Logger, PluginDescriptor a)
+lspLogger = do
+    lspEnvRef <- newIORef Nothing
+    let plugin = (defaultPluginDescriptor "lspLogging"){
+            pluginNotificationHandlers =
+                mkPluginNotificationHandler SInitialized $ \_ _ _ ->
+                    liftIO $ readIORef lspEnvRef >>= writeIORef lspEnvRef
+        }
+        logger = Logger $ \_p msg -> do
+            env <- readIORef lspEnvRef
+            whenJust env $ \env ->
+                LSP.runLspT env (LSP.sendNotification (SCustomMethod "ghcide/log") (A.String msg))
+    return (logger, plugin)

ghcide/test/exe/Main.hs

@@ -39,6 +39,7 @@ import           Development.IDE.Core.Shake               (Q (..))
 import qualified Development.IDE.Main                     as IDE
 import           Development.IDE.GHC.Util
 import           Development.IDE.Plugin.Completions.Types (extendImportCommandId)
+import           Development.IDE.Plugin.LspLogger
 import           Development.IDE.Plugin.TypeLenses        (typeLensCommandId)
 import           Development.IDE.Spans.Common
 import           Development.IDE.Test                     (Cursor,
@@ -51,7 +52,7 @@ import           Development.IDE.Test                     (Cursor,
                                                            expectNoMoreDiagnostics,
                                                            flushMessages,
                                                            standardizeQuotes,
-                                                           waitForAction, lspLogger)
+                                                           waitForAction)
 import           Development.IDE.Test.Runfiles
 import qualified Development.IDE.Types.Diagnostics        as Diagnostics
 import           Development.IDE.Types.Location

ghcide/test/src/Development/IDE/Test.hs

@@ -20,25 +20,19 @@ module Development.IDE.Test
   , standardizeQuotes
   , flushMessages
   , waitForAction
-  , lspLogger
   ) where
 
 import           Control.Applicative.Combinators
 import           Control.Lens                    hiding (List)
 import           Control.Monad
-import           Control.Monad.Extra             (whenJust)
 import           Control.Monad.IO.Class
 import qualified Data.Aeson                      as A
 import           Data.Bifunctor                  (second)
-import           Data.IORef
 import qualified Data.Map.Strict                 as Map
 import           Data.Maybe                      (fromJust)
 import qualified Data.Text                       as T
 import           Development.IDE.Plugin.Test     (TestRequest (..),
                                                   WaitForIdeRuleResult)
-import           Development.IDE.Types.Logger
-import           Ide.Types
-import qualified Language.LSP.Server             as LSP
 import           Language.LSP.Test               hiding (message)
 import qualified Language.LSP.Test               as LspTest
 import           Language.LSP.Types
@@ -206,18 +200,3 @@ waitForAction key TextDocumentIdentifier{_uri} = do
       case A.fromJSON e of
         A.Error e   -> Left $ ResponseError InternalError (T.pack e) Nothing
         A.Success a -> pure a
-
--- lspLogger :: lspEnv a -> T.Text -> IO ()
-lspLogger :: IO (Logger, PluginDescriptor a)
-lspLogger = do
-    lspEnvRef <- newIORef Nothing
-    let plugin = (defaultPluginDescriptor "lspLogging"){
-            pluginNotificationHandlers =
-                mkPluginNotificationHandler SInitialized $ \_ _ _ ->
-                    liftIO $ readIORef lspEnvRef >>= writeIORef lspEnvRef
-        }
-        logger = Logger $ \_p msg -> do
-            env <- readIORef lspEnvRef
-            whenJust env $ \env ->
-                LSP.runLspT env (LSP.sendNotification (SCustomMethod "ghcide/log") (A.String msg))
-    return (logger, plugin)