Harmonise CLI flags between ghcide/haskell-ide(-wrapper)

And add --example to enable the Example plugin in haskell-ide

Closes haskell#24

Author: alanz

cabal.project

@@ -6,5 +6,7 @@ tests: true
 
 package ide
   test-show-details: direct
+package ghcide
+  test-show-details: direct
 
 write-ghc-environment-files: never

exe/Arguments.hs

@@ -1,32 +1,73 @@
 -- Copyright (c) 2019 The DAML Authors. All rights reserved.
 -- SPDX-License-Identifier: Apache-2.0
+{-# LANGUAGE CPP #-} -- To get precise GHC version
+{-# LANGUAGE RecordWildCards #-}
+{-# LANGUAGE TemplateHaskell #-}
+{-# LANGUAGE TupleSections #-}
+{-# LANGUAGE ViewPatterns #-}
+{-# OPTIONS_GHC -Wno-dodgy-imports #-} -- GHC no longer exports def in GHC 8.6 and above
 
-module Arguments(Arguments(..), getArguments) where
+module Arguments
+  ( Arguments(..)
+  , getArguments
+  , ghcideVersion
+  , getLibdir
+  ) where
 
+import Data.Maybe
+import Data.Version
+import Development.GitRev
+import qualified GHC.Paths
 import Options.Applicative
+import Paths_ide
+import System.Environment
 
+-- ---------------------------------------------------------------------
 
 data Arguments = Arguments
     {argLSP :: Bool
     ,argsCwd :: Maybe FilePath
     ,argFiles :: [FilePath]
     ,argsVersion :: Bool
     ,argsShakeProfiling :: Maybe FilePath
+    ,argsExamplePlugin :: Bool
     }
 
-getArguments :: IO Arguments
-getArguments = execParser opts
+getArguments :: String -> IO Arguments
+getArguments exeName = execParser opts
   where
-    opts = info (arguments <**> helper)
+    opts = info (arguments exeName <**> helper)
       ( fullDesc
      <> progDesc "Used as a test bed to check your IDE will work"
-     <> header "ghcide - the core of a Haskell IDE")
+     <> header (exeName ++ " - GHC Haskell LSP server"))
 
-arguments :: Parser Arguments
-arguments = Arguments
+arguments :: String -> Parser Arguments
+arguments exeName = Arguments
       <$> switch (long "lsp" <> help "Start talking to an LSP server")
-      <*> optional (strOption $ long "cwd" <> metavar "DIR" <> help "Change to this directory")
+      <*> optional (strOption $ long "cwd" <> metavar "DIR"
+                    <> help "Change to this directory")
       <*> many (argument str (metavar "FILES/DIRS..."))
-      <*> switch (long "version" <> help "Show ghcide and GHC versions")
-      <*> optional (strOption $ long "shake-profiling" <> metavar "DIR" <> help "Dump profiling reports to this directory")
+      <*> switch (long "version"
+                  <> help ("Show " ++ exeName  ++ " and GHC versions"))
+      <*> optional (strOption $ long "shake-profiling" <> metavar "DIR"
+                    <> help "Dump profiling reports to this directory")
+      <*> switch (long "example"
+                  <> help "Include the Example Plugin. For Plugin devs only")
 
+-- ---------------------------------------------------------------------
+-- Set the GHC libdir to the nix libdir if it's present.
+getLibdir :: IO FilePath
+getLibdir = fromMaybe GHC.Paths.libdir <$> lookupEnv "NIX_GHC_LIBDIR"
+
+ghcideVersion :: IO String
+ghcideVersion = do
+  path <- getExecutablePath
+  let gitHashSection = case $(gitHash) of
+        x | x == "UNKNOWN" -> ""
+        x -> " (GIT hash: " <> x <> ")"
+  return $ "ghcide version: " <> showVersion version
+             <> " (GHC: " <> VERSION_ghc
+             <> ") (PATH: " <> path <> ")"
+             <> gitHashSection
+
+-- ---------------------------------------------------------------------

exe/Main.hs

@@ -1,8 +1,6 @@
 -- Copyright (c) 2019 The DAML Authors. All rights reserved.
 -- SPDX-License-Identifier: Apache-2.0
 {-# OPTIONS_GHC -Wno-dodgy-imports #-} -- GHC no longer exports def in GHC 8.6 and above
-{-# LANGUAGE CPP #-} -- To get precise GHC version
-{-# LANGUAGE TemplateHaskell #-}
 {-# LANGUAGE RecordWildCards #-}
 {-# LANGUAGE ViewPatterns #-}
 {-# LANGUAGE TupleSections #-}
@@ -37,51 +35,37 @@ import qualified Data.Text.IO as T
 import Language.Haskell.LSP.Messages
 import Language.Haskell.LSP.Types (LspId(IdInt))
 import Linker
-import Data.Version
 import Development.IDE.LSP.LanguageServer
 import System.Directory.Extra as IO
-import System.Environment
 import System.IO
 import System.Exit
-import Paths_ide
-import Development.GitRev
 import Development.Shake (Action, action)
 import qualified Data.Set as Set
 import qualified Data.Map.Strict as Map
 
 import GHC hiding (def)
-import qualified GHC.Paths
 
 import HIE.Bios
 
 -- ---------------------------------------------------------------------
 
-import Ide.Plugin.Example as Example
+import Development.IDE.Plugin.CodeAction  as CodeAction
 import Development.IDE.Plugin.Completions as Completions
-import Development.IDE.Plugin.CodeAction as CodeAction
+import Ide.Plugin.Example                 as Example
 
 -- ---------------------------------------------------------------------
 
--- Set the GHC libdir to the nix libdir if it's present.
-getLibdir :: IO FilePath
-getLibdir = fromMaybe GHC.Paths.libdir <$> lookupEnv "NIX_GHC_LIBDIR"
-
-ghcideVersion :: IO String
-ghcideVersion = do
-  path <- getExecutablePath
-  let gitHashSection = case $(gitHash) of
-        x | x == "UNKNOWN" -> ""
-        x -> " (GIT hash: " <> x <> ")"
-  return $ "ghcide version: " <> showVersion version
-             <> " (GHC: " <> VERSION_ghc
-             <> ") (PATH: " <> path <> ")"
-             <> gitHashSection
+idePlugins :: Bool -> Plugin
+idePlugins includeExample
+  = Completions.plugin <>
+    CodeAction.plugin <>
+    if includeExample then Example.plugin else mempty
 
 main :: IO ()
 main = do
     -- WARNING: If you write to stdout before runLanguageServer
     --          then the language server will not work
-    Arguments{..} <- getArguments
+    Arguments{..} <- getArguments "haskell-ide"
 
     if argsVersion then ghcideVersion >>= putStrLn >> exitSuccess
     else hPutStrLn stderr {- see WARNING above -} =<< ghcideVersion
@@ -95,8 +79,7 @@ main = do
 
     dir <- getCurrentDirectory
 
-    let plugins = Completions.plugin <> CodeAction.plugin
-                  <> Example.plugin
+    let plugins = idePlugins argsExamplePlugin
 
     if argLSP then do
         t <- offsetTime

exe/Wrapper.hs

@@ -1,70 +1,58 @@
 {-# LANGUAGE CPP             #-}
+{-# LANGUAGE RecordWildCards #-}
 -- | This module is based on the hie-wrapper.sh script in
 -- https://github.com/alanz/vscode-hie-server
 module Main where
 
 #if __GLASGOW_HASKELL__ < 804
 import           Data.Semigroup
 #endif
+
+import Arguments
+import Control.Concurrent.Extra
+import Control.Monad.Extra
 import           Data.Foldable
 import           Data.List
-import           Data.Version                          (showVersion)
-import           HIE.Bios
+import Data.List.Extra
+import qualified Data.Text as T
+import qualified Data.Text.IO as T
+import Development.IDE.Types.Logger
+import HIE.Bios
 import           Ide.Cradle (findLocalCradle, logm)
-import           Ide.Options
 import           Ide.Version
-import qualified Language.Haskell.LSP.Core             as Core
-import           Options.Applicative.Simple
-import qualified Paths_ide                             as Meta
 import           System.Directory
 import           System.Environment
+import System.Exit
 import           System.FilePath
+import System.IO
 import           System.Info
-import qualified System.Log.Logger as L
 import           System.Process
 
 -- ---------------------------------------------------------------------
 
 main :: IO ()
 main = do
-    let
-        numericVersion :: Parser (a -> a)
-        numericVersion =
-            infoOption
-                (showVersion Meta.version)
-                (long "numeric-version" <>
-                 help "Show only version number")
-        compiler :: Parser (a -> a)
-        compiler =
-            infoOption
-                hieGhcDisplayVersion
-                (long "compiler" <>
-                 help "Show only compiler and version supported")
-    -- Parse the options and run
-    (global, ()) <-
-        simpleOptions
-            hieVersion
-            "haskell-ide-wrapper - Launch the appropriate haskell-ide for a given project"
-            ""
-            (numericVersion <*> compiler <*> globalOptsParser)
-            empty
-
-    run global
+  -- WARNING: If you write to stdout before runLanguageServer
+  --          then the language server will not work
+  Arguments{..} <- getArguments "haskell-ide"
 
--- ---------------------------------------------------------------------
+  if argsVersion then ghcideVersion >>= putStrLn >> exitSuccess
+  else hPutStrLn stderr {- see WARNING above -} =<< ghcideVersion
 
-run :: GlobalOpts -> IO ()
-run opts = do
-  let mLogFileName = optLogFile opts
+  -- lock to avoid overlapping output on stdout
+  -- lock <- newLock
+  -- let logger p = Logger $ \pri msg -> when (pri >= p) $ withLock lock $
+  --         T.putStrLn $ T.pack ("[" ++ upper (show pri) ++ "] ") <> msg
 
-      logLevel = if optDebugOn opts
-                   then L.DEBUG
-                   else L.INFO
+  whenJust argsCwd setCurrentDirectory
 
-  Core.setupLogger mLogFileName ["hie"] logLevel
+  -- let mLogFileName = optLogFile opts
 
-  maybe (pure ()) setCurrentDirectory $ projectRoot opts
+  --     logLevel = if optDebugOn opts
+  --                  then L.DEBUG
+  --                  else L.INFO
 
+  -- Core.setupLogger mLogFileName ["hie"] logLevel
 
   progName <- getProgName
   logm $  "run entered for haskell-ide-wrapper(" ++ progName ++ ") " ++ hieVersion

hie.yaml.cbl

@@ -16,3 +16,9 @@ cradle:
 
     - path: "./src"
       component: "lib:ide"
+
+    - path: "./ghcide/src"
+      component: "ghcide:lib:ghcide"
+
+    - path: "./ghcide/exe"
+      component: "ghcide:exe:ghcide"

ide.cabal

@@ -30,7 +30,6 @@ library
   exposed-modules:
       Ide.Cradle
       Ide.Plugin.Example
-      Ide.Options
       Ide.Version
   other-modules:
       Paths_ide
@@ -90,10 +89,13 @@ library
 
 executable haskell-ide
   main-is: Main.hs
-  other-modules:
-      Paths_ide
   hs-source-dirs:
       exe
+  other-modules:
+      Arguments
+      Paths_ide
+  autogen-modules:
+      Paths_ide
   ghc-options:
               -threaded
               -Wall
@@ -118,7 +120,6 @@ executable haskell-ide
     , ghc
     , ghc-paths
     , ghcide
-    , ghcide
     , gitrev
     , haskell-lsp
     , hie-bios >= 0.3.2 && < 0.4
@@ -127,31 +128,48 @@ executable haskell-ide
     , optparse-applicative
     , shake >= 0.17.5
     , text
-  other-modules:
-      Arguments
-      Paths_ide
   default-language: Haskell2010
 
 executable haskell-ide-wrapper
-  hs-source-dirs:      exe
-  main-is:             Wrapper.hs
-  other-modules:       Paths_ide
-  autogen-modules:     Paths_ide
-  build-depends:       base
-                     , directory
-                     , filepath
-                     , haskell-lsp
-                     , hie-bios
-                     , hslogger
-                     , optparse-simple
-                     , process
-                     , ide
-  ghc-options:         -threaded -rtsopts -with-rtsopts=-N -Wall -Wredundant-constraints
-                       -with-rtsopts=-T
+  main-is: Wrapper.hs
+  hs-source-dirs:
+      exe
+  other-modules:
+      Arguments
+      Paths_ide
+  autogen-modules:
+      Paths_ide
+  ghc-options:
+              -threaded
+              -Wall
+              -Wno-name-shadowing
+              -Wredundant-constraints
+              -- allow user RTS overrides
+              -rtsopts
+              -- disable idle GC
+              -- disable parallel GC
+              -- increase nursery size
+              "-with-rtsopts=-I0 -qg -A128M"
   if flag(pedantic)
      ghc-options:      -Werror
+  build-depends:
+      base
+    , directory
+    , extra
+    , filepath
+    , gitrev
+    , ghc
+    , ghcide
+    , ghc-paths
+    , haskell-lsp
+    , hie-bios
+    , ide
+    , optparse-applicative
+    , process
+    , text
   default-language:    Haskell2010
 
+
 test-suite test
   type: exitcode-stdio-1.0
   main-is: Spec.hs