Implemented --flatten option: show only one status per line

Author: fboender

README.md

@@ -33,19 +33,21 @@ for that repo to `true`. (See "usage" below for an example).
 
 # Usage
 
-    Usage: ./mgitstatus [--version] [-w] [-e] [-f] [--no-X] [-d/--depth=2] [DIR [DIR]...]
+    Usage: mgitstatus [--version] [-w] [-e] [-f] [--throttle SEC] [-c] [-d/--depth=2] [--flatten] [--no-X] [DIR [DIR]...]
 
     mgitstatus shows uncommitted, untracked and unpushed changes in multiple Git
     repositories. By default, mgitstatus scans two directories deep. This can be
     changed with the -d (--depth) option.  If DEPTH is 0, the scan is infinitely
     deep.
 
-      --version      Show version
-      -w             Warn about dirs that are not Git repositories
-      -e             Exclude repos that are 'ok'
-      -f             Do a 'git fetch' on each repo (slow for many repos)
-      -c             Force color output (preserve colors when using pipes)
-      -d, --depth=2  Scan this many directories deep
+      --version        Show version
+      -w               Warn about dirs that are not Git repositories
+      -e               Exclude repos that are 'ok'
+      -f               Do a 'git fetch' on each repo (slow for many repos)
+      --throttle SEC   Wait SEC seconds between each 'git fetch' (-f option)
+      -c               Force color output (preserve colors when using pipes)
+      -d, --depth=2    Scan this many directories deep
+      --flatten        Show only one status per line
 
     You can limit output with the following options:
 

mgitstatus

@@ -8,7 +8,7 @@ DEBUG=0
 usage () {
     cat << EOF >&2
     
-Usage: $0 [--version] [-w] [-e] [-f] [--throttle SEC] [--no-X] [-d/--depth=2] [DIR [DIR]...]
+Usage: $0 [--version] [-w] [-e] [-f] [--throttle SEC] [-c] [-d/--depth=2] [--flatten] [--no-X] [DIR [DIR]...]
 
 mgitstatus shows uncommitted, untracked and unpushed changes in multiple Git
 repositories. By default, mgitstatus scans two directories deep. This can be
@@ -22,6 +22,7 @@ deep.
   --throttle SEC   Wait SEC seconds between each 'git fetch' (-f option)
   -c               Force color output (preserve colors when using pipes)
   -d, --depth=2    Scan this many directories deep
+  --flatten        Show only one status per line
 
 You can limit output with the following options:
 
@@ -40,6 +41,7 @@ WARN_NOT_REPO=0
 EXCLUDE_OK=0
 DO_FETCH=0
 FORCE_COLOR=0
+FLATTEN=0
 NO_PUSH=0
 NO_PULL=0
 NO_UPSTREAM=0
@@ -73,6 +75,9 @@ while [ -n "$1" ]; do
     if [ "$1" = "-c" ]; then
         FORCE_COLOR=1
     fi
+    if [ "$1" = "--flatten" ]; then
+        FLATTEN=1
+    fi
     if [ "$1" = "--no-push" ]; then
         NO_PUSH=1
     fi
@@ -253,35 +258,52 @@ for DIR in "${@:-"."}"; do
         STASHES=$(git stash list | wc -l)
         cd "$OLDPWD" || exit
 
-        # Build up the status string
+        # Build up the status string if not flattening. Otherwise, print
+        # results immediately.
         IS_OK=0  # 0 = Repo needs something, 1 = Repo needs nothing ('ok')
         STATUS_NEEDS=""
         if [ -n "$NEEDS_PUSH_BRANCHES" ] && [ "$NO_PUSH" -eq 0 ]; then
-            STATUS_NEEDS="${STATUS_NEEDS}${C_NEEDS_PUSH}Needs push ($NEEDS_PUSH_BRANCHES)${C_RESET} "
+            THIS_STATUS="${C_NEEDS_PUSH}Needs push ($NEEDS_PUSH_BRANCHES)${C_RESET}"
+            STATUS_NEEDS="${STATUS_NEEDS}${THIS_STATUS} "
+            [ "$FLATTEN" -eq 1 ] && printf "${PROJ_DIR}: $THIS_STATUS\n"
         fi
         if [ -n "$NEEDS_PULL_BRANCHES" ] && [ "$NO_PULL" -eq 0 ]; then
-            STATUS_NEEDS="${STATUS_NEEDS}${C_NEEDS_PULL}Needs pull ($NEEDS_PULL_BRANCHES)${C_RESET} "
+            THIS_STATUS="${C_NEEDS_PULL}Needs pull ($NEEDS_PULL_BRANCHES)${C_RESET}"
+            STATUS_NEEDS="${STATUS_NEEDS}${THIS_STATUS} "
+            [ "$FLATTEN" -eq 1 ] && printf "${PROJ_DIR}: $THIS_STATUS\n"
         fi
         if [ -n "$NEEDS_UPSTREAM_BRANCHES" ] && [ "$NO_UPSTREAM" -eq 0 ]; then
-            STATUS_NEEDS="${STATUS_NEEDS}${C_NEEDS_UPSTREAM}Needs upstream ($NEEDS_UPSTREAM_BRANCHES)${C_RESET} "
+            THIS_STATUS="${C_NEEDS_UPSTREAM}Needs upstream ($NEEDS_UPSTREAM_BRANCHES)${C_RESET}"
+            STATUS_NEEDS="${STATUS_NEEDS}${THIS_STATUS} "
+            [ "$FLATTEN" -eq 1 ] && printf "${PROJ_DIR}: $THIS_STATUS\n"
         fi
         if [ "$UNSTAGED" -ne 0 ] || [ "$UNCOMMITTED" -ne 0 ] && [ "$NO_UNCOMMITTED" -eq 0 ]; then
-            STATUS_NEEDS="${STATUS_NEEDS}${C_NEEDS_COMMIT}Uncommitted changes${C_RESET} "
+            THIS_STATUS="${C_NEEDS_COMMIT}Uncommitted changes${C_RESET}"
+            STATUS_NEEDS="${STATUS_NEEDS}${THIS_STATUS} "
+            [ "$FLATTEN" -eq 1 ] && printf "${PROJ_DIR}: $THIS_STATUS\n"
         fi
         if [ "$UNTRACKED" != "" ] && [ "$NO_UNTRACKED" -eq 0 ]; then
-            STATUS_NEEDS="${STATUS_NEEDS}${C_UNTRACKED}Untracked files${C_RESET} "
+            THIS_STATUS="${C_UNTRACKED}Untracked files${C_RESET}"
+            STATUS_NEEDS="${STATUS_NEEDS}${THIS_STATUS} "
+            [ "$FLATTEN" -eq 1 ] && printf "${PROJ_DIR}: $THIS_STATUS\n"
         fi
         if [ "$STASHES" -ne 0 ] && [ "$NO_STASHES" -eq 0 ]; then
-            STATUS_NEEDS="${STATUS_NEEDS}${C_STASHES}$STASHES stashes${C_RESET} "
+            THIS_STATUS="${C_STASHES}$STASHES stashes${C_RESET}"
+            STATUS_NEEDS="${STATUS_NEEDS}${THIS_STATUS} "
+            [ "$FLATTEN" -eq 1 ] && printf "${PROJ_DIR}: $THIS_STATUS\n"
         fi
         if [ "$STATUS_NEEDS" = "" ]; then
             IS_OK=1
-            STATUS_NEEDS="${STATUS_NEEDS}${C_OK}ok${C_RESET} "
+            THIS_STATUS="${C_OK}ok${C_RESET}"
+            STATUS_NEEDS="${STATUS_NEEDS}${THIS_STATUS} "
+            [ "$FLATTEN" -eq 1 ] && [ "$EXCLUDE_OK" -ne 1 ] && printf "${PROJ_DIR}: $THIS_STATUS\n"
         fi
 
-        # Print the output, unless repo is 'ok' and -e was specified
-        if [ "$IS_OK" -ne 1 ] || [ "$EXCLUDE_OK" -ne 1 ]; then
-            printf "${PROJ_DIR}: $STATUS_NEEDS\n"
+        if [ "$FLATTEN" -ne 1 ]; then
+            # Print the output, unless repo is 'ok' and -e was specified
+            if [ "$IS_OK" -ne 1 ] || [ "$EXCLUDE_OK" -ne 1 ]; then
+                printf "${PROJ_DIR}: $STATUS_NEEDS\n"
+            fi
         fi
 
         # Throttle if requested

mgitstatus.1

@@ -10,8 +10,8 @@ multiple Git repos.
 .PP
 \f[B]mgitstatus\f[R] [\f[B]\-\-version\f[R]] [\f[B]\-w\f[R]]
 [\f[B]\-e\f[R]] [\f[B]\-f\f[R]] [\f[B]\-\-throttle\f[R] SEC]
-[\f[B]\-\-no\-X\f[R]] [\f[B]\-d/\-\-depth\f[R]=2] [\f[B]DIR\f[R]
-[\f[B]DIR\f[R]]\&...]
+[\f[B]\-c\f[R]] [\f[B]\-d/\-\-depth\f[R]=2] [\f[B]\-\-flatten\f[R]]
+[\f[B]\-\-no\-X\f[R]] [\f[B]DIR\f[R] [\f[B]DIR\f[R]]\&...]
 .SH DESCRIPTION
 .PP
 \f[B]mgitstatus\f[R] shows uncommitted, untracked and unpushed changes
@@ -70,6 +70,11 @@ Force color output (preserve colors when using pipes)
 Scan this many directories deep.
 Default is 2.
 If \f[B]0\f[R], the scan is infinitely deep
+.TP
+.B \f[B]\-\-flatten\f[R]
+Flatten output by only showing one status per line.
+If a repo has multiple statuses, multiple lines are shown for that repo.
+This aids in grepability.
 .PP
 You can limit output with the following options:
 .TP

mgitstatus.1.md

@@ -8,7 +8,7 @@ mgitstatus - Show uncommitted, untracked and unpushed changes for multiple Git r
 
 # SYNOPSIS
 
- **mgitstatus** [**\--version**] [**-w**] [**-e**] [**-f**] [**\--throttle** SEC] [**\--no-X**] [**-d/\--depth**=2] [**DIR** [**DIR**]...]
+ **mgitstatus** [**\--version**] [**-w**] [**-e**] [**-f**] [**\--throttle** SEC] [**\-c**] [**-d/\--depth**=2] [**\--flatten**] [**\--no-X**] [**DIR** [**DIR**]...]
 
 # DESCRIPTION
 
@@ -64,6 +64,9 @@ mgitstatus makes no guarantees that all states are taken into account.
 **-d, \--depth=2**
 :   Scan this many directories deep. Default is 2. If **0**, the scan is infinitely deep
 
+**\--flatten**
+:   Flatten output by only showing one status per line. If a repo has multiple statuses, multiple lines are shown for that repo. This aids in grepability.
+
 You can limit output with the following options:
 
 **\--no-push**