feat(git-commit): Use git-dash commands

Issue: ohmyzsh/ohmyzsh#12627

This commit refactors the prior implementation which used git aliases and modified .gitconfig. This implementation uses proper git-dash commands, which are all just symlinks to one handler - omz_git_commit.

plugins/git-commit/README.md

@@ -1,7 +1,6 @@
 # git-commit plugin
 
-The git-commit plugin adds several
+The git-commit plugin adds several git subcommands for
-[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:
@@ -31,15 +30,13 @@ Where `type` is one of the following:
 - `test`
 - `wip`
 
-> NOTE: the alias for `revert` type is `rev`, as otherwise it conflicts with the git command of the same name.
+> NOTE: the subcommand for `revert` type is `rev`, as otherwise it conflicts with the
-> It will still generate a commit message in the format `revert: <message>`
+> 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 subcommand                                | Command                                              |
 | --------------------------------------------- | ---------------------------------------------------- |
 | `git style "remove trailing whitespace"`      | `git commit -m "style: remove trailing whitespace"`  |
 | `git wip "work in progress"`                  | `git commit -m "work in progress"`                   |

plugins/git-commit/git-commands/git-build

@@ -0,0 +1 @@
+./omz_git_commit

plugins/git-commit/git-commands/git-chore

@@ -0,0 +1 @@
+./omz_git_commit

plugins/git-commit/git-commands/git-ci

@@ -0,0 +1 @@
+./omz_git_commit

plugins/git-commit/git-commands/git-docs

@@ -0,0 +1 @@
+./omz_git_commit

plugins/git-commit/git-commands/git-feat

@@ -0,0 +1 @@
+./omz_git_commit

plugins/git-commit/git-commands/git-fix

@@ -0,0 +1 @@
+./omz_git_commit

plugins/git-commit/git-commands/git-perf

@@ -0,0 +1 @@
+./omz_git_commit

plugins/git-commit/git-commands/git-refactor

@@ -0,0 +1 @@
+./omz_git_commit

plugins/git-commit/git-commands/git-rev

@@ -0,0 +1 @@
+./omz_git_commit

plugins/git-commit/git-commands/git-style

@@ -0,0 +1 @@
+./omz_git_commit

plugins/git-commit/git-commands/git-test

@@ -0,0 +1 @@
+./omz_git_commit

plugins/git-commit/git-commands/git-wip

@@ -0,0 +1 @@
+./omz_git_commit

plugins/git-commit/git-commands/omz_git_commit

@@ -0,0 +1,34 @@
+#!/usr/bin/env zsh
+
+_omz_git_commit() {
+  0=${(%):-%x}
+  if [[ "$0" != */git-* ]]; then
+    echo >&2 "Expecting command named git-foo. Got '$0'."
+    return 1
+  fi
+
+  local _type="${0##*/git-}"
+  local _scope _attention _message
+  while [ $# -ne 0 ]; do
+  case $1 in
+    -s | --scope )
+      if [ -z $2 ]; then
+        echo >&2 "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}"
+}
+_omz_git_commit "$@"

plugins/git-commit/git-commit.plugin.zsh

@@ -1,58 +1,46 @@
-local _rev="$(git -C $ZSH rev-parse HEAD 2> /dev/null)"
+# Add git-commit commands directory to path
-if [[ $_rev == $(git config --global --get oh-my-zsh.git-commit-alias 2> /dev/null) ]]; then
+path=("$ZSH/plugins/git-commit/git-commands" $path)
-  return
-fi
-git config --global oh-my-zsh.git-commit-alias "$_rev"
 
-local -a _git_commit_aliases
+# Append completions for custom git commands
-_git_commit_aliases=(
+() {
-  'build'
+  local -a git_user_commands
-  'chore'
+  zstyle -a ':completion:*:*:git:*' user-commands 'git_user_commands' \
-  'ci'
+    || git_user_commands=()
-  'docs'
+  git_user_commands+=(
-  'feat'
+    build:'Commit with a message indicating a build' \
-  'fix'
+    chore:'Commit with a message indicating a chore' \
-  'perf'
+    ci:'Commit with a message indicating a CI change' \
-  'refactor'
+    docs:'Commit with a message indicating an update to the documentation' \
-  'revert'
+    feat:'Commit with a message indicating a feature' \
-  'style'
+    fix:'Commit with a message indicating a fix' \
-  'test'
+    perf:'Commit with a message indicating a performance enhancement' \
-  'wip'
+    refactor:'Commit with a message indicating a refactor' \
+    revert:'Commit with a message indicating a revert' \
+    style:'Commit with a message indicating a style change' \
+    test:'Commit with a message indicating updates to tests' \
+    wip:'Commit with a message indicating a work in progress'
   )
+  zstyle ':completion:*:*:git:*' user-commands "${git_user_commands[@]}"
+}
 
-local _alias _type
+########################################################################################
-for _type in "${_git_commit_aliases[@]}"; do
+### Remove below after Jan 2025:
-  # an alias can't be named "revert" because the git command takes precedence
+########################################################################################
-  # https://stackoverflow.com/a/3538791
+# Clean up aliases from the prior implementation of git-commit. Can be safely removed
-  case "$_type" in
+# once everyone's .gitconfig has been restored.
-    revert) _alias=rev ;;
+() {
-    *) _alias=$_type ;;
+  git config --global --get oh-my-zsh.git-commit-alias &> /dev/null || return
-  esac
+  local -a old_git_aliases=(
-
+    'build'  'chore'     'ci'
-  local _func='!a() {
+    'docs'   'feat'      'fix'
-local _scope _attention _message
+    'perf'   'refactor'  'rev'
-while [ $# -ne 0 ]; do
+    'style'  'test'      'wip'
-case $1 in
+  )
-  -s | --scope )
+  local git_alias
-    if [ -z $2 ]; then
+  for git_alias in $old_git_aliases; do
-      echo "Missing scope!"
+    if [[ "$(git config --global --get alias.$git_alias | tr '\n' ' ')" == "!a() { local _scope _attention _message"* ]]; then
-      return 1
+      git config --global --unset alias.$git_alias
     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
+  git config --global --unset oh-my-zsh.git-commit-alias
+}