for shell, copy 1 file, update 3 files and create 1 file

Author: MichaelCurrin

shell/README-old.md

@@ -0,0 +1,73 @@
+# Shell
+
+Bash scripts around this project, to be used instead of as a VS Code extension.
+
+<!-- TODO rewrite this content, remove, and move to src/bin -->
+
+## 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)
+
+
+## acm 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.
+
+- [acm-hook.sh](acm-hook.sh)
+- [acm.sh](acm.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/acm.sh
+chore: update settings.json
+$ ./shell/acm.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/acm.sh)"
+```
+
+This can be done easier using the bin and alias steps below.
+
+Move the script to a `bin` executables directory so you can run it from anywhere.
+
+```sh
+$ cp acm.sh /usr/local/bin
+```
+
+#### Alias
+
+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.
+
+```toml
+[alias]
+    c = '! git commit --edit -m "$(acm.sh)"'
+```
+
+Then instead of `git commit`, you can do:
+
+```sh
+$ git c
+
+$ git c foo.txt
+```

shell/README.md

@@ -1,99 +1,11 @@
-# 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.
-
-<!--
-
-Approaches
-
-- Make installable via repo with cp or npm link (better with esbuild for support of any module not just amd and system)
-- Or with GH URL for repo
-- Or with binary which is more effort and not needed for everyone
-
--->
-
-## 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)
-
-
-## acm 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.
-
-- [acm-hook.sh](acm-hook.sh)
-- [acm.sh](acm.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/acm.sh
-chore: update settings.json
-$ ./shell/acm.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/acm.sh)"
-```
-
-This can be done easier using the bin and alias steps below.
-
-Move the script to a `bin` executables directory so you can run it from anywhere.
-
-```sh
-$ cp acm.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.
-
-#### Alias
-
-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.
-
-```toml
-[alias]
-    c = '! git commit --edit -m "$(acm.sh)"'
-```
-
-Then instead of `git commit`, you can do:
-
-```sh
-$ git c
-
-$ git c foo.txt
-```
+# Shell
 
-#### TODO
+If you want to use the hook:
 
-- [ ] 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.
+1. Follow instructions to install the TS command globally as per [src/bin/README.md](/src/bin/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
+    ```

shell/TODO.md

@@ -0,0 +1,8 @@
+- [ ] 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.

shell/acm-hook.sh

@@ -35,7 +35,7 @@ if [ "$COMMIT_SOURCE" = 'template']; then
 fi
 
 CHANGES=$(git diff-index --name-status HEAD)
-MESSAGE=$(acm "$CHANGES")
+MESSAGE=$(auto_commit_msg_generate "$CHANGES")
 
 if [ "$1" = '-p' ]; then
   echo "$MESSAGE"

shell/acm.sh

@@ -3,16 +3,13 @@
 #
 # 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 details on flags. Note `--cached` can be added
-# if you want to use staged changes only.
+# The preferred way is to use a TS command in `src/bin` instead, to avoid
+# having to put this .sh script in a bin directory when npm link works.
+ # But this was the original way.`
 set -e
 
 DIFF_FLAGS='--name-status --find-renames --find-copies --no-color'
 CHANGES=$(git diff-index $DIFF_FLAGS HEAD)
 
-MESSAGE=$(acm "$CHANGES")
+MESSAGE=$(auto_commit_msg_generate "$CHANGES")
 echo "$MESSAGE"