Merge branch 'main' into hyperupcall-stale-bot

Author: hyperupcall

.github/workflows/ci.yml

@@ -36,8 +36,10 @@ jobs:
         env:
           # NOTE: use env to pass the output in order to avoid possible injection attacks
           FILES: "${{ steps.files.outputs.added_modified }}"
+      - name: Shellcheck
+        run: shellcheck --severity=error bin/* ./*.sh
       - name: Lint and format Python with Ruff
-        uses: astral-sh/ruff-action@v1
+        uses: astral-sh/ruff-action@v3
 
   typo:
     runs-on: ubuntu-latest

Commands.md

@@ -280,11 +280,20 @@ usage: git bulk [-g] ([-a]|[-w <ws-name>]) <git command>
        git bulk --listall
 ```
 
-  Register a workspace so that `git bulk` knows about it (notice that <ws-root-directory> must be absolute path):
+  Register a workspace so that `git bulk` knows about it (it will be registered in your `.gitconfig`):
 
 ```bash
 $ git bulk --addworkspace personal ~/workspaces/personal
 ```
+
+  Notice that `<ws-root-directory>` must be an absolute path (or an environment variable pointing to an absolute path).
+  In the case of a **single quoted environment variable**, it will be dereferenced at `git-bulk` runtime, suitable for dynamic workspaces (*e.g.*, defined in your `.bashrc`).
+  As an illustration:
+
+```bash
+$ git bulk --addworkspace personal '$PERSONAL_WORKSPACE'
+```
+
   With option `--from` the URL to a single repository or a file containing multiple URLs can be added and they will be cloned directly into the workspace. Suitable for the initial setup of a multi-repo project.
 
 ```bash

bin/git-bulk

@@ -9,12 +9,14 @@ guardedmode=false
 singlemode=false
 allwsmode=false
 quiet=false
+no_follow_symlinks=false
+no_follow_hidden=false
 
 #
 # print usage message
 #
 usage() {
-  echo 1>&2 "usage: git bulk [-q|--quiet] [-g] ([-a]|[-w <ws-name>]) <git command>"
+  echo 1>&2 "usage: git bulk [--no-follow-symlinks] [--no-follow-hidden] [-q|--quiet] [-g] ([-a]|[-w <ws-name>]) <git command>"
   echo 1>&2 "       git bulk --addworkspace <ws-name> <ws-root-directory> (--from <URL or file>)"
   echo 1>&2 "       git bulk --removeworkspace <ws-name>"
   echo 1>&2 "       git bulk --addcurrent <ws-name>"
@@ -111,7 +113,17 @@ function checkWSName () {
 # parse out wsname from workspacespec
 function parseWsName () {
   local wsspec="$1"
+  # Get the workspace value from its specification in the `.gitconfig`.
+  # May be an absolute path or a variable name of the form: `$VARNAME`
   rwsdir=${wsspec#* }
+  if [[ ${rwsdir:0:1} == '$' ]]; then
+    # Dereference the `rwsdir` value which is a variable name.
+    rwsdir_varname=${rwsdir:1}
+    rwsdir=${!rwsdir_varname}
+    if [[ -z "${rwsdir}" ]]; then
+      echo 1>&2 "error: bad environment variable: $rwsdir_varname" && exit 1
+    fi
+  fi
   rwsname=${wsspec#*.} && rwsname=${rwsname%% *}
 }
 
@@ -129,7 +141,7 @@ function wsnameToCurrent () {
 
 # helper to check number of arguments.
 function allowedargcount () {
-	if [ "$paramcount" -ne "$1"  ] && [ "$paramcount" -ne "$2" ]; then
+	if [ "$paramcount" -ne "${1:-0}"  ] && [ "$paramcount" -ne "${2:-0}" ]; then
 		echo 1>&2 "error: wrong number of arguments" && usage;
 		exit 1;
 	fi
@@ -142,19 +154,30 @@ function executBulkOp () {
   listall | while read -r workspacespec; do
     parseWsName "$workspacespec"
     if [[ -n $wsname ]] && [[ $rwsname != "$wsname" ]]; then continue; fi
-    eval cd "\"$rwsdir\""
+    cd "$rwsdir" || exit 1
     local actual=$PWD
     [ "${quiet?}" != "true" ] && echo 1>&2 "Executing bulk operation in workspace ${inverse}$actual${reset}"
 
-    allGitFolders=( $(eval find -L . -name ".git") )
+    # build `find` flags depending on command-line options
+    local find_flags=()
+    if [[ "$no_follow_symlinks" == true ]]; then
+      find_flags+=(-P)
+    else
+      find_flags+=(-L)
+    fi
+    # find all git repositories under the workspace on which we want to operate
+    readarray allGitFolders < <(find "${find_flags[@]}" . -name ".git" 2>/dev/null)
 
     for line in "${allGitFolders[@]}"; do
       local gitrepodir=${line::${#line}-5} # cut the .git part of find results to have the root git directory of that repository
-      eval cd "\"$gitrepodir\"" # into git repo location
+      cd "$gitrepodir" || exit 1 # into git repo location
       local curdir=$PWD
       local leadingpath=${curdir#"${actual}"}
-      guardedExecution "$@"
-      eval cd "\"$rwsdir\"" # back to origin location of last find command
+      # do not execute if we do not want to consider a ".git" directory under a hidden directory
+      if [ $no_follow_hidden = false ] || ! [[ "$leadingpath" =~ "/." ]]; then
+        guardedExecution "$@"
+      fi
+      cd "$rwsdir" || exit 1 # back to origin location of last find command
     done
   done
 }
@@ -172,6 +195,10 @@ while [ "${#}" -ge 1 ] ; do
       butilcommand="${1:2}" && break ;;
     --removeworkspace|--addcurrent|--addworkspace)
       butilcommand="${1:2}" && wsname="$2" && wsdir="$3" && if [ "$4" == "--from" ]; then source="$5"; fi && break ;;
+    --no-follow-symlinks)
+      no_follow_symlinks=true ;;
+    --no-follow-hidden)
+      no_follow_hidden=true ;;
     -a)
       allwsmode=true ;;
     -g)

bin/git-create-branch

@@ -39,7 +39,7 @@ then
 	REMOTE=origin
 fi
 
-test -z $BRANCH && echo "branch argument required." 1>&2 && exit 1
+test -z "$BRANCH" && echo "branch argument required." 1>&2 && exit 1
 
 if [[ -n $REMOTE ]]
 then

bin/git-fork

@@ -61,7 +61,7 @@ else
     # clone forked repo into current dir
     git clone "${remote_prefix}${user}/${project}.git" "$project"
     # add reference to origin fork so can merge in upstream changes
-    cd "$project"
+    cd "$project" || exit
     git remote add upstream "${remote_prefix}${owner}/${project}.git"
     git fetch upstream
 fi

bin/git-guilt

@@ -31,7 +31,7 @@ do
     esac
 done
 
-cd "$(git-root)" # cd for git blame
+cd "$(git-root)" || exit # cd for git blame
 MERGED_LOG=$(git_extra_mktemp)
 if [[ $EMAIL == '-e' ]]
 then
@@ -44,9 +44,11 @@ for file in $(git diff --name-only "$@")
 do
     test -n "$DEBUG" && echo "git blame $file"
     # $1 - since $2 - until
+    # shellcheck disable=SC2086
     git blame $NOT_WHITESPACE --line-porcelain "$1" -- "$file" 2> /dev/null |
         LC_ALL=C sed -n "$PATTERN" | sort | uniq -c | LC_ALL=C sed 's/^\(.\)/- \1/' >> "$MERGED_LOG"
     # if $2 not given, use current commit as "until"
+    # shellcheck disable=SC2086
     git blame $NOT_WHITESPACE --line-porcelain "${2-@}" -- "$file" 2> /dev/null |
         LC_ALL=C sed -n "$PATTERN" | sort | uniq -c | LC_ALL=C sed 's/^\(.\)/+ \1/' >> "$MERGED_LOG"
 done
@@ -71,7 +73,7 @@ END {
             printf("%d %s\n", contributors[people], people)
         }
     }
-}' $MERGED_LOG | sort -nr | # only gawk supports built-in sort function
+}' "$MERGED_LOG" | sort -nr | # only gawk supports built-in sort function
 while read -r line
 do
     people=${line#* }
@@ -103,7 +105,7 @@ do
             do
                 printf "-"
             done
-            printf "(%s)" $num
+            printf "(%s)" "$num"
         else
             for (( i = 0; i > num; i-- ))
             do

bin/git-obliterate

@@ -9,15 +9,15 @@ do
     file="$file"' '"$i"
     shift
 done
-test -n "$*" && range="$*"
+test -n "$*" && range=("$@")
 
 test -z "$file" && echo "file required." 1>&2 && exit 1
-if [ -z "$range" ]
+if [ -z "${range[*]}" ]
 then
     git filter-branch -f --index-filter "git rm -r --cached ""$file"" --ignore-unmatch" \
         --prune-empty --tag-name-filter cat -- --all
 else
-    # don't quote $range so that we can forward multiple rev-list arguments
+    # $range is an array so that we can forward multiple rev-list arguments
     git filter-branch -f --index-filter "git rm -r --cached ""$file"" --ignore-unmatch" \
-        --prune-empty --tag-name-filter cat -- $range
+        --prune-empty --tag-name-filter cat -- "${range[@]}"
 fi

bin/git-repl

@@ -44,8 +44,10 @@ while true; do
   esac
 
   if [[ $cmd == !*  ]]; then
+    # shellcheck disable=SC2086
     eval ${cmd:1}
   elif [[ $cmd == git* ]]; then
+    # shellcheck disable=SC2086
     eval $cmd
   else
     eval git "$cmd"

bin/git-scp

@@ -59,7 +59,7 @@ function php_lint()
 
 function _dos2unix()
 {
-	command -v dos2unix > /dev/null && dos2unix $@
+	command -v dos2unix > /dev/null && dos2unix "$@"
 	return 0
 }
 
@@ -68,8 +68,8 @@ function _sanitize()
 	git config --get-all extras.scp.sanitize | while read -r i
 	do
 		case $i in
-			php_lint) php_lint  $@;; # git config --global --add extras.scp.sanitize php_lint
-			dos2unix) _dos2unix $@;; # git config --global --add extras.scp.sanitize dos2unix
+			php_lint) php_lint  "$@";; # git config --global --add extras.scp.sanitize php_lint
+			dos2unix) _dos2unix "$@";; # git config --global --add extras.scp.sanitize dos2unix
 		esac
 	done
 	return $?
@@ -107,6 +107,7 @@ function scp_and_stage
 	if [ -n "$list" ]
 	then
 		local _TMP=${0///}
+		# shellcheck disable=SC2086
 		echo "$list" > "$_TMP" &&
 		_sanitize $list &&
 		_info "Pushing to $remote ($(git config "remote.$remote.url"))" &&
@@ -131,7 +132,7 @@ function reverse_scp()
 	shift
 
 	local _TMP=${0///}
-	echo $@ > "$_TMP" &&
+	echo "$@" > "$_TMP" &&
 		rsync -rlDv --files-from="$_TMP" "$(git config "remote.$remote.url")/" ./ &&
 		rm "$_TMP"
 }
@@ -173,8 +174,8 @@ case $(basename "$0") in
 	git-scp)
 		case $1 in
 			''|-h|'?'|help|--help) shift; _test_git_scp; _usage "$@";;
-			*)                   scp_and_stage $@;;
+			*)                   scp_and_stage "$@";;
 		esac
 	;;
-	git-rscp)                  reverse_scp $@;;
+	git-rscp)                  reverse_scp "$@";;
 esac

bin/git-summary

@@ -3,12 +3,16 @@
 
 cd "$(git root)" || { echo "Can't cd to top level directory";exit 1; }
 
+PROJECT_FULL_PATH=
 SUMMARY_BY_LINE=
 DEDUP_BY_EMAIL=
 MERGES_ARG=
 OUTPUT_STYLE=
 for arg in "$@"; do
     case "$arg" in
+        --full-path)
+            PROJECT_FULL_PATH=1
+            ;;
         --line)
             SUMMARY_BY_LINE=1
             ;;
@@ -51,7 +55,12 @@ if [ -n "$SUMMARY_BY_LINE" ]; then
 else
   [ $# -ne 0 ] && commit=$*
 fi
-project=${PWD##*/}
+
+if [[ -n "$PROJECT_FULL_PATH" ]]; then
+  project=${PWD/${HOME}/\~}
+else
+  project=${PWD##*/}
+fi
 
 #
 # get date for the given <commit>