deblan-mirror/gum
deblan-mirror/gum
1
0
Fork 0
mirror of https://github.com/charmbracelet/gum synced 2024-05-29 03:42:26 +02:00
Code Issues Packages Projects Releases Wiki Activity

docs(examples): Add example of conventional commit script

Browse source 
This change adds an example script of how to prompt the user for the necessary information for a conventional commit.
This commit is contained in:
Maas Lalani 2022-07-11 17:07:53 -04:00
parent 593cf711be
commit 11e7e18256
No known key found for this signature in database
GPG key ID: 5A6ED5CBF1A0A000
1 changed files with 23 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

23
examples/commit.sh Executable file
View file

@ -0,0 +1,23 @@
#!/bin/bash
# This script is used to write a conventional commit message.
# It prompts the user to choose the type of commit as specified in the
# conventional commit spec. And then prompts for the summary and detailed
# description of the message and uses the values provided. as the summary and
# details of the message.
#
# If you want to add a simpler version of this script to your dotfiles, use:
#
# alias gcm='git commit -m "$(gum input)" -m "$(gum write)"'
TYPE=$(gum choose "fix" "feat" "docs" "style" "refactor" "test" "chore" "revert")
SCOPE=$(gum input --placeholder "scope")
if [ -n "$SCOPE" ]; then
SCOPE="($SCOPE)"
fi
git commit \
-m "$(gum input --value "$TYPE$SCOPE: " --placeholder "Summary of this change")" \
-m "$(gum write --placeholder "Details of this change")"