Remove exactprint dependencies from ghcide by introducing hls-refactor-plugin.

All code actions have been moved to hls-refactor-plugin

Mostly straightforward, only slight complication was that completion auto imports
depends on exactprint, but I didn't want to remove all completion logic from ghcide
just for this.

Instead, I added logic to dynamically lookup the plugin that provides
the extend import command, so that auto imports work as expected when you have
hls-refactor-plugin enabled.

Move lookupPluginId out of loop

Replace code actions with lenses in benchmarks

Allow plugins to use GetAnnotatedParsedSource by linking it in when depended on

Move lookupPluginId to IdePlugins

Add default extensions

Move traceAst

Author: wz1000

.github/workflows/test.yml

@@ -160,6 +160,10 @@ jobs:
         name: Test hls-brittany-plugin
         run: cabal test hls-brittany-plugin --test-options="$TEST_OPTS" || cabal test hls-brittany-plugin --test-options="$TEST_OPTS" || LSP_TEST_LOG_COLOR=0 LSP_TEST_LOG_MESSAGES=true LSP_TEST_LOG_STDERR=true cabal test hls-brittany-plugin --test-options="$TEST_OPTS"
 
+      - if: matrix.test
+        name: Test hls-refactor-plugin
+        run: cabal test hls-refactor-plugin --test-options="$TEST_OPTS" || cabal test hls-refactor-plugin --test-options="$TEST_OPTS" || LSP_TEST_LOG_COLOR=0 LSP_TEST_LOG_MESSAGES=true LSP_TEST_LOG_STDERR=true cabal test hls-refactor-plugin --test-options="$TEST_OPTS"
+
       - if: matrix.test
         name: Test hls-floskell-plugin
         run: cabal test hls-floskell-plugin --test-options="$TEST_OPTS" || cabal test hls-floskell-plugin --test-options="$TEST_OPTS" || LSP_TEST_LOG_COLOR=0 LSP_TEST_LOG_MESSAGES=true LSP_TEST_LOG_STDERR=true cabal test hls-floskell-plugin --test-options="$TEST_OPTS"

cabal.project

@@ -32,6 +32,7 @@ packages:
          ./plugins/hls-stan-plugin
          ./plugins/hls-gadt-plugin
          ./plugins/hls-explicit-fixity-plugin
+         ./plugins/hls-refactor-plugin
 
 -- Standard location for temporary packages needed for particular environments
 -- For example it is used in the project gitlab mirror to help in the MAcOS M1 build script

ghcide-bench/src/Experiments.hs

@@ -139,7 +139,7 @@ experiments =
           not . null <$> getCompletions doc (fromJust identifierP),
       ---------------------------------------------------------------------------------------
       benchWithSetup
-        "code actions"
+        "code lens"
         ( \docs -> do
             unless (any (isJust . identifierP) docs) $
                 error "None of the example modules is suitable for this experiment"
@@ -148,13 +148,12 @@ experiments =
                 waitForProgressStart
             waitForProgressDone
         )
-        ( \docs -> not . null . catMaybes <$> forM docs (\DocumentPositions{..} ->
-            forM identifierP $ \p ->
-              getCodeActions doc (Range p p))
+        ( \docs -> not . null <$> forM docs (\DocumentPositions{..} ->
+            getCodeLenses doc)
         ),
       ---------------------------------------------------------------------------------------
       benchWithSetup
-        "code actions after edit"
+        "code lens after edit"
         ( \docs -> do
             unless (any (isJust . identifierP) docs) $
                 error "None of the example modules is suitable for this experiment"
@@ -166,9 +165,8 @@ experiments =
               changeDoc doc [charEdit stringLiteralP]
               waitForProgressStart
             waitForProgressDone
-            not . null . catMaybes <$> forM docs (\DocumentPositions{..} -> do
-              forM identifierP $ \p ->
-                getCodeActions doc (Range p p))
+            not . null <$> forM docs (\DocumentPositions{..} -> do
+              getCodeLenses doc)
         ),
       ---------------------------------------------------------------------------------------
       benchWithSetup

ghcide/ghcide.cabal

@@ -60,7 +60,6 @@ library
         filepath,
         fingertree,
         focus,
-        ghc-exactprint < 1 || >= 1.4,
         ghc-trace-events,
         Glob,
         haddock-library >= 1.8 && < 1.11,
@@ -74,16 +73,13 @@ library
         lsp ^>= 1.5.0.0 ,
         monoid-subclasses,
         mtl,
-        network-uri,
         optparse-applicative,
         parallel,
         prettyprinter-ansi-terminal,
         prettyprinter >= 1.6,
         random,
         regex-tdfa >= 1.3.1.0,
-        retrie,
         text-rope,
-        safe,
         safe-exceptions,
         hls-graph ^>= 1.7,
         sorted-list,
@@ -95,9 +91,7 @@ library
         time,
         transformers,
         unordered-containers >= 0.2.10.0,
-        utf8-string,
         vector,
-        vector-algorithms,
         hslogger,
         Diff ^>=0.4.0,
         vector,
@@ -114,9 +108,6 @@ library
         hie-bios ^>= 0.9.1,
         implicit-hie-cradle ^>= 0.3.0.5 || ^>= 0.5,
         base16-bytestring >=0.1.1 && <1.1
-    if impl(ghc >= 9.2)
-      build-depends:
-        ghc-exactprint >= 1.4
     if os(windows)
       build-depends:
         Win32
@@ -172,7 +163,6 @@ library
         Development.IDE.GHC.Compat
         Development.IDE.GHC.Compat.Core
         Development.IDE.GHC.Compat.Env
-        Development.IDE.GHC.Compat.ExactPrint
         Development.IDE.GHC.Compat.Iface
         Development.IDE.GHC.Compat.Logger
         Development.IDE.GHC.Compat.Outputable
@@ -182,9 +172,7 @@ library
         Development.IDE.GHC.Compat.Util
         Development.IDE.Core.Compile
         Development.IDE.GHC.CoreFile
-        Development.IDE.GHC.Dump
         Development.IDE.GHC.Error
-        Development.IDE.GHC.ExactPrint
         Development.IDE.GHC.Orphans
         Development.IDE.GHC.Util
         Development.IDE.Import.DependencyInformation
@@ -214,8 +202,6 @@ library
         Development.IDE.Plugin
         Development.IDE.Plugin.Completions
         Development.IDE.Plugin.Completions.Types
-        Development.IDE.Plugin.CodeAction
-        Development.IDE.Plugin.CodeAction.ExactPrint
         Development.IDE.Plugin.HLS
         Development.IDE.Plugin.HLS.GhcIde
         Development.IDE.Plugin.Test
@@ -226,8 +212,6 @@ library
         Development.IDE.Core.FileExists
         Development.IDE.GHC.CPP
         Development.IDE.GHC.Warnings
-        Development.IDE.Plugin.CodeAction.PositionIndexed
-        Development.IDE.Plugin.CodeAction.Args
         Development.IDE.Plugin.Completions.Logic
         Development.IDE.Session.VersionCheck
         Development.IDE.Types.Action
@@ -365,6 +349,7 @@ test-suite ghcide-tests
         ghc,
         --------------------------------------------------------------
         ghcide,
+        ghcide-test-utils,
         ghc-typelits-knownnat,
         lsp,
         lsp-types,
@@ -393,12 +378,10 @@ test-suite ghcide-tests
       build-depends:
           record-dot-preprocessor,
           record-hasfield
-    hs-source-dirs: test/cabal test/exe test/src bench/lib
+    hs-source-dirs: test/cabal test/exe bench/lib
     ghc-options: -threaded -Wall -Wno-name-shadowing -O0 -Wno-unticked-promoted-constructors
     main-is: Main.hs
     other-modules:
-        Development.IDE.Test
-        Development.IDE.Test.Diagnostic
         Development.IDE.Test.Runfiles
         FuzzySearch
         Progress
@@ -418,3 +401,42 @@ test-suite ghcide-tests
         TupleSections
         TypeApplications
         ViewPatterns
+
+library ghcide-test-utils
+    visibility: public
+    default-language: Haskell2010
+    build-depends:
+        aeson,
+        base,
+        containers,
+        data-default,
+        directory,
+        extra,
+        filepath,
+        ghcide,
+        lsp-types,
+        hls-plugin-api,
+        lens,
+        lsp-test ^>= 0.14,
+        tasty-hunit >= 0.10,
+        text,
+    hs-source-dirs: test/src
+    ghc-options: -Wunused-packages
+    exposed-modules:
+        Development.IDE.Test
+        Development.IDE.Test.Diagnostic
+    default-extensions:
+        BangPatterns
+        DeriveFunctor
+        DeriveGeneric
+        FlexibleContexts
+        GeneralizedNewtypeDeriving
+        LambdaCase
+        NamedFieldPuns
+        OverloadedStrings
+        RecordWildCards
+        ScopedTypeVariables
+        StandaloneDeriving
+        TupleSections
+        TypeApplications
+        ViewPatterns

ghcide/src/Development/IDE/Core/Rules.hs

@@ -119,7 +119,6 @@ import           Development.IDE.GHC.Compat                   hiding
 import qualified Development.IDE.GHC.Compat                   as Compat hiding (vcat, nest)
 import qualified Development.IDE.GHC.Compat.Util              as Util
 import           Development.IDE.GHC.Error
-import           Development.IDE.GHC.ExactPrint hiding (LogShake, Log)
 import           Development.IDE.GHC.Util                     hiding
                                                               (modifyDynFlags)
 import           Development.IDE.Graph
@@ -154,7 +153,6 @@ import System.Info.Extra (isWindows)
 import HIE.Bios.Ghc.Gap (hostIsDynamic)
 import Development.IDE.Types.Logger (Recorder, logWith, cmapWithPrio, WithPriority, Pretty (pretty), (<+>), nest, vcat)
 import qualified Development.IDE.Core.Shake as Shake
-import qualified Development.IDE.GHC.ExactPrint as ExactPrint hiding (LogShake)
 import qualified Development.IDE.Types.Logger as Logger
 import qualified Development.IDE.Types.Shake as Shake
 import           Development.IDE.GHC.CoreFile
@@ -167,7 +165,6 @@ data Log
   | LogLoadingHieFile !NormalizedFilePath
   | LogLoadingHieFileFail !FilePath !SomeException
   | LogLoadingHieFileSuccess !FilePath
-  | LogExactPrint ExactPrint.Log
   | LogTypecheckedFOI !NormalizedFilePath
   deriving Show
 
@@ -185,7 +182,6 @@ instance Pretty Log where
           , pretty (displayException e) ]
     LogLoadingHieFileSuccess path ->
       "SUCCEEDED LOADING HIE FILE FOR" <+> pretty path
-    LogExactPrint log -> pretty log
     LogTypecheckedFOI path -> vcat
       [ "Typechecked a file which is not currently open in the editor:" <+> pretty (fromNormalizedFilePath path)
       , "This can indicate a bug which results in excessive memory usage."
@@ -1230,7 +1226,6 @@ mainRule recorder RulesConfig{..} = do
       else defineNoDiagnostics (cmapWithPrio LogShake recorder) $ \NeedsCompilation _ -> return $ Just Nothing
     generateCoreRule recorder
     getImportMapRule recorder
-    getAnnotatedParsedSourceRule (cmapWithPrio LogExactPrint recorder)
     persistentHieFileRule recorder
     persistentDocMapRule
     persistentImportMapRule

ghcide/src/Development/IDE/Core/Service.hs

@@ -41,6 +41,7 @@ import           Development.IDE.Core.Shake       hiding (Log)
 import qualified Development.IDE.Core.Shake       as Shake
 import           Development.IDE.Types.Monitoring (Monitoring)
 import           Development.IDE.Types.Shake      (WithHieDb)
+import           Ide.Types                        (IdePlugins)
 import           System.Environment               (lookupEnv)
 
 data Log
@@ -61,6 +62,7 @@ instance Pretty Log where
 -- | Initialise the Compiler Service.
 initialise :: Recorder (WithPriority Log)
            -> Config
+           -> IdePlugins IdeState
            -> Rules ()
            -> Maybe (LSP.LanguageContextEnv Config)
            -> Logger
@@ -70,7 +72,7 @@ initialise :: Recorder (WithPriority Log)
            -> IndexQueue
            -> Monitoring
            -> IO IdeState
-initialise recorder defaultConfig mainRule lspEnv logger debouncer options withHieDb hiedbChan metrics = do
+initialise recorder defaultConfig plugins mainRule lspEnv logger debouncer options withHieDb hiedbChan metrics = do
     shakeProfiling <- do
         let fromConf = optShakeProfiling options
         fromEnv <- lookupEnv "GHCIDE_BUILD_PROFILING"
@@ -79,6 +81,7 @@ initialise recorder defaultConfig mainRule lspEnv logger debouncer options withH
         (cmapWithPrio LogShake recorder)
         lspEnv
         defaultConfig
+        plugins
         logger
         debouncer
         shakeProfiling

ghcide/src/Development/IDE/Core/Shake.hs

@@ -158,7 +158,7 @@ import           GHC.Stack                              (HasCallStack)
 import           HieDb.Types
 import           Ide.Plugin.Config
 import qualified Ide.PluginUtils                        as HLS
-import           Ide.Types                              (PluginId)
+import           Ide.Types                              (PluginId, IdePlugins)
 import           Language.LSP.Diagnostics
 import qualified Language.LSP.Server                    as LSP
 import           Language.LSP.Types
@@ -239,6 +239,7 @@ data ShakeExtras = ShakeExtras
      lspEnv :: Maybe (LSP.LanguageContextEnv Config)
     ,debouncer :: Debouncer NormalizedUri
     ,logger :: Logger
+    ,idePlugins :: IdePlugins IdeState
     ,globals :: TVar (HMap.HashMap TypeRep Dynamic)
       -- ^ Registry of global state used by rules.
       -- Small and immutable after startup, so not worth using an STM.Map.
@@ -552,6 +553,7 @@ seqValue val = case val of
 shakeOpen :: Recorder (WithPriority Log)
           -> Maybe (LSP.LanguageContextEnv Config)
           -> Config
+          -> IdePlugins IdeState
           -> Logger
           -> Debouncer NormalizedUri
           -> Maybe FilePath
@@ -563,7 +565,7 @@ shakeOpen :: Recorder (WithPriority Log)
           -> Monitoring
           -> Rules ()
           -> IO IdeState
-shakeOpen recorder lspEnv defaultConfig logger debouncer
+shakeOpen recorder lspEnv defaultConfig idePlugins logger debouncer
   shakeProfileDir (IdeReportProgress reportProgress)
   ideTesting@(IdeTesting testing)
   withHieDb indexQueue opts monitoring rules = mdo

ghcide/src/Development/IDE/GHC/Compat.hs

@@ -63,7 +63,6 @@ module Development.IDE.GHC.Compat(
     -- * Compat modules
     module Development.IDE.GHC.Compat.Core,
     module Development.IDE.GHC.Compat.Env,
-    module Development.IDE.GHC.Compat.ExactPrint,
     module Development.IDE.GHC.Compat.Iface,
     module Development.IDE.GHC.Compat.Logger,
     module Development.IDE.GHC.Compat.Outputable,
@@ -119,7 +118,6 @@ module Development.IDE.GHC.Compat(
 import           Data.Bifunctor
 import           Development.IDE.GHC.Compat.Core
 import           Development.IDE.GHC.Compat.Env
-import           Development.IDE.GHC.Compat.ExactPrint
 import           Development.IDE.GHC.Compat.Iface
 import           Development.IDE.GHC.Compat.Logger
 import           Development.IDE.GHC.Compat.Outputable

ghcide/src/Development/IDE/GHC/Orphans.hs

@@ -29,8 +29,6 @@ import           Unique                     (getKey)
 #endif
 
 
-import           Retrie.ExactPrint          (Annotated)
-
 import           Development.IDE.GHC.Compat
 import           Development.IDE.GHC.Util
 
@@ -195,12 +193,6 @@ instance NFData ModGuts where
 instance NFData (ImportDecl GhcPs) where
     rnf = rwhnf
 
-instance Show (Annotated ParsedSource) where
-  show _ = "<Annotated ParsedSource>"
-
-instance NFData (Annotated ParsedSource) where
-  rnf = rwhnf
-
 #if MIN_VERSION_ghc(9,0,1)
 instance (NFData HsModule) where
 #else