update 5 shell scripts

Author: MichaelCurrin

shell/autofill-hook.sh

@@ -1,19 +1,18 @@
 #!/usr/bin/env bash
-# CLI test.
+# CLI test for autofill hook.
 #
 # This script is *not* ready to be used in other projects. See shell/README.md
 # for dev notes.
 #
-# This is a pure CLI that script bypasses using VS Code or an extension. It will
-# get output from git, send it to Node CLI entry-point tool and print it. This
-# can be used as part of git commit message hook flow.
+# This is a pure CLIhat script that bypasses using VS Code or an extension.
+# It will get output from git, send it to Node CLI entry-point tool and print
+# it. This can be used as part of Git commit message hook flow.
 #
 # Optionally add a `-d` debug flag to print without writing to a file. This
-# makes it easy to debug the script outside a git commit hook flow.
+# makes it easy to debug the script outside a Git commit hook flow.
 #  ./autofill-hook.sh -p
 #
 # See shell/README.md doc.
-
 set -e
 
 COMMIT_MSG_FILE=$1

shell/autofill.sh

@@ -2,15 +2,16 @@
 # Autofill script.
 #
 # Produce a commit message from changed files and print to stdout.
-
+#
 # This works similar to a Git hook, but is intended to be used alone or in a Git
 # alias.
 #
 # See shell/README.md doc.
-# See src/git/cli.ts for flags.
+# See src/git/cli.ts for details on flags. Note `--cached` can be added
+# if you want to use staged changes only.
 set -e
 
-DIFF_FLAGS="--name-status --find-renames --find-copies --no-color --cached"
+DIFF_FLAGS='--name-status --find-renames --find-copies --no-color'
 CHANGES=$(git diff-index $DIFF_FLAGS HEAD)
 
 # TODO: Make this a global bin path.

shell/count-files.sh

@@ -2,17 +2,18 @@
 # 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. If you use this as a hook, it
-# will print output in the console only not add to commit message
+# Run this as a standalone report, not for use as a hook.
+# If you use this as a hook, it will print output in the console only and
+# not add to commit message.
 #
-# See simple-hook.sh script for how CHANGES
-# would get written out to a commit message file.
+# See simple-hook.sh script for how CHANGES would get written out to a commit
+# message file.
 #
 # 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.
-# This does not support C (copied).
-
+# This does not support 'C' (copied).
+#
 # This report uses git status and passes it do the steps below to parse it.
 # A more flexible approach (for unit tests for example) would be for this
 # script to handle the status and call another script to do the parsing and
@@ -22,7 +23,8 @@
 # Status summary excluding untracked files using a flag.
 CHANGES=$(git status -s -uno --porcelain)
 
-# Note quotes AND -n to preserve newlines so line count for 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

@@ -22,8 +22,8 @@ SHA1=$3
 
 ###
 
-# Show files change.
-# (It will uncomment files changed in the message - which is maybe less
+# Show files changed.
+# (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,)

shell/simple-hook.sh

@@ -1,8 +1,9 @@
 #!/bin/sh
-# A minimal git commit hook.
+# 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.
 #
@@ -12,7 +13,7 @@
 set -e
 
 # These are the 3 standard prepare-commit-msg args as per the hooks example and
-# git hook docs.
+# Git hook docs.
 COMMIT_MSG_FILE=$1
 COMMIT_SOURCE=$2
 SHA1=$3
@@ -34,7 +35,8 @@ else
   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.
+# 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