Format comparisons, functions, and redirections to be consistent (#1201)

* Format comparisons and functions to be consistent

* Add `checkstyle.py` script and add check to CI

* Fix Ruff lints

Author: hyperupcall

.github/workflows/ci.yml

@@ -36,6 +36,8 @@ jobs:
         env:
           # NOTE: use env to pass the output in order to avoid possible injection attacks
           FILES: "${{ steps.files.outputs.added_modified }}"
+      - name: checkstyle
+        run: ./scripts/checkstyle.py
       - name: Shellcheck
         run: shellcheck --severity=error bin/* ./*.sh
       - name: Lint and format Python with Ruff

bin/git-abort

@@ -2,7 +2,7 @@
 
 set -euo pipefail
 
-function discover_op() {
+discover_op() {
   local gitdir
   # git rev-parse emits an error if not in a git repo so only need to bail out
   gitdir="$(git rev-parse --git-dir)" || exit
@@ -14,7 +14,7 @@ function discover_op() {
   done
 }
 
-function validate_op() {
+validate_op() {
   local op="$1"
   if [ -z "$op" ]; then
     echo "No active operation found" >&2
@@ -26,7 +26,7 @@ function validate_op() {
   fi
 }
 
-function discover_action() {
+discover_action() {
     local action=${1/git-/}
     if [ "$action" != "abort" ] && [ "$action" != "continue" ]; then
         echo "Invalid action: $1" >&2

bin/git-bulk

@@ -30,7 +30,7 @@ cdfail() {
 }
 
 # add another workspace to global git config
-function addworkspace {
+addworkspace() {
   git config --global bulkworkspaces."$wsname" "$wsdir";
   if [ -n "$source" ]; then
         if [ ! -d "$wsdir" ]; then echo 1>&2 "Path of workspace doesn't exist, make it first."; exit 1; fi
@@ -59,19 +59,19 @@ function addworkspace {
 }
 
 # add current directory
-function addcurrent { git config --global bulkworkspaces."$wsname" "$PWD"; }
+addcurrent() { git config --global bulkworkspaces."$wsname" "$PWD"; }
 
 # remove workspace from global git config
-function removeworkspace { checkWSName && git config --global --unset bulkworkspaces."$wsname"; }
+removeworkspace() { checkWSName && git config --global --unset bulkworkspaces."$wsname"; }
 
 # remove workspace from global git config
-function purge { git config --global --remove-section bulkworkspaces; }
+purge() { git config --global --remove-section bulkworkspaces; }
 
 # list all current workspace locations defined
-function listall { git config --global --get-regexp bulkworkspaces; }
+listall() { git config --global --get-regexp bulkworkspaces; }
 
 # guarded execution of a git command in one specific repository
-function guardedExecution () {
+guardedExecution () {
   if [ "${quiet?}" != "true" ] || $guardedmode; then
     echo 1>&2 "${bldred}->${reset} executing ${inverse}git $gitcommand${reset} in repository ${leadingpath%/*}/${bldred}${curdir##*/}${reset}"
   fi
@@ -88,7 +88,7 @@ function guardedExecution () {
 }
 
 # check if the passed command is known as a core git command
-function checkGitCommand () {
+checkGitCommand () {
   if git help -a | grep -o -q "\b${corecommand}\b"; then
     echo 1>&2 "Core command \"$corecommand\" accepted."
   else
@@ -101,7 +101,7 @@ function checkGitCommand () {
 }
 
 # check if workspace name is registered
-function checkWSName () {
+checkWSName () {
   while read -r workspace; do
     parseWsName "$workspace"
     if [[ $rwsname == "$wsname" ]]; then return; fi
@@ -111,7 +111,7 @@ function checkWSName () {
 }
 
 # parse out wsname from workspacespec
-function parseWsName () {
+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`
@@ -128,7 +128,7 @@ function parseWsName () {
 }
 
 # detects the wsname of the current directory
-function wsnameToCurrent () {
+wsnameToCurrent () {
   while read -r workspace; do
     if [ -z "$workspace" ]; then continue; fi
     parseWsName "$workspace"
@@ -140,15 +140,15 @@ function wsnameToCurrent () {
 }
 
 # helper to check number of arguments.
-function allowedargcount () {
+allowedargcount () {
 	if [ "$paramcount" -ne "${1:-0}"  ] && [ "$paramcount" -ne "${2:-0}" ]; then
 		echo 1>&2 "error: wrong number of arguments" && usage;
 		exit 1;
 	fi
 }
 
 # execute the bulk operation
-function executBulkOp () {
+executBulkOp () {
   checkGitCommand
   if ! $allwsmode && ! $singlemode; then wsnameToCurrent; fi # by default git bulk works within the 'current' workspace
   listall | while read -r workspacespec; do
@@ -194,7 +194,7 @@ while [ "${#}" -ge 1 ] ; do
     --listall|--purge)
       butilcommand="${1:2}" && break ;;
     --removeworkspace|--addcurrent|--addworkspace)
-      butilcommand="${1:2}" && wsname="$2" && wsdir="$3" && if [ "$4" == "--from" ]; then source="$5"; fi && break ;;
+      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)

bin/git-clear

@@ -2,7 +2,7 @@
 PROGNAME="git-clear"
 FORCE=0
 
-function _usage() {
+_usage() {
 cat << EOF
 usage: $PROGNAME options
 usage: $PROGNAME -h|help|?
@@ -38,6 +38,6 @@ else
     clean=y
 fi
 
-if [ "$clean" == "y" ]; then
+if [ "$clean" = "y" ]; then
     git clean -d -f -x && git reset --hard
 fi

bin/git-clear-soft

@@ -2,6 +2,6 @@
 
 echo -n "Sure? - This command may delete files that cannot be recovered. Files and directories in .gitignore will be preserved [y/N]: "
 read -r answer
-if [ "$answer" == "y" ]
+if [ "$answer" = "y" ]
     then git clean -d -f && git reset --hard
 fi

bin/git-ignore

@@ -2,7 +2,7 @@
 
 GIT_DIR=$(git rev-parse --git-dir 2>/dev/null)
 
-function show_contents {
+show_contents() {
   local file="${2/#~/$HOME}"
   if [ -f "$file" ]; then
     echo "$1 gitignore: $2" && cat "$file"
@@ -11,7 +11,7 @@ function show_contents {
   fi
 }
 
-function cd_to_git_root {
+cd_to_git_root() {
   local error_level="$1"
 
   if ! git rev-parse --git-dir &>/dev/null; then
@@ -29,7 +29,7 @@ function cd_to_git_root {
   fi
 }
 
-function global_ignore() {
+global_ignore() {
   if ! git config --global core.excludesFile 2>/dev/null; then
     if [ -f "$HOME/.gitignore" ]; then
       echo "$HOME/.gitignore"
@@ -39,11 +39,11 @@ function global_ignore() {
   fi
 }
 
-function show_global {
+show_global() {
   show_contents Global "$(global_ignore)"
 }
 
-function add_global {
+add_global() {
   local global_gitignore
   global_gitignore="$(global_ignore)"
   if [ -z "$global_gitignore" ]; then
@@ -56,28 +56,28 @@ function add_global {
   fi
 }
 
-function show_local {
+show_local() {
   cd_to_git_root --warn
   show_contents Local .gitignore
 }
 
-function add_local {
+add_local() {
   cd_to_git_root --warn
   add_patterns .gitignore "$@"
 }
 
-function show_private {
+show_private() {
   cd_to_git_root --error
   show_contents Private "${GIT_DIR}/info/exclude"
 }
 
-function add_private {
+add_private() {
   cd_to_git_root --error
   test -d "${GIT_DIR}/info" || mkdir -p "${GIT_DIR}/info"
   add_patterns "${GIT_DIR}/info/exclude" "$@"
 }
 
-function add_patterns {
+add_patterns() {
   echo "Adding pattern(s) to: $1"
   local file="${1/#~/$HOME}"
   dir_name=$(dirname "$file")

bin/git-merge-into

@@ -18,7 +18,7 @@ then
     git stash
 fi
 
-if [ "${!#}" == '--ff-only' ]; then
+if [ "${!#}" = '--ff-only' ]; then
     case $# in
         2 ) # dest --ff
             git push "$(git rev-parse --show-toplevel)" "$cur_branch":"$1";;

bin/git-paste

@@ -2,7 +2,7 @@
 set -e
 set -o pipefail
 
-if ! command -v pastebinit >/dev/null 2>&1; then
+if ! command -v pastebinit &>/dev/null; then
     echo >&2 "To run 'git paste', you need to install pastebinit in your system"
     exit 1
 fi

bin/git-psykorebase

@@ -5,7 +5,7 @@ SECONDARY_BRANCH=""
 FF="--ff"
 CONTINUE="no"
 
-function current_branch() {
+current_branch() {
     git rev-parse --abbrev-ref HEAD
 }
 

bin/git-pull-request

@@ -43,7 +43,7 @@ if [ -z "$remote" ]; then
     echo 'no upstream found, push to origin as default'
     remote="origin"
 fi
-[ "$remote" == "." ] && abort "the upstream should be a remote branch."
+[ "$remote" = "." ] && abort "the upstream should be a remote branch."
 
 # make sure it's pushed