Skip to content

Commit

Permalink
docs: update shell/README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
MichaelCurrin committed Nov 3, 2024
1 parent f06417b commit 97c079e
Showing 1 changed file with 7 additions and 6 deletions.
13 changes: 7 additions & 6 deletions shell/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,9 +56,10 @@ $ cp autofill.sh /usr/local/bin

TODO:

- Where to put the Node script so it can reference it.
- 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.
- [] 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

Expand All @@ -79,9 +80,9 @@ $ git c foo.txt

#### TODO

- For now this points to the output directory so it limited in real world use. This is a stepping
- [] 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
- [] 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.
- [] Add a flag for staged to get `--cached` flag.

0 comments on commit 97c079e

Please sign in to comment.