Customization/ohmyzsh
1
0
Fork 0
mirror of https://github.com/ohmyzsh/ohmyzsh.git synced 2024-11-27 16:20:07 +00:00
Code Releases Activity
ohmyzsh/plugins/git-commit
History
mattmc3 440b66da14
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.
2024-08-19 18:10:13 -04:00
..
git-commands feat(git-commit): Use git-dash commands 2024-08-19 18:10:13 -04:00
git-commit.plugin.zsh feat(git-commit): Use git-dash commands 2024-08-19 18:10:13 -04:00
README.md feat(git-commit): Use git-dash commands 2024-08-19 18:10:13 -04:00

README.md

git-commit plugin

The git-commit plugin adds several git subcommands 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>"] [(-a, --attention)] "<message>"

Where type is one of the following:

  • build
  • chore
  • ci
  • docs
  • feat
  • fix
  • perf
  • refactor
  • rev
  • style
  • test
  • wip

NOTE: the subcommand 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 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"
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"