feat(): finish 3.0.0 release

Author: gbataille

.githudrc

@@ -120,7 +120,7 @@
 # The following config controls the background fetcher daemon behavior called githudd
 # -------------------------------------------------------------------------------------------
 # run_fetcher_daemon=True
-# githudd_sleep_seconds=5       # how long does the daemon sleep between cycles
+# githudd_sleep_seconds=30       # how long does the daemon sleep between cycles
 # githudd_pid_file_path=/usr/local/var/run/githudd.pid
 # githudd_socket_file_path=/usr/local/var/run/githudd.socket
 #

CHANGELOG.md

@@ -1,75 +1,97 @@
-From v2.0.2
------------
+3.0.0
+-----
+* Feat: Add a daemon called `githudd` that will continuously fetch the last git folder where
+  `githud` was executed. In a typical install where `githud` is used in the prompt, that means the
+last git folder browsed.
+* Config: some new configuration has been added for the `githudd` daemon. The default values have
+  been tested on Mac. You can find this new section in the `.githudrc` file in this repo. The new
+parameters are also pasted below along with their default values.
+```
+# -------------------------------------------------------------------------------------------
+# The following config controls the background fetcher daemon behavior called githudd
+# -------------------------------------------------------------------------------------------
+# run_fetcher_daemon=True
+# githudd_sleep_seconds=30       # how long does the daemon sleep between cycles
+# githudd_pid_file_path=/usr/local/var/run/githudd.pid
+# githudd_socket_file_path=/usr/local/var/run/githudd.socket
+#
+# # Githudd logs can be verbose. They are here for debugging only. It is not advised that you
+# # activate them
+# githudd_log_file_path=/dev/null
+```
+
+2.1.0
+-----
 * Feat: Add support for TMUX with `githud tmux`. You can now use tmux inside the status bar or the
   pane title of TMUX for example
 * Feat: Add support for no output formatting with `githud none`.
 
-From v2.0.1
------------
+2.0.2
+-----
 * Fix: Properly reset "normal" styling after displaying "Bold" characters (#13)
 
-From v1.3.7
------------
+2.0.1
+-----
 * BREAKING: the executable is renamed from `gitHUD` to `githud`, as suggested in
   [#14](https://github.com/gbataille/gitHUD/issues/14) by [@voidus](https://github.com/voidus)
 
-From v1.3.6
------------
+1.3.7
+-----
 * When in detached, but on a commit that has a tag, display the tag name rather than the commit SHA
 
-From v1.3.5
------------
+1.3.6
+-----
 * BASH shell: properly escape invisible control characters so that the prompt length is computed
   properly
 
-From v1.3.4
------------
+1.3.5
+-----
 * in 1.3.1 I introduced `merge_branch_ignore_branches` to be able to deal with
   "false" branches like the famous gh-pages. It happens that if this branch
 was properly created as an orphan branch (`git branch --orphan gh-pages`),
 then I can detect that it does not merge back into master and not show this
 part of the prompt automatically without people having to manually maintain
 exception. Thanks to [Markus](https://github.com/mgee) for pointing that out
 
-From v1.3.3
------------
+1.3.4
+-----
 * Minor breaking change: Removed the trailing space. If you need it, just put
   it in your prompt definition
 * Do not override background color. Just act on foreground text color
 
-From v1.3.2
------------
+1.3.3
+-----
 * Merge branch count indicator will not include merge-commit anymore. This is
   actually redundant in all case. In fact, in a develop/master typical flow,
 when develop merges into master and develop and master are actually equal, if
 you count the merge-commit, you'll have the impression that there is a delta
 between the 2 branches
 
-From v1.3.1
------------
+1.3.2
+-----
 * Introduce `merge_branch_ignore_branches` config list that allows to not
   display the merge-branch part of the prompt for certain branch names
 
-From v1.3.0
------------
+1.3.1
+-----
 * Allow for a special "NoColor" configuration color to reset to the terminal
   foreground color
 * NoColor is the default if the config file cannot be read
 * Protect the prompt from possible color set before gitHUD is invoked
 * Branch name has no color by default
 * The default commit pull-push symbol is changed to a (hopefully) clearer '⥯'
 
-From v1.2.0
------------
+1.3.0
+-----
 * Remove dependency on a patched font in the default config
 * Allow for partial prompt through configuration
 
-From v1.1.0
------------
+1.2.0
+-----
 * Configurable "no remote tracking branch" color
 * Fix brew formula in gbataille/homebrew-gba which failed on some configs
 
-From v1.0.0
------------
+1.1.0
+-----
 * Configurable prompt parts (text and colors)
 * Tech: refactoring to a writer and wide test coverage

githud.cabal

@@ -1,6 +1,6 @@
 cabal-version:       2.2
 name:                githud
-version:             2.1.0
+version:             3.0.0
 synopsis:            More efficient replacement to the great git-radar
 description:         Please see README.md (used to be gitHUD)
 homepage:            http://github.com/gbataille/gitHUD#readme

src/GitHUD/Config/Parse.hs

@@ -290,7 +290,7 @@ intParser = read <$> many1 digit
 intConfigToInt :: String -> Int
 intConfigToInt str =
   either
-    (const 5)
+    (const 30)
     id
     (parse intParser "" str)
 

src/GitHUD/Config/Types.hs

@@ -163,7 +163,7 @@ defaultConfig = Config {
   , confStashSuffixIntensity = Vivid
 
   , confRunFetcherDaemon = True
-  , confGithuddSleepSeconds = 5
+  , confGithuddSleepSeconds = 30
   , confGithuddPidFilePath = "/usr/local/var/run/githudd.pid"
   , confGithuddSocketFilePath = "/usr/local/var/run/githudd.socket"
 

src/GitHUD/Daemon/Runner.hs

@@ -14,6 +14,7 @@ import System.Posix.Daemon (isRunning, runDetached, Redirection(DevNull, ToFile)
 import System.Posix.Files (fileExist)
 
 import GitHUD.Config.Types
+import GitHUD.Git.Command
 import GitHUD.Daemon.Network
 
 runDaemon :: Config
@@ -65,7 +66,7 @@ socketClient socketPath mvar =
   fromSocket socketPath withMessage
     where
       withMessage msg = do
-        putStrLn $ "callback with " ++ msg
+        putStrLn $ "Switching to poll " ++ msg
         swapMVar mvar msg
 
 fetcher :: Int
@@ -74,6 +75,6 @@ fetcher :: Int
         -> IO ()
 fetcher delaySec socketPath mvar = do
   path <- readMVar mvar
-  putStrLn $ "fetching " ++ path
+  gitCmdFetch path
   threadDelay $ delaySec * 1_000_000
   return ()

src/GitHUD/Git/Command.hs

@@ -17,7 +17,6 @@ import Control.Concurrent.MVar (MVar, putMVar)
 import GHC.IO.Handle (hGetLine)
 import System.Directory (doesDirectoryExist)
 import System.Exit (ExitCode(ExitSuccess))
-import System.IO (hClose, hPutStrLn, openFile, IOMode(WriteMode))
 import System.Process (readCreateProcess, readProcessWithExitCode, proc, StdStream(CreatePipe, UseHandle), createProcess, CreateProcess(..))
 
 import GitHUD.Process (readProcessWithIgnoreExitCode)
@@ -103,17 +102,12 @@ gitCmdCommitTag out = do
 gitCmdFetch :: String
             -> IO ()
 gitCmdFetch path = do
-  -- TODO: gbataille - code org
   isDir <- doesDirectoryExist path
-  stdout <- openFile "/tmp/out" WriteMode
-  stderr <- openFile "/tmp/err" WriteMode
   if isDir
     then do
-      let fetch_proc = (proc "git" ["fetch"]) { cwd = Just path, std_out = UseHandle stdout, std_err = UseHandle stderr }
+      let fetch_proc = (proc "git" ["fetch"]) { cwd = Just path }
       readCreateProcess fetch_proc ""
       return ()
     else do
-      hPutStrLn stderr ("Folder" ++ path ++ " does not exist")
+      putStrLn ("Folder" ++ path ++ " does not exist")
       return ()
-  hClose stdout
-  hClose stderr