Lint bin/clicksnap-setup

Author: JedMeister

bin/clicksnap-setup

@@ -1,5 +1,5 @@
 #!/bin/bash -e
-# Copyright (c) 2023 TurnKey GNU/Linux - https://www.turnkeylinux.org
+# Copyright (c) 2023-2025 TurnKey GNU/Linux - https://www.turnkeylinux.org
 #
 # This file is part of buildtasks.
 #
@@ -8,13 +8,14 @@
 # Free Software Foundation; either version 3 of the License, or (at your
 # option) any later version.
 
-fatal() { echo "FATAL [$(basename $0)]: $@" 1>&2; exit 1; }
-warn() { echo -e "WARNING [$(basename $0)]: $@"; }
-info() { echo "INFO [$(basename $0)]: $@"; }
+fatal() { echo "FATAL [$(basename "$0")]: $*" 1>&2; exit 1; }
+warn() { echo -e "WARNING [$(basename "$0")]: $*"; }
+info() { echo "INFO [$(basename "$0")]: $*"; }
 
 usage() {
+    local msg="$*"
     cat<<EOF
-Syntax: $(basename $0) [APP_NAME]
+Syntax: $(basename "$0") [APP_NAME]
 Setup/update system ready for bt-iso (clicksnap & deps)
 
 Option::
@@ -29,20 +30,20 @@ Environment::
     BT_DEBUG        turn on debugging
 
 EOF
-    if [[ -n "$1" ]]; then
-        echo "Error: $@" >&2
-        exit 1
+    if [[ -n "$msg" ]]; then
+        fatal "$msg"
     fi
     exit
 }
 
 [ -n "$BT_DEBUG" ] && set -x
 
-export BT=$(dirname $(dirname $(readlink -f $0)))
+BT=$(dirname "$(dirname "$(readlink -f "$0")")")
+export BT
 export BT_CONFIG=$BT/config
 
 [[ -n "$BASE_DIR" ]] || BASE_DIR=/turnkey/public
-mkdir -p $BASE_DIR
+mkdir -p "$BASE_DIR"
 GH_URL=https://github.com/turnkeylinux
 
 unset app
@@ -59,19 +60,20 @@ while [ "$1" != "" ]; do
 done
 
 install() {
-    info "Updating apt cache and installing deps:" $@
-    info "installing $@"
+    info "Updating apt cache and installing deps: $*"
+    info "installing $*"
     apt-get -qq update
-    DEBIAN_FRONTEND=noninteractive apt-get -y install $@
+    DEBIAN_FRONTEND=noninteractive apt-get -y install "$@"
 }
 
 git_pull() {
     local dir=$1
     local app=$2
-    cd $dir
-    local remote=$(sed -En "s|(^[a-zA-Z0-9_-]*)[[:space:]].*|\1|p" \
-                    <<<$(git remote -v | grep -m1 "turnkeylinux/$app"))
-    git pull $remote master
+    cd "$dir"
+    local remote
+    remote=$(sed -En "s|(^[a-zA-Z0-9_-]*)[[:space:]].*|\1|p" \
+                    <<<"$(git remote -v | grep -m1 "turnkeylinux/$app")")
+    git pull "$remote" master
 }
 
 # dl & check for screenshot code first so we can bail as early as possible
@@ -86,14 +88,15 @@ for dl in tkldev-docker clicksnap; do
         fi
     else
         info "Downloading $dl source"
-        git clone --depth=1 $GH_URL/$dl $BASE_DIR/$dl
+        git clone --depth=1 $GH_URL/$dl "$BASE_DIR/$dl"
     fi
 done
 
-app=$(sed "s|-|_|g" <<<$app)
+# TODO use ${variable//search/replace} instead of sed here
+app="$(sed "s|-|_|g" <<< "$app")"
 if [[ -z "$app" ]]; then
     warn "App name not given - continuing, but may fail later"
-elif ! ls $BASE_DIR/clicksnap/src/apps/ | grep -q -w "$app" \
+elif ! grep -r -q -w "$app" "$BASE_DIR"/clicksnap/src/apps/ \
         && [[ -z "$no_screens" ]] ; then
     fatal "Clicksnap code for $app not found (checked in $BASE_DIR/clicksnap/src/apps/)"
 fi
@@ -102,30 +105,31 @@ fi
 deps="podman sed fab deck"
 missing=''
 for dep in $deps; do
-    which $dep >/dev/null || missing="$missing $dep"
+    which "$dep" >/dev/null || missing="$missing $dep"
 done
-[[ -z "$missing" ]] || install $missing
+[[ -z "$missing" ]] || install "$missing"
 
 case "$(which cargo || echo 'fail')" in
     "$HOME/.cargo/bin/cargo")
         info "Rust installed via rustup detected, attempting update"
-        rustup update;;
+        rustup update
+        ;;
     /usr/bin/cargo)
         warn "system installed rust detected; continuing but may cause issues\n" \
              "   - if you encountner issues, please remove rust and rerun";;
     fail)
         info "Installing rust via rustup"
         curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh -s -- -y
-        echo "export PATH=\"\$HOME/.cargo/bin:\$PATH\"" > $HOME/.bashrc.d/rust
-        chmod +x $HOME/.bashrc.d/rust
-        source $HOME/.bashrc.d/rust;;
+        echo "export PATH=\"\$HOME/.cargo/bin:\$PATH\"" > "$HOME"/.bashrc.d/rust
+        chmod +x "$HOME"/.bashrc.d/rust
+        source "$HOME/.bashrc.d/rust";;
     *)
         fatal "Unexpected cargo path: '$1'";;
 esac
 
-cd $BASE_DIR/clicksnap
+cd "$BASE_DIR"/clicksnap
 info "Building & installing clicksnap"
 cargo build
-ln -sf $PWD/target/debug/clicksnap /usr/local/bin/clicksnap
-ln -sf $BASE_DIR/tkldev-docker/dockerize.sh /usr/local/bin/dockerize
-ln -sf $BASE_DIR/tkldev-docker/wait-ready.sh /usr/local/bin/tkl-docker-wait-ready
+ln -sf "$PWD"/target/debug/clicksnap /usr/local/bin/clicksnap
+ln -sf "$BASE_DIR"/tkldev-docker/dockerize.sh /usr/local/bin/dockerize
+ln -sf "$BASE_DIR"/tkldev-docker/wait-ready.sh /usr/local/bin/tkl-docker-wait-ready