Bump version to 0.7.0

New init system

README.md

@@ -1,6 +1,6 @@
 # Tmuxifier
 
-Tmuxify your Tmux. Create, edit, mangage and load complex Tmux session, window
+Tmuxify your Tmux. Create, edit, manage and load complex Tmux session, window
 and pane configurations with ease.
 
 In short, Tmuxifier allows you to easily create, edit, and load "layout"
@@ -58,23 +58,51 @@ Clone the repo to your machine:
 git clone https://github.com/jimeh/tmuxifier.git ~/.tmuxifier
 ```
 
-### bash & zsh
+Then add `~/.tmuxifier/bin` to your PATH to make the `tmuxifier` executable
+available to you:
+
+__In bash & zsh:__
+
+```bash
+export PATH="~/.tmuxifier/bin:$PATH"
+```
+
+__In tcsh:__
+
+```tcsh
+set path = ( "~/.tmuxifier/bin" $path )
+```
+
+### Custom Installation Path
+
+To install Tmuxifier somewhere else than the suggested `~/.tmuxifier`, simply
+clone the repository to your custom location, and ensure the `bin` folder is
+added to your PATH making the `tmuxifier` executable available to you.
+
+## Setup
+
+__In bash & zsh:__
 
 And add the following to your `~/.profile`, `~/.bash_profile`, `~/.zshrc` or
 equivalent:
 
 ```bash
-[[ -s "$HOME/.tmuxifier/init.sh" ]] && source "$HOME/.tmuxifier/init.sh"
+eval "$(tmuxifier init -)"
 ```
 
-### tcsh
+__In tcsh:__
 
 Add the following to your `~/.cshrc`, `~/.tcshrc` or equivalent:
 
 ```tcsh
-if ( -s "$HOME/.tmuxifier/init.sh" ) then
+eval `tmuxifier init -`
-  source "$HOME/.tmuxifier/init.sh"
+```
-endif
+
+## Updating
+
+```bash
+cd ~/.tmuxifier
+git pull
 ```
 
 ## Usage
@@ -129,17 +157,6 @@ in it.
 
 ## Configure & Customize
 
-### Custom Installaton Path
-
-To install Tmuxifier to a custom path, clone the repository to your desired
-path and set `$TMUXIFIER` to that path, additionally loading `init.sh` or
-`init.tcsh` from that same path.
-
-```bash
-export TMUXIFIER="$HOME/.dotfiles/tmuxifier"
-[[ -s "$TMUXIFIER/init.sh" ]] && source "$TMUXIFIER/init.sh"
-```
-
 ### Custom Layouts Path
 
 You can customize the layouts directory used by Tmuxifier by setting

bin/tmuxifier

@@ -2,8 +2,26 @@
 set -e
 [ -n "$TMUXIFIER_DEBUG" ] && set -x
 
+resolve_link() {
+  $(type -p greadlink readlink | head -1) $1
+}
+
+abs_dirname() {
+  local cwd="$(pwd)"
+  local path="$1"
+
+  while [ -n "$path" ]; do
+    cd "${path%/*}"
+    local name="${path##*/}"
+    path="$(resolve_link "$name" || true)"
+  done
+
+  pwd
+  cd "$cwd"
+}
+
 if [ -z "${TMUXIFIER}" ]; then
-  export TMUXIFIER="${HOME}/.tmuxifier"
+  export TMUXIFIER="$(dirname "$(abs_dirname "$0")")"
 else
   export TMUXIFIER="${TMUXIFIER%/}"
 fi

init.sh

@@ -1,4 +1,4 @@
-# Set tmuxifier root path.
+# Set/fix Tmuxifier root path if needed.
 if [ -z "${TMUXIFIER}" ]; then
   export TMUXIFIER="${HOME}/.tmuxifier"
 else
@@ -6,10 +6,12 @@ else
 fi
 
 # Add `bin` directroy to `$PATH`.
+if [[ ":$PATH:" != *":$TMUXIFIER/bin:"* ]]; then
   export PATH="$TMUXIFIER/bin:$PATH"
+fi
 
 # If `tmuxifier` is available, and `$TMUXIFIER_NO_COMPLETE` is not set, then
-# load tmuxifier shell completion.
+# load Tmuxifier shell completion.
 if [ -n "$(command -v "tmuxifier")" ] && [ -z "$TMUXIFIER_NO_COMPLETE" ]; then
   if [ -n "$BASH_VERSION" ]; then
     source "$TMUXIFIER/completion/tmuxifier.bash"

init.tcsh

@@ -1,13 +1,15 @@
-# Set tmuxifier root path.
+# Set Tmuxifier root path if needed.
 if ( ! $?TMUXIFIER ) then
   setenv TMUXIFIER "${HOME}/.tmuxifier"
 endif
 
-# Add `bin` directroy to `$PATH`.
+# Add `bin` directroy to `$path` if needed.
+if ( ! (" $path " =~ "* $TMUXIFIER/bin *" ) ) then
   set path = ( $TMUXIFIER/bin $path )
+endif
 
 # If `tmuxifier` is available, and `$TMUXIFIER_NO_COMPLETE` is not set, then
-# load tmuxifier shell completion.
+# load Tmuxifier shell completion.
 if ( ! $?TMUXIFIER_NO_COMPLETE ) then
   which tmuxifier > /dev/null && source "$TMUXIFIER/completion/tmuxifier.tcsh"
 endif

lib/util.sh

@@ -0,0 +1,11 @@
+calling-help() {
+  if [[ " $@ " != *" --help "* ]] && [[ " $@ " != *" -h "* ]]; then
+    return 1
+  fi
+}
+
+calling-complete() {
+  if [[ " $@ " != *" --complete "* ]]; then
+    return 1
+  fi
+}

libexec/tmuxifier-alias

@@ -2,8 +2,11 @@
 set -e
 [ -n "$TMUXIFIER_DEBUG" ] && set -x
 
+# Load internal utility functions.
+source "$TMUXIFIER/lib/util.sh"
+
 # Provide tmuxifier help
-if [ "$1" == "--help" ]; then
+if calling-help "$@"; then
   echo "usage: tmuxifier alias <alias>
 
 Resolve a command alias to it's full name."

libexec/tmuxifier-commands

@@ -2,8 +2,11 @@
 set -e
 [ -n "$TMUXIFIER_DEBUG" ] && set -x
 
+# Load internal utility functions.
+source "$TMUXIFIER/lib/util.sh"
+
 # Provide tmuxifier help
-if [ "$1" == "--help" ]; then
+if calling-help "$@"; then
   echo "usage: tmuxifier commands
 
 List all available commands, includes internal commands not intended for

libexec/tmuxifier-completions

@@ -2,8 +2,11 @@
 set -e
 [ -n "$TMUXIFIER_DEBUG" ] && set -x
 
+# Load internal utility functions.
+source "$TMUXIFIER/lib/util.sh"
+
 # Provide tmuxifier help
-if [ "$1" == "--help" ]; then
+if calling-help "$@"; then
   echo "usage: tmuxifier completion <command>
 
 Print a list of available completions for specified command."
@@ -11,7 +14,7 @@ Print a list of available completions for specified command."
 fi
 
 # Provide tmuxifier completions
-if [ "$1" == "--complete" ]; then
+if calling-complete "$@"; then
   tmuxifier-commands
   exit
 fi
@@ -21,7 +24,7 @@ has-completions() {
 }
 
 if [ -z "$1" ]; then
-  echo "$(tmuxifier-help completions)" >&2
+  echo "$(tmuxifier-help completions $@)" >&2
   exit 1
 fi
 

libexec/tmuxifier-current-session

@@ -2,8 +2,11 @@
 set -e
 [ -n "$TMUXIFIER_DEBUG" ] && set -x
 
+# Load internal utility functions.
+source "$TMUXIFIER/lib/util.sh"
+
 # Provide tmuxifier help
-if [ "$1" == "--help" ]; then
+if calling-help "$@"; then
   echo "usage: tmuxifier current-session
 
 Outputs the name of the current Tmux session."

libexec/tmuxifier-edit-session

@@ -2,8 +2,11 @@
 set -e
 [ -n "$TMUXIFIER_DEBUG" ] && set -x
 
+# Load internal utility functions.
+source "$TMUXIFIER/lib/util.sh"
+
 # Provide tmuxifier help
-if [ "$1" == "--help" ]; then
+if calling-help "$@"; then
   echo "usage: tmuxifier edit-session <layout_name>
 
 Aliases: edit-ses, eses, es
@@ -13,15 +16,13 @@ Open specified session layout for editing in \$EDITOR."
 fi
 
 # Provide tmuxifier completions
-if [ "$1" == "--complete" ]; then
+if calling-complete "$@"; then
-  for item in $(tmuxifier-list-sessions); do
+  tmuxifier-list-sessions
-    echo "$item"
-  done
   exit
 fi
 
 if [ -z "$1" ]; then
-  echo "$(tmuxifier-help edit-session)" >&2
+  echo "$(tmuxifier-help edit-session $@)" >&2
   exit 1
 fi
 
@@ -36,4 +37,10 @@ if [ ! -f "$layout_file" ]; then
   exit 1
 fi
 
+if [ -n "$EDITOR" ]; then
   exec "$EDITOR" "$layout_file"
+else
+  echo "'\$EDITOR' is not set. Please manually open the layout for editing:"
+  echo "$layout_file"
+  echo
+fi

libexec/tmuxifier-edit-window

@@ -2,8 +2,11 @@
 set -e
 [ -n "$TMUXIFIER_DEBUG" ] && set -x
 
+# Load internal utility functions.
+source "$TMUXIFIER/lib/util.sh"
+
 # Provide tmuxifier help
-if [ "$1" == "--help" ]; then
+if calling-help "$@"; then
   echo "usage: tmuxifier edit-window <layout_name>
 
 Aliases: edit-win, ewin, ew
@@ -13,15 +16,13 @@ Open specified window layout for editing in \$EDITOR."
 fi
 
 # Provide tmuxifier completions
-if [ "$1" == "--complete" ]; then
+if calling-complete "$@"; then
-  for item in $(tmuxifier-list-windows); do
+  tmuxifier-list-windows
-    echo "$item"
-  done
   exit
 fi
 
 if [ -z "$1" ]; then
-  echo "$(tmuxifier-help edit-window)" >&2
+  echo "$(tmuxifier-help edit-window $@)" >&2
   exit 1
 fi
 
@@ -36,4 +37,10 @@ if [ ! -f "$layout_file" ]; then
   exit 1
 fi
 
+if [ -n "$EDITOR" ]; then
   exec "$EDITOR" "$layout_file"
+else
+  echo "'\$EDITOR' is not set. Please manually open the layout for editing:"
+  echo "$layout_file"
+  echo
+fi

libexec/tmuxifier-help

@@ -2,14 +2,17 @@
 set -e
 [ -n "$TMUXIFIER_DEBUG" ] && set -x
 
+# Load internal utility functions.
+source "$TMUXIFIER/lib/util.sh"
+
 # Provide tmuxifier help
-if [ "$1" == "--help" ]; then
+if calling-help "$@"; then
   tmuxifier-help
   exit
 fi
 
 # Provide tmuxifier completions
-if [ "$1" == "--complete" ]; then
+if calling-complete "$@"; then
   tmuxifier-commands
   exit
 fi
@@ -18,7 +21,6 @@ has-help() {
   grep -i "^# Provide tmuxifier help" "$1" >/dev/null
 }
 
-command="$1"
 if [ -z "$1" ]; then
   echo "usage: tmuxifier <command> [<args>]
 
@@ -50,7 +52,7 @@ fi
 
 if has-help "$command_path"; then
   shift
-  exec "$command_path" --help "$@"
+  exec "$command_path" "$@" --help
 else
   command="$(basename "$command_path")"
   command="${command/tmuxifier\-/}"

libexec/tmuxifier-init

@@ -0,0 +1,74 @@
+#! /usr/bin/env bash
+set -e
+[ -n "$TMUXIFIER_DEBUG" ] && set -x
+
+# Set shell to first argument that is not "-", "-h" or "--help".
+for arg in "$@"; do
+  if [ "$arg" != "-" ] &&[ "$arg" != "-h" ] && [ "$arg" != "--help" ]; then
+    shell="$arg"
+  fi
+done
+
+if [ -z "$shell" ]; then
+  shell="$(basename "$SHELL")"
+fi
+
+case "$shell" in
+  bash )
+    profile='~/.bash_profile'
+    ;;
+  zsh )
+    profile='~/.zshrc'
+    ;;
+  ksh )
+    profile='~/.profile'
+    ;;
+  csh )
+    profile='~/.cshrc'
+    ;;
+  tcsh )
+    profile='~/.tcshrc'
+    ;;
+  * )
+    profile='shell init file'
+    ;;
+esac
+
+# Provide tmuxifier help
+if [[ " $@ " == *" --help "* ]]; then
+  echo "usage: tmuxifier init -
+
+Load Tmuxifier by adding the following to your ${profile}:
+"
+
+  case "$shell" in
+    csh | tcsh )
+      echo "    eval \`tmuxifier init -\`
+"
+      ;;
+    * )
+      echo "    eval \"\$(tmuxifier init -)\"
+"
+      ;;
+  esac
+
+  echo "You might also need to add Tmuxifier's bin directory to your PATH."
+  exit
+fi
+
+# Print help if "-" argument is not given
+if [[ " $@ " != *" - "* ]]; then
+  echo "$(tmuxifier-help init $@)" >&2
+  exit 1
+fi
+
+case "$shell" in
+  csh | tcsh )
+    echo "setenv TMUXIFIER \"$TMUXIFIER\";"
+    echo "source \"\$TMUXIFIER/init.tcsh\";"
+    ;;
+  * )
+    echo "export TMUXIFIER=\"$TMUXIFIER\";"
+    echo "source \"\$TMUXIFIER/init.sh\";"
+    ;;
+esac

libexec/tmuxifier-list

@@ -2,8 +2,11 @@
 set -e
 [ -n "$TMUXIFIER_DEBUG" ] && set -x
 
+# Load internal utility functions.
+source "$TMUXIFIER/lib/util.sh"
+
 # Provide tmuxifier help
-if [ "$1" == "--help" ]; then
+if calling-help "$@"; then
   echo "usage: tmuxifier list
 
 Aliases: l

libexec/tmuxifier-list-sessions

@@ -2,8 +2,11 @@
 set -e
 [ -n "$TMUXIFIER_DEBUG" ] && set -x
 
+# Load internal utility functions.
+source "$TMUXIFIER/lib/util.sh"
+
 # Provide tmuxifier help
-if [ "$1" == "--help" ]; then
+if calling-help "$@"; then
   echo "usage: tmuxifier list-sessions
 
 Aliases: list-ses, lses, ls

libexec/tmuxifier-list-windows

@@ -2,8 +2,11 @@
 set -e
 [ -n "$TMUXIFIER_DEBUG" ] && set -x
 
+# Load internal utility functions.
+source "$TMUXIFIER/lib/util.sh"
+
 # Provide tmuxifier help
-if [ "$1" == "--help" ]; then
+if calling-help "$@"; then
   echo "usage: tmuxifier list-windows
 
 Aliases: list-win, lwin, lw

libexec/tmuxifier-load-session

@@ -2,8 +2,11 @@
 set -e
 [ -n "$TMUXIFIER_DEBUG" ] && set -x
 
+# Load internal utility functions.
+source "$TMUXIFIER/lib/util.sh"
+
 # Provide tmuxifier help
-if [ "$1" == "--help" ]; then
+if calling-help "$@"; then
   echo "usage: tmuxifier load-session <layout_name>
 
 Aliases: session, ses, s
@@ -14,15 +17,13 @@ in which case, we simply attach/switch to the existing one."
 fi
 
 # Provide tmuxifier completions
-if [ "$1" == "--complete" ]; then
+if calling-complete "$@"; then
-  for item in $(tmuxifier-list-sessions); do
+  tmuxifier-list-sessions
-    echo "$item"
-  done
   exit
 fi
 
 if [ -z "$1" ]; then
-  echo "$(tmuxifier-help load-session)" >&2
+  echo "$(tmuxifier-help load-session $@)" >&2
   exit 1
 fi
 

libexec/tmuxifier-load-window

@@ -2,8 +2,11 @@
 set -e
 [ -n "$TMUXIFIER_DEBUG" ] && set -x
 
+# Load internal utility functions.
+source "$TMUXIFIER/lib/util.sh"
+
 # Provide tmuxifier help
-if [ "$1" == "--help" ]; then
+if calling-help "$@"; then
   echo "usage: tmuxifier load-window <layout_name>
 
 Aliases: window, win, w
@@ -13,15 +16,13 @@ Create a new window using the specified window layout in the current session."
 fi
 
 # Provide tmuxifier completions
-if [ "$1" == "--complete" ]; then
+if calling-complete "$@"; then
-  for item in $(tmuxifier-list-windows); do
+  tmuxifier-list-windows
-    echo "$item"
-  done
   exit
 fi
 
 if [ -z "$1" ]; then
-  echo "$(tmuxifier-help load-window)" >&2
+  echo "$(tmuxifier-help load-window $@)" >&2
   exit 1
 fi
 

libexec/tmuxifier-new-session

@@ -2,8 +2,11 @@
 set -e
 [ -n "$TMUXIFIER_DEBUG" ] && set -x
 
+# Load internal utility functions.
+source "$TMUXIFIER/lib/util.sh"
+
 # Provide tmuxifier help
-if [ "$1" == "--help" ]; then
+if calling-help "$@"; then
   echo "usage: tmuxifier new-session <layout_name>
 
 Aliases: new-ses, nses, ns
@@ -13,15 +16,13 @@ Create a new session layout and open it for editing in \$EDITOR."
 fi
 
 # Provide tmuxifier completions
-if [ "$1" == "--complete" ]; then
+if calling-complete "$@"; then
-  for item in $(tmuxifier-list-sessions); do
+  tmuxifier-list-sessions
-    echo "$item"
-  done
   exit
 fi
 
 if [ -z "$1" ]; then
-  echo "$(tmuxifier-help new-session)" >&2
+  echo "$(tmuxifier-help new-session $@)" >&2
   exit 1
 fi
 
@@ -45,7 +46,7 @@ fi
 content="$(cat "$template")"
 echo "${content//\{\{SESSION_NAME\}\}/$layout_name}" > "$layout_file"
 
-if [ ! -z "$EDITOR" ]; then
+if [ -n "$EDITOR" ]; then
   exec "$EDITOR" "$layout_file"
 else
   echo "Layout file has been created, but '\$EDITOR' is not set. Please "

libexec/tmuxifier-new-window

@@ -2,8 +2,11 @@
 set -e
 [ -n "$TMUXIFIER_DEBUG" ] && set -x
 
+# Load internal utility functions.
+source "$TMUXIFIER/lib/util.sh"
+
 # Provide tmuxifier help
-if [ "$1" == "--help" ]; then
+if calling-help "$@"; then
   echo "usage: tmuxifier new-window <layout_name>
 
 Aliases: new-win, nwin, nw
@@ -13,15 +16,13 @@ Create a new window layout and open it for editing in \$EDITOR."
 fi
 
 # Provide tmuxifier completions
-if [ "$1" == "--complete" ]; then
+if calling-complete "$@"; then
-  for item in $(tmuxifier-list-windows); do
+  tmuxifier-list-windows
-    echo "$item"
-  done
   exit
 fi
 
 if [ -z "$1" ]; then
-  echo "$(tmuxifier-help new-window)" >&2
+  echo "$(tmuxifier-help new-window $@)" >&2
   exit 1
 fi
 
@@ -45,7 +46,7 @@ fi
 content="$(cat "$template")"
 echo "${content//\{\{WINDOW_NAME\}\}/$layout_name}" > "$layout_file"
 
-if [ ! -z "$EDITOR" ]; then
+if [ -n "$EDITOR" ]; then
   exec "$EDITOR" "$layout_file"
 else
   echo "Layout file has been created, but '\$EDITOR' is not set. Please "

libexec/tmuxifier-resolve-command-path

@@ -2,8 +2,11 @@
 set -e
 [ -n "$TMUXIFIER_DEBUG" ] && set -x
 
+# Load internal utility functions.
+source "$TMUXIFIER/lib/util.sh"
+
 # Provide tmuxifier help
-if [ "$1" == "--help" ]; then
+if calling-help "$@"; then
   echo "usage: tmuxifier resolve-command-path <command_or_alias>
 
 Outputs the absolute path to the given command or command alias."

libexec/tmuxifier-version

@@ -2,12 +2,15 @@
 set -e
 [ -n "$TMUXIFIER_DEBUG" ] && set -x
 
+# Load internal utility functions.
+source "$TMUXIFIER/lib/util.sh"
+
 # Provide tmuxifier help
-if [ "$1" == "--help" ]; then
+if calling-help "$@"; then
   echo "usage: tmuxifier version
 
 Outputs Tmuxifier version."
   exit
 fi
 
-echo "0.6.0"
+echo "0.7.0"