Move the completions and code actions into Plugin (#359)

* Move the completions into a Plugin pile

* Fix HLint

* Turn CodeAction into a plugin as well

* Fix HLint

* Remove a redundant def <>

Author: ndmitchell

.hlint.yaml

@@ -76,16 +76,16 @@
   - {name: ImplicitParams, within: []}
   - name: CPP
     within:
-    - Development.IDE.Core.Completions
     - Development.IDE.Core.FileStore
     - Development.IDE.Core.Compile
     - Development.IDE.GHC.Compat
     - Development.IDE.GHC.Util
     - Development.IDE.Import.FindImports
-    - Development.IDE.LSP.CodeAction
     - Development.IDE.Spans.Calculate
     - Development.IDE.Spans.Documentation
     - Development.IDE.Spans.Common
+    - Development.IDE.Plugin.CodeAction
+    - Development.IDE.Plugin.Completions.Logic
     - Main
 
 - flags:

exe/Main.hs

@@ -28,6 +28,8 @@ import Development.IDE.Types.Diagnostics
 import Development.IDE.Types.Options
 import Development.IDE.Types.Logger
 import Development.IDE.GHC.Util
+import Development.IDE.Plugin.Completions
+import Development.IDE.Plugin.CodeAction
 import qualified Data.Text as T
 import qualified Data.Text.IO as T
 import Language.Haskell.LSP.Messages
@@ -83,11 +85,18 @@ main = do
 
     dir <- getCurrentDirectory
 
+    let handlers =
+            setHandlersCompletion <>
+            setHandlersCodeAction <> setHandlersCodeLens
+    let rules = do
+            mainRule
+            produceCompletions
+
     if argLSP then do
         t <- offsetTime
         hPutStrLn stderr "Starting LSP server..."
         hPutStrLn stderr "If you are seeing this in a terminal, you probably should have run ghcidie WITHOUT the --lsp option!"
-        runLanguageServer def def $ \getLspId event vfs caps -> do
+        runLanguageServer def handlers $ \getLspId event vfs caps -> do
             t <- t
             hPutStrLn stderr $ "Started LSP server in " ++ showDuration t
             -- very important we only call loadSession once, and it's fast, so just do it before starting
@@ -96,7 +105,7 @@ main = do
                     { optReportProgress = clientSupportsProgress caps
                     , optShakeProfiling = argsShakeProfiling
                     }
-            initialise caps (mainRule >> action kick) getLspId event (logger minBound) options vfs
+            initialise caps (rules >> action kick) getLspId event (logger minBound) options vfs
     else do
         putStrLn $ "Ghcide setup tester in " ++ dir ++ "."
         putStrLn "Report bugs at https://github.com/digital-asset/ghcide/issues"

ghcide.cabal

@@ -99,8 +99,6 @@ library
     include-dirs:
         include
     exposed-modules:
-        Development.IDE.Core.Completions
-        Development.IDE.Core.CompletionsTypes
         Development.IDE.Core.FileStore
         Development.IDE.Core.OfInterest
         Development.IDE.Core.PositionMapping
@@ -117,6 +115,8 @@ library
         Development.IDE.Types.Location
         Development.IDE.Types.Logger
         Development.IDE.Types.Options
+        Development.IDE.Plugin.Completions
+        Development.IDE.Plugin.CodeAction
     other-modules:
         Development.IDE.Core.Debouncer
         Development.IDE.Core.Compile
@@ -128,8 +128,6 @@ library
         Development.IDE.GHC.Orphans
         Development.IDE.GHC.Warnings
         Development.IDE.Import.FindImports
-        Development.IDE.LSP.CodeAction
-        Development.IDE.LSP.Completions
         Development.IDE.LSP.HoverDefinition
         Development.IDE.LSP.Notifications
         Development.IDE.LSP.Outline
@@ -138,6 +136,8 @@ library
         Development.IDE.Spans.Common
         Development.IDE.Spans.Documentation
         Development.IDE.Spans.Type
+        Development.IDE.Plugin.Completions.Logic
+        Development.IDE.Plugin.Completions.Types
     ghc-options: -Wall -Wno-name-shadowing
 
 executable ghcide-test-preprocessor

src/Development/IDE/Core/RuleTypes.hs

@@ -27,7 +27,6 @@ import Module (InstalledUnitId)
 import HscTypes (CgGuts, Linkable, HomeModInfo, ModDetails)
 import Development.IDE.GHC.Compat
 
-import           Development.IDE.Core.CompletionsTypes
 import           Development.IDE.Spans.Type
 
 
@@ -86,9 +85,6 @@ type instance RuleResult ReportImportCycles = ()
 -- | Read the given HIE file.
 type instance RuleResult GetHieFile = HieFile
 
--- | Produce completions info for a file
-type instance RuleResult ProduceCompletions = (CachedCompletions, TcModuleResult)
-
 
 data GetParsedModule = GetParsedModule
     deriving (Eq, Show, Typeable, Generic)
@@ -157,9 +153,3 @@ data GetHieFile = GetHieFile FilePath
 instance Hashable GetHieFile
 instance NFData   GetHieFile
 instance Binary   GetHieFile
-
-data ProduceCompletions = ProduceCompletions
-    deriving (Eq, Show, Typeable, Generic)
-instance Hashable ProduceCompletions
-instance NFData   ProduceCompletions
-instance Binary   ProduceCompletions

src/Development/IDE/Core/Rules.hs

@@ -32,7 +32,6 @@ import Control.Monad
 import Control.Monad.Trans.Class
 import Control.Monad.Trans.Maybe
 import Development.IDE.Core.Compile
-import Development.IDE.Core.Completions
 import Development.IDE.Types.Options
 import Development.IDE.Spans.Calculate
 import Development.IDE.Import.DependencyInformation
@@ -307,20 +306,6 @@ generateCoreRule :: Rules ()
 generateCoreRule =
     define $ \GenerateCore -> generateCore
 
-produceCompletions :: Rules ()
-produceCompletions =
-    define $ \ProduceCompletions file -> do
-        deps <- maybe (TransitiveDependencies [] []) fst <$> useWithStale GetDependencies file
-        tms <- mapMaybe (fmap fst) <$> usesWithStale TypeCheck (transitiveModuleDeps deps)
-        tm <- fmap fst <$> useWithStale TypeCheck file
-        packageState <- fmap (hscEnv . fst) <$> useWithStale GhcSession file
-        case (tm, packageState) of
-            (Just tm', Just packageState') -> do
-                cdata <- liftIO $ cacheDataProducer packageState' (hsc_dflags packageState')
-                                                    (tmrModule tm') (map tmrModule tms)
-                return ([], Just (cdata, tm'))
-            _ -> return ([], Nothing)
-
 generateByteCodeRule :: Rules ()
 generateByteCodeRule =
     define $ \GenerateByteCode file -> do
@@ -378,7 +363,7 @@ mainRule = do
     generateByteCodeRule
     loadGhcSession
     getHieFileRule
-    produceCompletions
+
 
 ------------------------------------------------------------
 

src/Development/IDE/LSP/LanguageServer.hs

@@ -29,8 +29,6 @@ import System.IO
 import Control.Monad.Extra
 
 import Development.IDE.LSP.HoverDefinition
-import Development.IDE.LSP.CodeAction
-import Development.IDE.LSP.Completions
 import Development.IDE.LSP.Notifications
 import Development.IDE.LSP.Outline
 import Development.IDE.Core.Service
@@ -98,8 +96,6 @@ runLanguageServer options userHandlers getIdeState = do
     let PartialHandlers parts =
             setHandlersIgnore <> -- least important
             setHandlersDefinition <> setHandlersHover <>
-            setHandlersCodeAction <> setHandlersCodeLens <> -- useful features someone may override
-            setHandlersCompletion <>
             setHandlersOutline <>
             userHandlers <>
             setHandlersNotifications <> -- absolutely critical, join them with user notifications

src/Development/IDE/LSP/CodeAction.hs renamed to src/Development/IDE/Plugin/CodeAction.hs

@@ -6,7 +6,7 @@
 #include "ghc-api-version.h"
 
 -- | Go to the definition of a variable.
-module Development.IDE.LSP.CodeAction
+module Development.IDE.Plugin.CodeAction
     ( setHandlersCodeAction
     , setHandlersCodeLens
     ) where

src/Development/IDE/LSP/Completions.hs renamed to src/Development/IDE/Plugin/Completions.hs

@@ -1,20 +1,55 @@
-module Development.IDE.LSP.Completions (
-  setHandlersCompletion
+{-# LANGUAGE TypeFamilies #-}
+
+module Development.IDE.Plugin.Completions (
+  setHandlersCompletion, produceCompletions
 ) where
 
 import Language.Haskell.LSP.Messages
 import Language.Haskell.LSP.Types
 import qualified Language.Haskell.LSP.Core as LSP
 import qualified Language.Haskell.LSP.VFS as VFS
 import Language.Haskell.LSP.Types.Capabilities
+import Development.Shake.Classes
+import Development.Shake
+import GHC.Generics
+import Data.Maybe
+import HscTypes
 
 import Development.IDE.Core.Service
-import Development.IDE.Core.Completions
+import Development.IDE.Plugin.Completions.Logic
 import Development.IDE.Types.Location
 import Development.IDE.Core.PositionMapping
 import Development.IDE.Core.RuleTypes
 import Development.IDE.Core.Shake
+import Development.IDE.GHC.Util
 import Development.IDE.LSP.Server
+import Development.IDE.Import.DependencyInformation
+
+
+produceCompletions :: Rules ()
+produceCompletions =
+    define $ \ProduceCompletions file -> do
+        deps <- maybe (TransitiveDependencies [] []) fst <$> useWithStale GetDependencies file
+        tms <- mapMaybe (fmap fst) <$> usesWithStale TypeCheck (transitiveModuleDeps deps)
+        tm <- fmap fst <$> useWithStale TypeCheck file
+        packageState <- fmap (hscEnv . fst) <$> useWithStale GhcSession file
+        case (tm, packageState) of
+            (Just tm', Just packageState') -> do
+                cdata <- liftIO $ cacheDataProducer packageState' (hsc_dflags packageState')
+                                                    (tmrModule tm') (map tmrModule tms)
+                return ([], Just (cdata, tm'))
+            _ -> return ([], Nothing)
+
+
+-- | Produce completions info for a file
+type instance RuleResult ProduceCompletions = (CachedCompletions, TcModuleResult)
+
+data ProduceCompletions = ProduceCompletions
+    deriving (Eq, Show, Typeable, Generic)
+instance Hashable ProduceCompletions
+instance NFData   ProduceCompletions
+instance Binary   ProduceCompletions
+
 
 -- | Generate code actions.
 getCompletionsLSP

src/Development/IDE/Core/Completions.hs renamed to src/Development/IDE/Plugin/Completions/Logic.hs

@@ -1,6 +1,6 @@
 {-# LANGUAGE CPP #-}
 -- Mostly taken from "haskell-ide-engine"
-module Development.IDE.Core.Completions (
+module Development.IDE.Plugin.Completions.Logic (
   CachedCompletions
 , cacheDataProducer
 , WithSnippets(..)
@@ -29,7 +29,7 @@ import DynFlags
 import Language.Haskell.LSP.Types
 import Language.Haskell.LSP.Types.Capabilities
 import qualified Language.Haskell.LSP.VFS as VFS
-import Development.IDE.Core.CompletionsTypes
+import Development.IDE.Plugin.Completions.Types
 import Development.IDE.Spans.Documentation
 import Development.IDE.GHC.Error
 import Development.IDE.Types.Options

src/Development/IDE/Core/CompletionsTypes.hs renamed to src/Development/IDE/Plugin/Completions/Types.hs

@@ -1,5 +1,5 @@
-module Development.IDE.Core.CompletionsTypes (
-  module Development.IDE.Core.CompletionsTypes
+module Development.IDE.Plugin.Completions.Types (
+  module Development.IDE.Plugin.Completions.Types
 ) where
 
 import           Control.DeepSeq