feat: Update scripts in shell

Author: MichaelCurrin

shell/count-files.sh

@@ -1,10 +1,13 @@
 #!/usr/bin/env bash
 # Proof of concept script to use Bash to produce report of file counts from git status.
 #
-# Run this as a standalone report, not as a hook. See simple-hook.sh script for how CHANGES
+# Run this as a standalone report, not as a hook. If you use this as a hook, it will
+# print output in the console only not add to commit message
+#
+# See simple-hook.sh script for how CHANGES
 # would get written out to a commit message file.
 #
-# This will get count of files added, modified, deleted and renamed/moved and output it.
+# This script will get count of files added, modified, deleted and renamed/moved and output it.
 # Note that modified and renamed/moved can both apply to the same file.
 # There also other states like C for copied and ?? for untracked.
 
@@ -16,7 +19,7 @@
 # Status summary excluding untracked files using a flag.
 CHANGES=$(git status -s -uno --porcelain)
 
-# Note quotes and -n to preserve newlines so line count or grep for start of lines works.
+# Note quotes AND -n to preserve newlines so line count for grep, for start of lines works.
 FILES=$(echo -n "$CHANGES" | wc -l)
 
 echo "All files changed: $FILES"

shell/sample.sh

@@ -1,25 +1,30 @@
 #!/bin/sh
 
-# This script is based on the prepare-commit-msg.sample file in a git repo.
+# This script is based on the prepare-commit-msg.sample file that comes by default in any git repo when you run git init or git clone (you can also run git init later on to restore hooks).
+# Note everything here is uncommented but you're only meant to run one of the 3 sections after setting up vars.
 
+# e.g. '.git/COMMIT_EDITMSG'
 COMMIT_MSG_FILE=$1
+# e.g. 'message' or 'template'
 COMMIT_SOURCE=$2
+# A hash, if relevant.
 SHA1=$3
 
+###
+
 # Remove line.
 /usr/bin/perl -i.bak -ne 'print unless(m/^. Please enter the commit message/..m/^#$/)' "$COMMIT_MSG_FILE"
 
-LINES=$(git status -s -uno --porcelain | wc -l)
-# Write over
-# echo "Files changed: $LINES" > $COMMIT_MSG_FILE
+###
 
 # Show files change.
-# (Uncomments files changed in the message)
+# (It will uncomment files changed in the message - which is maybe less efficient than just running git status but this is what git comes with.)
 #
-# case "$COMMIT_SOURCE,$SHA1" in
-#  ,|template,)
-#    /usr/bin/perl -i.bak -pe '
-#       print "\n" . `git diff --cached --name-status -r`
-# 	 if /^#/ && $first++ == 0' "$COMMIT_MSG_FILE" ;;
-#  *) ;;
-# esac
+case "$COMMIT_SOURCE,$SHA1" in
+, | template,)
+    /usr/bin/perl -i.bak -pe '
+      print "\n" . `git diff --cached --name-status -r`
+	 if /^#/ && $first++ == 0' "$COMMIT_MSG_FILE"
+    ;;
+*) ;;
+esac

shell/simple-hook.sh

@@ -1,6 +1,12 @@
 #!/bin/sh
 # A minimal git commit hook.
+# Usage:
+#   ./simple-hook.sh MSG SRC SHA [-d]
+# The last part is an optional non-standard flag, allowing this to be run directly without writing out.
 
+set -e
+
+# These are the 3 standard prepare-commit-msg args as per the hooks example and git hook docs.
 COMMIT_MSG_FILE=$1
 COMMIT_SOURCE=$2
 SHA1=$3
@@ -12,4 +18,26 @@ echo "COMMIT_MSG_FILE = $COMMIT_MSG_FILE"
 echo "COMMIT_SOURCE = $COMMIT_SOURCE"
 echo "SHA1 = $SHA1"
 
-echo -n "This is a message inserted before your commit message\n$CHANGES" >$COMMIT_MSG_FILE
+MESSAGE="This is a message inserted before your commit message
+$CHANGES"
+
+if [ "$4" = '-d' ]; then
+    echo '\nDRY RUN'
+    echo "$MESSAGE"
+else
+    # Note that -n flag is not needed here on echo.
+    echo "$MESSAGE" >$COMMIT_MSG_FILE
+fi
+
+# There is a weird bug where the space before the first line goes missing, but not in the dry run output.
+#
+# This is a message inserted before your commit message
+# M  docs/installation.md
+#  M shell/count-files.sh
+#  M shell/simple-hook.sh
+
+# Even weird in the logs
+#    This is a message inserted before your commit message
+#     M docs/installation.md
+#     M shell/count-files.sh
+#    M  shell/simple-hook.sh