chore: 🔧 refactor gitutils

Author: tomgrv

src/gitutils/_degit.sh

@@ -6,24 +6,36 @@ if [ "$#" -lt 1 ]; then
     exit 1
 fi
 
-# Get repository URL from argument
-repo="${1}"
+set -e
 
-# Get directory from argument or use current directory
-directory="${2:-.}"
+# Source colors script
+. zz_colors
+
+# Function to print help and manage arguments
+eval $(
+    zz_args "Clone and degit a repository" $0 "$@" <<-help
+		    - repo      repo        repository to clone
+			- directory directory   directory to degit into
+	help
+)
 
 # Get the repository host
 host=$(echo "${repo}" | sed -E 's/https?:\/\/([^/]+)\/.*/\1/')
 
 # Keep only the repository name
 repo=$(echo "${repo}" | sed -E 's/.*github.com\/([^/]+)\/([^/]+).*/\1\/\2/')
 
-# Create directory if it doesn't exist
-mkdir -p "${directory}"
+# Check if the directory is provided
+if [ -z "${directory}" ]; then
+    directory=.
+fi
 
 # Trace
-echo "Repository: ${repo}"
-echo "Directory: ${directory}"
+zz_log i "Repository: ${repo}"
+zz_log i "Directory: ${directory}"
+
+# Create directory if it doesn't exist
+mkdir -p "${directory}"
 
 # Download and extract repository per host
 case $host in
@@ -40,7 +52,7 @@ case $host in
         tar --extract --ungzip --strip-components=1 --directory "${directory}"
     ;;
 *)
-    echo "Unsupported host: ${host}"
+    zz_log e "Unsupported host: {U ${host}}"
     exit 1
     ;;
 esac

src/gitutils/_fixup.sh

@@ -1,5 +1,18 @@
 #!/bin/sh
 
+set -e
+
+# Source colors script
+. zz_colors
+
+# Function to print help and manage arguments
+eval $(
+	zz_args "Fix git history" $0 "$@" <<-help
+		    f -        force     allow overwritting pushed history
+			- sha      sha       sha commit to fixup
+	help
+)
+
 ## Do not fixup if staged files contains composer.lock or package-lock.json
 if [ -n "$(git diff --cached --name-only | grep -E 'composer.lock|package-lock.json')" ]; then
 	echo 'Packages lock file are staged, fixup is not allowed.'
@@ -12,43 +25,32 @@ cd "$(git rev-parse --show-toplevel)" >/dev/null
 #### Integrate modifications from remote
 git fetch --progress --prune --recurse-submodules=no origin >/dev/null
 
-#### Display help
-if [ "$1" = '--help' ]; then
-	echo 'Usage: git fixup [--force|<commit>]'
-	exit 0
-fi
-
 #### Check if fixup commit exists
-echo 'Check if fixup commit exists...'
-if ! git isFixup; then
-
-	## Do not fixup if no files are staged
-	if [ -z "$(git diff --cached --name-only)" ]; then
-		echo 'No files are staged, fixup is not allowed.'
-		exit 1
-	fi
-
-	#### Get commit to fixup
-
-	sha=$(git getcommit "$@")
+if git isFixup; then
+	zz_log e 'Fixup commit found, please continue rebasing...'
+	exit 1
+fi
 
-	#### Display commit to fixup
-	echo 'Fixup commit given:' $sha
+## Do not fixup if no files are staged
+if [ -z "$(git diff --cached --name-only)" ]; then
+	zz_log e 'No files are staged, fixup is not allowed.'
+	exit 1
+fi
 
-	## Create fixup commit and exit if commit is not done
-	if ! git commit --fixup $sha --no-verify; then
-		echo 'Fixup commit failed...'
-		exit 1
-	fi
+#### Get commit to fixup
+sha=$(git getcommit $sha)
 
-	#### Start rebase
-	git rebase -i --autosquash $sha~ --autostash --no-verify --exec '[ -f .git/hooks/pre-commit ] && (.git/hooks/pre-commit --name-only HEAD HEAD~1 && git commit --amend --no-edit --no-verify) || true'
-else
-	echo -e "\e[32mExisting !fixup commit found. Continue rebasing...\e[0m"
+#### Display commit to fixup
+zz_log i "Fixup commit given: $sha"
 
-	#### Stage all changes
-	git add --update && git rebase --continue
+## Create fixup commit and exit if commit is not done
+if ! git commit --fixup $sha --no-verify; then
+	zz_log e 'Fixup commit failed...'
+	exit 1
 fi
 
+#### Start rebase
+git rebase -i --autosquash $sha~ --autostash --no-verify --exec '[ -f .git/hooks/pre-commit ] && (.git/hooks/pre-commit --name-only HEAD HEAD~1 && git commit --amend --no-edit --no-verify) || true'
+
 #### Back to previous directory
 cd - >/dev/null

src/gitutils/_getcommit.sh

@@ -1,24 +1,26 @@
 #!/bin/sh
 
-#### Go to repository root
-cd "$(git rev-parse --show-toplevel)"
+set -e
 
-#### Get calling script name without extension and starting _
-script=$(basename $0 .sh | sed 's/^_//')
+# Source colors script
+. zz_colors
 
-#### Display help
-if [ "$1" = '--help' ]; then
-    echo 'Usage: git '$script' [--force|<commit>]'
-    exit 0
-fi
+# Function to print help and manage arguments
+eval $(
+    zz_args "List git history and asks for commit" $0 "$@" <<-help
+		    f -        force     allow overwritting pushed history
+			- sha      sha       sha commit to fixup
+	help
+)
+
+#### Go to repository root
+cd "$(git rev-parse --show-toplevel)"
 
-#### List commits to fixup and ask user to choose one
-if [ "$1" = "--force" ]; then
-    echo 'Get commit to fixup by overwritting pushed history...' >&2
+if [ -n "$force" ]; then
+    zz_log w "Force mode enabled, overwriting pushed history"
     git forceable >&2
     read -p 'What commit to fix? ' sha
-elif [ -z "$1" ]; then
-    echo 'Get commit to fixup without overwritting pushed history...' >&2
+elif [ -z "$sha" ]; then
     git fixable >&2
     read -p 'What commit to fix? ' sha
 else

src/gitutils/_release-prod.sh

@@ -1,55 +1,70 @@
 #!/bin/sh
 
+set -e
+
+# Source colors script
+. zz_colors
+
+# Function to print help and manage arguments
+eval $(
+    zz_args "Release production branch" $0 "$@" <<-help
+	help
+)
+
 #### Goto repository root
 cd "$(git rev-parse --show-toplevel)" >/dev/null
 
 #### CHECK IF ON A HOTFIX BRANCH, EXTRACT BRANCH NAME
 if [ -n "$(git branch --list hotfix/*)" ]; then
     flow=hotfix
     name=$(git branch --list hotfix/* | sed 's/.*hotfix\///')
-    npx --yes chalk-cli -t "{green ✔} Hotfix branch found: {yellow $name}"
+    zz_log i "Hotfix branch found: {Yellow $name}"
 fi
 
 #### CHECK IF ON A RELEASE BRANCH, EXTRACT BRANCH NAME
 if [ -n "$(git branch --list release/*)" ]; then
     flow=release
     name=$(git branch --list release/* | sed 's/.*release\///')
-    npx --yes chalk-cli -t "{green ✔} Release branch found: {blue $name}"
+    zz_log i "Release branch found: {Blue $name}"
 fi
 
 #### CHECK IF A FLOW BRANCH IS FOUND
 if [ -z "$flow" ] && [ -f .git/RELEASE ]; then
     flow=release
     name=$(cat .git/RELEASE)
-
-    npx --yes chalk-cli -t "{green ✔} Release branch found: {blue $name}"
+    zz_log i "Release branch found: {Blue $name}"
     git checkout $flow/$name
 fi
 
 #### EXIT IF NO FLOW BRANCH IS FOUND
 if [ -z "$flow" ] || [ -z "$name" ]; then
-    npx --yes chalk-cli -t "{red ✘} No flow branch found"
+    zz_log e "No flow branch found"
     exit 1
 fi
 
 #### GET BUMP VERSION
 GBV=$(gitversion -config .gitversion -showvariable MajorMinorPatch)
-npx --yes chalk-cli -t "{green ✔} Bump version: {green $GBV}"
+if [ -z "$GBV" ]; then
+    zz_log e "Cannot get version from .gitversion"
+    exit 1
+fi
+
+zz_log i "Bump version: {Blue $GBV}"
 
 #### PREVENT GIT EDITOR PROMPT
 GIT_EDITOR=:
 
 #### UPDATE VERSION & CHANGELOG & FINISH RELEASE
-if npx --yes json --validate -q -f package.json && npx --yes commit-and-tag-version --skip.tag --no-verify --release-as $GBV; then
+if npx --yes commit-and-tag-version --skip.tag --no-verify --release-as $GBV; then
     if git flow $flow finish $name --tagname $GBV --message $GBV --push; then
-        npx --yes chalk-cli -t "{green ✔} Release finished: {blue $name -> $GBV}"
+        zz_log s "Release finished: {B $GBV}"
         rm -f .git/RELEASE
     else
         git undo
-        npx --yes chalk-cli -t "{red ✘} Cannot finish release. CHANGELOG & VERSION are not updated."
+        zz_log e "Cannot finish release. CHANGELOG & VERSION are not updated."
     fi
 else
-    npx --yes chalk-cli -t "{red ✘} Cannot update version & finish release"
+    zz_log e "Cannot update version & finish release"
 fi
 
 #### BACK

src/gitutils/devcontainer-feature.json

@@ -2,7 +2,7 @@
     "id": "gitutils",
     "name": "Git Aliases",
     "description": "A feature to add useful Git aliases to your shell.",
-    "version": "5.4.3",
+    "version": "5.5.1",
     "dependsOn": {
         "ghcr.io/devcontainers/features/node:1": "lts",
         "ghcr.io/tomgrv/devcontainer-features/common-utils:3": {