From 2f7da325327d1e130f73cc6c087ff003bd14d2e8 Mon Sep 17 00:00:00 2001
From: John D Pell <John+Git@gaelicWizard.net>
Date: Sat, 12 Feb 2022 00:14:12 -0800
Subject: [PATCH] template: `shellcheck`

- and generally comment out useless varbls
---
 template/bashrc.template.bash | 40 ++++++++++++++++++-----------------
 test/install/install.bats     |  2 +-
 2 files changed, 22 insertions(+), 20 deletions(-)
 mode change 100644 => 100755 test/install/install.bats

diff --git a/template/bashrc.template.bash b/template/bashrc.template.bash
index 478cbc9891..20bd3ca676 100644
--- a/template/bashrc.template.bash
+++ b/template/bashrc.template.bash
@@ -1,4 +1,5 @@
-#!/usr/bin/env bash
+# shellcheck shell=bash
+# shellcheck disable=SC2034
 
 # If not running interactively, don't do anything
 case $- in
@@ -7,12 +8,12 @@ case $- in
 esac
 
 # Path to the bash it configuration
-export BASH_IT="{{BASH_IT}}"
+BASH_IT="{{BASH_IT}}"
 
 # Lock and Load a custom theme file.
 # Leave empty to disable theming.
-# location /.bash_it/themes/
-export BASH_IT_THEME='bobby'
+# location ~/.bash_it/themes/
+BASH_IT_THEME='bobby'
 
 # Some themes can show whether `sudo` has a current token or not.
 # Set `$THEME_CHECK_SUDO` to `true` to check every prompt:
@@ -20,14 +21,14 @@ export BASH_IT_THEME='bobby'
 
 # (Advanced): Change this to the name of your remote repo if you
 # cloned bash-it with a remote other than origin such as `bash-it`.
-# export BASH_IT_REMOTE='bash-it'
+#BASH_IT_REMOTE='bash-it'
 
 # (Advanced): Change this to the name of the main development branch if
 # you renamed it or if it was changed for some reason
-# export BASH_IT_DEVELOPMENT_BRANCH='master'
+#BASH_IT_DEVELOPMENT_BRANCH='master'
 
 # Your place for hosting Git repos. I use this for private repos.
-export GIT_HOSTING='git@git.domain.com'
+#GIT_HOSTING='git@git.domain.com'
 
 # Don't check mail when opening terminal.
 unset MAILCHECK
@@ -36,49 +37,50 @@ unset MAILCHECK
 export IRC_CLIENT='irssi'
 
 # Set this to the command you use for todo.txt-cli
-export TODO="t"
+TODO="t"
 
 # Set this to the location of your work or project folders
 #BASH_IT_PROJECT_PATHS="${HOME}/Projects:/Volumes/work/src"
 
 # Set this to false to turn off version control status checking within the prompt for all themes
-export SCM_CHECK=true
+#SCM_CHECK=true
+
 # Set to actual location of gitstatus directory if installed
-#export SCM_GIT_GITSTATUS_DIR="$HOME/gitstatus"
+#SCM_GIT_GITSTATUS_DIR="$HOME/gitstatus"
 # per default gitstatus uses 2 times as many threads as CPU cores, you can change this here if you must
 #export GITSTATUS_NUM_THREADS=8
 
 # Set Xterm/screen/Tmux title with only a short hostname.
 # Uncomment this (or set SHORT_HOSTNAME to something else),
 # Will otherwise fall back on $HOSTNAME.
-#export SHORT_HOSTNAME=$(hostname -s)
+#SHORT_HOSTNAME=$(hostname -s)
 
 # Set Xterm/screen/Tmux title with only a short username.
 # Uncomment this (or set SHORT_USER to something else),
 # Will otherwise fall back on $USER.
-#export SHORT_USER=${USER:0:8}
+#SHORT_USER=${USER:0:8}
 
 # If your theme use command duration, uncomment this to
 # enable display of last command duration.
-#export BASH_IT_COMMAND_DURATION=true
+#BASH_IT_COMMAND_DURATION=true
 # You can choose the minimum time in seconds before
 # command duration is displayed.
-#export COMMAND_DURATION_MIN_SECONDS=1
+#COMMAND_DURATION_MIN_SECONDS=1
 
 # Set Xterm/screen/Tmux title with shortened command and directory.
 # Uncomment this to set.
-#export SHORT_TERM_LINE=true
+#SHORT_TERM_LINE=true
 
 # Set vcprompt executable path for scm advance info in prompt (demula theme)
 # https://github.com/djl/vcprompt
-#export VCPROMPT_EXECUTABLE=~/.vcprompt/bin/vcprompt
+#VCPROMPT_EXECUTABLE=~/.vcprompt/bin/vcprompt
 
 # (Advanced): Uncomment this to make Bash-it reload itself automatically
 # after enabling or disabling aliases, plugins, and completions.
-# export BASH_IT_AUTOMATIC_RELOAD_AFTER_CONFIG_CHANGE=1
+# BASH_IT_AUTOMATIC_RELOAD_AFTER_CONFIG_CHANGE=1
 
 # Uncomment this to make Bash-it create alias reload.
-# export BASH_IT_RELOAD_LEGACY=1
+# BASH_IT_RELOAD_LEGACY=1
 
 # Load Bash It
-source "$BASH_IT"/bash_it.sh
+source "${BASH_IT?}/bash_it.sh"
diff --git a/test/install/install.bats b/test/install/install.bats
old mode 100644
new mode 100755
index d4149bba36..1bbbda7022
--- a/test/install/install.bats
+++ b/test/install/install.bats
@@ -76,5 +76,5 @@ function local_setup_file() {
   run cat "$HOME/$BASH_IT_CONFIG_FILE"
 
   assert_line "test file content"
-  assert_line "source \"\$BASH_IT\"/bash_it.sh"
+  assert_line 'source "${BASH_IT?}/bash_it.sh"'
 }