Fix shell convention warnings and explain closure of #3

Author: lu0

git-worktree-wrapper.sh

@@ -15,7 +15,9 @@
 # shellcheck disable=SC2164
 set -uo pipefail
 
-
+# git command overrider,
+# selects override function according to the command passed to git (`$1`).
+# Commands supported: `checkout` and `branch`
 gww::override_command() {
     case "${1:-}" in
         checkout)   checkout::override_commands "${@:-}" ;;
@@ -24,7 +26,8 @@ gww::override_command() {
     esac
 }
 
-
+# Detects if the repository is a bare repository and triggers
+# the command overrider, else runs vanilla git.
 gww::main() {
     local is_bare_repo
 
@@ -39,6 +42,7 @@ gww::main() {
     fi
 }
 
+# Checks and initializes script's libraries and environment
 gww::init() {
     local script_real_dir
 
@@ -49,12 +53,18 @@ gww::init() {
         exit 1
     fi
 
-    # Load libraries
     # shellcheck source=libs/_init_libs.sh
     source "${script_real_dir}/libs/_init_libs.sh"
 }
 
 
+# This script must be sourced to be able "cd" within the current shell,
+# then we can't just use `set -e` on pipefails: this would close the shell.
+# Here I emulate `set -e` by wrapping the script's execution in a while loop and
+# forcing a `break` after an error is trapped.
+# This is why we can ignore shellcheck's SC2164 code, since "cd'ing" into an
+# inexisting directory returns an error that will be trapped and then 
+# will abort the script, keeping the current shell.
 trap 'break' ERR;
 
 while true; do
@@ -63,5 +73,6 @@ while true; do
     break
 done
 
+# Revert traps and shell options
 trap - ERR
 set +u +o pipefail

libs/_branch.sh

@@ -1,8 +1,10 @@
+#!/usr/bin/env bash
+# shellcheck disable=SC2164
+
 #
 # Functions to wrap git's branch command in bare repositories
 #
 
-
 # Override branch commands. Triggered by:
 # > git branch ...
 branch::override_commands() {
@@ -22,16 +24,15 @@ branch::override_commands() {
 # Delete worktree then branch
 branch::_delete_worktree_and_branch() {
     local opt="${2:-}" branch="${3:-}"
-    local to_dir cd_to_bare_dir worktree_abs_dir
-    local bare_dir
+    local cd_to_bare_dir=false
+    local bare_dir to_dir worktree_abs_dir
 
     bare_dir="$(utils::get_bare_dir)"
     to_dir=$(utils::branch_to_dir_name "${branch}")
-    cd_to_bare_dir=false
 
     worktree_abs_dir="${bare_dir%%/}/${to_dir}"
 
-    case "${2}" in
+    case "${opt}" in
         -d)
             # Soft remove
             utils::git worktree remove "${worktree_abs_dir}" 2> /dev/null \

libs/_checkout.sh

@@ -1,4 +1,7 @@
-#
+#!/usr/bin/env bash
+# shellcheck disable=SC2164
+
+# 
 # Functions to wrap git's checkout command in bare repositories
 #
 # Uses globals:
@@ -46,7 +49,7 @@ checkout::override_commands() {
 checkout::_create_branch_and_worktree() {
 
     local opt="${2:-}" to="${3:-}" from="${4:-}"
-    local to_dir existing_branch existing_worktree
+    local to_dir existing_branch
 
     if [ -z "${from:-}" ]; then
         # Use current branch as reference
@@ -116,14 +119,13 @@ checkout::_switch_to_branch_and_worktree() {
 #             an empty string if the creation was not successful.
 checkout::__create_worktree_from_branch() {
     local to_dir
-    local existing_worktree
     local bare_dir
 
     bare_dir=$(utils::get_bare_dir)
     to_dir=$(utils::branch_to_dir_name "${to}")
 
     # Create worktree if does not exist
-    if [ -z $(utils::get_branch_path "${to}") ]; then
+    if [ -z "$(utils::get_branch_path "${to}")" ]; then
         # Created in the directory of the bare repository
         cd "${bare_dir}"
 

libs/_utils.sh

@@ -1,3 +1,6 @@
+#!/usr/bin/env bash
+# shellcheck disable=SC2164
+
 #
 # Miscellaneous utilities
 #
@@ -37,15 +40,16 @@ utils::get_bare_dir() {
 
 
 utils::__store_last_checkedout() {
+    local branch worktree_path info
     branch=$(git branch --show-current)
-    worktree_path=$(utils::get_branch_path ${branch})
+    worktree_path=$(utils::get_branch_path "${branch}")
     info="${worktree_path}\t[${branch}]"
-    echo -e "${info}" > $(utils::get_bare_dir)/.lastcheckedout
+    echo -e "${info}" > "$(utils::get_bare_dir)"/.lastcheckedout
 }
 
 
 # Open the current worktree in a enabled and set editor and
-# store a reference to the worktree directory in the repository's roots
+# store a reference to the worktree directory in the repository's root
 utils::open_editor_and_store_reference() {
     if [[ "${EDITOR:-}" ]] && [[ "${DISABLE_GIT_WORKTREE_EDITOR:-}" != "1" ]]; then
         utils::info "Opening in editor: ${EDITOR:-}"