Merge pull request #109 from plaffitt/skip-run_cmd-history

Prepend commands in run_cmd with a space to prevent them to be stored in the history

.travis.yml

@@ -8,7 +8,7 @@ env:
 before_install:
   - sudo apt-get update
   - sudo apt-get install -y bc build-essential libevent-dev libncurses5-dev
-  - wget http://downloads.sourceforge.net/tmux/tmux-${TMUX_VERSION}.tar.gz
+  - wget https://github.com/tmux/tmux/releases/download/${TMUX_VERSION}/tmux-${TMUX_VERSION}.tar.gz
   - tar -zxf tmux-${TMUX_VERSION}.tar.gz
   - cd tmux-${TMUX_VERSION}
   - ./configure && make && sudo make install

README.md

@@ -3,18 +3,18 @@
 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"
-files, which are simple shell scripts where you use the `tmux` command and
-helper commands provided by `tmuxifier` to manage Tmux sessions and windows
+In short, Tmuxifier allows you to easily create, edit, and load "layout" files,
+which are simple shell scripts where you use the `tmux` command and helper
+commands provided by `tmuxifier` to manage Tmux sessions and windows
 
 ### Window Layouts
 
-Window layouts create a new Tmux window, optionally setting the window title
-and root path where all shells are cd'd to by default. It allows you to easily
-split a window into specifically sized panes and more as you wish.
+Window layouts create a new Tmux window, optionally setting the window title and
+root path where all shells are cd'd to by default. It allows you to easily split
+a window into specifically sized panes and more as you wish.
 
-You can load a window layout directly into your current Tmux session, or into
-a session layout to have the window created along with the session.
+You can load a window layout directly into your current Tmux session, or into a
+session layout to have the window created along with the session.
 
 ### Session Layouts
 
@@ -25,10 +25,11 @@ defined directly within the session layout file.
 
 ## Example
 
-Given we have a window layout file called [example.window.sh][] which
-looks like:
+Given we have a window layout file called [example.window.sh][] which looks
+like:
 
-[example.window.sh]: https://github.com/jimeh/tmuxifier/blob/master/examples/example.window.sh
+[example.window.sh]:
+  https://github.com/jimeh/tmuxifier/blob/master/examples/example.window.sh
 
 ```bash
 window_root "~/Desktop"
@@ -39,8 +40,8 @@ split_h 60
 select_pane 0
 ```
 
-You can then load that window layout into a new window in the
-current tmux session using:
+You can then load that window layout into a new window in the current tmux
+session using:
 
     tmuxifier load-window example
 
@@ -50,6 +51,8 @@ Which will yield a Tmux window looking like this:
 
 ## Installation
 
+### Manual
+
 Clone the repo to your machine:
 
     git clone https://github.com/jimeh/tmuxifier.git ~/.tmuxifier
@@ -57,33 +60,49 @@ Clone the repo to your machine:
 Then add `$HOME/.tmuxifier/bin` to your PATH to make the `tmuxifier` executable
 available to you:
 
-__In bash & zsh:__
+**In bash & zsh:**
 
 ```bash
 export PATH="$HOME/.tmuxifier/bin:$PATH"
 ```
 
-__In tcsh:__
+**In tcsh:**
 
 ```tcsh
 set path = ( "~/.tmuxifier/bin" $path )
 ```
 
-__In fish:__
+**In fish:**
 
 ```bash
 set -gx PATH "~/.tmuxifier/bin" $PATH
 ```
 
-### Custom Installation 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.
 
+### TPM
+
+You can also install and update Tmuxifier with
+[TPM](https://github.com/tmux-plugins/tpm):
+
+```bash
+set -g @plugin 'jimeh/tmuxifier'
+```
+
+Trigger TPM's install command with `prefix` + `I` to install Tmuxifier to TPM's
+plugin directory (default is `$HOME/.tmux/plugins`).
+
+To use the `tmuxifier` command, you will need to add the `bin` directory to your
+PATH. If you are using the default TPM plugin directory, the `bin` directory
+will be `$HOME/.tmux/plugins/tmuxifier/bin`.
+
 ## Setup
 
-__In bash & zsh:__
+**In bash & zsh:**
 
 And add the following to your `~/.profile`, `~/.bash_profile`, `~/.zshrc` or
 equivalent:
@@ -92,7 +111,7 @@ equivalent:
 eval "$(tmuxifier init -)"
 ```
 
-__In tcsh:__
+**In tcsh:**
 
 Add the following to your `~/.cshrc`, `~/.tcshrc` or equivalent:
 
@@ -100,19 +119,19 @@ Add the following to your `~/.cshrc`, `~/.tcshrc` or equivalent:
 eval `tmuxifier init -`
 ```
 
-__In fish:__
+**In fish:**
 
 And add the following to your `~/.config/fish/config.fish` or equivalent:
 
 ```bash
-eval (tmuxifier init -)
+eval (tmuxifier init - fish)
 ```
 
 ### Custom Tmux Arguments
 
-If you need to pass custom arguments to `tmux` itself, you can do so by
-setting the `TMUXIFIER_TMUX_OPTS` environment variable. For example to set
-custom arguments globally:
+If you need to pass custom arguments to `tmux` itself, you can do so by setting
+the `TMUXIFIER_TMUX_OPTS` environment variable. For example to set custom
+arguments globally:
 
 ```bash
 export TMUXIFIER_TMUX_OPTS="-L my-awesome-socket-name"
@@ -134,7 +153,7 @@ git pull
 
 ## Usage
 
-*__Note:__ This section needs expanding upon.*
+_**Note:** This section needs expanding upon._
 
 For a quick reference on available commands and their aliases, please run:
 
@@ -142,8 +161,8 @@ For a quick reference on available commands and their aliases, please run:
 
 Tmuxifier doesn't come with any layouts, so you'll want to create your own
 window and session layout files. New layout files are populated with examples
-and comments explaining what things do. Also, having a look at the
-[examples][] directory will also give you a good idea.
+and comments explaining what things do. Also, having a look at the [examples][]
+directory will also give you a good idea.
 
 ### Window Layouts
 
@@ -151,16 +170,16 @@ First off you'll want to define a window layout:
 
     tmuxifier new-window my-awesome-window
 
-This will create a new layout file called `my-awesome-window.window.sh` in
-your `$TMUXIFIER_LAYOUT_PATH`, and open it with the editor defined in
-`$EDITOR`. Customize it as you wish, and save.
+This will create a new layout file called `my-awesome-window.window.sh` in your
+`$TMUXIFIER_LAYOUT_PATH`, and open it with the editor defined in `$EDITOR`.
+Customize it as you wish, and save.
 
-You can now load *my-awesome-window* with the following command:
+You can now load _my-awesome-window_ with the following command:
 
     tmuxifier load-window my-awesome-window
 
-You should now have a new Tmux window open created from your custom and
-awesome window layout.
+You should now have a new Tmux window open created from your custom and awesome
+window layout.
 
 ### Session Layouts
 
@@ -170,8 +189,9 @@ To create your first session layout, run:
 
 Same deal as with creating a new window, except the filename ends with
 `.session.sh` instead of `.window.sh`, and the file's pre-populated content
-looks different. To have your awesome window loaded, add `load_window
-"my-awesome-window"` to the session layout next to existing examples.
+looks different. To have your awesome window loaded, add
+`load_window "my-awesome-window"` to the session layout next to existing
+examples.
 
 To load the session layout simply run:
 
@@ -195,8 +215,8 @@ export TMUXIFIER_LAYOUT_PATH="$HOME/.tmux-layouts"
 
 ### Disable Shell-Completion
 
-Tmuxifier comes with shell-completion for bash, zsh, tcsh, and fish. If for
-any reason you need to disable it, just set `$TMUXIFIER_NO_COMPLETE`.
+Tmuxifier comes with shell-completion for bash, zsh, tcsh, and fish. If for any
+reason you need to disable it, just set `$TMUXIFIER_NO_COMPLETE`.
 
 ```bash
 export TMUXIFIER_NO_COMPLETE=1
@@ -208,15 +228,14 @@ export TMUXIFIER_NO_COMPLETE=1
 
 Tmuxifier supports iTerm2's [Tmux integration][]. It can be used in two ways:
 
-- Passing `-CC` as a second argument to the `load-session` command. For
-example:
+- Passing `-CC` as a second argument to the `load-session` command. For example:
 
-        tmuxifier load-session my-awesome-session -CC
+          tmuxifier load-session my-awesome-session -CC
 
-- Setting the `TMUXIFIER_TMUX_ITERM_ATTACH` environment variable to `-CC`
-  before calling the `load-session` command.
+- Setting the `TMUXIFIER_TMUX_ITERM_ATTACH` environment variable to `-CC` before
+  calling the `load-session` command.
 
-[tmux integration]: https://code.google.com/p/iterm2/wiki/TmuxIntegration
+[tmux integration]: https://gitlab.com/gnachman/iterm2/wikis/TmuxIntegration
 
 ## Inspiration
 
@@ -226,16 +245,16 @@ example:
 
 ## Tmuxifier vs. Tmuxinator
 
-Though Tmuxifier is largely inspired by the excellent [Tmuxinator][] project,
-it does set itself apart in a number of ways:
+Though Tmuxifier is largely inspired by the excellent [Tmuxinator][] project, it
+does set itself apart in a number of ways:
 
-- Uses shell scripts to define Tmux sessions and windows instead of YAML
-  files. The benefit is total control over Tmux, but the definition files are
-  more complicated to work with.
+- Uses shell scripts to define Tmux sessions and windows instead of YAML files.
+  The benefit is total control over Tmux, but the definition files are more
+  complicated to work with.
 - Instead of using a "project" concept, Tmuxifier uses a concept of "sessions"
   and "windows" just like Tmux itself. This allows you to load a whole session
-  with multiple pre-defined window configurations, or just load a single
-  window configuration into your existing session.
+  with multiple pre-defined window configurations, or just load a single window
+  configuration into your existing session.
 - Tmuxifier is a set of shell scripts, meaning it doesn't require Ruby to be
   installed on the machine.
 
@@ -244,8 +263,8 @@ it does set itself apart in a number of ways:
 
 ## Todos
 
-* Improve Readme, specially Usage section.
-* Write up a detailed reference for all available layout helper functions.
+- Improve Readme, specially Usage section.
+- Write up a detailed reference for all available layout helper functions.
 
 ## License
 
@@ -253,20 +272,19 @@ it does set itself apart in a number of ways:
 
 Copyright (c) 2014 Jim Myhrberg.
 
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
 
 The above copyright notice and this permission notice shall be included in all
 copies or substantial portions of the Software.
 
 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

init.fish

@@ -11,7 +11,10 @@ end
 # If `tmuxifier` is available, and `$TMUXIFIER_NO_COMPLETE` is not set, then
 # load Tmuxifier shell completion.
 if test -n (which tmuxifier); and test -z $TMUXIFIER_NO_COMPLETE
-  source "$TMUXIFIER/completion/tmuxifier.fish"
+    # fish shell 2.0.0 does not have the source alias
+    if [ (fish --version 2>| awk -F'version ' '{print $2}') = '2.0.0' ];
+      . "$TMUXIFIER/completion/tmuxifier.fish"
+    else
+      source "$TMUXIFIER/completion/tmuxifier.fish"
+    end
 end
-
-

lib/layout-helpers.sh

@@ -22,6 +22,10 @@ new_window() {
   if [ -n "$2" ]; then local command=("$2"); fi
 
   tmuxifier-tmux new-window -t "$session:" "${winarg[@]}" "${command[@]}"
+
+  # Disable renaming if a window name was given.
+  if [ -n "$1" ]; then tmuxifier-tmux set-option -t "$1" allow-rename off; fi
+
   window="$(__get_current_window_index)"
   __go_to_window_or_session_path
 }
@@ -33,7 +37,12 @@ new_window() {
 #   - $2: (optional) Target pane ID to split in current window.
 #
 split_v() {
-  if [ -n "$1" ]; then local percentage=(-p "$1"); fi
+  if [ "$(tmuxifier-tmux-version "3.0")" == ">" ]; then
+    # Tmux 3.1 and later.
+    if [ -n "$1" ]; then local percentage=(-l "$1"'%'); fi
+  else
+    if [ -n "$1" ]; then local percentage=(-p "$1"); fi
+  fi
   tmuxifier-tmux split-window -t "$session:$window.$2" -v "${percentage[@]}"
   __go_to_window_or_session_path
 }
@@ -45,7 +54,12 @@ split_v() {
 #   - $2: (optional) Target pane ID to split in current window.
 #
 split_h() {
-  if [ -n "$1" ]; then local percentage=(-p "$1"); fi
+  if [ "$(tmuxifier-tmux-version "3.0")" == ">" ]; then
+    # Tmux 3.1 and later.
+    if [ -n "$1" ]; then local percentage=(-l "$1"'%'); fi
+  else
+    if [ -n "$1" ]; then local percentage=(-p "$1"); fi
+  fi
   tmuxifier-tmux split-window -t "$session:$window.$2" -h "${percentage[@]}"
   __go_to_window_or_session_path
 }
@@ -101,6 +115,44 @@ select_pane() {
   tmuxifier-tmux select-pane -t "$session:$window.$1"
 }
 
+# Balance windows vertically with the "even-vertical" layout.
+#
+# Arguments:
+#   - $1: (optional) Window ID or name to operate on.
+#
+balance_windows_vertical() {
+  tmuxifier-tmux select-layout -t "$session:${1:-$window}" even-vertical
+}
+
+# Balance windows horizontally with the "even-horizontal" layout.
+#
+# Arguments:
+#   - $1: (optional) Window ID or name to operate on.
+#
+balance_windows_horizontal() {
+  tmuxifier-tmux select-layout -t "$session:${1:-$window}" even-horizontal
+}
+
+# Turn on synchronize-panes in a window.
+#
+# Arguments:
+#   - $1: (optional) Window ID or name to operate on.
+#
+synchronize_on() {
+  tmuxifier-tmux set-window-option -t "$session:${1:-$window}" \
+                 synchronize-panes on
+}
+
+# Turn off synchronize-panes in a window.
+#
+# Arguments:
+#   - $1: (optional) Window ID or name to operate on.
+#
+synchronize_off() {
+  tmuxifier-tmux set-window-option -t "$session:${1:-$window}" \
+                 synchronize-panes off
+}
+
 # Send/paste keys to the currently active pane/window.
 #
 # Arguments:
@@ -185,31 +237,39 @@ load_window() {
 #   - $2: (optional) Override default window name.
 #
 load_session() {
-  local file="$1"
-  if [ ! -f "$file" ]; then
-    file="$TMUXIFIER_LAYOUT_PATH/$1.session.sh"
-  fi
-
-  if [ -f "$file" ]; then
-    if [ $# -gt 1 ]; then
-      session="$2"
+  local file
+  if [ "${1#*/}" = "$1" ]; then
+    # There's no slash in the path.
+    if [ -f "$TMUXIFIER_LAYOUT_PATH/$1.session.sh" ] || [ ! -f "$1" ]; then
+      file="$TMUXIFIER_LAYOUT_PATH/$1.session.sh"
     else
-      session="${1/%.session.sh}"
-      session="${session/%.sh}"
-    fi
-
-    set_default_path=true
-    source "$file"
-    session=
-
-    # Reset `$session_root`.
-    if [[ "$session_root" != "$HOME" ]]; then
-      session_root="$HOME"
+      # bash's 'source' requires an slash in the filename to not use $PATH.
+      file="./$1"
     fi
   else
+    file="$1"
+  fi
+
+  if ! [ -f "$file" ]; then
     echo "\"$1\" session layout not found." >&2
     return 1
   fi
+
+  if [ $# -gt 1 ]; then
+    session="$2"
+  else
+    session="${1/%.session.sh}"
+    session="${session/%.sh}"
+  fi
+
+  set_default_path=true
+  source "$file"
+  session=
+
+  # Reset `$session_root`.
+  if [[ "$session_root" != "$HOME" ]]; then
+    session_root="$HOME"
+  fi
 }
 
 # Create a new session, returning 0 on success, 1 on failure.
@@ -233,7 +293,7 @@ initialize_session() {
   tmuxifier-tmux start-server
 
   # Check if the named session already exists.
-  if tmuxifier-tmux has-session -t "$session:" 2>/dev/null; then
+  if tmuxifier-tmux list-sessions | grep -q "^$session:"; then
     return 1
   fi
 
@@ -348,7 +408,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 "clear"
+    run_cmd " cd \"$target_path\""
+    run_cmd " clear"
   fi
 }

libexec/tmuxifier-init

@@ -76,7 +76,12 @@ case "$shell" in
     ;;
   fish )
     echo "set -gx TMUXIFIER \"$TMUXIFIER\";"
-    echo "source \"\$TMUXIFIER/init.fish\";"
+    # fish shell 2.0.0 does not have the source alias
+    if [[ $(fish --version 2>&1 | awk -F'version ' '{print $2}') = '2.0.0' ]]; then
+      echo ". \"\$TMUXIFIER/init.fish\";"
+    else
+      echo "source \"\$TMUXIFIER/init.fish\";"
+    fi  
     ;;
   * )
     echo "export TMUXIFIER=\"$TMUXIFIER\";"

libexec/tmuxifier-list-sessions

@@ -15,7 +15,7 @@ List all session layouts."
   exit
 fi
 
-list=$(find -L "$TMUXIFIER_LAYOUT_PATH" -name "*.session.sh")
+list=$(find -L "$TMUXIFIER_LAYOUT_PATH" -name "*.session.sh" | sort)
 for file in $list; do
   file=${file/$TMUXIFIER_LAYOUT_PATH\//}
   echo "${file/.session.sh/}"

libexec/tmuxifier-list-windows

@@ -15,7 +15,7 @@ List all window layouts."
   exit
 fi
 
-list=$(find -L "$TMUXIFIER_LAYOUT_PATH" -name "*.window.sh")
+list=$(find -L "$TMUXIFIER_LAYOUT_PATH" -name "*.window.sh" | sort)
 for file in $list; do
   file=${file/$TMUXIFIER_LAYOUT_PATH\//}
   echo "${file/.window.sh/}"

libexec/tmuxifier-load-session

@@ -19,7 +19,7 @@ Arguments:
                                 directory, or path to a session layout file.
    <iterm mode>               - When given as \"-CC\" tmux will be called with
                                 the -CC argument enabling iTerm2 integration.
-                                More info: http://bit.ly/1yDbMlm"
+                                More info: https://iterm2.com"
   exit
 fi
 

libexec/tmuxifier-tmux-version

@@ -11,7 +11,7 @@ if calling-help "$@"; then
 
 Outputs current Tmux version. If given optional target-version it outputs one
 of three possible characters indicating if the current Tmux version number is
-equal to, less than, or greater than the [target-version].
+equal to, less than, or greater than the <target-version>.
 
 The three possible outputs are \"=\", \"<\", and \">\"."
   exit
@@ -44,7 +44,19 @@ vercomp () {
 version=$(tmux -V)
 version=${version/tmux /}
 
-if [ -n "$1" ]; then
+# Fix for tmux next-* versions
+version=${version/next-/}
+
+if [ -z "$1" ]; then
+  echo "$version"
+  exit
+fi
+
+if [ "$version" == "master" ]; then
+  # When version string is "master", tmux was compiled from source, and we
+  # assume it's later than whatever the <target-version> is.
+  echo '>'
+else
   # Fix for "1.9a" version comparison, as vercomp() can only deal with
   # purely numeric version numbers.
   version=${version//+([a-zA-Z])/}
@@ -55,6 +67,4 @@ if [ -n "$1" ]; then
     1) echo '>';;
     2) echo '<';;
   esac
-else
-  echo "$version"
 fi

libexec/tmuxifier-version

@@ -13,4 +13,4 @@ Outputs Tmuxifier version."
   exit
 fi
 
-echo "0.12.1"
+echo "0.13.0"

tmuxifier.tmux

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