From 89b5c1819673b6aee8d36e0841711cfc066a15c7 Mon Sep 17 00:00:00 2001 From: Bruno Sutic Date: Mon, 19 May 2014 00:35:55 +0200 Subject: [PATCH] First commit --- scripts/key_binding.sh | 6 +++ scripts/set_tpm_path.sh | 22 ++++++++++ scripts/shared_functions.sh | 31 +++++++++++++ scripts/source_plugins.sh | 34 +++++++++++++++ scripts/sync_plugins.sh | 87 +++++++++++++++++++++++++++++++++++++ tpm | 35 +++++++++++++++ 6 files changed, 215 insertions(+) create mode 100755 scripts/key_binding.sh create mode 100755 scripts/set_tpm_path.sh create mode 100644 scripts/shared_functions.sh create mode 100755 scripts/source_plugins.sh create mode 100755 scripts/sync_plugins.sh create mode 100755 tpm diff --git a/scripts/key_binding.sh b/scripts/key_binding.sh new file mode 100755 index 0000000..05c3a88 --- /dev/null +++ b/scripts/key_binding.sh @@ -0,0 +1,6 @@ +#!/usr/bin/env bash + +CURRENT_DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )" + +# (I)nstalls all plugins +tmux bind-key I run-shell "$CURRENT_DIR/sync_plugins.sh 2>&1 1>&/dev/null" diff --git a/scripts/set_tpm_path.sh b/scripts/set_tpm_path.sh new file mode 100755 index 0000000..2229320 --- /dev/null +++ b/scripts/set_tpm_path.sh @@ -0,0 +1,22 @@ +#!/usr/bin/env bash + +default_tpm_path="$HOME/.tmux/plugins/" + +tpm_path_set() { + tmux show-environment -g TMUX_PLUGIN_MANAGER_PATH +} + +set_default_tpm_path() { + tmux set-environment -g TMUX_PLUGIN_MANAGER_PATH "$default_tpm_path" +} + +ensure_tpm_path() { + if ! tpm_path_set; then + set_default_tpm_path + fi +} + +main() { + ensure_tpm_path +} +main diff --git a/scripts/shared_functions.sh b/scripts/shared_functions.sh new file mode 100644 index 0000000..6e22542 --- /dev/null +++ b/scripts/shared_functions.sh @@ -0,0 +1,31 @@ +# shared functions and constants + +tpm_plugins_variable_name="@tpm_plugins" +SHARED_TPM_PATH="" + +# sets a "global variable" for the current file +shared_set_tpm_path_constant() { + SHARED_TPM_PATH=$(tmux show-environment -g TMUX_PLUGIN_MANAGER_PATH | cut -f2 -d=) +} + +shared_get_tpm_plugins_list() { + tmux show-option -gqv "$tpm_plugins_variable_name" +} + +# Allowed plugin name formats: +# 1. "git://github.com/user/plugin_name.git" +# 2. "user/plugin_name" +shared_plugin_name() { + local plugin=$1 + # get only the part after the last slash, e.g. "plugin_name.git" + local plugin_basename=$(basename "$plugin") + # remove ".git" extension (if it exists) to get only "plugin_name" + local plugin_name=${plugin_basename%.git} + echo $plugin_name +} + +shared_plugin_path() { + local plugin=$1 + local plugin_name=$(shared_plugin_name "$plugin") + echo "$SHARED_TPM_PATH$plugin_name/" +} diff --git a/scripts/source_plugins.sh b/scripts/source_plugins.sh new file mode 100755 index 0000000..58cfce1 --- /dev/null +++ b/scripts/source_plugins.sh @@ -0,0 +1,34 @@ +#!/usr/bin/env bash + +CURRENT_DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )" + +source "$CURRENT_DIR/shared_functions.sh" + +# Sources all *.tmux files from the plugin directory. +# Files are sourced as tmux config files, not as shell scripts! +# No errors if the plugin dir does not exist. +silently_source_all_tmux_files() { + local plugin_path=$1 + for tmux_file in $plugin_path/*.tmux; do + tmux run-shell "source-file $tmux_file 2>&1 1>&/dev/null" + done +} + +source_plugin() { + local plugin=$1 + local plugin_path=$(shared_plugin_path "$plugin") + silently_source_all_tmux_files "$plugin_path" +} + +source_plugins() { + local plugins=$(shared_get_tpm_plugins_list) + for plugin in $plugins; do + source_plugin "$plugin" + done +} + +main() { + shared_set_tpm_path_constant + source_plugins +} +main diff --git a/scripts/sync_plugins.sh b/scripts/sync_plugins.sh new file mode 100755 index 0000000..fc2262b --- /dev/null +++ b/scripts/sync_plugins.sh @@ -0,0 +1,87 @@ +#!/usr/bin/env bash + +CURRENT_DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )" + +source "$CURRENT_DIR/shared_functions.sh" + +# TMUX messaging is weird. You only get a nice clean pane if you do it with +# `run-shell` command. +display_message() { + local message=$1 + tmux run-shell "echo '$message'" +} + +end_message() { + display_message "" + display_message "TMUX environment reloaded." + display_message "" + display_message "Done, press ENTER to continue." +} + +clone() { + local plugin=$1 + cd $SHARED_TPM_PATH && + git clone --recursive $plugin +} + +# tries cloning: +# 1. plugin name directly - works if it's a valid git url +# 2. expands the plugin name to point to a github repo and tries cloning again +clone_plugin() { + local plugin=$1 + clone "$plugin" || + clone "https://github.com/$plugin" +} + +plugin_already_cloned() { + local plugin=$1 + local plugin_path=$(shared_plugin_path "$plugin") + cd $plugin_path && + git remote +} + +pull_changes() { + local plugin=$1 + local plugin_path=$(shared_plugin_path "$plugin") + cd $plugin_path && + git pull && + git submodule update --init --recursive +} + +# pull new changes or clone plugin +sync_plugin() { + local plugin=$1 + if plugin_already_cloned "$plugin"; then + # plugin is already cloned - update it + display_message "Updating $plugin" + pull_changes "$plugin" && + display_message " $plugin update success" || + display_message " $plugin update fail" + else + # plugin wasn't cloned so far - clone it + display_message "Downloading $plugin" + clone_plugin "$plugin" && + display_message " $plugin download success" || + display_message " $plugin download fail" + fi +} + +sync_plugins() { + local plugins=$(shared_get_tpm_plugins_list) + for plugin in $plugins; do + sync_plugin "$plugin" + done +} + +reload_tmux_environment() { + tmux source-file ~/.tmux.conf 2>&1 1>&/dev/null +} + +main() { + reload_tmux_environment + shared_set_tpm_path_constant + sync_plugins + reload_tmux_environment + end_message +} +main diff --git a/tpm b/tpm new file mode 100755 index 0000000..5e39d29 --- /dev/null +++ b/tpm @@ -0,0 +1,35 @@ +#!/usr/bin/env bash + +CURRENT_DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )" + +# Ensures TMUX_PLUGIN_MANAGER_PATH global env variable is set. +# Default tpm path is "$HOME/.tmux/plugins/". That's where all the plugins are +# downloaded. +# +# Put this in `.tmux.conf` to override the default: +# `set-environment -g TMUX_PLUGIN_MANAGER_PATH "/some/other/path/"` +set_tpm_path() { + $CURRENT_DIR/scripts/set_tpm_path.sh 2>&1 1>&/dev/null +} + +# 1. Fetches plugin names from `@tpm_plugins` user variable. +# 2. Creates full plugin path +# 3. Sources all *.tmux files from each of the plugin directories +# - no errors raised if directory does not exist +# Files are sourced as tmux config files, not as shell scripts! +source_plugins() { + $CURRENT_DIR/scripts/source_plugins.sh 2>&1 1>&/dev/null +} + +# Defines key binding: +# prefix + I - downloads TPM plugins and reloads TMUX environment. +set_tpm_key_binding() { + $CURRENT_DIR/scripts/key_binding.sh +} + +main() { + set_tpm_path + set_tpm_key_binding + source_plugins +} +main