chore: fix shellcheck issues

Author: gurpreetatwal

.github/workflows/ci.yml

@@ -15,4 +15,4 @@ jobs:
       - uses: actions/checkout@v5
 
       - name: Run shellcheck
-        run: shellcheck "install/run-helper" "install/helpers.sh" shell/*
+        run: shellcheck --exclude=SC1090,SC1091 "install/run-helper" "install/helpers.sh" shell/aliases shell/commonrc shell/functions shell/profile

install/helpers.sh

@@ -1,9 +1,16 @@
-# vi: ft=zsh
+#!/usr/bin/env bash
 
 # Colored output
+# shellcheck disable=SC2034  # Color codes defined for potential use
 black=30 red=31 green=32 brown=33 blue=34 purple=35 cyan=36 gray=37
 color() {
-  printf "\e[1;$1m$2\e[0m" "${*:3}"
+  local color_code="$1"
+  local format="$2"
+  shift 2
+  printf '\e[1;%sm' "$color_code"
+  # shellcheck disable=SC2059  # Format string is intentionally variable
+  printf "$format" "$@"
+  printf '\e[0m'
 }
 
 # use apt if its available
@@ -20,7 +27,7 @@ installif() {
     fi
 
     color $green " installing\n"
-    sudo $apt install --quiet=4 --yes "$pkg"
+    sudo "$apt" install --quiet=4 --yes "$pkg"
   done
 }
 
@@ -54,22 +61,22 @@ git-clone() {
 
   REMOTE="$1"
   DEST="$2"
-  FLAGS="${@:3}"
+  FLAGS=("${@:3}")
   repo="$(basename "$REMOTE" ".git")"
 
   color $cyan "[git]:  %-20s" "$repo"
 
   if [[ -d "$DEST" ]]; then
     color $green " pulling in $DEST\n"
 
-    if [[ -n "$FLAGS" ]]; then
-      git -C "$DEST" pull "$FLAGS"
+    if [[ ${#FLAGS[@]} -gt 0 ]]; then
+      git -C "$DEST" pull "${FLAGS[@]}"
     else
       git -C "$DEST" pull
     fi
 
   else
     color $green " cloning to $DEST\n"
-    git clone $FLAGS -- "$REMOTE" "$DEST"
+    git clone "${FLAGS[@]}" -- "$REMOTE" "$DEST"
   fi
 }

install/run-helper

@@ -1,4 +1,4 @@
 #!/bin/bash
 
-source $(dirname "$0")/helpers.sh
-$1 ${@:2}
+source "$(dirname "$0")/helpers.sh"
+"$1" "${@:2}"

shell/aliases

@@ -1,4 +1,4 @@
-# vi: ft=sh
+#!/usr/bin/env bash
 
 # Use global aliases if possible
 alias_g() {
@@ -150,7 +150,9 @@ alias gcom="git checkout main"
 ### Merge
 alias gm="git merge"
 alias gma="git merge --abort"
-alias gmc="git status --short | awk '/^U/{print \$2}'  | xargs vim"
+gmc() {
+  git status --short | awk '/^U/{print $2}' | xargs vim
+}
 
 ### Rebasing
 alias grb="git rebase"

shell/commonrc

@@ -1,4 +1,4 @@
-# vi: ft=sh
+#!/usr/bin/env bash
 
 if [[ -n "$ZSH_VERSION" ]]; then
   _SHELL="zsh"
@@ -10,12 +10,12 @@ fi
 [ -f "${XDG_CONFIG_HOME}/fzf/fzf.${_SHELL}" ] && source "${XDG_CONFIG_HOME}/fzf/fzf.${_SHELL}"
 
 # fasd
-if [ $(command -v fasd) ]; then
+if [ "$(command -v fasd)" ]; then
 
-  fasd_cache="$HOME/.fasd-init-$(basename $SHELL)"
+  fasd_cache="$HOME/.fasd-init-$(basename "$SHELL")"
 
   # Update cache if needed
-  if [ "$(command -v fasd)" -nt "$fasd_cache" -o ! -s "$fasd_cache" ]; then
+  if [ "$(command -v fasd)" -nt "$fasd_cache" ] || [ ! -s "$fasd_cache" ]; then
     fasd --init zsh-hook zsh-ccomp zsh-ccomp zsh-ccomp-install zsh-wcomp zsh-wcomp-install >| "$fasd_cache"
   fi
   source "$fasd_cache"
@@ -24,7 +24,8 @@ if [ $(command -v fasd) ]; then
 fi
 
 # gpg
-export GPG_TTY="$(tty)"
+GPG_TTY="$(tty)"
+export GPG_TTY
 
 source ~/dotfiles/shell/functions
 source ~/dotfiles/shell/aliases

shell/functions

@@ -1,11 +1,11 @@
-# vi: ft=zsh
+#!/usr/bin/env bash
 
 view() {
   pygmentize -f 16m -O style=paraiso-dark "$1"
 }
 
 json() {
-  # need to use subshell otherwise file is empty
+  # shellcheck disable=SC2005  # echo with command substitution is intentional to capture output
   echo "$(jq --sort-keys . "$1")" | tee "$1"
 }
 

shell/profile

@@ -1,4 +1,4 @@
-# vi: ft=sh
+#!/usr/bin/env bash
 
 # General Environment Setup
 
@@ -18,13 +18,15 @@ test -d /opt/maven       && PATH+=":/opt/maven/bin"             # maven
 test -d /opt/gradle      && PATH+=":/opt/gradle/bin"            # gradle
 
 ## Editor
-[ "$(command -v nvim)" ] && export EDITOR="nvim" || export EDITOR="vim"
+if [ "$(command -v nvim)" ]; then export EDITOR="nvim"; else export EDITOR="vim"; fi
 
 # Application Environment Variables
 
 ## java
-[ "$(command -v java)" ] && \
-  export JAVA_HOME="$(update-alternatives --query java | grep --perl-regexp --only-matching '(?<=Best: ).*(?=/bin/java)')"
+if [ "$(command -v java)" ]; then
+  JAVA_HOME="$(update-alternatives --query java | grep --perl-regexp --only-matching '(?<=Best: ).*(?=/bin/java)')"
+  export JAVA_HOME
+fi
 
 ## psql
 export PGHOST="localhost"