summaryrefslogtreecommitdiff
path: root/home/.oh-my-zsh/plugins/git-commit
diff options
context:
space:
mode:
authornavewindre <boneyaard@gmail.com>2025-07-13 06:42:05 +0200
committernavewindre <boneyaard@gmail.com>2025-07-13 06:42:05 +0200
commit02f14a9cb152561a5e44062aac79f3b700403b40 (patch)
tree2db8ebda3b7f6f8777783aeb5c60018e6e1359d8 /home/.oh-my-zsh/plugins/git-commit
parentcbbdeb2f6b40a102a829f0c47cff052937231f00 (diff)
omz
Diffstat (limited to 'home/.oh-my-zsh/plugins/git-commit')
-rw-r--r--home/.oh-my-zsh/plugins/git-commit/README.md47
-rw-r--r--home/.oh-my-zsh/plugins/git-commit/git-commit.plugin.zsh58
2 files changed, 105 insertions, 0 deletions
diff --git a/home/.oh-my-zsh/plugins/git-commit/README.md b/home/.oh-my-zsh/plugins/git-commit/README.md
new file mode 100644
index 0000000..f812ee2
--- /dev/null
+++ b/home/.oh-my-zsh/plugins/git-commit/README.md
@@ -0,0 +1,47 @@
+# git-commit plugin
+
+The git-commit plugin adds several
+[git aliases](https://www.git-scm.com/docs/git-config#Documentation/git-config.txt-alias) for
+[conventional commit](https://www.conventionalcommits.org/en/v1.0.0/#summary) messages.
+
+To use it, add `git-commit` to the plugins array in your zshrc file:
+
+```zsh
+plugins=(... git-commit)
+```
+
+## Syntax
+
+```zsh
+git <type> [(-s, --scope) "<scope>"] [(-a, --attention)] "<message>"
+```
+
+Where `type` is one of the following:
+
+- `build`
+- `chore`
+- `ci`
+- `docs`
+- `feat`
+- `fix`
+- `perf`
+- `refactor`
+- `rev`
+- `style`
+- `test`
+- `wip`
+
+> NOTE: the alias for `revert` type is `rev`, as otherwise it conflicts with the git command of the same name.
+> It will still generate a commit message in the format `revert: <message>`
+
+> ⚠️ Enabling this plugin will (potentially) overwrite all `alias.<type>` that you manually set. Use with
+> care!
+
+## Examples
+
+| Git alias | Command |
+| --------------------------------------------- | ---------------------------------------------------- |
+| `git style "remove trailing whitespace"` | `git commit -m "style: remove trailing whitespace"` |
+| `git wip "work in progress"` | `git commit -m "work in progress"` |
+| `git fix -s "router" "correct redirect link"` | `git commit -m "fix(router): correct redirect link"` |
+| `git rev -s "api" "rollback v2"` | `git commit -m "revert(api): rollback v2"` |
diff --git a/home/.oh-my-zsh/plugins/git-commit/git-commit.plugin.zsh b/home/.oh-my-zsh/plugins/git-commit/git-commit.plugin.zsh
new file mode 100644
index 0000000..c4df77c
--- /dev/null
+++ b/home/.oh-my-zsh/plugins/git-commit/git-commit.plugin.zsh
@@ -0,0 +1,58 @@
+local _rev="$(git -C $ZSH rev-parse HEAD 2> /dev/null)"
+if [[ $_rev == $(git config --global --get oh-my-zsh.git-commit-alias 2> /dev/null) ]]; then
+ return
+fi
+git config --global oh-my-zsh.git-commit-alias "$_rev"
+
+local -a _git_commit_aliases
+_git_commit_aliases=(
+ 'build'
+ 'chore'
+ 'ci'
+ 'docs'
+ 'feat'
+ 'fix'
+ 'perf'
+ 'refactor'
+ 'revert'
+ 'style'
+ 'test'
+ 'wip'
+)
+
+local _alias _type
+for _type in "${_git_commit_aliases[@]}"; do
+ # an alias can't be named "revert" because the git command takes precedence
+ # https://stackoverflow.com/a/3538791
+ case "$_type" in
+ revert) _alias=rev ;;
+ *) _alias=$_type ;;
+ esac
+
+ local _func='!a() {
+local _scope _attention _message
+while [ $# -ne 0 ]; do
+case $1 in
+ -s | --scope )
+ if [ -z $2 ]; then
+ echo "Missing scope!"
+ return 1
+ fi
+ _scope="$2"
+ shift 2
+ ;;
+ -a | --attention )
+ _attention="!"
+ shift 1
+ ;;
+ * )
+ _message="${_message} $1"
+ shift 1
+ ;;
+esac
+done
+git commit -m "'$_type'${_scope:+(${_scope})}${_attention}:${_message}"
+}; a'
+
+ git config --global alias.$_alias "$_func"
+done