Merge pull request #11 from tchoutri/verbose-mode

Implement a verbose mode

app/Main.hs

@@ -22,6 +22,7 @@ import Confer.Effect.Symlink
 
 data Options = Options
   { dryRun :: Bool
+  , verbose :: Bool
   , configurationFile :: Maybe OsPath
   , cliCommand :: Command
   }
@@ -50,6 +51,7 @@ parseOptions =
   Options
     <$> switch
       (long "dry-run" <> help "Do not perform actual file system operations")
+    <*> switch (long "verbose" <> help "Make the program more talkative")
     <*> optional (option osPathOption (long "deployments-file" <> metavar "FILENAME" <> help "Use the specified the deployments.lua file"))
     <*> parseCommand
 
@@ -72,23 +74,23 @@ runOptions
      )
   => Options
   -> Eff es ()
-runOptions (Options dryRun configurationFile Check) = do
-  deployments <- processConfiguration configurationFile
+runOptions (Options dryRun verbose configurationFile Check) = do
+  deployments <- processConfiguration verbose configurationFile
   if dryRun
     then
-      Cmd.check deployments
+      Cmd.check verbose deployments
         & runSymlinkPure Map.empty
     else
-      Cmd.check deployments
+      Cmd.check verbose deployments
         & runSymlinkIO
-runOptions (Options dryRun configurationFile Deploy) = do
-  deployments <- processConfiguration configurationFile
+runOptions (Options dryRun verbose configurationFile Deploy) = do
+  deployments <- processConfiguration verbose configurationFile
   if dryRun
     then
-      Cmd.deploy deployments
+      Cmd.deploy verbose deployments
         & runSymlinkPure Map.empty
     else
-      Cmd.deploy deployments
+      Cmd.deploy verbose deployments
         & runSymlinkIO
 
 withInfo :: Parser a -> String -> ParserInfo a

cabal.project

@@ -14,7 +14,9 @@ profiling: True
 
 library-profiling: True
 
-semaphore: True
+-- semaphore: True
+
+-- multi-repl: True
 
 jobs: $ncpus
 

src/Confer/CLI/Cmd/Check.hs

@@ -1,31 +1,18 @@
 module Confer.CLI.Cmd.Check (check) where
 
 import Control.Monad
-import Control.Placeholder
-import Data.Foldable
-import Data.Function
 import Data.List.NonEmpty
 import Data.List.NonEmpty qualified as NE
-import Data.Text (Text)
-import Data.Text qualified as Text
 import Data.Text.Display
 import Data.Text.IO qualified as Text
 import Data.Vector (Vector)
 import Data.Vector qualified as Vector
 import Effectful
 import Effectful.Error.Static (Error)
 import Effectful.Error.Static qualified as Error
-import Effectful.FileSystem (FileSystem)
-import Effectful.FileSystem qualified as FileSystem
-import System.Exit qualified as System
-import System.Info qualified as System
-import System.OsPath (OsPath)
-import System.OsPath qualified as OsPath
 import Validation
 
 import Confer.CLI.Errors (CLIError (..))
-import Confer.CLI.Errors qualified as Errors
-import Confer.Config.Evaluator
 import Confer.Config.Types
 import Confer.Effect.Symlink (Symlink, SymlinkError (..))
 import Confer.Effect.Symlink qualified as Symlink
@@ -35,14 +22,15 @@ check
      , Symlink :> es
      , Error CLIError :> es
      )
-  => Vector Deployment
+  => Bool
+  -> Vector Deployment
   -> Eff es ()
-check deployments = do
+check verbose deployments = do
   result <-
     mconcat . Vector.toList <$> do
       let facts :: Vector Fact = foldMap (.facts) deployments
       forM facts $ \fact -> do
-        liftIO $ Text.putStrLn $ "[+] Checking " <> display fact
+        liftIO $ Text.putStrLn $ "Checking " <> display fact
         validateSymlink fact
   case result of
     Failure errors -> do

src/Confer/CLI/Cmd/Deploy.hs

@@ -27,9 +27,10 @@ deploy
      , Symlink :> es
      , IOE :> es
      )
-  => Vector Deployment
+  => Bool
+  -> Vector Deployment
   -> Eff es ()
-deploy deployments = do
+deploy verbose deployments = do
   forM_ deployments $ \d ->
     forM_ d.facts $ \fact -> do
       filepath <- liftIO $ OsPath.decodeFS fact.destination

src/Confer/Config/ConfigFile.hs

@@ -32,18 +32,20 @@ processConfiguration
      , FileSystem :> es
      , Error CLIError :> es
      )
-  => Maybe OsPath
+  => Bool
+  -> Maybe OsPath
   -> Eff es (Vector Deployment)
-processConfiguration mConfigurationFilePath = do
+processConfiguration verbose mConfigurationFilePath = do
   pathToConfigFile <- determineConfigurationFilePath mConfigurationFilePath
-  loadConfiguration pathToConfigFile >>= \case
+  loadConfiguration verbose pathToConfigFile >>= \case
     Right allDeployments -> do
       let currentOS = OS (Text.pack System.os)
       let currentArch = Arch (Text.pack System.arch)
       currentHost <- Text.pack <$> liftIO getHostName
-      liftIO $ Text.putStrLn $ "Hostname: " <> currentHost <> " (detected)"
-      liftIO $ Text.putStrLn $ "OS: " <> display currentOS <> " (detected)"
-      liftIO $ Text.putStrLn $ "Architecture: " <> display currentArch <> " (detected)"
+      when verbose $ do
+        liftIO $ Text.putStrLn $ "Hostname: " <> currentHost <> " (detected)"
+        liftIO $ Text.putStrLn $ "OS: " <> display currentOS <> " (detected)"
+        liftIO $ Text.putStrLn $ "Architecture: " <> display currentArch <> " (detected)"
       let deployments =
             adjustConfiguration
               currentHost

src/Confer/Config/Evaluator.hs

@@ -3,7 +3,7 @@ module Confer.Config.Evaluator
   , adjustConfiguration
   ) where
 
-import Control.Monad (void)
+import Control.Monad (void, when)
 import Control.Placeholder
 import Data.Maybe (isNothing)
 import Data.Text (Text)
@@ -52,22 +52,29 @@ loadConfiguration
   :: ( IOE :> es
      , FileSystem :> es
      )
-  => OsPath
+  => Bool
+  -> OsPath
   -> Eff es (Either String (Vector Deployment))
-loadConfiguration pathToConfigFile = do
+loadConfiguration verbose pathToConfigFile = do
   userModule <- API.mkUserModule
   hostModule <- API.mkHostModule
   liftIO $ Lua.run $ do
     Lua.openlibs -- load the default Lua packages
     conferLuaFilePath <- liftIO $ getDataFileName "runtime/lua/confer.lua"
-    liftIO $ Text.putStrLn $ "Loading " <> Text.pack conferLuaFilePath
+    when verbose $
+      liftIO $
+        Text.putStrLn $
+          "Loading " <> Text.pack conferLuaFilePath
     Lua.dofile (Just conferLuaFilePath)
     Lua.setglobal "confer"
     Lua.registerModule Lua.System.documentedModule
     Lua.registerModule userModule
     Lua.registerModule hostModule
     configFilePath <- liftIO $ OsPath.decodeFS pathToConfigFile
-    liftIO $ Text.putStrLn $ "Loading " <> Text.pack (show configFilePath)
+    when verbose $
+      liftIO $
+        Text.putStrLn $
+          "Loading " <> Text.pack configFilePath
     Lua.dofile (Just configFilePath)
       >>= \case Lua.OK -> pure (); _ -> Lua.throwErrorAsException
     Lua.resultToEither <$> Lua.runPeeker peekConfig Lua.top