add shellcheck

.github/workflows/bats.yml

@@ -4,11 +4,11 @@ name: CI
 
 # Controls when the action will run. 
 on:
-  # Triggers the workflow on push or pull request events but only for the master branch
+  # Triggers the workflow on push or pull request events but only for the main branch
   push:
-    branches: [ master ]
+    branches: [ main ]
   pull_request:
-    branches: [ master ]
+    branches: [ main ]
 
   # Allows you to run this workflow manually from the Actions tab
   workflow_dispatch:
@@ -27,4 +27,11 @@ jobs:
       - uses: actions/setup-node@v1
       - run: npm install -g bats
       - run: mkdir -p $HOME/.local/bin
-      - run: bats tests
+      - run: bats tests
+  shellcheck:
+    name: Shellcheck
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - name: Run ShellCheck
+      uses: ludeeus/action-shellcheck@master    

1password.sh

@@ -1,5 +1,7 @@
+#!/usr/bin/env bash
+
 1password_install_cli() {
     [[ "$(uname)" == "Darwin" ]] && brew install 1password-cli && libsh__exit_with_message "Installed" "1password-cli"
     [[ "$(uname)" == "Linux" ]] && export LIBSH_OSLINUX=t
     [[ "${LIBSH_OSLINUX}" == "t" ]] && wget -O /tmp/op.zip https://cache.agilebits.com/dist/1P/op/pkg/v1.8.0/op_linux_386_v1.8.0.zip && mkdir -p $HOME/.local/bin && unzip /tmp/op.zip -d $HOME/.local/bin
-}
+}

README.md

@@ -2,34 +2,48 @@
 
 boot your sh
 
-## install
+## install summary
+
+List of steps for installing libsh:
 
 * git clone https://github.com/aaronaddleman/libsh
-* add libsh to your init files
+* add libsh to your init files:
+  * .zshrc
+  * .zshenv
+* cp .libshrc_example to $HOME/.libshrc
+* (optional) create $HOME/.sh.d/ and any filename.sh or filename.env.sh file will be loaded
+
+## install (copy+paste)
 
 ```
-# .zshrc
-source $HOME/src/libsh/libsh.sh "fn"
-# .zshenv
-source $HOME/src/libsh/libsh.sh "env"
+echo "source $(pwd)/libsh.sh \"fn\"" >> $HOME/.zshrc
+echo "source $(pwd)/libsh.sh \"env\"" >> $HOME/.zshenv
+cp .libshrc_example $HOME/.libshrc
 ```
 
-* add .libshrc from $HOME/src/libsh/.libshrc
-
-This file selects which modules are loaded. This file
-contains lots of comments about each option.
+## install (manual)
 
 ```
-cp $HOME/src/libsh/.libshrc_example $HOME/.libshrc
+source $LIBSH_REPO_PATH/libsh.sh \"fn\"" >> $HOME/.zshrc
+source $LIBSH_REPO_PATH/libsh.sh \"env\"" >> $HOME/.zshenv
+cp .libshrc_example $HOME/.libshrc
 ```
 
-* (optional) create a `$HOME/.sh.d/yourown.env.sh` or `$HOME/.sh.d/yourown.sh`.
+## description of files
+
+`libsh.sh`
+
+- This is the main file that loads libsh files and environment variables.
+
+`.libshrc_example`
+
+- Example configuration file for settings to be used in your shell and libsh.
 
-LIBSH will load all `yourown.env.sh` or `yourown.sh` files from $HOME/.sh.d
+`$HOME/.config/libsh/hc_vaults.json`
 
-## config files
+- Configuration file for multiple HashiCorp Vault servers
 
-### hc vaults
+## hc vaults file
 
 Creating a file like the following allows you to select vaults
 

aws.sh

@@ -1,3 +1,4 @@
+#!/usr/bin/env bash
 
 aws_validate_env() {
     if command -v aws > /dev/null; then

bash.env.sh

@@ -1,8 +1,10 @@
+#!/usr/bin/env bash
+
 # load any additional settings
 #[ -d $HOME/.bash.d ] && ls $HOME/.bash.d/*.env.sh 1> /dev/null 2>&1
 
 #[ "$?" == "0" ] && source $HOME/.bash.d/*.env.sh
 
-local num_of_env_sh=$(find $HOME/.bash.d -maxdepth 1 -type f  -name '*.env.sh' | wc -l)
-libsh__debug "INFO Found ${num_of_env_sh} files matching $HOME/.bash.d/*.env.sh ."
-[ "${num_of_env_sh}" -gt 0 ] && source $HOME/.bash.d/*.env.sh
+libsh__num_of_env_sh=$(find $HOME/.bash.d -maxdepth 1 -type f  -name '*.env.sh' | wc -l)
+libsh__debug "INFO Found ${libsh__num_of_env_sh} files matching $HOME/.bash.d/*.env.sh ."
+[ "${libsh__num_of_env_sh}" -gt 0 ] && source $HOME/.bash.d/*.env.sh

brew.env.sh

@@ -0,0 +1 @@
+[[ -f /opt/homebrew/bin/brew ]] && eval "$(/opt/homebrew/bin/brew shellenv)"

clojure.sh

@@ -1,3 +1,5 @@
+#!/usr/bin/env bash
+
 clojure_install() {
     brew install clojure/tools/clojure
-}
+}

custom.env.sh

@@ -1,3 +1,5 @@
+#!/usr/bin/env bash
+
 # load any additional settings
 {
     local dirlist=($(ls $HOME/.sh.d/*.env.sh))

custom.sh

@@ -1,3 +1,5 @@
+#!/usr/bin/env bash
+
 # load any additional settings
 {
     local dirlist=($(ls $HOME/.sh.d/*.fn.sh))

figlet.sh

@@ -1,3 +1,5 @@
+#!/usr/bin/env bash
+
 figlet_install_fonts() {
     local help=$(cat <<HELP
 ## figlet_install_fonts

git.sh

@@ -1,3 +1,5 @@
+#!/usr/bin/env bash
+
 #
 # set git auto correct
 #

go.env.sh

@@ -1,3 +1,5 @@
+#!/usr/bin/env bash
+
 # GOENV
 [ -d $HOME/.goenv ] && export GOENV_ROOT="$HOME/.goenv"
 [ -d $HOME/.goenv ] && libsh__add_path "pre" "$GOENV_ROOT/bin"
@@ -10,7 +12,7 @@
 # GOPATH
 ## this will not conflict with goenv because the destination for 
 ## for goenv is $HOME/go/VER/bin
-[ -d $HOME/go -a ! -d $HOME/.goenv ] && export GOPATH="$HOME/go" || libsh__debug "x..could not find $HOME/go"
+[ -d $HOME/go && ! -d $HOME/.goenv ] && export GOPATH="$HOME/go" || libsh__debug "x..could not find $HOME/go"
 [ -d $HOME/go/bin ] && libsh__add_path "post" "$HOME/go/bin"
 
 # GOROOT

go.sh

@@ -1,3 +1,5 @@
+#!/usr/bin/env bash
+
 # if you have .goenv installed, init
 #[ -d $HOME/.goenv ] && export GOENV_ROOT="$HOME/.goenv"
 #[ -d $HOME/.goenv ] && libsh__add_path "pre" "$GOENV_ROOT/bin"

haskell.sh

@@ -1,4 +1,6 @@
+#!/usr/bin/env bash
+
 haskell_install_stack() {
     # install the stack so you can run haskell
     curl -sSL https://get.haskellstack.org/ | sh
-}
+}

jupyter.sh

@@ -1,3 +1,5 @@
+#!/usr/bin/env bash
+
 jupyter_labs_docker_base() {
     local help=$(cat <<HELP
 ## jupyter_labs_docker_base

jupyterlabs_boot.sh

@@ -1,3 +1,5 @@
+#!/usr/bin/env bash
+
 # do things before the notebook is created
 sudo apt update && apt install -y curl net-tools zsh git unzip
 # set zsh for the user

libsh.env.sh

@@ -0,0 +1 @@
+#!/usr/bin/env bash

libsh.sh

@@ -1,3 +1,5 @@
+#!/usr/bin/env bash
+
 #
 # LIBSH
 #
@@ -19,41 +21,47 @@
 #
 # Find out where this file lives and call it home
 #
-if [ -z $LIBSH_HOME ]; then
+if [ -z "$LIBSH_HOME" ]; then
     case $SHELL in
         *zsh)
-            export LIBSH_HOME=${0:a:h}
-            export LIBSH_DEBUG_LOGFILE=$LIBSH_HOME/debug.log
+            LIBSH_HOME=${0:a:h}
+            export LIBSH_HOME
+            LIBSH_DEBUG_LOGFILE=$LIBSH_HOME/debug.log
+            export LIBSH_DEBUG_LOGFILE
             ;;
         *bash)
-            export LIBSH_HOME=$(dirname $BASH_SOURCE[@])
-            export LIBSH_DEBUG_LOGFILE=$LIBSH_HOME/debug.log
+            LIBSH_HOME=$(dirname "${BASH_SOURCE[@]}")
+            export LIBSH_HOME
+            LIBSH_DEBUG_LOGFILE=$LIBSH_HOME/debug.log
+            export LIBSH_DEBUG_LOGFILE
             ;;
         *ash)
-            export LIBSH_HOME=$(dirname $BASH_SOURCE[@])
-            export LIBSH_DEBUG_LOGFILE=$LIBSH_HOME/debug.log
+            LIBSH_HOME=$(dirname "${BASH_SOURCE[@]}")
+            export LIBSH_HOME
+            LIBSH_DEBUG_LOGFILE=$LIBSH_HOME/debug.log
+            export LIBSH_DEBUG_LOGFILE
             ;;
         *)
             echo "Failed. Shell of \"$SHELL\" not supported" && kill -INT $$
     esac
 
-    [ -n $LIBSH_HOME ] && export LIBSH_DEBUG_LOGFILE=$LIBSH_HOME/debug.log
-    [ -z $LIBSH_HOME ] && echo "Could not set LIBSH_HOME." && kill -INT $$
+    [[ -n "$LIBSH_HOME" ]] && export LIBSH_DEBUG_LOGFILE=$LIBSH_HOME/debug.log
+    [[ -z "$LIBSH_HOME" ]] && echo "Could not set LIBSH_HOME." && kill -INT $$
 fi
 
 
 #
 # Load libsh_utils.sh
 #
-[ -n "${LIBSH_HOME}" ] && source $LIBSH_HOME/libsh_utils.sh
+[ -n "${LIBSH_HOME}" ] && source "$LIBSH_HOME"/libsh_utils.sh
 
 #
 # define custom Functions and default Functions
 #
-source $LIBSH_HOME/.libshrc.sh && libsh__debug "loaded $LIBSH_HOME/.libshrc.sh"
+source "$LIBSH_HOME"/.libshrc.sh && libsh__debug "loaded $LIBSH_HOME/.libshrc.sh"
 # if custom libshrc exists, load that
-[[ -f "$HOME/.libshrc" ]] && source $HOME/.libshrc && libsh__debug "loaded $HOME/.libshrc"
-[[ -f "$HOME/.libshrc.sh" ]] && source $HOME/.libshrc.sh && libsh__debug "loaded $HOME/.libshrc.sh"
+[[ -f "$HOME/.libshrc" ]] && source "$HOME"/.libshrc && libsh__debug "loaded $HOME/.libshrc"
+[[ -f "$HOME/.libshrc.sh" ]] && source "$HOME"/.libshrc.sh && libsh__debug "loaded $HOME/.libshrc.sh"
 
 libsh_fn=("${libsh_fn_custom[@]}" "${libsh_fn_defaults[@]}")
 libsh__debug "fn custom -> ${libsh_fn_custom[*]}"
@@ -67,16 +75,16 @@ libsh__load() {
 
     # when in debug mode,
     # remove log file if it exists
-    [ -n $LIBSH_DEBUG ] && \
-    [ -f $LIBSH_DEBUG_LOGFILE ] && \
-        [ $(wc -l $LIBSH_DEBUG_LOGFILE | awk '{print $1}') -gt 1000 ] && \
-        rm $LIBSH_DEBUG_LOGFILE
+    [ -n "$LIBSH_DEBUG" ] && \
+        [ -f "$LIBSH_DEBUG_LOGFILE" ] && \
+        [ "$(wc -l "$LIBSH_DEBUG_LOGFILE" | awk '{print $1}')" -gt 1000 ] && \
+        rm "$LIBSH_DEBUG_LOGFILE"
 
     # start of libsh fn and env for-loop
     if [ ${#libsh_fn[@]} ]; then
         [[ "${mode}" == "env" ]] && libsh__debug "\n\n---ENV-$(date)--"
         [[ "${mode}" == "fn" ]] && libsh__debug "\n\n---FN-$(date)--"
-        for fn in ${libsh_fn[@]}
+        for fn in "${libsh_fn[@]}"
         do
             ### FN
             # debug and show what we load for ${FN}.sh
@@ -85,8 +93,8 @@ libsh__load() {
             local fn_varname="LIBSH_status_fn_${fn}"
             # load the FNs
             [[ "${mode}" == "fn" ]] && \
-                [ -f ${LIBSH_HOME}/${fn}.sh ] && \
-                source ${LIBSH_HOME}/${fn}.sh && \
+                [ -f "${LIBSH_HOME}"/"${fn}".sh ] && \
+                source "${LIBSH_HOME}"/"${fn}".sh && \
                 printf -v "$fn_varname" '%s' "loaded" && \
                 libsh__debug "FN  Loaded '${LIBSH_HOME}/${fn}.sh'"
 
@@ -97,8 +105,8 @@ libsh__load() {
             local env_varname="LIBSH_status_env_${fn}"
             # load the FNs envs
             [[ "${mode}" == "env" ]] && \
-                [ -f ${LIBSH_HOME}/${fn}.env.sh ] && \
-                source ${LIBSH_HOME}/${fn}.env.sh && \
+                [ -f "${LIBSH_HOME}"/"${fn}".env.sh ] && \
+                source "${LIBSH_HOME}"/"${fn}".env.sh && \
                 printf -v "$env_varname" '%s' "loaded" && \
                 libsh__debug "ENV  Loading '${LIBSH_HOME}/${fn}.env.sh'"
         done
@@ -111,14 +119,14 @@ libsh__load() {
         libsh__exit_with_message "ERR" "Something went wrong in loading libsh."
     fi
 
-    if [ ${LIBSH_CHECK_BY_DATE} ]; then
+    if [ "${LIBSH_CHECK_BY_DATE}" ]; then
         libsh__check_by_date
     fi
 }
 
 # if we get an arg, load the things!
 [ -z "${1}" ] && libsh__exit_with_message "ERR" "I need to know if you want to load 'fn' or 'env'. Instead I got: '${1}'."
-[[ "$1" = "fn" || "$1" = "env" ]] && libsh__load ${1} || libsh__exit_with_message "ERR" "I did not get fn or env. Instead I got: '$1'"
+( [[ "$1" = "fn" || "$1" = "env" ]] && libsh__load "${1}" ) || libsh__exit_with_message "ERR" "I did not get fn or env. Instead I got: '$1'"
 
 
 #

libsh_utils.sh

@@ -1,3 +1,5 @@
+#!/usr/bin/env bash
+
 # exit with problem and not exit shell
 libsh__exit_with_message() {
     echo "$1: $2"

lpass.env.sh

@@ -1,2 +1,4 @@
+#!/usr/bin/env bash
+
 [ ! -z ${ENABLE_LPASS_AGENT_TIMEOUT} ] && \
     export set LPASS_AGENT_TIMEOUT="${ENABLE_LPASS_AGENT_TIMEOUT-300}"

npm.env.sh

@@ -1,3 +1,5 @@
+#!/usr/bin/env bash
+
 # npm env
 
 # npm command found?

npm.sh

@@ -1 +1,3 @@
-# npm
+#!/usr/bin/env bash
+
+# npm

nvm.env.sh

@@ -0,0 +1,3 @@
+export NVM_DIR="$HOME/.nvm"
+[ -s "/opt/homebrew/opt/nvm/nvm.sh" ] && \. "/opt/homebrew/opt/nvm/nvm.sh"  # This loads nvm
+[ -s "/opt/homebrew/opt/nvm/etc/bash_completion.d/nvm" ] && \. "/opt/homebrew/opt/nvm/etc/bash_completion.d/nvm"  # This loads nvm bash_completion

nvm.sh

@@ -0,0 +1,6 @@
+# nvm
+nvm_install() {
+    command -v nvm > /dev/null
+    [ "${?}" = "0" ] || brew install nvm
+    [[ -d $HOME/.nvm ]] || mkdir $HOME/.nvm
+}

ohmyzsh.sh

@@ -1,3 +1,5 @@
+#!/usr/bin/env bash
+
 ohmyzsh_validate() {
     [ -z $ZSH_CUSTOM ] && export ZSH_CUSTOM=$HOME/.oh-my-zsh/custom
 }

options.sh

@@ -1,3 +1,5 @@
+#!/usr/bin/env bash
+
 case $SHELL in
   *zsh)
       command -v setopt > /dev/null

paths.env.sh

@@ -1,3 +1,5 @@
+#!/usr/bin/env bash
+
 [ -d $HOME/.local/bin ] && libsh__add_path "pre" "$HOME/.local/bin"
 [ -d /usr/local/bin ] && libsh__add_path "pre" "/usr/local/bin"
 [ ! -z $LIBSH_CDPATH ] && export CDPATH=$LIBSH_CDPATH

pyenv.env.sh

@@ -1,3 +1,5 @@
+#!/usr/bin/env bash
+
 if [ -d $HOME/.pyenv ]; then
     # set the PYENV_ROOT
     export PYENV_ROOT="$HOME/.pyenv"

pyenv.sh

@@ -1,3 +1,5 @@
+#!/usr/bin/env bash
+
 if [ -d $HOME/.pyenv ]; then
     eval "$(pyenv init --path)"
     # execute the eval

python.env.sh

@@ -1,3 +1,5 @@
+#!/usr/bin/env bash
+
 ## disabled until I find a reason to use "workon" because its confusing
 # set your python workon home or use default
 # [ -n "$LIBSH_PYTHON_WORKON_HOME" ] && \