extract haskell-language-server:plugins and let go of examples

pepeiborra · pepeiborra · commit b7716a4cb4fc · 2022-08-24T13:17:36.000+01:00
The main goal here is to move the Plugins module into an internal
library so that it can be reused from the benchmark suite.

In order to
make that easier, and since they hardly serve a purpose in a repository
with 25 plugins, I delete the Example and Example2 plugin descriptors
and their dependencies.
diff --git a/exe/Main.hs b/exe/Main.hs
@@ -20,6 +20,7 @@ import           Development.IDE.Types.Logger (Doc,
                                                payload, renderStrict,
                                                withDefaultRecorder)
 import qualified Development.IDE.Types.Logger as Logger
+import qualified HlsPlugins                   as Plugins
 import           Ide.Arguments                (Arguments (..),
                                                GhcideArguments (..),
                                                getArguments)
@@ -31,7 +32,6 @@ import           Ide.Types                    (PluginDescriptor (pluginNotificat
                                                mkPluginNotificationHandler)
 import           Language.LSP.Server          as LSP
 import           Language.LSP.Types           as LSP
-import qualified Plugins
 #if MIN_VERSION_prettyprinter(1,7,0)
 import           Prettyprinter                (Pretty (pretty), vsep)
 #else
@@ -52,7 +52,7 @@ main = do
     -- plugin cli commands use stderr logger for now unless we change the args
     -- parser to get logging arguments first or do more complicated things
     pluginCliRecorder <- cmapWithPrio pretty <$> makeDefaultStderrRecorder Nothing Info
-    args <- getArguments "haskell-language-server" (Plugins.idePlugins (cmapWithPrio LogPlugins pluginCliRecorder) False)
+    args <- getArguments "haskell-language-server" (Plugins.idePlugins (cmapWithPrio LogPlugins pluginCliRecorder))
 
     (lspLogRecorder, cb1) <- Logger.withBacklog Logger.lspClientLogRecorder
     (lspMessageRecorder, cb2) <- Logger.withBacklog Logger.lspClientMessageRecorder
@@ -64,12 +64,12 @@ main = do
               liftIO $ (cb1 <> cb2) env
           }
 
-    let (argsTesting, minPriority, logFilePath, includeExamplePlugins) =
+    let (argsTesting, minPriority, logFilePath) =
           case args of
-            Ghcide GhcideArguments{ argsTesting, argsDebugOn, argsLogFile, argsExamplePlugin } ->
+            Ghcide GhcideArguments{ argsTesting, argsDebugOn, argsLogFile} ->
               let minPriority = if argsDebugOn || argsTesting then Debug else Info
-              in (argsTesting, minPriority, argsLogFile, argsExamplePlugin)
-            _ -> (False, Info, Nothing, False)
+              in (argsTesting, minPriority, argsLogFile)
+            _ -> (False, Info, Nothing)
 
     withDefaultRecorder logFilePath Nothing minPriority $ \textWithPriorityRecorder -> do
       let
@@ -87,7 +87,7 @@ main = do
                 -- ability of lsp-test to detect a stuck server in tests and benchmarks
                 & if argsTesting then cfilter (not . heapStats . snd . payload) else id
             ]
-        plugins = (Plugins.idePlugins (cmapWithPrio LogPlugins recorder) includeExamplePlugins)
+        plugins = (Plugins.idePlugins (cmapWithPrio LogPlugins recorder))
 
       defaultMain
         (cmapWithPrio LogIdeMain recorder)
diff --git a/haskell-language-server.cabal b/haskell-language-server.cabal
@@ -233,12 +233,6 @@ flag dynamic
   default:     True
   manual:      True
 
-common example-plugins
-  hs-source-dirs: plugins/default/src
-  other-modules: Ide.Plugin.Example,
-                 Ide.Plugin.Example2,
-                 Ide.Plugin.ExampleCabal
-
 common class
   if flag(class)
     build-depends: hls-class-plugin ^>= 1.0
@@ -366,13 +360,12 @@ common brittany
     build-depends: hls-brittany-plugin ^>= 1.0
     cpp-options: -Dhls_brittany
 
-executable haskell-language-server
+library plugins
   import:             common-deps
                     -- configuration
                     , warnings
                     , pedantic
                     -- plugins
-                    , example-plugins
                     , callHierarchy
                     , changeTypeSignature
                     , class
@@ -398,10 +391,20 @@ executable haskell-language-server
                     , ormolu
                     , stylishHaskell
                     , brittany
+  exposed-modules: HlsPlugins
+  hs-source-dirs: src
+
+  build-depends: ghcide, hls-plugin-api
+  default-language: Haskell2010
+  default-extensions: DataKinds, TypeOperators
 
+executable haskell-language-server
+  import:           common-deps
+                    -- configuration
+                  , warnings
+                  , pedantic
   main-is:          Main.hs
   hs-source-dirs:   exe
-  other-modules:    Plugins
 
   ghc-options:
     -threaded
@@ -412,8 +415,6 @@ executable haskell-language-server
     -- Enable collection of heap statistics
     "-with-rtsopts=-I0 -A128M -T"
     -Wno-unticked-promoted-constructors
-  if flag(pedantic)
-    ghc-options: -Werror
   if !os(windows) && flag(dynamic)
   -- We want to link against the dyn rts just like official GHC binaries do;
   --   the linked rts determines how external libs are loaded dynamically by TH.
@@ -438,6 +439,7 @@ executable haskell-language-server
     , ghcide
     , hashable
     , haskell-language-server
+    , haskell-language-server:plugins
     , lsp
     , hie-bios
     , hiedb
diff --git a/src/HlsPlugins.hs b/src/HlsPlugins.hs
@@ -1,7 +1,7 @@
 {-# LANGUAGE CPP                       #-}
 {-# LANGUAGE ExistentialQuantification #-}
 {-# LANGUAGE OverloadedStrings         #-}
-module Plugins where
+module HlsPlugins where
 
 import           Development.IDE.Types.Logger      (Pretty (pretty), Recorder,
                                                     WithPriority, cmapWithPrio)
@@ -11,9 +11,6 @@ import           Ide.Types                         (IdePlugins)
 -- fixed plugins
 import           Development.IDE                   (IdeState)
 import qualified Development.IDE.Plugin.HLS.GhcIde as GhcIde
-import qualified Ide.Plugin.Example                as Example
-import qualified Ide.Plugin.Example2               as Example2
-import qualified Ide.Plugin.ExampleCabal           as ExampleCabal
 
 -- haskell-language-server optional plugins
 #if hls_qualifyImportedNames
@@ -130,15 +127,12 @@ instance Pretty Log where
 -- These can be freely added or removed to tailor the available
 -- features of the server.
 
-idePlugins :: Recorder (WithPriority Log) -> Bool -> IdePlugins IdeState
-idePlugins recorder includeExamples = pluginDescToIdePlugins allPlugins
+idePlugins :: Recorder (WithPriority Log) -> IdePlugins IdeState
+idePlugins recorder = pluginDescToIdePlugins allPlugins
   where
     pluginRecorder :: forall log. (Pretty log) => Recorder (WithPriority log)
     pluginRecorder = cmapWithPrio Log recorder
-    allPlugins = if includeExamples
-                   then basePlugins ++ examplePlugins
-                   else basePlugins
-    basePlugins =
+    allPlugins =
 #if hls_pragmas
       Pragmas.descriptor  "pragmas" :
 #endif
@@ -215,9 +209,4 @@ idePlugins recorder includeExamples = pluginDescToIdePlugins allPlugins
 #if explicitFixity
       ++ [ExplicitFixity.descriptor pluginRecorder]
 #endif
-    examplePlugins =
-      [Example.descriptor  pluginRecorder "eg"
-      ,Example2.descriptor pluginRecorder "eg2"
-      ,ExampleCabal.descriptor pluginRecorder "ec"
-      ]
 
diff --git a/test/functional/Diagnostic.hs b/test/functional/Diagnostic.hs
@@ -10,23 +10,8 @@ import           Test.Hls.Command
 -- ---------------------------------------------------------------------
 
 tests :: TestTree
-tests = testGroup "diagnostics providers" [
-        basicTests
-        , warningTests
-    ]
+tests = testGroup "diagnostics providers" [ warningTests ]
 
-basicTests :: TestTree
-basicTests = testGroup "Diagnostics work" [
-    testCase "example plugin produces diagnostics" $
-        runSession hlsCommandExamplePlugin fullCaps "test/testdata/diagnostics" $ do
-            doc <- openDoc "Foo.hs" "haskell"
-            diags <- waitForDiagnosticsFromSource doc "example2"
-            reduceDiag <- liftIO $ inspectDiagnostic diags ["example2 diagnostic, hello world"]
-            liftIO $ do
-                length diags @?= 1
-                reduceDiag ^. LSP.range @?= Range (Position 0 0) (Position 1 0)
-                reduceDiag ^. LSP.severity @?= Just DsError
-    ]
 
 warningTests :: TestTree
 warningTests = testGroup  "Warnings are warnings" [
