You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: shell/README.md
+13-14Lines changed: 13 additions & 14 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,8 +1,8 @@
1
1
# Shell
2
2
3
-
Git hook test scripts.
3
+
Bash scripts around this project.
4
4
5
-
All the scripts in this directory are named with dashes not underscores, to match the git hook filenames convention.
5
+
All the scripts in this directory are named with dashes and not underscores, to match the Git hook filenames convention.
6
6
7
7
8
8
## Samples
@@ -16,22 +16,22 @@ Archive of shell scripts for reference. These are used in the early development
16
16
17
17
## Autofill scripts
18
18
19
-
These integrate with the JS scripts in this project, as an alternative to VS Code so I can use it any terminal and in other IDEs with terminals. And if I stop using VS Code completely I can keep the core use at least in a terminal.
19
+
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.
20
20
21
21
-[autofill-hook.sh](autofill-hook.sh)
22
22
-[autofill.sh](autofill.sh)
23
23
24
-
They are not complete but work as a POC for using the core logic outside project outside of VS Code as git hook.
24
+
They are not complete but work as a POC for using the core logic outside project outside of VS Code as Git hook.
25
25
26
26
### Dev notes
27
27
28
-
Remember to compile before running this script to get the latest changes.
28
+
Remember to **compile** before running this script to get the latest changes.
29
29
30
30
#### Purpose
31
31
32
-
This script should be used as **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 **ignores** any message you type in and uses its own generated message from the hook).
32
+
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).
33
33
34
-
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).
34
+
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).
35
35
36
36
e.g.
37
37
@@ -59,9 +59,9 @@ $ cp autofill.sh /usr/local/bin
59
59
60
60
TODO:
61
61
62
-
- Where to put the Node script so it can reference to.
63
-
- How to automated the install process for upgrades.
64
-
- 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.
62
+
- Where to put the Node script so it can reference it.
63
+
- How to automated the install process for upgrades. Maybe the JS + shell script as NPM package or at least on GitHub with cURL install.
64
+
- 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.
65
65
66
66
#### Alias
67
67
@@ -82,9 +82,8 @@ $ git c foo.txt
82
82
83
83
#### TODO
84
84
85
-
**TODO** For now this points to the output directory so it limited in real world use. This is stepping
85
+
- For now this points to the output directory so it limited in real world use. This is a stepping
86
86
stone. But ideally the JS files can be copied outside of this project to a central location (maybe
87
-
with a bin entry point). And the SH script can be added to an individual project in .git/hooks dir as `prepare-commit-msg`.
88
-
89
-
**TODO** When using this as a hook, consider reading from the existing commit message file in the case
87
+
with a `bin` entry point). And the SH script can be added to an individual project in `.git/hooks` dir as `prepare-commit-msg`.
88
+
- When using this as a hook, consider reading from the **existing** commit message file in the case
0 commit comments