feat: update shell

Author: MichaelCurrin

shell/README.md

@@ -1,88 +1,25 @@
-# Shell
-
-Bash scripts around this project, to be used instead of as a VS Code extension. **This area is not complete and is still experimental.**
-
-Note: All the scripts in this directory are named with dashes and not underscores, to match the Git hook filenames convention.
-
-
-## Samples
-
-Archive of shell scripts for reference. These are used in the early development of the project but are not actively used.
-
-- [count-files.sh](count-files.sh)
-- [sample.sh](sample.sh)
-- [simple-hook.sh](simple-hook.sh)
-
-
-## Autofill scripts
-
-These are shell scripts to integrate with the JS scripts in this project, as an alternative to using, VS Code so I can use it any terminal and in other IDEs with their terminals. And if I stop using VS Code completely I can keep using the core at least in a terminal.
-
-- [autofill-hook.sh](autofill-hook.sh)
-- [autofill.sh](autofill.sh)
-
-They are not complete but work as a POC for using the core logic outside project outside of VS Code as Git hook.
-
-### Dev notes
 
-Remember to **compile** the TS to JS before running this script to get the latest changes. Or use a pre-compiled script.
-
-#### Purpose
-
-This script should be used as an **alternative** to using VS Code itself to handle your commit messages, as VS Code does not support a hook properly when going through the UI box (it actually **ignores** any message you type in and uses its own generated message from the hook).
-
-But, if you don't use it as an actual hook, there is an alternative flow that doesn't mess with VS Code. You can use the other script and set up a Git alias (which can be used across projects without setting a hook even).
-
-Sample output:
-
-```console
-$ ./shell/autofill.sh
-chore: update settings.json
-$ ./shell/autofill.sh
-update 11 files
-```
-
-Use it with Git. This uses the tool to generate a message and pass it as the Git commit message, but forcing edit mode so you can override it.
-
-```sh
-$ git commit --edit -m "$(shell/autofill.sh)"
-```
-
-Move the script to a `bin` executables directory so you can run it from anywhere.
-
-```sh
-$ cp autofill.sh /usr/local/bin
-```
-
-TODO:
-
-- [ ] Where to put the Node script so it can reference it.
-- [ ] Windows support
-- [ ] How to automated the install process for upgrades. Maybe the JS + shell script as NPM package or at least on GitHub with cURL install.
-- [ ] Figure out how to switch between staged and not, with `--cached`. Like passing a param to the shell script and having two aliases. Or to have it as pass of the shell script to fallback to all if anything is staged. Or just control with filenames e.g. `git c .` or `git c package*` - oh wait, the shell script doesn't look at what is passed to `git commit`, only what is staged or not.
+# Shell
 
-#### Alias
+See [acm-hook.sh](acm-hook.sh).
 
-Set this up in git config aliases as `c` or something. If this was in a _bin_ directory, or used with an absolute path to the script.
+A CLI 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 (pre-commit hook).
 
-```toml
-[alias]
-    c = '! git commit --edit -m "$(autofill.sh)"'
-```
 
-Then instead of `git commit`, you can do:
+## Setup
 
-```sh
-$ git c
+If you want to use the hook:
 
-$ git c foo.txt
-```
+1. Follow instructions to install the TS command globally as per [src/cli/README.md](/src/cli/README.md)
+1. Install the pre-commit hook.
+    ```sh
+    $ cp shell/acm-hook.sh YOUR_PROJECT/.hooks/pre-commit
+    $ chmod +x YOUR_PROJECT/.hooks/pre-commit
+    ```
 
-#### TODO
+## Debugging
 
-- [ ] For now this points to the output directory so it limited in real world use. This is a stepping
-stone. But ideally the JS files can be copied outside of this project to a central location (maybe
-with a `bin` entry point). And the SH script can be added to an individual project in `.git/hooks` dir as `prepare-commit-msg`.
-- [ ] When using this as a hook, consider reading from the **existing** commit message file in the case
-of template, so it that can be passed on.
-- [ ] Add a flag for staged to get `--cached` flag.
+Optionally add a `-p` debug flag to print without writing to a file. This
+makes it easy to debug the script outside a Git commit hook flow.

shell/TODO.md

@@ -0,0 +1,14 @@
+- [ ] For now this points to the output directory so it limited in real world use. This is a stepping
+stone. But ideally the JS files can be copied outside of this project to a central location (maybe
+with a `bin` entry point). And the SH script can be added to an individual project in `.git/hooks` dir as `prepare-commit-msg`.
+- [ ] When using this as a hook, consider reading from the **existing** commit message file in the case
+of template, so it that can be passed on.
+- [ ] Add a flag for staged to get `--cached` flag.
+- [ ] How to automated the install process for upgrades. Maybe the JS + shell script as NPM package or at least on GitHub with cURL install.
+- [ ] Figure out how to switch between staged and not, with `--cached`. Like passing a param to the shell script and having two aliases. Or to have it as pass of the shell script to fallback to all if anything is staged. Or just control with filenames e.g. `git c .` or `git c package*` - oh wait, the shell script doesn't look at what is passed to `git commit`, only what is staged or not.
+- Fix bug where message is on modified and staged but only staged is commit with gacm
+
+    If the flag is omitted, then the standard `git status` logic is followed:
+    look for staged changes and use them, otherwise use unstaged changes.
+    there's a problem - commit does not take cached flag - but it will use implied staged or not. so do not pass through.
+    BUT could look at advanced mode of pass through names of files to commit IF they are handled by status and commit, but using manual git add is good enough probably. esp for untracked files which need add anyway.

shell/acm-hook.sh

@@ -0,0 +1,35 @@
+#!/usr/bin/env bash
+# CLI test for autofill hook.
+#
+# See shell/README.md doc.
+set -e
+
+GENERATE_CMD='auto_commit_msg_generate'
+
+if ! command -v "$GENERATE_CMD" &> /dev/null; then
+  echo "Error: $GENERATE_CMD could not be found"
+  exit 1
+fi
+
+COMMIT_MSG_FILE=$1
+COMMIT_SOURCE=$2
+
+echo 'Input values'
+echo "COMMIT_MSG_FILE = $COMMIT_MSG_FILE"
+# Either 'message' or 'template'
+echo "COMMIT_SOURCE = $COMMIT_SOURCE"
+
+# TODO: Test this - this conditional is untested.
+if [ "$COMMIT_SOURCE" = 'template']; then
+  echo "Current commit message"
+  <"$COMMIT_MSG_FILE"
+fi
+
+CHANGES=$(git diff-index --name-status HEAD)
+MESSAGE=$($GENERATE_CMD "$CHANGES")
+
+if [ "$1" = '-p' ]; then
+  echo "$MESSAGE"
+else
+  echo "$MESSAGE" >$COMMIT_MSG_FILE
+fi

shell/archive/README.md

@@ -0,0 +1,11 @@
+# Shell
+
+Bash scripts around this project, to be used instead of as a VS Code extension.
+
+## Samples
+
+Archive of shell scripts for reference. These are used in the early development of the project but are not actively used.
+
+- [count-files.sh](count-files.sh)
+- [sample.sh](sample.sh)
+- [simple-hook.sh](simple-hook.sh)