Merge pull request #117 from jimeh/improve-shell-script-formatting

Apply shfmt formatting and fix some schellcheck complaints.

bin/tmuxifier

@@ -3,13 +3,12 @@ set -e
 [ -n "$TMUXIFIER_DEBUG" ] && set -x
 
 resolve_link() {
-  $(type -p greadlink readlink | head -1) "$1"
+  $(type -p greadlink readlink | head -1) $1
 }
 
 abs_dirname() {
-  local cwd
+  local cwd="$(pwd)"
   local path="$1"
-  cwd="$(pwd)"
 
   while [ -n "$path" ]; do
     cd "${path%/*}"
@@ -23,12 +22,11 @@ abs_dirname() {
 
 if [ -z "${TMUXIFIER}" ]; then
   # Set TMUXIFIER relative to the "tmuxifier" executable.
-  TMUXIFIER="$(dirname "$(abs_dirname "$0")")"
+  export TMUXIFIER="$(dirname "$(abs_dirname "$0")")"
 else
   # Strip any trailing slash (/) characters from TMUXIFIER variable.
-  TMUXIFIER="${TMUXIFIER%/}"
+  export TMUXIFIER="${TMUXIFIER%/}"
 fi
-export TMUXIFIER
 
 # Load tmuxifier environment variables.
 source "$TMUXIFIER/lib/env.sh"
@@ -50,15 +48,19 @@ case "$command" in
   "" | "-h" | "--help")
     echo -e "tmuxifier $(tmuxifier-version)\n$(tmuxifier-help)" >&2
     ;;
+
   "-v" | "--version")
     tmuxifier-version
     ;;
+
   *)
     ! command_path="$(tmuxifier-resolve-command-path "$command")"
+
     if [ -z "$command_path" ]; then
       echo "tmuxifier: no such command '$command'" >&2
       exit 1
     fi
+
     shift 1
     exec "$command_path" "$@"
     ;;

completion/tmuxifier.bash

@@ -6,8 +6,7 @@ _tmuxifier() {
     COMPREPLY=($(compgen -W "$(tmuxifier commands)" -- "$word"))
   else
     local command="${COMP_WORDS[1]}"
-    local completions
+    local completions="$(tmuxifier completions "$command")"
-    completions="$(tmuxifier completions "$command")"
     COMPREPLY=($(compgen -W "$completions" -- "$word"))
   fi
 }

lib/layout-helpers.sh

@@ -180,9 +180,7 @@ run_cmd() {
 #   - $1: Directory path to use for session root.
 #
 session_root() {
-  local dir
+  local dir="$(__expand_path $@)"
-  dir="$(__expand_path "$@")"
-
   if [ -d "$dir" ]; then
     session_root="$dir"
   fi
@@ -194,9 +192,7 @@ session_root() {
 #   - $1: Directory path to use for window root.
 #
 window_root() {
-  local dir
+  local dir="$(__expand_path $@)"
-  dir="$(__expand_path "$@")"
-
   if [ -d "$dir" ]; then
     window_root="$dir"
   fi
@@ -221,8 +217,6 @@ load_window() {
       window="${1/%.window.sh/}"
       window="${window/%.sh/}"
     fi
-
-    # shellcheck disable=SC1090
     source "$file"
     window=
 
@@ -269,7 +263,6 @@ load_session() {
   fi
 
   set_default_path=true
-  # shellcheck disable=SC1090
   source "$file"
   session=
 
@@ -311,7 +304,7 @@ initialize_session() {
 
     # Set default-path for session
     if [ -n "$session_root" ] && [ -d "$session_root" ]; then
-      cd "$session_root" || return 1
+      cd "$session_root"
 
       $set_default_path && tmuxifier-tmux \
         set-option -t "$session:" \
@@ -336,8 +329,7 @@ initialize_session() {
   # In order to ensure only specified windows are created, we move the
   # default window to position 999, and later remove it with the
   # `finalize_and_go_to_session` function.
-  local first_window_index
+  local first_window_index=$(__get_first_window_index)
-  first_window_index="$(__get_first_window_index)"
   tmuxifier-tmux move-window \
     -s "$session:$first_window_index" -t "$session:999"
 }
@@ -370,17 +362,12 @@ finalize_and_go_to_session() {
 #   /Users/jimeh/Projects
 #
 __expand_path() {
-  local path="$1"
+  echo $(eval echo "$@")
-  path="${path/#\~/$HOME}"
-  echo "$path"
 }
 
 __get_first_window_index() {
-  local index
+  local index=$(tmuxifier-tmux list-windows -t "$session:" \
-  index="$(
+    -F "#{window_index}" 2> /dev/null)
-    tmuxifier-tmux list-windows \
-      -t "$session:" -F "#{window_index}" 2> /dev/null
-  )"
 
   if [ -n "$index" ]; then
     echo "$index" | head -1
@@ -390,11 +377,8 @@ __get_first_window_index() {
 }
 
 __get_current_window_index() {
-  local lookup
+  local lookup=$(tmuxifier-tmux list-windows -t "$session:" \
-  lookup="$(
+    -F "#{window_active}:#{window_index}" 2> /dev/null | grep "^1:")
-    tmuxifier-tmux list-windows -t "$session:" \
-      -F "#{window_active}:#{window_index}" 2> /dev/null | grep "^1:"
-  )"
 
   if [ -n "$lookup" ]; then
     echo "${lookup/1:/}"
@@ -403,7 +387,6 @@ __get_current_window_index() {
 
 __go_to_session() {
   if [ -z "$TMUX" ]; then
-    # shellcheck disable=2086
     tmuxifier-tmux $TMUXIFIER_TMUX_ITERM_ATTACH -u \
       attach-session -t "$session:"
   else
@@ -424,7 +407,7 @@ __go_to_window_or_session_path() {
 
   # local window_or_session_root=${window_root-$session_root}
   if [ -n "$target_path" ]; then
-    run_cmd "cd \"$target_path\""
+    run_cmd " cd \"$target_path\""
-    run_cmd "clear"
+    run_cmd " clear"
   fi
 }

libexec/tmuxifier-alias

@@ -41,9 +41,6 @@ case "$1" in
   "list-win" | "lwin" | "lw")
     echo "list-windows"
     ;;
-  "completion")
-    echo "completions"
-    ;;
   *)
     exit 1
     ;;

libexec/tmuxifier-completions

@@ -7,9 +7,7 @@ source "$TMUXIFIER/lib/util.sh"
 
 # Provide tmuxifier help
 if calling-help "$@"; then
-  echo "usage: tmuxifier completions <command>
+  echo "usage: tmuxifier completion <command>
-
-Aliases: completion
 
 Print a list of available completions for specified command."
   exit
@@ -30,7 +28,7 @@ if [ -z "$1" ]; then
   exit 1
 fi
 
-command_path="$(tmuxifier-resolve-command-path "$1")" || true
+! command_path="$(tmuxifier-resolve-command-path "$1")"
 
 if [ -n "$command_path" ] && has-completions "$command_path"; then
   shift

libexec/tmuxifier-help

@@ -43,7 +43,7 @@ See 'tmuxifier help <command>' for information on a specific command."
   exit
 fi
 
-command_path="$(tmuxifier-resolve-command-path "$1")" || true
+! command_path="$(tmuxifier-resolve-command-path "$1")"
 
 if [ -z "$command_path" ]; then
   echo "tmuxifier: no such command '$1'" >&2

libexec/tmuxifier-init

@@ -2,9 +2,6 @@
 set -e
 [ -n "$TMUXIFIER_DEBUG" ] && set -x
 
-# Load internal utility functions.
-source "$TMUXIFIER/lib/util.sh"
-
 # Set shell to first argument that is not "-", "-h" or "--help".
 for arg in "$@"; do
   if [ "$arg" != "-" ] && [ "$arg" != "-h" ] && [ "$arg" != "--help" ]; then
@@ -18,22 +15,22 @@ fi
 
 case "$shell" in
   bash)
-    profile='.bash_profile'
+    profile='~/.bash_profile'
     ;;
   zsh)
-    profile='.zshrc'
+    profile='~/.zshrc'
     ;;
   ksh)
-    profile='.profile'
+    profile='~/.profile'
     ;;
   csh)
-    profile='.cshrc'
+    profile='~/.cshrc'
     ;;
   tcsh)
-    profile='.tcshrc'
+    profile='~/.tcshrc'
     ;;
   fish)
-    profile='.config/fish/config.fish'
+    profile='~/.config/fish/config.fish'
     ;;
   *)
     profile='shell init file'
@@ -41,10 +38,10 @@ case "$shell" in
 esac
 
 # Provide tmuxifier help
-if calling-help "$@"; then
+if [[ " $@ " == *" --help "* ]]; then
   echo "usage: tmuxifier init -
 
-Load Tmuxifier by adding the following to your ~/${profile}:
+Load Tmuxifier by adding the following to your ${profile}:
 "
 
   case "$shell" in

libexec/tmuxifier-load-window

@@ -33,7 +33,7 @@ fi
 # Load runtime functions.
 source "$TMUXIFIER/lib/runtime.sh"
 
-if [ -n "$TMUX" ]; then
+if [ ! -z "$TMUX" ]; then
   session="$(tmuxifier-current-session)"
   load_window "$1"
 else

libexec/tmuxifier-resolve-command-path

@@ -14,11 +14,11 @@ Outputs the absolute path to the given command or command alias."
 fi
 
 if [ -n "$1" ]; then
-  command_path="$(command -v "tmuxifier-$1")" || true
+  ! command_path="$(command -v "tmuxifier-$1")"
   if [ -z "$command_path" ]; then
     resolved="$(tmuxifier-alias "$1")"
     if [ -n "$resolved" ]; then
-      command_path="$(command -v "tmuxifier-$resolved")" || true
+      ! command_path="$(command -v "tmuxifier-$resolved")"
     fi
   fi
 fi

libexec/tmuxifier-tmux

@@ -2,5 +2,4 @@
 set -e
 [ -n "$TMUXIFIER_DEBUG" ] && set -x
 
-# shellcheck disable=SC2086
 tmux $TMUXIFIER_TMUX_OPTS "$@"

libexec/tmuxifier-tmux-version

@@ -20,10 +20,9 @@ fi
 # The vercomp() function is shamelessly ripped/borrowed from the following
 # StackOverflow answer: http://stackoverflow.com/a/4025065/42146
 vercomp() {
-  if [[ "$1" == "$2" ]]; then return 0; fi
+  if [[ $1 == $2 ]]; then return 0; fi
 
   local IFS=.
-  # shellcheck disable=SC2206
   local i ver1=($1) ver2=($2)
 
   # fill empty fields in ver1 with zeros

test/lib/env.test.sh

@@ -11,25 +11,21 @@ TMUXIFER="/path/to/tmuxifier"
 
 # When TMUXIFIER_LAYOUT_PATH is not set.
 source "${root}/lib/env.sh"
-# shellcheck disable=SC2016
 assert 'echo $TMUXIFIER_LAYOUT_PATH' "${TMUXIFIER}/layouts"
 
 # When TMUXIFIER_LAYOUT_PATH is set and has a trailing slash.
 TMUXIFIER_LAYOUT_PATH="/path/to/layouts/"
 source "${root}/lib/env.sh"
-# shellcheck disable=SC2016
 assert 'echo $TMUXIFIER_LAYOUT_PATH' "/path/to/layouts"
 unset TMUXIFIER_LAYOUT_PATH
 
 # When TMUXIFIER_LAYOUT_PATH is set and does not have a trailing slash.
 TMUXIFIER_LAYOUT_PATH="/path/to/layouts"
 source "${root}/lib/env.sh"
-# shellcheck disable=SC2016
 assert 'echo $TMUXIFIER_LAYOUT_PATH' "/path/to/layouts"
 unset TMUXIFIER_LAYOUT_PATH
 
 # Tear down.
-# shellcheck disable=SC2034
 TMUXIFER="$realTMUXIFIER"
 unset realTMUXIFIER
 

test/lib/layout-helpers/__expand_path.test.sh

@@ -19,12 +19,6 @@ assert '__expand_path "/path/to/file"' "/path/to/file"
 # When given a path containing spaces, it returns path correctly.
 assert '__expand_path "~/Path To/File"' "${HOME}/Path To/File"
 
-# When given a relative path, it returns path as is.
-assert '__expand_path "foo/bar"' "foo/bar"
-
-# When given a relative parent path, it returns path as is.
-assert '__expand_path "../foo/bar"' "../foo/bar"
-
 # Tear down.
 HOME="$realHOME"
 unset realHOME

test/lib/layout-helpers/__get_current_window_index.test.sh

@@ -7,25 +7,25 @@ source "${root}/lib/layout-helpers.sh"
 #
 
 # When current window is the first and only window.
-create-test-session "test"
+create-test-session
 assert "__get_current_window_index" "0"
-kill-test-session "test"
+kill-test-session
 
 # When creating a second window.
-create-test-session "test"
+create-test-session
 test-socket-tmux new-window -t "$session:1"
 assert "__get_current_window_index" "1"
-kill-test-session "test"
+kill-test-session
 
 # When creating a second window and then switching back to the first window.
-create-test-session "test"
+create-test-session
 test-socket-tmux new-window -t "$session:1"
 test-socket-tmux select-window -t "$session:0"
 assert "__get_current_window_index" "0"
-kill-test-session "test"
+kill-test-session
 
 # When creating multiples windows and switching between them randomly.
-create-test-session "test"
+create-test-session
 assert "__get_current_window_index" "0"
 test-socket-tmux new-window -t "$session:1"
 assert "__get_current_window_index" "1"
@@ -41,7 +41,8 @@ test-socket-tmux select-window -t "$session:3"
 assert "__get_current_window_index" "3"
 test-socket-tmux select-window -t "$session:2"
 assert "__get_current_window_index" "2"
-kill-test-session "test"
+kill-test-session
+
 
 # End of tests.
 assert_end "__get_current_window_index()"

test/lib/layout-helpers/__get_first_window_index.test.sh

@@ -7,23 +7,24 @@ source "${root}/lib/layout-helpers.sh"
 #
 
 # When first window has a index of 0.
-create-test-session "test"
+create-test-session
 assert "__get_first_window_index" "0"
-kill-test-session "test"
+kill-test-session
 
 # When first window has a index of 1.
-create-test-session "test"
+create-test-session
 test-socket-tmux new-window -t "$session:1"
 test-socket-tmux kill-window -t "$session:0"
 assert "__get_first_window_index" "1"
-kill-test-session "test"
+kill-test-session
 
 # When first window has a index of 2.
-create-test-session "test"
+create-test-session
 test-socket-tmux new-window -t "$session:2"
 test-socket-tmux kill-window -t "$session:0"
 assert "__get_first_window_index" "2"
-kill-test-session "test"
+kill-test-session
+
 
 # End of tests.
 assert_end "__get_first_window_index()"

test/lib/layout-helpers/__go_to_window_or_session_path.test.sh

@@ -12,6 +12,7 @@ __go_to_window_or_session_path
 assert "stub_called_times run_cmd" "0"
 restore run_cmd
 
+
 # When only $window_root is set, runs cd to $window_root path.
 stub run_cmd
 window_root="/tmp"
@@ -21,6 +22,7 @@ assert 'stub_called_with_times run_cmd clear' "1"
 unset window_root
 restore run_cmd
 
+
 # When only $TMUXIFIER_SESSION_ROOT is set, runs cd to $TMUXIFIER_SESSION_ROOT
 # path.
 stub run_cmd
@@ -31,6 +33,7 @@ assert 'stub_called_with_times run_cmd clear' "1"
 unset TMUXIFIER_SESSION_ROOT
 restore run_cmd
 
+
 # When only $session_root is set, runs cd to $session_root path.
 stub run_cmd
 session_root="/usr"
@@ -40,6 +43,7 @@ assert 'stub_called_with_times run_cmd clear' "1"
 unset session_root
 restore run_cmd
 
+
 # When $window_root and $session_root are set, runs cd to $window_root path.
 stub run_cmd
 window_root="/tmp"
@@ -51,6 +55,7 @@ unset window_root
 unset session_root
 restore run_cmd
 
+
 # When $TMUXIFIER_SESSION_ROOT and $session_root are set, runs cd to
 # $TMUXIFIER_SESSION_ROOT path.
 stub run_cmd
@@ -63,6 +68,7 @@ unset TMUXIFIER_SESSION_ROOT
 unset session_root
 restore run_cmd
 
+
 # When $window_root, $TMUXIFIER_SESSION_ROOT, and $session_root are set, runs
 # cd to $window_root path.
 stub run_cmd
@@ -77,5 +83,6 @@ unset TMUXIFIER_SESSION_ROOT
 unset session_root
 restore run_cmd
 
+
 # End of tests.
 assert_end "__go_to_window_or_session_path()"

test/lib/layout-helpers/new_window.test.sh

@@ -7,29 +7,29 @@ source "${root}/lib/layout-helpers.sh"
 #
 
 # When called without arguments, creates new window.
-create-test-session "test"
+create-test-session
 stub __go_to_window_or_session_path
 assert "test-socket-window-count" "1"
 new_window
 assert "test-socket-window-count" "2"
 assert "stub_called_times __go_to_window_or_session_path" "1"
 restore __go_to_window_or_session_path
-kill-test-session "test"
+kill-test-session
 
 # When called with name argument, creates new window with specified name.
-create-test-session "test"
+create-test-session
 stub __go_to_window_or_session_path
 assert "test-socket-window-count yippieezzz" "0"
 new_window "yippieezzz"
 assert "test-socket-window-count" "2"
 assert "test-socket-window-count yippieezzz" "1"
 restore __go_to_window_or_session_path
-kill-test-session "test"
+kill-test-session
 
 # When called with name and command argument, creates new window with
 # specified name and executes given command.
 rm "/tmp/tmuxifier-new_window-test" &> /dev/null
-create-test-session "test"
+create-test-session
 stub __go_to_window_or_session_path
 new_window "foobardoo" "touch /tmp/tmuxifier-new_window-test; bash"
 assert "test-socket-window-count" "2"
@@ -37,13 +37,13 @@ assert "test-socket-window-count foobardoo" "1"
 sleep 0.1 # attempt to avoid timing issue causing flicker
 assert_raises 'test -f "/tmp/tmuxifier-new_window-test"' 0
 restore __go_to_window_or_session_path
-kill-test-session "test"
+kill-test-session
 rm "/tmp/tmuxifier-new_window-test" &> /dev/null
 
 # When called ensure it sets the $window variable to the index of the newly
 # created window.
 unset window
-create-test-session "test"
+create-test-session
 stub __go_to_window_or_session_path
 new_window "foo"
 assert "echo $window" "1"
@@ -52,7 +52,7 @@ assert "echo $window" "2"
 new_window "bar"
 assert "echo $window" "3"
 restore __go_to_window_or_session_path
-kill-test-session "test"
+kill-test-session
 unset window
 
 # End of tests.

test/lib/layout-helpers/select_window.test.sh

@@ -8,11 +8,11 @@ source "${root}/lib/layout-helpers.sh"
 
 window_list() {
   test-socket-tmux list-windows -t "$session:" \
-    -F "#{window_active}:#{window_index}" 2> /dev/null
+    -F "#{window_active}:#{window_index}" 2>/dev/null
 }
 
 # Selects given window when passed a window index
-create-test-session "test"
+create-test-session
 test-socket-tmux new-window -t "$session:1"
 test-socket-tmux new-window -t "$session:2"
 select_window 0
@@ -21,22 +21,23 @@ select_window 1
 assert "window_list | grep '^1:'" "1:1"
 select_window 2
 assert "window_list | grep '^1:'" "1:2"
-kill-test-session "test"
+kill-test-session
 
 # Selects given window when passed a window name
-create-test-session "test"
+create-test-session
 test-socket-tmux new-window -t "$session:1" -n "foo"
 test-socket-tmux new-window -t "$session:2" -n "bar"
 select_window foo
 assert "window_list | grep '^1:'" "1:1"
 select_window bar
 assert "window_list | grep '^1:'" "1:2"
-kill-test-session "test"
+kill-test-session
+
 
 # When called ensure it sets the $window variable to the index of the newly
 # created window.
 unset window
-create-test-session "test"
+create-test-session
 test-socket-tmux new-window -t "$session:1" -n "foo"
 test-socket-tmux new-window -t "$session:2" -n "bar"
 select_window "foo"
@@ -47,7 +48,7 @@ select_window 1
 assert "echo $window" "1"
 select_window 2
 assert "echo $window" "2"
-kill-test-session "test"
+kill-test-session
 unset window
 
 # End of tests.

test/lib/runtime.test.sh

@@ -8,11 +8,9 @@ source "../test-helper.sh"
 source "${root}/lib/runtime.sh"
 
 # We assume env.sh has been sourced if $TMUXIFIER_LAYOUT_PATH has been set.
-# shellcheck disable=SC2016
 assert 'echo $TMUXIFIER_LAYOUT_PATH' "${TMUXIFIER}/layouts"
 
 # We ensure $session_root is set to $HOME by default.
-# shellcheck disable=SC2016
 assert 'echo $session_root' "$HOME"
 
 # We assume layout-helpers.sh has been sourced if a few of them are available.
@@ -20,5 +18,6 @@ for helper in new_window split_v split_h select_window select_pane; do
   assert "type $helper | head -1" "$helper is a function"
 done
 
+
 # End of tests.
 assert_end "runtime.sh"

test/lib/util.test.sh

@@ -34,6 +34,7 @@ assert_raises 'calling-help welcome-home' 1
 # End of tests.
 assert_end "calling-help()"
 
+
 #
 # calling-complete() tests.
 #

test/test-helper.sh

@@ -5,9 +5,8 @@ resolve_link() {
 }
 
 abs_dirname() {
-  local cwd
+  local cwd="$(pwd)"
   local path="$1"
-  cwd="$(pwd)"
 
   while [ -n "$path" ]; do
     cd "${path%/*}"
@@ -48,13 +47,14 @@ unset TMUXIFIER_NO_COMPLETE
 source "${testroot}/assert.sh"
 source "${testroot}/stub.sh"
 
+
 #
 # Test Helpers
 #
 
 test-socket-tmux() {
   export TMUXIFIER_TMUX_OPTS="-L tmuxifier-tests"
-  "$TMUX_BIN" $TMUXIFIER_TMUX_OPTS "$@"
+  "$TMUX_BIN" $TMUXIFIER_TMUX_OPTS $@
 }
 
 create-test-session() {
@@ -78,10 +78,9 @@ kill-test-server() {
 }
 
 test-socket-window-count() {
-  local list
+  local list="$(test-socket-tmux list-windows)"
-  list="$(test-socket-tmux list-windows)"
   if [ -n "$1" ]; then
-    echo "$list" | grep "$1" -c | awk '{print $1}'
+    echo "$list" | grep $1 | wc -l | awk '{print $1}'
   else
     echo "$list" | wc -l | awk '{print $1}'
   fi