ohmyzsh/plugins/git-commit
2023-10-25 19:47:46 +02:00
..
git-commit.plugin.zsh fix(git-commit): fix revert alias conflict () 2023-10-25 19:47:46 +02:00
README.md fix(git-commit): fix revert alias conflict () 2023-10-25 19:47:46 +02:00

git-commit plugin

The git-commit plugin adds several git aliases for conventional commit messages.

To use it, add git-commit to the plugins array in your zshrc file:

plugins=(... git-commit)

Syntax

git <type> [(-s, --scope) "<scope>"] "<message>"

⚠️ Single/Double quotes around the scope and message are required

Where type is one of the following:

  • build
  • chore
  • ci
  • docs
  • feat
  • fix
  • perf
  • refactor
  • 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 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"