fix(git-commit): fix revert alias conflict (#12007)

Fixes #12007
This commit is contained in:
Marc Cornellà 2023-10-25 19:47:10 +02:00
parent 5c22c5812e
commit 048455ccef
No known key found for this signature in database
GPG Key ID: 0314585E776A9C1B
2 changed files with 24 additions and 14 deletions

View File

@ -10,7 +10,7 @@ plugins=(... git-commit)
## Syntax
```zshrc
```zsh
git <type> [(-s, --scope) "<scope>"] "<message>"
```
@ -26,11 +26,17 @@ Where `type` is one of the following:
- `fix`
- `perf`
- `refactor`
- `revert`
- `rev`
- `style`
- `test`
> 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>`
## Examples
`git style "remove trailing whitespace"` -> `git commit -m "style: remove trailing whitespace"`
`git fix -s "router" "correct redirect link"` -> `git commit -m "fix(router): correct redirect link"`
| Git alias | Command |
| --------------------------------------------- | ---------------------------------------------------- |
| `git style "remove trailing whitespace"` | `git commit -m "style: remove trailing whitespace"` |
| `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"` |

View File

@ -1,9 +1,3 @@
function _git_commit_register {
if ! git config --global --get-all alias.$1 >/dev/null 2>&1; then
git config --global alias.$1 '!a() { if [ "$1" = "-s" ] || [ "$1" = "--scope" ]; then local scope="$2"; shift 2; git commit -m "'$1'(${scope}): ${@}"; else git commit -m "'$1': ${@}"; fi }; a'
fi
}
local -a _git_commit_aliases
_git_commit_aliases=(
'build'
@ -19,9 +13,19 @@ _git_commit_aliases=(
'test'
)
for _alias in "${_git_commit_aliases[@]}"; do
_git_commit_register $_alias
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() { if [ "$1" = "-s" ] || [ "$1" = "--scope" ]; then local scope="$2"; shift 2; git commit -m "'$type'(${scope}): ${@}"; else git commit -m "'$type': ${@}"; fi }; a'
if ! git config --global --get-all alias.${alias} >/dev/null 2>&1; then
git config --global alias.${alias} "$func"
fi
done
unfunction _git_commit_register
unset _alias
unset _git_commit_aliases alias type func