mirror of
https://github.com/tmux-plugins/tpm.git
synced 2025-06-25 00:01:45 -04:00
Compare commits
No commits in common. "master" and "v0.0.2" have entirely different histories.
9
.gitattributes
vendored
9
.gitattributes
vendored
@ -1,9 +0,0 @@
|
|||||||
# Force text files to have unix eols, so Windows/Cygwin does not break them
|
|
||||||
*.* eol=lf
|
|
||||||
|
|
||||||
# These files are unfortunately not recognized as text files so
|
|
||||||
# explicitly listing them here
|
|
||||||
tpm eol=lf
|
|
||||||
bin/* eol=lf
|
|
||||||
bindings/* eol=lf
|
|
||||||
tests/* eol=lf
|
|
||||||
3
.gitignore
vendored
3
.gitignore
vendored
@ -1,4 +1 @@
|
|||||||
**/.vagrant/
|
**/.vagrant/
|
||||||
run_tests
|
|
||||||
tests/run_tests_in_isolation
|
|
||||||
tests/helpers/helpers.sh
|
|
||||||
|
|||||||
3
.gitmodules
vendored
3
.gitmodules
vendored
@ -1,3 +0,0 @@
|
|||||||
[submodule "lib/tmux-test"]
|
|
||||||
path = lib/tmux-test
|
|
||||||
url = https://github.com/tmux-plugins/tmux-test.git
|
|
||||||
19
.travis.yml
19
.travis.yml
@ -1,19 +0,0 @@
|
|||||||
# generic packages and tmux
|
|
||||||
before_install:
|
|
||||||
- sudo apt-get update
|
|
||||||
- sudo apt-get install -y git-core expect
|
|
||||||
- sudo apt-get install -y python-software-properties software-properties-common
|
|
||||||
- sudo apt-get install -y libevent-dev libncurses-dev
|
|
||||||
- git clone https://github.com/tmux/tmux.git
|
|
||||||
- cd tmux
|
|
||||||
- git checkout 2.0
|
|
||||||
- sh autogen.sh
|
|
||||||
- ./configure && make && sudo make install
|
|
||||||
|
|
||||||
install:
|
|
||||||
- git fetch --unshallow --recurse-submodules || git fetch --recurse-submodules
|
|
||||||
# manual `git clone` required for testing `tmux-test` plugin itself
|
|
||||||
- git clone https://github.com/tmux-plugins/tmux-test lib/tmux-test; true
|
|
||||||
- lib/tmux-test/setup
|
|
||||||
|
|
||||||
script: ./tests/run_tests_in_isolation
|
|
||||||
72
CHANGELOG.md
72
CHANGELOG.md
@ -2,78 +2,6 @@
|
|||||||
|
|
||||||
### master
|
### master
|
||||||
|
|
||||||
### v3.1.0, 2023-01-03
|
|
||||||
- upgrade to new version of `tmux-test`
|
|
||||||
- bug: when using `emacs` copy mode, Enter does not quit screen after tpm
|
|
||||||
installation/update. Fix by making `Escape` the key for emacs mode.
|
|
||||||
- add a doc with troubleshooting instructions
|
|
||||||
- add `.gitattributes` file that forces linefeed characters (classic `\n`) as
|
|
||||||
line endings - helps with misconfigured git on windows/cygwin
|
|
||||||
- readme update: announce Cygwin support
|
|
||||||
- un-deprecate old plugin definition syntax: `set -g @tpm_plugins`
|
|
||||||
- More stuff, check `git log`.
|
|
||||||
|
|
||||||
### v3.0.0, 2015-08-03
|
|
||||||
- refactor `shared_set_tpm_path_constant` function
|
|
||||||
- move all instructions to `docs/` dir
|
|
||||||
- add `bin/install_plugins` cli executable script
|
|
||||||
- improved test runner function
|
|
||||||
- switch to using [tmux-test](https://github.com/tmux-plugins/tmux-test)
|
|
||||||
framework
|
|
||||||
- add `bin/update_plugins` cli executable script
|
|
||||||
- refactor test `expect` scripts, make them simpler and ensure they properly
|
|
||||||
assert expectations
|
|
||||||
- refactor code that sets 'TMUX_PLUGIN_MANAGER_PATH' global env var
|
|
||||||
- stop using global variable for 'tpm path'
|
|
||||||
- support defining plugins via `set -g @plugin` in sourced files as well
|
|
||||||
|
|
||||||
### v2.0.0, 2015-07-07
|
|
||||||
- enable overriding default key bindings
|
|
||||||
- start using `C-c` to clear screen
|
|
||||||
- add uninstall/clean procedure and keybinding (prefix+alt+u) (@chilicuil)
|
|
||||||
- add new `set @plugin 'repo'` plugin definition syntax (@chilicuil)
|
|
||||||
- revert back to using `-g` flag in new plugin definition syntax
|
|
||||||
- permit leading whitespace with new plugin definition syntax (thanks @chilicuil)
|
|
||||||
- make sure `TMUX_PLUGIN_MANAGER_PATH` always has trailng slash
|
|
||||||
- ensure old/deprecated plugin syntax `set -g @tpm_plugins` works alongside new
|
|
||||||
`set -g @plugin` syntax
|
|
||||||
|
|
||||||
### v1.2.2, 2015-02-08
|
|
||||||
- set GIT_TERMINAL_PROMPT=0 when doing `git clone`, `pull` or `submodule update`
|
|
||||||
to ensure git does not prompt for username/password in any case
|
|
||||||
|
|
||||||
### v1.2.1, 2014-11-21
|
|
||||||
- change the way plugin name is expanded. It now uses the http username
|
|
||||||
and password by default, like this: `https://git::@github.com/`. This prevents
|
|
||||||
username and password prompt (and subsequently tmux install hanging) with old
|
|
||||||
git versions. Fixes #7.
|
|
||||||
|
|
||||||
### v1.2.0, 2014-11-20
|
|
||||||
- refactor tests so they can be used on travis
|
|
||||||
- add travis.yml, add travis badge to the readme
|
|
||||||
|
|
||||||
### v1.1.0, 2014-11-19
|
|
||||||
- if the plugin is not downloaded do not source it
|
|
||||||
- remove `PLUGINS.md`, an obsolete list of plugins
|
|
||||||
- update readme with instructions about uninstalling plugins
|
|
||||||
- tilde char and `$HOME` in `TMUX_SHARED_MANAGER_PATH` couldn't be used because
|
|
||||||
they are just plain strings. Fixing the problem by manually expanding them.
|
|
||||||
- bugfix: fragile `*.tmux` file globbing (@majutsushi)
|
|
||||||
|
|
||||||
### v1.0.0, 2014-08-05
|
|
||||||
- update readme because of github organization change to
|
|
||||||
[tmux-plugins](https://github.com/tmux-plugins)
|
|
||||||
- update tests to pass
|
|
||||||
- update README to suggest different first plugin
|
|
||||||
- update list of plugins in the README
|
|
||||||
- remove README 'about' section
|
|
||||||
- move key binding to the main file. Delete `key_binding.sh`.
|
|
||||||
- rename `display_message` -> `echo_message`
|
|
||||||
- installing plugins installs just new plugins. Already installed plugins aren't
|
|
||||||
updated.
|
|
||||||
- add 'update plugin' binding and functionality
|
|
||||||
- add test for updating a plugin
|
|
||||||
|
|
||||||
### v0.0.2, 2014-07-17
|
### v0.0.2, 2014-07-17
|
||||||
- run all *.tmux plugin files as executables
|
- run all *.tmux plugin files as executables
|
||||||
- fix all redirects to /dev/null
|
- fix all redirects to /dev/null
|
||||||
|
|||||||
115
HOW_TO_PLUGIN.md
115
HOW_TO_PLUGIN.md
@ -1,2 +1,113 @@
|
|||||||
Instructions moved to
|
# How to create Tmux plugins
|
||||||
[docs/how_to_create_plugin.md](docs/how_to_create_plugin.md).
|
|
||||||
|
Creating a new plugin is easy.
|
||||||
|
|
||||||
|
For demonstration purposes we'll create a simple plugin that lists all
|
||||||
|
installed TPM plugins. Yes, a plugin that lists plugins :) We'll bind that to
|
||||||
|
`prefix + T`.
|
||||||
|
|
||||||
|
### 1. create a new git project
|
||||||
|
|
||||||
|
TPM depends on git for downloading and updating plugins.
|
||||||
|
|
||||||
|
To create a new git project:
|
||||||
|
|
||||||
|
$ mkdir tmux_my_plugin
|
||||||
|
$ cd tmux_my_plugin
|
||||||
|
$ git init
|
||||||
|
|
||||||
|
### 2. create a `*.tmux` plugin run file
|
||||||
|
|
||||||
|
When it sources a plugin, TPM executes all `*.tmux` files in your plugins'
|
||||||
|
directory. That's how plugins are run.
|
||||||
|
|
||||||
|
Create a plugin run file in plugin directory:
|
||||||
|
|
||||||
|
$ touch my_plugin.tmux
|
||||||
|
$ chmod +x my_plugin.tmux
|
||||||
|
|
||||||
|
You can have more than one `*.tmux` file, and all will get executed. Usually
|
||||||
|
however, you'll need just one.
|
||||||
|
|
||||||
|
### 3. create a plugin key binding
|
||||||
|
|
||||||
|
We want the behavior of the plugin to trigger when a user hits `prefix + T`.
|
||||||
|
|
||||||
|
Key `T` is chosen because:
|
||||||
|
- it's "kind of" a mnemonic for `TPM`
|
||||||
|
- the key is not used by Tmux natively. Tmux man page, KEY BINDINGS section
|
||||||
|
contains a list of all the bindings Tmux uses. We don't want to override any
|
||||||
|
Tmux default binding, and there's plenty of unused keys.
|
||||||
|
|
||||||
|
Open the plugin run file in your favorite text editor:
|
||||||
|
|
||||||
|
$ vim my_plugin.tmux
|
||||||
|
# or
|
||||||
|
$ subl my_plugin.tmux
|
||||||
|
|
||||||
|
Put the following content in the file:
|
||||||
|
|
||||||
|
#!/usr/bin/env bash
|
||||||
|
|
||||||
|
CURRENT_DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
|
||||||
|
tmux bind-key T run-shell "$CURRENT_DIR/scripts/tmux_list_plugins.sh"
|
||||||
|
|
||||||
|
As you can see, plugin run file is a simple bash script that sets up binding.
|
||||||
|
|
||||||
|
When pressed, `prefix + T` will now execute another shell script:
|
||||||
|
`tmux_list_plugins.sh`. That script should be in `scripts/` directory -
|
||||||
|
relative to the plugin run file.
|
||||||
|
|
||||||
|
|
||||||
|
### 4. listing plugins
|
||||||
|
|
||||||
|
Now that we have the binding, let's create a script that's invoked on
|
||||||
|
`prefix + T`.
|
||||||
|
|
||||||
|
$ mkdir scripts
|
||||||
|
$ touch scripts/tmux_list_plugins.sh
|
||||||
|
$ chmod +x scripts/tmux_list_plugins.sh
|
||||||
|
|
||||||
|
And here's the script content:
|
||||||
|
|
||||||
|
#!/usr/bin/env bash
|
||||||
|
|
||||||
|
# fetching the value of "tpm_plugins" option
|
||||||
|
plugins_list=$(tmux show-option -gqv "@tpm_plugins")
|
||||||
|
|
||||||
|
# displaying variable content, line by line
|
||||||
|
for plugin in $plugins_list; do
|
||||||
|
echo $plugin
|
||||||
|
done
|
||||||
|
|
||||||
|
### 5. try it out
|
||||||
|
|
||||||
|
To try if this works, execute the plugin run file:
|
||||||
|
|
||||||
|
$ ./my_plugin.tmux
|
||||||
|
|
||||||
|
That should set up the key binding. Now hit `prefix + T` and see if it works.
|
||||||
|
|
||||||
|
If you get stuck you can download and check this tutorial
|
||||||
|
[plugin here](https://github.com/bruno-/tmux_example_plugin).
|
||||||
|
|
||||||
|
### 6. publish the plugin
|
||||||
|
|
||||||
|
When everything works, push the plugin to an online git repository, preferably
|
||||||
|
Github.
|
||||||
|
|
||||||
|
Other users can install your plugin by just adding plugin git URL to the
|
||||||
|
`@tpm_plugins` list in their `.tmux.conf`.
|
||||||
|
|
||||||
|
If the plugin is on Github, your users will be able to use the shorthand of
|
||||||
|
`github_username/repository`.
|
||||||
|
|
||||||
|
### Conclusion
|
||||||
|
|
||||||
|
Hopefully, that was easy. As you can see, it's mostly shell scripting.
|
||||||
|
|
||||||
|
You can also check source code of other plugins from the
|
||||||
|
[List of plugins](PLUGINS.md).
|
||||||
|
|
||||||
|
You can use other scripting languages (ruby, phyton etc), but plain old shell
|
||||||
|
is preferred because it will work almost anywhere.
|
||||||
|
|||||||
13
PLUGINS.md
Normal file
13
PLUGINS.md
Normal file
@ -0,0 +1,13 @@
|
|||||||
|
# Tmux plugins list
|
||||||
|
|
||||||
|
If you create a plugin, feel free to create a pull request that adds it to the
|
||||||
|
list.
|
||||||
|
|
||||||
|
- [pain control](https://github.com/bruno-/tmux_pain_control) - standard
|
||||||
|
bindings for controlling panes.
|
||||||
|
- [goto session](https://github.com/bruno-/tmux_goto_session) - faster session
|
||||||
|
switching.
|
||||||
|
- [battery osx](https://github.com/bruno-/tmux_battery_osx) - battery status
|
||||||
|
for OSX in tmux `status-right`
|
||||||
|
- [logging](https://github.com/bruno-/tmux_logging) - easy logging and
|
||||||
|
screen capturing.
|
||||||
116
README.md
116
README.md
@ -1,100 +1,92 @@
|
|||||||
# Tmux Plugin Manager
|
# Tmux Plugin Manager
|
||||||
|
|
||||||
[](https://travis-ci.org/tmux-plugins/tpm)
|
Installs and loads TMUX plugins.
|
||||||
|
|
||||||
Installs and loads `tmux` plugins.
|
|
||||||
|
|
||||||
Tested and working on Linux, OSX, and Cygwin.
|
|
||||||
|
|
||||||
See list of plugins [here](https://github.com/tmux-plugins/list).
|
|
||||||
|
|
||||||
### Installation
|
### Installation
|
||||||
|
|
||||||
Requirements: `tmux` version 1.9 (or higher), `git`, `bash`.
|
Requirements: `tmux` version 1.9 (or higher), `git`
|
||||||
|
|
||||||
Clone TPM:
|
Clone TPM:
|
||||||
|
|
||||||
```bash
|
$ git clone https://github.com/bruno-/tpm ~/.tmux/plugins/tpm
|
||||||
git clone https://github.com/tmux-plugins/tpm ~/.tmux/plugins/tpm
|
|
||||||
```
|
|
||||||
|
|
||||||
Put this at the bottom of `~/.tmux.conf` (`$XDG_CONFIG_HOME/tmux/tmux.conf`
|
Put this at the bottom of your `.tmux.conf` (backslashes at the end of the lines
|
||||||
works too):
|
are required):
|
||||||
|
|
||||||
```bash
|
# List of plugins
|
||||||
# List of plugins
|
# Supports `github_username/repo` or full git URLs
|
||||||
set -g @plugin 'tmux-plugins/tpm'
|
set -g @tpm_plugins " \
|
||||||
set -g @plugin 'tmux-plugins/tmux-sensible'
|
bruno-/tpm \
|
||||||
|
bruno-/tmux_pain_control \
|
||||||
|
"
|
||||||
|
# Other examples:
|
||||||
|
# github_username/plugin_name \
|
||||||
|
# git@github.com/user/plugin \
|
||||||
|
# git@bitbucket.com/user/plugin \
|
||||||
|
|
||||||
# Other examples:
|
# initializes TMUX plugin manager
|
||||||
# set -g @plugin 'github_username/plugin_name'
|
run-shell ~/.tmux/plugins/tpm/tpm
|
||||||
# set -g @plugin 'github_username/plugin_name#branch'
|
|
||||||
# set -g @plugin 'git@github.com:user/plugin'
|
|
||||||
# set -g @plugin 'git@bitbucket.com:user/plugin'
|
|
||||||
|
|
||||||
# Initialize TMUX plugin manager (keep this line at the very bottom of tmux.conf)
|
|
||||||
run '~/.tmux/plugins/tpm/tpm'
|
|
||||||
```
|
|
||||||
|
|
||||||
Reload TMUX environment so TPM is sourced:
|
Reload TMUX environment so TPM is sourced:
|
||||||
|
|
||||||
```bash
|
# type this in terminal
|
||||||
# type this in terminal if tmux is already running
|
$ tmux source-file ~/.tmux.conf
|
||||||
tmux source ~/.tmux.conf
|
|
||||||
```
|
|
||||||
|
|
||||||
That's it!
|
That's it!
|
||||||
|
|
||||||
### Installing plugins
|
### Installing plugins
|
||||||
|
|
||||||
1. Add new plugin to `~/.tmux.conf` with `set -g @plugin '...'`
|
1. add a new plugin to the `@tpm_plugins` list
|
||||||
2. Press `prefix` + <kbd>I</kbd> (capital i, as in **I**nstall) to fetch the plugin.
|
2. hit `prefix + I` (I as in *I*nstall) to fetch the plugin
|
||||||
|
|
||||||
You're good to go! The plugin was cloned to `~/.tmux/plugins/` dir and sourced.
|
You're good to go! The plugin was cloned to `~/.tmux/plugins/` dir and sourced.
|
||||||
|
|
||||||
### Uninstalling plugins
|
|
||||||
|
|
||||||
1. Remove (or comment out) plugin from the list.
|
|
||||||
2. Press `prefix` + <kbd>alt</kbd> + <kbd>u</kbd> (lowercase u as in **u**ninstall) to remove the plugin.
|
|
||||||
|
|
||||||
All the plugins are installed to `~/.tmux/plugins/` so alternatively you can
|
|
||||||
find plugin directory there and remove it.
|
|
||||||
|
|
||||||
### Key bindings
|
### Key bindings
|
||||||
|
|
||||||
`prefix` + <kbd>I</kbd>
|
TPM provides only 1 key binding: `prefix + I`. Here's what it does:
|
||||||
- Installs new plugins from GitHub or any other git repository
|
|
||||||
- Refreshes TMUX environment
|
|
||||||
|
|
||||||
`prefix` + <kbd>U</kbd>
|
- clones new plugins from github or any other git repo
|
||||||
- updates plugin(s)
|
- pulls updates for already installed plugins
|
||||||
|
- refreshes TMUX environment
|
||||||
|
|
||||||
`prefix` + <kbd>alt</kbd> + <kbd>u</kbd>
|
After you press `prefix + I`, everything should be up to date.
|
||||||
- remove/uninstall plugins not on the plugin list
|
|
||||||
|
|
||||||
### Docs
|
### List of plugins
|
||||||
|
|
||||||
- [Help, tpm not working](docs/tpm_not_working.md) - problem solutions
|
- [pain control](https://github.com/bruno-/tmux_pain_control) - useful standard
|
||||||
|
bindings for controlling panes
|
||||||
|
- [goto session](https://github.com/bruno-/tmux_goto_session) - faster session
|
||||||
|
switching
|
||||||
|
- [battery osx](https://github.com/bruno-/tmux_battery_osx) - battery status
|
||||||
|
for OSX in Tmux `status-right`
|
||||||
|
- [logging](https://github.com/bruno-/tmux_logging) - easy logging and
|
||||||
|
screen capturing
|
||||||
|
- [online status](https://github.com/bruno-/tmux_online_status) - online status
|
||||||
|
indicator in Tmux `status-right`. Useful when on flaky connection to see if
|
||||||
|
you're online.
|
||||||
|
|
||||||
More advanced features and instructions, regular users probably do not need
|
If you create a plugin, feel free to create a pull request that adds it to the
|
||||||
this:
|
list.
|
||||||
|
|
||||||
- [How to create a plugin](docs/how_to_create_plugin.md). It's easy.
|
### Creating plugins
|
||||||
- [Managing plugins via the command line](docs/managing_plugins_via_cmd_line.md)
|
|
||||||
- [Changing plugins install dir](docs/changing_plugins_install_dir.md)
|
[How to create a plugin](HOW_TO_PLUGIN.md). It's easy.
|
||||||
- [Automatic TPM installation on a new machine](docs/automatic_tpm_installation.md)
|
|
||||||
|
|
||||||
### Tests
|
### Tests
|
||||||
|
|
||||||
Tests for this project run on [Travis CI](https://travis-ci.org/tmux-plugins/tpm).
|
Requirements: [vagrant](https://www.vagrantup.com/)
|
||||||
|
|
||||||
When run locally, [vagrant](https://www.vagrantup.com/) is required.
|
Running the test suite:
|
||||||
Run tests with:
|
|
||||||
|
|
||||||
```bash
|
$ ./run-tests
|
||||||
# within project directory
|
|
||||||
./run_tests
|
### About
|
||||||
```
|
|
||||||
|
Truth be told, there aren't too many TMUX plugins out there. People mostly just
|
||||||
|
copy code snippets from each others' `.tmux.conf` files.
|
||||||
|
|
||||||
|
I hope TMUX plugin manager (TPM) inspires people to do better and more creative
|
||||||
|
things with TMUX.
|
||||||
|
|
||||||
### License
|
### License
|
||||||
|
|
||||||
|
|||||||
10
Vagrantfile
vendored
Normal file
10
Vagrantfile
vendored
Normal file
@ -0,0 +1,10 @@
|
|||||||
|
VAGRANTFILE_API_VERSION = '2'
|
||||||
|
|
||||||
|
Vagrant.configure(VAGRANTFILE_API_VERSION) do |config|
|
||||||
|
config.vm.box = 'precise32'
|
||||||
|
config.vm.box_url = 'http://files.vagrantup.com/precise32.box'
|
||||||
|
|
||||||
|
config.vm.synced_folder './', '/home/vagrant/tpm'
|
||||||
|
|
||||||
|
config.vm.provision 'shell', path: 'vagrant_provisioning.sh'
|
||||||
|
end
|
||||||
@ -1,14 +0,0 @@
|
|||||||
#!/usr/bin/env bash
|
|
||||||
|
|
||||||
# Script intended for use via the command line.
|
|
||||||
#
|
|
||||||
# `.tmux.conf` needs to be set for TPM. Tmux has to be installed on the system,
|
|
||||||
# but does not need to be started in order to run this script.
|
|
||||||
|
|
||||||
CURRENT_DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
|
|
||||||
SCRIPTS_DIR="$CURRENT_DIR/../scripts"
|
|
||||||
|
|
||||||
main() {
|
|
||||||
"$SCRIPTS_DIR/clean_plugins.sh" # has correct exit code
|
|
||||||
}
|
|
||||||
main
|
|
||||||
@ -1,14 +0,0 @@
|
|||||||
#!/usr/bin/env bash
|
|
||||||
|
|
||||||
# Script intended for use via the command line.
|
|
||||||
#
|
|
||||||
# `.tmux.conf` needs to be set for TPM. Tmux has to be installed on the system,
|
|
||||||
# but does not need to be started in order to run this script.
|
|
||||||
|
|
||||||
CURRENT_DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
|
|
||||||
SCRIPTS_DIR="$CURRENT_DIR/../scripts"
|
|
||||||
|
|
||||||
main() {
|
|
||||||
"$SCRIPTS_DIR/install_plugins.sh" # has correct exit code
|
|
||||||
}
|
|
||||||
main
|
|
||||||
@ -1,24 +0,0 @@
|
|||||||
#!/usr/bin/env bash
|
|
||||||
|
|
||||||
# Script intended for use via the command line.
|
|
||||||
#
|
|
||||||
# `.tmux.conf` needs to be set for TPM. Tmux has to be installed on the system,
|
|
||||||
# but does not need to be started in order to run this script.
|
|
||||||
|
|
||||||
CURRENT_DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
|
|
||||||
SCRIPTS_DIR="$CURRENT_DIR/../scripts"
|
|
||||||
PROGRAM_NAME="$0"
|
|
||||||
|
|
||||||
if [ $# -eq 0 ]; then
|
|
||||||
echo "usage:"
|
|
||||||
echo " $PROGRAM_NAME all update all plugins"
|
|
||||||
echo " $PROGRAM_NAME tmux-foo update plugin 'tmux-foo'"
|
|
||||||
echo " $PROGRAM_NAME tmux-bar tmux-baz update multiple plugins"
|
|
||||||
exit 1
|
|
||||||
fi
|
|
||||||
|
|
||||||
main() {
|
|
||||||
"$SCRIPTS_DIR/update_plugin.sh" --shell-echo "$*" # has correct exit code
|
|
||||||
}
|
|
||||||
main "$*"
|
|
||||||
|
|
||||||
@ -1,19 +0,0 @@
|
|||||||
#!/usr/bin/env bash
|
|
||||||
|
|
||||||
# Tmux key-binding script.
|
|
||||||
# Scripts intended to be used via the command line are in `bin/` directory.
|
|
||||||
|
|
||||||
CURRENT_DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
|
|
||||||
SCRIPTS_DIR="$CURRENT_DIR/../scripts"
|
|
||||||
HELPERS_DIR="$SCRIPTS_DIR/helpers"
|
|
||||||
|
|
||||||
source "$HELPERS_DIR/tmux_echo_functions.sh"
|
|
||||||
source "$HELPERS_DIR/tmux_utils.sh"
|
|
||||||
|
|
||||||
main() {
|
|
||||||
reload_tmux_environment
|
|
||||||
"$SCRIPTS_DIR/clean_plugins.sh" --tmux-echo >/dev/null 2>&1
|
|
||||||
reload_tmux_environment
|
|
||||||
end_message
|
|
||||||
}
|
|
||||||
main
|
|
||||||
@ -1,19 +0,0 @@
|
|||||||
#!/usr/bin/env bash
|
|
||||||
|
|
||||||
# Tmux key-binding script.
|
|
||||||
# Scripts intended to be used via the command line are in `bin/` directory.
|
|
||||||
|
|
||||||
CURRENT_DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
|
|
||||||
SCRIPTS_DIR="$CURRENT_DIR/../scripts"
|
|
||||||
HELPERS_DIR="$SCRIPTS_DIR/helpers"
|
|
||||||
|
|
||||||
source "$HELPERS_DIR/tmux_echo_functions.sh"
|
|
||||||
source "$HELPERS_DIR/tmux_utils.sh"
|
|
||||||
|
|
||||||
main() {
|
|
||||||
reload_tmux_environment
|
|
||||||
"$SCRIPTS_DIR/install_plugins.sh" --tmux-echo >/dev/null 2>&1
|
|
||||||
reload_tmux_environment
|
|
||||||
end_message
|
|
||||||
}
|
|
||||||
main
|
|
||||||
@ -1,49 +0,0 @@
|
|||||||
#!/usr/bin/env bash
|
|
||||||
|
|
||||||
# Tmux key-binding script.
|
|
||||||
# Scripts intended to be used via the command line are in `bin/` directory.
|
|
||||||
|
|
||||||
# This script:
|
|
||||||
# - shows a list of installed plugins
|
|
||||||
# - starts a prompt to enter the name of the plugin that will be updated
|
|
||||||
|
|
||||||
CURRENT_DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
|
|
||||||
SCRIPTS_DIR="$CURRENT_DIR/../scripts"
|
|
||||||
HELPERS_DIR="$SCRIPTS_DIR/helpers"
|
|
||||||
|
|
||||||
source "$HELPERS_DIR/plugin_functions.sh"
|
|
||||||
source "$HELPERS_DIR/tmux_echo_functions.sh"
|
|
||||||
source "$HELPERS_DIR/tmux_utils.sh"
|
|
||||||
|
|
||||||
display_plugin_update_list() {
|
|
||||||
local plugins="$(tpm_plugins_list_helper)"
|
|
||||||
tmux_echo "Installed plugins:"
|
|
||||||
tmux_echo ""
|
|
||||||
|
|
||||||
for plugin in $plugins; do
|
|
||||||
# displaying only installed plugins
|
|
||||||
if plugin_already_installed "$plugin"; then
|
|
||||||
local plugin_name="$(plugin_name_helper "$plugin")"
|
|
||||||
tmux_echo " $plugin_name"
|
|
||||||
fi
|
|
||||||
done
|
|
||||||
|
|
||||||
tmux_echo ""
|
|
||||||
tmux_echo "Type plugin name to update it."
|
|
||||||
tmux_echo ""
|
|
||||||
tmux_echo "- \"all\" - updates all plugins"
|
|
||||||
tmux_echo "- ENTER - cancels"
|
|
||||||
}
|
|
||||||
|
|
||||||
update_plugin_prompt() {
|
|
||||||
tmux command-prompt -p 'plugin update:' " \
|
|
||||||
send-keys C-c; \
|
|
||||||
run-shell '$SCRIPTS_DIR/update_plugin_prompt_handler.sh %1'"
|
|
||||||
}
|
|
||||||
|
|
||||||
main() {
|
|
||||||
reload_tmux_environment
|
|
||||||
display_plugin_update_list
|
|
||||||
update_plugin_prompt
|
|
||||||
}
|
|
||||||
main
|
|
||||||
@ -1,12 +0,0 @@
|
|||||||
# Automatic tpm installation
|
|
||||||
|
|
||||||
One of the first things we do on a new machine is cloning our dotfiles. Not everything comes with them though, so for example `tpm` most likely won't be installed.
|
|
||||||
|
|
||||||
If you want to install `tpm` and plugins automatically when tmux is started, put the following snippet in `.tmux.conf` before the final `run '~/.tmux/plugins/tpm/tpm'`:
|
|
||||||
|
|
||||||
```
|
|
||||||
if "test ! -d ~/.tmux/plugins/tpm" \
|
|
||||||
"run 'git clone https://github.com/tmux-plugins/tpm ~/.tmux/plugins/tpm && ~/.tmux/plugins/tpm/bin/install_plugins'"
|
|
||||||
```
|
|
||||||
|
|
||||||
This useful tip was submitted by @acr4 and narfman0.
|
|
||||||
@ -1,16 +0,0 @@
|
|||||||
# Changing plugins install dir
|
|
||||||
|
|
||||||
By default, TPM installs plugins in a subfolder named `plugins/` inside
|
|
||||||
`$XDG_CONFIG_HOME/tmux/` if a `tmux.conf` file was found at that location, or
|
|
||||||
inside `~/.tmux/` otherwise.
|
|
||||||
|
|
||||||
You can change the install path by putting this in `.tmux.conf`:
|
|
||||||
|
|
||||||
set-environment -g TMUX_PLUGIN_MANAGER_PATH '/some/other/path/'
|
|
||||||
|
|
||||||
Tmux plugin manager initialization in `.tmux.conf` should also be updated:
|
|
||||||
|
|
||||||
# initializes TMUX plugin manager in a new path
|
|
||||||
run /some/other/path/tpm/tpm
|
|
||||||
|
|
||||||
Please make sure that the `run` line is at the very bottom of `.tmux.conf`.
|
|
||||||
@ -1,108 +0,0 @@
|
|||||||
# How to create Tmux plugins
|
|
||||||
|
|
||||||
Creating a new plugin is easy.
|
|
||||||
|
|
||||||
For demonstration purposes we'll create a simple plugin that lists all
|
|
||||||
installed TPM plugins. Yes, a plugin that lists plugins :) We'll bind that to
|
|
||||||
`prefix + T`.
|
|
||||||
|
|
||||||
The source code for this example plugin can be found
|
|
||||||
[here](https://github.com/tmux-plugins/tmux-example-plugin).
|
|
||||||
|
|
||||||
### 1. create a new git project
|
|
||||||
|
|
||||||
TPM depends on git for downloading and updating plugins.
|
|
||||||
|
|
||||||
To create a new git project:
|
|
||||||
|
|
||||||
$ mkdir tmux_my_plugin
|
|
||||||
$ cd tmux_my_plugin
|
|
||||||
$ git init
|
|
||||||
|
|
||||||
### 2. create a `*.tmux` plugin run file
|
|
||||||
|
|
||||||
When it sources a plugin, TPM executes all `*.tmux` files in your plugins'
|
|
||||||
directory. That's how plugins are run.
|
|
||||||
|
|
||||||
Create a plugin run file in plugin directory:
|
|
||||||
|
|
||||||
$ touch my_plugin.tmux
|
|
||||||
$ chmod u+x my_plugin.tmux
|
|
||||||
|
|
||||||
You can have more than one `*.tmux` file, and all will get executed. However, usually
|
|
||||||
you'll need just one.
|
|
||||||
|
|
||||||
### 3. create a plugin key binding
|
|
||||||
|
|
||||||
We want the behavior of the plugin to trigger when a user hits `prefix + T`.
|
|
||||||
|
|
||||||
Key `T` is chosen because:
|
|
||||||
- it's "kind of" a mnemonic for `TPM`
|
|
||||||
- the key is not used by Tmux natively. Tmux man page, KEY BINDINGS section
|
|
||||||
contains a list of all the bindings Tmux uses. There's plenty of unused keys
|
|
||||||
and we don't want to override any of Tmux default key bindings.
|
|
||||||
|
|
||||||
Open the plugin run file in your favorite text editor:
|
|
||||||
|
|
||||||
$ vim my_plugin.tmux
|
|
||||||
# or
|
|
||||||
$ subl my_plugin.tmux
|
|
||||||
|
|
||||||
Put the following content in the file:
|
|
||||||
|
|
||||||
#!/usr/bin/env bash
|
|
||||||
|
|
||||||
CURRENT_DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
|
|
||||||
tmux bind-key T run-shell "$CURRENT_DIR/scripts/tmux_list_plugins.sh"
|
|
||||||
|
|
||||||
As you can see, plugin run file is a simple bash script that sets up the binding.
|
|
||||||
|
|
||||||
When pressed, `prefix + T` will execute another shell script:
|
|
||||||
`tmux_list_plugins.sh`. That script should be in `scripts/` directory -
|
|
||||||
relative to the plugin run file.
|
|
||||||
|
|
||||||
|
|
||||||
### 4. listing plugins
|
|
||||||
|
|
||||||
Now that we have the binding, let's create a script that's invoked with
|
|
||||||
`prefix + T`.
|
|
||||||
|
|
||||||
$ mkdir scripts
|
|
||||||
$ touch scripts/tmux_list_plugins.sh
|
|
||||||
$ chmod u+x scripts/tmux_list_plugins.sh
|
|
||||||
|
|
||||||
And here's the script content:
|
|
||||||
|
|
||||||
#!/usr/bin/env bash
|
|
||||||
|
|
||||||
# fetching the directory where plugins are installed
|
|
||||||
plugin_path="$(tmux show-env -g TMUX_PLUGIN_MANAGER_PATH | cut -f2 -d=)"
|
|
||||||
|
|
||||||
# listing installed plugins
|
|
||||||
ls -1 "$plugin_path"
|
|
||||||
|
|
||||||
### 5. try it out
|
|
||||||
|
|
||||||
To see if this works, execute the plugin run file:
|
|
||||||
|
|
||||||
$ ./my_plugin.tmux
|
|
||||||
|
|
||||||
That should set up the key binding. Now hit `prefix + T` and see if it works.
|
|
||||||
|
|
||||||
### 6. publish the plugin
|
|
||||||
|
|
||||||
When everything is ready, push the plugin to an online git repository,
|
|
||||||
preferably GitHub.
|
|
||||||
|
|
||||||
Other users can install your plugin by just adding plugin git URL to the
|
|
||||||
`@plugin` list in their `.tmux.conf`.
|
|
||||||
|
|
||||||
If the plugin is on GitHub, your users will be able to use the shorthand of
|
|
||||||
`github_username/repository`.
|
|
||||||
|
|
||||||
### Conclusion
|
|
||||||
|
|
||||||
Hopefully, that was easy. As you can see, it's mostly shell scripting.
|
|
||||||
|
|
||||||
You can use other scripting languages (ruby, python etc) but plain old shell
|
|
||||||
is preferred because of portability.
|
|
||||||
@ -1,36 +0,0 @@
|
|||||||
# Managing plugins via the command line
|
|
||||||
|
|
||||||
Aside from tmux key bindings, TPM provides shell interface for managing plugins
|
|
||||||
via scripts located in [bin/](../bin/) directory.
|
|
||||||
|
|
||||||
Tmux does not need to be started in order to run scripts (but it's okay if it
|
|
||||||
is). If you [changed tpm install dir](../docs/changing_plugins_install_dir.md)
|
|
||||||
in `.tmux.conf` that should work fine too.
|
|
||||||
|
|
||||||
Prerequisites:
|
|
||||||
|
|
||||||
- tmux installed on the system (doh)
|
|
||||||
- `.tmux.conf` set up for TPM
|
|
||||||
|
|
||||||
### Installing plugins
|
|
||||||
|
|
||||||
As usual, plugins need to be specified in `.tmux.conf`. Run the following
|
|
||||||
command to install plugins:
|
|
||||||
|
|
||||||
~/.tmux/plugins/tpm/bin/install_plugins
|
|
||||||
|
|
||||||
### Updating plugins
|
|
||||||
|
|
||||||
To update all installed plugins:
|
|
||||||
|
|
||||||
~/.tmux/plugins/tpm/bin/update_plugins all
|
|
||||||
|
|
||||||
or update a single plugin:
|
|
||||||
|
|
||||||
~/.tmux/plugins/tpm/bin/update_plugins tmux-sensible
|
|
||||||
|
|
||||||
### Removing plugins
|
|
||||||
|
|
||||||
To remove plugins not on the plugin list:
|
|
||||||
|
|
||||||
~/.tmux/plugins/tpm/bin/clean_plugins
|
|
||||||
@ -1,102 +0,0 @@
|
|||||||
# Help, tpm not working!
|
|
||||||
|
|
||||||
Here's the list of issues users had with `tpm`:
|
|
||||||
|
|
||||||
<hr />
|
|
||||||
|
|
||||||
> Nothing works. `tpm` key bindings `prefix + I`, `prefix + U` not even
|
|
||||||
defined.
|
|
||||||
|
|
||||||
Related [issue #22](https://github.com/tmux-plugins/tpm/issues/22)
|
|
||||||
|
|
||||||
- Do you have required `tmux` version to run `tpm`?<br/>
|
|
||||||
Check `tmux` version with `$ tmux -V` command and make sure it's higher or
|
|
||||||
equal to the required version for `tpm` as stated in the readme.
|
|
||||||
|
|
||||||
- ZSH tmux plugin might be causing issues.<br/>
|
|
||||||
If you have it installed, try disabling it and see if `tpm` works then.
|
|
||||||
|
|
||||||
<hr />
|
|
||||||
|
|
||||||
> Help, I'm using custom config file with `tmux -f /path/to/my_tmux.conf`
|
|
||||||
to start Tmux and for some reason plugins aren't loaded!?
|
|
||||||
|
|
||||||
Related [issue #57](https://github.com/tmux-plugins/tpm/issues/57)
|
|
||||||
|
|
||||||
`tpm` has a known issue when using custom config file with `-f` option.
|
|
||||||
The solution is to use alternative plugin definition syntax. Here are the steps
|
|
||||||
to make it work:
|
|
||||||
|
|
||||||
1. remove all `set -g @plugin` lines from tmux config file
|
|
||||||
2. in the config file define the plugins in the following way:
|
|
||||||
|
|
||||||
# List of plugins
|
|
||||||
set -g @tpm_plugins ' \
|
|
||||||
tmux-plugins/tpm \
|
|
||||||
tmux-plugins/tmux-sensible \
|
|
||||||
tmux-plugins/tmux-resurrect \
|
|
||||||
'
|
|
||||||
|
|
||||||
# Initialize TMUX plugin manager (keep this line at the very bottom of tmux.conf)
|
|
||||||
run '~/.tmux/plugins/tpm/tpm'
|
|
||||||
|
|
||||||
3. Reload TMUX environment so TPM is sourced: `$ tmux source /path/to/my_tmux.conf`
|
|
||||||
|
|
||||||
The plugins should now be working.
|
|
||||||
|
|
||||||
<hr />
|
|
||||||
|
|
||||||
> Weird sequence of characters show up when installing or updating plugins
|
|
||||||
|
|
||||||
Related: [issue #25](https://github.com/tmux-plugins/tpm/issues/25)
|
|
||||||
|
|
||||||
- This could be caused by [tmuxline.vim](https://github.com/edkolev/tmuxline.vim)
|
|
||||||
plugin. Uninstall it and see if things work.
|
|
||||||
|
|
||||||
<hr />
|
|
||||||
|
|
||||||
> "failed to connect to server" error when sourcing .tmux.conf
|
|
||||||
|
|
||||||
Related: [issue #48](https://github.com/tmux-plugins/tpm/issues/48)
|
|
||||||
|
|
||||||
- Make sure `tmux source ~/.tmux.conf` command is ran from inside `tmux`.
|
|
||||||
|
|
||||||
<hr />
|
|
||||||
|
|
||||||
> tpm not working: '~/.tmux/plugins/tpm/tpm' returned 2 (Windows / Cygwin)
|
|
||||||
|
|
||||||
Related: [issue #81](https://github.com/tmux-plugins/tpm/issues/81)
|
|
||||||
|
|
||||||
This issue is most likely caused by Windows line endings. For example, if you
|
|
||||||
have git's `core.autocrlf` option set to `true`, git will automatically convert
|
|
||||||
all the files to Windows line endings which might cause a problem.
|
|
||||||
|
|
||||||
The solution is to convert all line ending to Unix newline characters. This
|
|
||||||
command handles that for all files under `.tmux/` dir (skips `.git`
|
|
||||||
subdirectories):
|
|
||||||
|
|
||||||
```bash
|
|
||||||
find ~/.tmux -type d -name '.git*' -prune -o -type f -print0 | xargs -0 dos2unix
|
|
||||||
```
|
|
||||||
|
|
||||||
<hr />
|
|
||||||
|
|
||||||
> '~/.tmux/plugins/tpm/tpm' returned 127 (on macOS, w/ tmux installed using brew)
|
|
||||||
|
|
||||||
Related: [issue #67](https://github.com/tmux-plugins/tpm/issues/67)
|
|
||||||
|
|
||||||
This problem is because tmux's `run-shell` command runs a shell which doesn't read from user configs, thus tmux installed in a brew prefix (e.g. `/usr/local/bin`) will not be found.
|
|
||||||
|
|
||||||
The solution is to find your brew prefix
|
|
||||||
|
|
||||||
```sh
|
|
||||||
> echo "$(brew --prefix)/bin"
|
|
||||||
/opt/homebrew/bin
|
|
||||||
```
|
|
||||||
|
|
||||||
And prepend it to the `PATH` environment variable
|
|
||||||
```
|
|
||||||
set-environment -g PATH "/opt/homebrew/bin:/bin:/usr/bin"
|
|
||||||
```
|
|
||||||
|
|
||||||
before any `run-shell`/`run` commands in `~/.tmux.conf`.
|
|
||||||
@ -1 +0,0 @@
|
|||||||
Subproject commit 33fa65fbfb72ba6dd106c21bf5ee6cc353ecdbb6
|
|
||||||
37
run-tests
Executable file
37
run-tests
Executable file
@ -0,0 +1,37 @@
|
|||||||
|
#!/usr/bin/env bash
|
||||||
|
|
||||||
|
CURRENT_DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
|
||||||
|
|
||||||
|
run_vagrant() {
|
||||||
|
vagrant up
|
||||||
|
}
|
||||||
|
|
||||||
|
# Halt vagrant after tests are done running, unless KEEP_RUNNING environment
|
||||||
|
# variable is set to 'true'.
|
||||||
|
stop_vagrant() {
|
||||||
|
if [ -z "$KEEP_RUNNING" ]; then
|
||||||
|
vagrant halt
|
||||||
|
fi
|
||||||
|
}
|
||||||
|
|
||||||
|
test_files() {
|
||||||
|
ls -1 ./tests/ | # test files are in `./tests/` dir
|
||||||
|
grep -i '^test' | # test file names start with 'test'
|
||||||
|
xargs # file names in one line
|
||||||
|
}
|
||||||
|
|
||||||
|
run_tests() {
|
||||||
|
local test_file
|
||||||
|
local test_dir_path="~/tpm/tests/"
|
||||||
|
for test_file in $(test_files); do
|
||||||
|
echo "Running test: $test_file"
|
||||||
|
vagrant ssh -c "${test_dir_path}${test_file}"
|
||||||
|
done
|
||||||
|
}
|
||||||
|
|
||||||
|
main() {
|
||||||
|
run_vagrant
|
||||||
|
run_tests
|
||||||
|
stop_vagrant
|
||||||
|
}
|
||||||
|
main
|
||||||
@ -1,41 +0,0 @@
|
|||||||
#!/usr/bin/env bash
|
|
||||||
|
|
||||||
CURRENT_DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
|
|
||||||
HELPERS_DIR="$CURRENT_DIR/helpers"
|
|
||||||
|
|
||||||
source "$HELPERS_DIR/plugin_functions.sh"
|
|
||||||
source "$HELPERS_DIR/utility.sh"
|
|
||||||
|
|
||||||
if [ "$1" == "--tmux-echo" ]; then # tmux-specific echo functions
|
|
||||||
source "$HELPERS_DIR/tmux_echo_functions.sh"
|
|
||||||
else # shell output functions
|
|
||||||
source "$HELPERS_DIR/shell_echo_functions.sh"
|
|
||||||
fi
|
|
||||||
|
|
||||||
clean_plugins() {
|
|
||||||
local plugins plugin plugin_directory
|
|
||||||
plugins="$(tpm_plugins_list_helper)"
|
|
||||||
|
|
||||||
for plugin_directory in "$(tpm_path)"/*; do
|
|
||||||
[ -d "${plugin_directory}" ] || continue
|
|
||||||
plugin="$(plugin_name_helper "${plugin_directory}")"
|
|
||||||
case "${plugins}" in
|
|
||||||
*"${plugin}"*) : ;;
|
|
||||||
*)
|
|
||||||
[ "${plugin}" = "tpm" ] && continue
|
|
||||||
echo_ok "Removing \"$plugin\""
|
|
||||||
rm -rf "${plugin_directory}" >/dev/null 2>&1
|
|
||||||
[ -d "${plugin_directory}" ] &&
|
|
||||||
echo_err " \"$plugin\" clean fail" ||
|
|
||||||
echo_ok " \"$plugin\" clean success"
|
|
||||||
;;
|
|
||||||
esac
|
|
||||||
done
|
|
||||||
}
|
|
||||||
|
|
||||||
main() {
|
|
||||||
ensure_tpm_path_exists
|
|
||||||
clean_plugins
|
|
||||||
exit_value_helper
|
|
||||||
}
|
|
||||||
main
|
|
||||||
@ -1,104 +0,0 @@
|
|||||||
# using @tpm_plugins is now deprecated in favor of using @plugin syntax
|
|
||||||
tpm_plugins_variable_name="@tpm_plugins"
|
|
||||||
|
|
||||||
# manually expanding tilde char or `$HOME` variable.
|
|
||||||
_manual_expansion() {
|
|
||||||
local path="$1"
|
|
||||||
local expanded_tilde="${path/#\~/$HOME}"
|
|
||||||
echo "${expanded_tilde/#\$HOME/$HOME}"
|
|
||||||
}
|
|
||||||
|
|
||||||
_tpm_path() {
|
|
||||||
local string_path="$(tmux start-server\; show-environment -g TMUX_PLUGIN_MANAGER_PATH | cut -f2 -d=)/"
|
|
||||||
_manual_expansion "$string_path"
|
|
||||||
}
|
|
||||||
|
|
||||||
_CACHED_TPM_PATH="$(_tpm_path)"
|
|
||||||
|
|
||||||
# Get the absolute path to the users configuration file of TMux.
|
|
||||||
# This includes a prioritized search on different locations.
|
|
||||||
#
|
|
||||||
_get_user_tmux_conf() {
|
|
||||||
# Define the different possible locations.
|
|
||||||
xdg_location="${XDG_CONFIG_HOME:-$HOME/.config}/tmux/tmux.conf"
|
|
||||||
default_location="$HOME/.tmux.conf"
|
|
||||||
|
|
||||||
# Search for the correct configuration file by priority.
|
|
||||||
if [ -f "$xdg_location" ]; then
|
|
||||||
echo "$xdg_location"
|
|
||||||
|
|
||||||
else
|
|
||||||
echo "$default_location"
|
|
||||||
fi
|
|
||||||
}
|
|
||||||
|
|
||||||
_tmux_conf_contents() {
|
|
||||||
user_config=$(_get_user_tmux_conf)
|
|
||||||
cat /etc/tmux.conf "$user_config" 2>/dev/null
|
|
||||||
if [ "$1" == "full" ]; then # also output content from sourced files
|
|
||||||
local file
|
|
||||||
for file in $(_sourced_files); do
|
|
||||||
cat $(_manual_expansion "$file") 2>/dev/null
|
|
||||||
done
|
|
||||||
fi
|
|
||||||
}
|
|
||||||
|
|
||||||
# return files sourced from tmux config files
|
|
||||||
_sourced_files() {
|
|
||||||
_tmux_conf_contents |
|
|
||||||
sed -E -n -e "s/^[[:space:]]*source(-file)?[[:space:]]+(-q+[[:space:]]+)?['\"]?([^'\"]+)['\"]?/\3/p"
|
|
||||||
}
|
|
||||||
|
|
||||||
# Want to be able to abort in certain cases
|
|
||||||
trap "exit 1" TERM
|
|
||||||
export TOP_PID=$$
|
|
||||||
|
|
||||||
_fatal_error_abort() {
|
|
||||||
echo >&2 "Aborting."
|
|
||||||
kill -s TERM $TOP_PID
|
|
||||||
}
|
|
||||||
|
|
||||||
# PUBLIC FUNCTIONS BELOW
|
|
||||||
|
|
||||||
tpm_path() {
|
|
||||||
if [ "$_CACHED_TPM_PATH" == "/" ]; then
|
|
||||||
echo >&2 "FATAL: Tmux Plugin Manager not configured in tmux.conf"
|
|
||||||
_fatal_error_abort
|
|
||||||
fi
|
|
||||||
echo "$_CACHED_TPM_PATH"
|
|
||||||
}
|
|
||||||
|
|
||||||
tpm_plugins_list_helper() {
|
|
||||||
# lists plugins from @tpm_plugins option
|
|
||||||
echo "$(tmux start-server\; show-option -gqv "$tpm_plugins_variable_name")"
|
|
||||||
|
|
||||||
# read set -g @plugin "tmux-plugins/tmux-example-plugin" entries
|
|
||||||
_tmux_conf_contents "full" |
|
|
||||||
awk '/^[ \t]*set(-option)? +-g +@plugin/ { gsub(/'\''/,""); gsub(/'\"'/,""); print $4 }'
|
|
||||||
}
|
|
||||||
|
|
||||||
# Allowed plugin name formats:
|
|
||||||
# 1. "git://github.com/user/plugin_name.git"
|
|
||||||
# 2. "user/plugin_name"
|
|
||||||
plugin_name_helper() {
|
|
||||||
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"
|
|
||||||
}
|
|
||||||
|
|
||||||
plugin_path_helper() {
|
|
||||||
local plugin="$1"
|
|
||||||
local plugin_name="$(plugin_name_helper "$plugin")"
|
|
||||||
echo "$(tpm_path)${plugin_name}/"
|
|
||||||
}
|
|
||||||
|
|
||||||
plugin_already_installed() {
|
|
||||||
local plugin="$1"
|
|
||||||
local plugin_path="$(plugin_path_helper "$plugin")"
|
|
||||||
[ -d "$plugin_path" ] &&
|
|
||||||
cd "$plugin_path" &&
|
|
||||||
git remote >/dev/null 2>&1
|
|
||||||
}
|
|
||||||
@ -1,7 +0,0 @@
|
|||||||
echo_ok() {
|
|
||||||
echo "$*"
|
|
||||||
}
|
|
||||||
|
|
||||||
echo_err() {
|
|
||||||
fail_helper "$*"
|
|
||||||
}
|
|
||||||
@ -1,28 +0,0 @@
|
|||||||
_has_emacs_mode_keys() {
|
|
||||||
$(tmux show -gw mode-keys | grep -q emacs)
|
|
||||||
}
|
|
||||||
|
|
||||||
tmux_echo() {
|
|
||||||
local message="$1"
|
|
||||||
tmux run-shell "echo '$message'"
|
|
||||||
}
|
|
||||||
|
|
||||||
echo_ok() {
|
|
||||||
tmux_echo "$*"
|
|
||||||
}
|
|
||||||
|
|
||||||
echo_err() {
|
|
||||||
tmux_echo "$*"
|
|
||||||
}
|
|
||||||
|
|
||||||
end_message() {
|
|
||||||
if _has_emacs_mode_keys; then
|
|
||||||
local continue_key="ESCAPE"
|
|
||||||
else
|
|
||||||
local continue_key="ENTER"
|
|
||||||
fi
|
|
||||||
tmux_echo ""
|
|
||||||
tmux_echo "TMUX environment reloaded."
|
|
||||||
tmux_echo ""
|
|
||||||
tmux_echo "Done, press $continue_key to continue."
|
|
||||||
}
|
|
||||||
@ -1,6 +0,0 @@
|
|||||||
HELPERS_DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
|
|
||||||
source "$HELPERS_DIR/plugin_functions.sh"
|
|
||||||
|
|
||||||
reload_tmux_environment() {
|
|
||||||
tmux source-file $(_get_user_tmux_conf) >/dev/null 2>&1
|
|
||||||
}
|
|
||||||
@ -1,17 +0,0 @@
|
|||||||
ensure_tpm_path_exists() {
|
|
||||||
mkdir -p "$(tpm_path)"
|
|
||||||
}
|
|
||||||
|
|
||||||
fail_helper() {
|
|
||||||
local message="$1"
|
|
||||||
echo "$message" >&2
|
|
||||||
FAIL="true"
|
|
||||||
}
|
|
||||||
|
|
||||||
exit_value_helper() {
|
|
||||||
if [ "$FAIL" == "true" ]; then
|
|
||||||
exit 1
|
|
||||||
else
|
|
||||||
exit 0
|
|
||||||
fi
|
|
||||||
}
|
|
||||||
@ -1,75 +0,0 @@
|
|||||||
#!/usr/bin/env bash
|
|
||||||
|
|
||||||
CURRENT_DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
|
|
||||||
HELPERS_DIR="$CURRENT_DIR/helpers"
|
|
||||||
|
|
||||||
source "$HELPERS_DIR/plugin_functions.sh"
|
|
||||||
source "$HELPERS_DIR/utility.sh"
|
|
||||||
|
|
||||||
if [ "$1" == "--tmux-echo" ]; then # tmux-specific echo functions
|
|
||||||
source "$HELPERS_DIR/tmux_echo_functions.sh"
|
|
||||||
else # shell output functions
|
|
||||||
source "$HELPERS_DIR/shell_echo_functions.sh"
|
|
||||||
fi
|
|
||||||
|
|
||||||
clone() {
|
|
||||||
local plugin="$1"
|
|
||||||
local branch="$2"
|
|
||||||
if [ -n "$branch" ]; then
|
|
||||||
cd "$(tpm_path)" &&
|
|
||||||
GIT_TERMINAL_PROMPT=0 git clone -b "$branch" --single-branch --recursive "$plugin" >/dev/null 2>&1
|
|
||||||
else
|
|
||||||
cd "$(tpm_path)" &&
|
|
||||||
GIT_TERMINAL_PROMPT=0 git clone --single-branch --recursive "$plugin" >/dev/null 2>&1
|
|
||||||
fi
|
|
||||||
}
|
|
||||||
|
|
||||||
# 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"
|
|
||||||
local branch="$2"
|
|
||||||
clone "$plugin" "$branch" ||
|
|
||||||
clone "https://git::@github.com/$plugin" "$branch"
|
|
||||||
}
|
|
||||||
|
|
||||||
# clone plugin and produce output
|
|
||||||
install_plugin() {
|
|
||||||
local plugin="$1"
|
|
||||||
local branch="$2"
|
|
||||||
local plugin_name="$(plugin_name_helper "$plugin")"
|
|
||||||
|
|
||||||
if plugin_already_installed "$plugin"; then
|
|
||||||
echo_ok "Already installed \"$plugin_name\""
|
|
||||||
else
|
|
||||||
echo_ok "Installing \"$plugin_name\""
|
|
||||||
clone_plugin "$plugin" "$branch" &&
|
|
||||||
echo_ok " \"$plugin_name\" download success" ||
|
|
||||||
echo_err " \"$plugin_name\" download fail"
|
|
||||||
fi
|
|
||||||
}
|
|
||||||
|
|
||||||
install_plugins() {
|
|
||||||
local plugins="$(tpm_plugins_list_helper)"
|
|
||||||
for plugin in $plugins; do
|
|
||||||
IFS='#' read -ra plugin <<< "$plugin"
|
|
||||||
install_plugin "${plugin[0]}" "${plugin[1]}"
|
|
||||||
done
|
|
||||||
}
|
|
||||||
|
|
||||||
verify_tpm_path_permissions() {
|
|
||||||
local path="$(tpm_path)"
|
|
||||||
# check the write permission flag for all users to ensure
|
|
||||||
# that we have proper access
|
|
||||||
[ -w "$path" ] ||
|
|
||||||
echo_err "$path is not writable!"
|
|
||||||
}
|
|
||||||
|
|
||||||
main() {
|
|
||||||
ensure_tpm_path_exists
|
|
||||||
verify_tpm_path_permissions
|
|
||||||
install_plugins
|
|
||||||
exit_value_helper
|
|
||||||
}
|
|
||||||
main
|
|
||||||
6
scripts/key_binding.sh
Executable file
6
scripts/key_binding.sh
Executable file
@ -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 >/dev/null 2>&1"
|
||||||
22
scripts/set_tpm_path.sh
Executable file
22
scripts/set_tpm_path.sh
Executable file
@ -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
|
||||||
31
scripts/shared_functions.sh
Normal file
31
scripts/shared_functions.sh
Normal file
@ -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/"
|
||||||
|
}
|
||||||
@ -1,42 +1,36 @@
|
|||||||
#!/usr/bin/env bash
|
#!/usr/bin/env bash
|
||||||
|
|
||||||
CURRENT_DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
|
CURRENT_DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
|
||||||
HELPERS_DIR="$CURRENT_DIR/helpers"
|
|
||||||
|
|
||||||
source "$HELPERS_DIR/plugin_functions.sh"
|
source "$CURRENT_DIR/shared_functions.sh"
|
||||||
|
|
||||||
plugin_dir_exists() {
|
|
||||||
[ -d "$1" ]
|
|
||||||
}
|
|
||||||
|
|
||||||
# Runs all *.tmux files from the plugin directory.
|
# Runs all *.tmux files from the plugin directory.
|
||||||
# Files are ran as executables.
|
# Files are ran as executables.
|
||||||
# No errors if the plugin dir does not exist.
|
# No errors if the plugin dir does not exist.
|
||||||
silently_source_all_tmux_files() {
|
silently_source_all_tmux_files() {
|
||||||
local plugin_path="$1"
|
local plugin_path=$1
|
||||||
local plugin_tmux_files="$plugin_path*.tmux"
|
local plugin_tmux_files="$plugin_path*.tmux"
|
||||||
if plugin_dir_exists "$plugin_path"; then
|
|
||||||
for tmux_file in $plugin_tmux_files; do
|
for tmux_file in $plugin_tmux_files; do
|
||||||
# if the glob didn't find any files this will be the
|
|
||||||
# unexpanded glob which obviously doesn't exist
|
|
||||||
[ -f "$tmux_file" ] || continue
|
|
||||||
# runs *.tmux file as an executable
|
# runs *.tmux file as an executable
|
||||||
$tmux_file >/dev/null 2>&1
|
$tmux_file >/dev/null 2>&1
|
||||||
done
|
done
|
||||||
fi
|
}
|
||||||
|
|
||||||
|
source_plugin() {
|
||||||
|
local plugin=$1
|
||||||
|
local plugin_path=$(shared_plugin_path "$plugin")
|
||||||
|
silently_source_all_tmux_files "$plugin_path"
|
||||||
}
|
}
|
||||||
|
|
||||||
source_plugins() {
|
source_plugins() {
|
||||||
local plugin plugin_path
|
local plugins=$(shared_get_tpm_plugins_list)
|
||||||
local plugins="$(tpm_plugins_list_helper)"
|
|
||||||
for plugin in $plugins; do
|
for plugin in $plugins; do
|
||||||
IFS='#' read -ra plugin <<< "$plugin"
|
source_plugin "$plugin"
|
||||||
plugin_path="$(plugin_path_helper "${plugin[0]}")"
|
|
||||||
silently_source_all_tmux_files "$plugin_path"
|
|
||||||
done
|
done
|
||||||
}
|
}
|
||||||
|
|
||||||
main() {
|
main() {
|
||||||
|
shared_set_tpm_path_constant
|
||||||
source_plugins
|
source_plugins
|
||||||
}
|
}
|
||||||
main
|
main
|
||||||
|
|||||||
92
scripts/sync_plugins.sh
Executable file
92
scripts/sync_plugins.sh
Executable file
@ -0,0 +1,92 @@
|
|||||||
|
#!/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
|
||||||
|
}
|
||||||
|
|
||||||
|
ensure_tpm_path_exists() {
|
||||||
|
mkdir -p $SHARED_TPM_PATH
|
||||||
|
}
|
||||||
|
|
||||||
|
reload_tmux_environment() {
|
||||||
|
tmux source-file ~/.tmux.conf >/dev/null 2>&1
|
||||||
|
}
|
||||||
|
|
||||||
|
main() {
|
||||||
|
reload_tmux_environment
|
||||||
|
shared_set_tpm_path_constant
|
||||||
|
ensure_tpm_path_exists
|
||||||
|
sync_plugins
|
||||||
|
reload_tmux_environment
|
||||||
|
end_message
|
||||||
|
}
|
||||||
|
main
|
||||||
@ -1,78 +0,0 @@
|
|||||||
#!/usr/bin/env bash
|
|
||||||
|
|
||||||
# this script handles core logic of updating plugins
|
|
||||||
|
|
||||||
CURRENT_DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
|
|
||||||
HELPERS_DIR="$CURRENT_DIR/helpers"
|
|
||||||
|
|
||||||
source "$HELPERS_DIR/plugin_functions.sh"
|
|
||||||
source "$HELPERS_DIR/utility.sh"
|
|
||||||
|
|
||||||
if [ "$1" == "--tmux-echo" ]; then # tmux-specific echo functions
|
|
||||||
source "$HELPERS_DIR/tmux_echo_functions.sh"
|
|
||||||
else # shell output functions
|
|
||||||
source "$HELPERS_DIR/shell_echo_functions.sh"
|
|
||||||
fi
|
|
||||||
|
|
||||||
# from now on ignore first script argument
|
|
||||||
shift
|
|
||||||
|
|
||||||
pull_changes() {
|
|
||||||
local plugin="$1"
|
|
||||||
local plugin_path="$(plugin_path_helper "$plugin")"
|
|
||||||
cd "$plugin_path" &&
|
|
||||||
GIT_TERMINAL_PROMPT=0 git pull &&
|
|
||||||
GIT_TERMINAL_PROMPT=0 git submodule update --init --recursive
|
|
||||||
}
|
|
||||||
|
|
||||||
update() {
|
|
||||||
local plugin="$1" output
|
|
||||||
output=$(pull_changes "$plugin" 2>&1)
|
|
||||||
if (( $? == 0 )); then
|
|
||||||
echo_ok " \"$plugin\" update success"
|
|
||||||
echo_ok "$(echo "$output" | sed -e 's/^/ | /')"
|
|
||||||
else
|
|
||||||
echo_err " \"$plugin\" update fail"
|
|
||||||
echo_err "$(echo "$output" | sed -e 's/^/ | /')"
|
|
||||||
fi
|
|
||||||
}
|
|
||||||
|
|
||||||
update_all() {
|
|
||||||
echo_ok "Updating all plugins!"
|
|
||||||
echo_ok ""
|
|
||||||
local plugins="$(tpm_plugins_list_helper)"
|
|
||||||
for plugin in $plugins; do
|
|
||||||
IFS='#' read -ra plugin <<< "$plugin"
|
|
||||||
local plugin_name="$(plugin_name_helper "${plugin[0]}")"
|
|
||||||
# updating only installed plugins
|
|
||||||
if plugin_already_installed "$plugin_name"; then
|
|
||||||
update "$plugin_name" &
|
|
||||||
fi
|
|
||||||
done
|
|
||||||
wait
|
|
||||||
}
|
|
||||||
|
|
||||||
update_plugins() {
|
|
||||||
local plugins="$*"
|
|
||||||
for plugin in $plugins; do
|
|
||||||
IFS='#' read -ra plugin <<< "$plugin"
|
|
||||||
local plugin_name="$(plugin_name_helper "${plugin[0]}")"
|
|
||||||
if plugin_already_installed "$plugin_name"; then
|
|
||||||
update "$plugin_name" &
|
|
||||||
else
|
|
||||||
echo_err "$plugin_name not installed!" &
|
|
||||||
fi
|
|
||||||
done
|
|
||||||
wait
|
|
||||||
}
|
|
||||||
|
|
||||||
main() {
|
|
||||||
ensure_tpm_path_exists
|
|
||||||
if [ "$1" == "all" ]; then
|
|
||||||
update_all
|
|
||||||
else
|
|
||||||
update_plugins "$*"
|
|
||||||
fi
|
|
||||||
exit_value_helper
|
|
||||||
}
|
|
||||||
main "$*"
|
|
||||||
@ -1,18 +0,0 @@
|
|||||||
#!/usr/bin/env bash
|
|
||||||
|
|
||||||
CURRENT_DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
|
|
||||||
HELPERS_DIR="$CURRENT_DIR/helpers"
|
|
||||||
|
|
||||||
if [ $# -eq 0 ]; then
|
|
||||||
exit 0
|
|
||||||
fi
|
|
||||||
|
|
||||||
source "$HELPERS_DIR/tmux_echo_functions.sh"
|
|
||||||
source "$HELPERS_DIR/tmux_utils.sh"
|
|
||||||
|
|
||||||
main() {
|
|
||||||
"$CURRENT_DIR/update_plugin.sh" --tmux-echo "$*"
|
|
||||||
reload_tmux_environment
|
|
||||||
end_message
|
|
||||||
}
|
|
||||||
main "$*"
|
|
||||||
@ -1,13 +0,0 @@
|
|||||||
install_key_option="@tpm-install"
|
|
||||||
default_install_key="I"
|
|
||||||
|
|
||||||
update_key_option="@tpm-update"
|
|
||||||
default_update_key="U"
|
|
||||||
|
|
||||||
clean_key_option="@tpm-clean"
|
|
||||||
default_clean_key="M-u"
|
|
||||||
|
|
||||||
SUPPORTED_TMUX_VERSION="1.9"
|
|
||||||
|
|
||||||
DEFAULT_TPM_ENV_VAR_NAME="TMUX_PLUGIN_MANAGER_PATH"
|
|
||||||
DEFAULT_TPM_PATH="$HOME/.tmux/plugins/"
|
|
||||||
@ -1,36 +0,0 @@
|
|||||||
#!/usr/bin/env expect
|
|
||||||
|
|
||||||
# disables script output
|
|
||||||
log_user 0
|
|
||||||
|
|
||||||
spawn tmux
|
|
||||||
|
|
||||||
# Waiting for tmux to attach. If this is not done, next command, `send` will
|
|
||||||
# not work properly.
|
|
||||||
sleep 1
|
|
||||||
|
|
||||||
# this is tmux prefix + I
|
|
||||||
send "I"
|
|
||||||
|
|
||||||
# cloning might take a while
|
|
||||||
set timeout 20
|
|
||||||
|
|
||||||
expect_after {
|
|
||||||
timeout { exit 1 }
|
|
||||||
}
|
|
||||||
|
|
||||||
expect {
|
|
||||||
"Installing \"non-existing-plugin\""
|
|
||||||
}
|
|
||||||
|
|
||||||
expect {
|
|
||||||
"\"non-existing-plugin\" download fail"
|
|
||||||
}
|
|
||||||
|
|
||||||
expect {
|
|
||||||
"Done, press ENTER to continue" {
|
|
||||||
exit 0
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
exit 1
|
|
||||||
@ -1,35 +0,0 @@
|
|||||||
#!/usr/bin/env expect
|
|
||||||
|
|
||||||
# disables script output
|
|
||||||
log_user 0
|
|
||||||
|
|
||||||
spawn tmux
|
|
||||||
|
|
||||||
# Waiting for tmux to attach. If this is not done, next command, `send` will
|
|
||||||
# not work properly.
|
|
||||||
sleep 1
|
|
||||||
|
|
||||||
# this is tmux prefix + alt + u
|
|
||||||
send "u"
|
|
||||||
|
|
||||||
set timeout 5
|
|
||||||
|
|
||||||
expect_after {
|
|
||||||
timeout { exit 1 }
|
|
||||||
}
|
|
||||||
|
|
||||||
expect {
|
|
||||||
"Removing \"tmux-example-plugin\""
|
|
||||||
}
|
|
||||||
|
|
||||||
expect {
|
|
||||||
"\"tmux-example-plugin\" clean success"
|
|
||||||
}
|
|
||||||
|
|
||||||
expect {
|
|
||||||
"Done, press ENTER to continue." {
|
|
||||||
exit 0
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
exit 1
|
|
||||||
@ -1,44 +0,0 @@
|
|||||||
#!/usr/bin/env expect
|
|
||||||
|
|
||||||
# disables script output
|
|
||||||
log_user 0
|
|
||||||
|
|
||||||
spawn tmux
|
|
||||||
|
|
||||||
# Waiting for tmux to attach. If this is not done, next command, `send` will
|
|
||||||
# not work properly.
|
|
||||||
sleep 1
|
|
||||||
|
|
||||||
# this is tmux prefix + I
|
|
||||||
send "I"
|
|
||||||
|
|
||||||
# cloning might take a while
|
|
||||||
set timeout 15
|
|
||||||
|
|
||||||
expect_after {
|
|
||||||
timeout { exit 1 }
|
|
||||||
}
|
|
||||||
|
|
||||||
expect {
|
|
||||||
"Installing \"tmux-example-plugin\""
|
|
||||||
}
|
|
||||||
|
|
||||||
expect {
|
|
||||||
"\"tmux-example-plugin\" download success"
|
|
||||||
}
|
|
||||||
|
|
||||||
expect {
|
|
||||||
"Installing \"tmux-copycat\""
|
|
||||||
}
|
|
||||||
|
|
||||||
expect {
|
|
||||||
"\"tmux-copycat\" download success"
|
|
||||||
}
|
|
||||||
|
|
||||||
expect {
|
|
||||||
"Done, press ENTER to continue." {
|
|
||||||
exit 0
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
exit 1
|
|
||||||
@ -15,36 +15,21 @@ send "I"
|
|||||||
# cloning might take a while
|
# cloning might take a while
|
||||||
set timeout 15
|
set timeout 15
|
||||||
|
|
||||||
expect_after {
|
|
||||||
timeout { exit 1 }
|
|
||||||
}
|
|
||||||
|
|
||||||
expect {
|
expect {
|
||||||
"Installing \"tmux-example-plugin\""
|
"Downloading bruno-/tmux_example_plugin" {
|
||||||
}
|
|
||||||
|
|
||||||
expect {
|
expect {
|
||||||
"\"tmux-example-plugin\" download success"
|
"bruno-/tmux_example_plugin download success" {
|
||||||
}
|
|
||||||
|
|
||||||
expect {
|
expect { "Done, press ENTER to continue" { exit } }
|
||||||
"Done, press ENTER to continue" {
|
|
||||||
send "
"
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
}
|
||||||
|
|
||||||
|
timeout {
|
||||||
|
puts "Plugin update timeout";
|
||||||
|
exit 1
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
sleep 1
|
|
||||||
# this is tmux prefix + I
|
|
||||||
send "I"
|
|
||||||
|
|
||||||
expect {
|
|
||||||
"Already installed \"tmux-example-plugin\""
|
|
||||||
}
|
|
||||||
|
|
||||||
expect {
|
|
||||||
"Done, press ENTER to continue" {
|
|
||||||
exit 0
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
exit 1
|
|
||||||
|
|||||||
@ -1,55 +0,0 @@
|
|||||||
#!/usr/bin/env expect
|
|
||||||
|
|
||||||
# disables script output
|
|
||||||
log_user 0
|
|
||||||
|
|
||||||
spawn tmux
|
|
||||||
|
|
||||||
# Waiting for tmux to attach. If this is not done, next command, `send` will
|
|
||||||
# not work properly.
|
|
||||||
sleep 1
|
|
||||||
|
|
||||||
# this is tmux prefix + U
|
|
||||||
send "U"
|
|
||||||
|
|
||||||
set timeout 15
|
|
||||||
|
|
||||||
expect_after {
|
|
||||||
timeout { exit 1 }
|
|
||||||
}
|
|
||||||
|
|
||||||
expect {
|
|
||||||
"Installed plugins"
|
|
||||||
}
|
|
||||||
|
|
||||||
expect {
|
|
||||||
"tmux-example-plugin"
|
|
||||||
}
|
|
||||||
|
|
||||||
expect {
|
|
||||||
"\"all\" - updates all plugins"
|
|
||||||
}
|
|
||||||
|
|
||||||
expect {
|
|
||||||
"ENTER - cancels"
|
|
||||||
}
|
|
||||||
|
|
||||||
# wait for tmux to display prompt before sending characters
|
|
||||||
sleep 1
|
|
||||||
send "tmux-example-plugin\r"
|
|
||||||
|
|
||||||
expect {
|
|
||||||
"Updating \"tmux-example-plugin\""
|
|
||||||
}
|
|
||||||
|
|
||||||
expect {
|
|
||||||
"\"tmux-example-plugin\" update success"
|
|
||||||
}
|
|
||||||
|
|
||||||
expect {
|
|
||||||
"Done, press ENTER to continue." {
|
|
||||||
exit 0
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
exit 1
|
|
||||||
@ -1,59 +0,0 @@
|
|||||||
#!/usr/bin/env expect
|
|
||||||
|
|
||||||
# disables script output
|
|
||||||
log_user 0
|
|
||||||
|
|
||||||
spawn tmux
|
|
||||||
|
|
||||||
# Waiting for tmux to attach. If this is not done, next command, `send` will
|
|
||||||
# not work properly.
|
|
||||||
sleep 1
|
|
||||||
|
|
||||||
# this is tmux prefix + U
|
|
||||||
send "U"
|
|
||||||
|
|
||||||
set timeout 5
|
|
||||||
|
|
||||||
expect_after {
|
|
||||||
timeout { exit 1 }
|
|
||||||
}
|
|
||||||
|
|
||||||
expect {
|
|
||||||
"Installed plugins"
|
|
||||||
}
|
|
||||||
|
|
||||||
expect {
|
|
||||||
"tmux-example-plugin"
|
|
||||||
}
|
|
||||||
|
|
||||||
expect {
|
|
||||||
"\"all\" - updates all plugins"
|
|
||||||
}
|
|
||||||
|
|
||||||
expect {
|
|
||||||
"ENTER - cancels"
|
|
||||||
}
|
|
||||||
|
|
||||||
# wait for tmux to display prompt before sending characters
|
|
||||||
sleep 1
|
|
||||||
send "all\r"
|
|
||||||
|
|
||||||
expect {
|
|
||||||
"Updating all plugins!"
|
|
||||||
}
|
|
||||||
|
|
||||||
expect {
|
|
||||||
"Updating \"tmux-example-plugin\""
|
|
||||||
}
|
|
||||||
|
|
||||||
expect {
|
|
||||||
"\"tmux-example-plugin\" update success"
|
|
||||||
}
|
|
||||||
|
|
||||||
expect {
|
|
||||||
"Done, press ENTER to continue." {
|
|
||||||
exit 0
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
exit 1
|
|
||||||
55
tests/helpers.sh
Normal file
55
tests/helpers.sh
Normal file
@ -0,0 +1,55 @@
|
|||||||
|
#!/usr/bin/env bash
|
||||||
|
|
||||||
|
FAIL="false"
|
||||||
|
|
||||||
|
set_tmux_conf_helper() {
|
||||||
|
> ~/.tmux.conf # empty filename
|
||||||
|
while read -r line; do
|
||||||
|
echo $line >> ~/.tmux.conf
|
||||||
|
done
|
||||||
|
}
|
||||||
|
|
||||||
|
create_test_plugin_helper() {
|
||||||
|
local plugin_path="$HOME/.tmux/plugins/tmux_test_plugin/"
|
||||||
|
rm -rf $plugin_path
|
||||||
|
mkdir -p $plugin_path
|
||||||
|
|
||||||
|
while read -r line; do
|
||||||
|
echo $line >> "$plugin_path/test_plugin.tmux"
|
||||||
|
done
|
||||||
|
chmod +x "$plugin_path/test_plugin.tmux"
|
||||||
|
}
|
||||||
|
|
||||||
|
teardown_helper() {
|
||||||
|
rm ~/.tmux.conf
|
||||||
|
rm -rf ~/.tmux/
|
||||||
|
tmux kill-server >/dev/null 2>&1
|
||||||
|
}
|
||||||
|
|
||||||
|
check_dir_exists_helper() {
|
||||||
|
local dir_path=$1
|
||||||
|
if [ -d "$dir_path" ]; then
|
||||||
|
return 0
|
||||||
|
else
|
||||||
|
return 1
|
||||||
|
fi
|
||||||
|
}
|
||||||
|
|
||||||
|
fail_helper() {
|
||||||
|
local message="$1"
|
||||||
|
echo "$message" >&2
|
||||||
|
FAIL="true"
|
||||||
|
}
|
||||||
|
|
||||||
|
exit_value_helper() {
|
||||||
|
local fail="$1"
|
||||||
|
if [ "$FAIL" == "true" ]; then
|
||||||
|
echo "FAIL!"
|
||||||
|
echo
|
||||||
|
exit 1
|
||||||
|
else
|
||||||
|
echo "SUCCESS"
|
||||||
|
echo
|
||||||
|
exit 0
|
||||||
|
fi
|
||||||
|
}
|
||||||
@ -1,13 +0,0 @@
|
|||||||
check_dir_exists_helper() {
|
|
||||||
[ -d "$1" ]
|
|
||||||
}
|
|
||||||
|
|
||||||
# runs the scripts and asserts it has the correct output and exit code
|
|
||||||
script_run_helper() {
|
|
||||||
local script="$1"
|
|
||||||
local expected_output="$2"
|
|
||||||
local expected_exit_code="${3:-0}"
|
|
||||||
$script 2>&1 |
|
|
||||||
grep "$expected_output" >/dev/null 2>&1 && # grep -q flag quits the script early
|
|
||||||
[ "${PIPESTATUS[0]}" -eq "$expected_exit_code" ]
|
|
||||||
}
|
|
||||||
@ -1,67 +0,0 @@
|
|||||||
#!/usr/bin/env bash
|
|
||||||
|
|
||||||
CURRENT_DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
|
|
||||||
TPM_DIR="$PWD"
|
|
||||||
PLUGINS_DIR="$HOME/.tmux/plugins"
|
|
||||||
|
|
||||||
source "$CURRENT_DIR/helpers/helpers.sh"
|
|
||||||
source "$CURRENT_DIR/helpers/tpm.sh"
|
|
||||||
|
|
||||||
manually_install_the_plugin() {
|
|
||||||
rm -rf "$PLUGINS_DIR"
|
|
||||||
mkdir -p "$PLUGINS_DIR"
|
|
||||||
cd "$PLUGINS_DIR"
|
|
||||||
git clone --quiet https://github.com/tmux-plugins/tmux-example-plugin
|
|
||||||
}
|
|
||||||
|
|
||||||
# TMUX KEY-BINDING TESTS
|
|
||||||
|
|
||||||
test_plugin_uninstallation_via_tmux_key_binding() {
|
|
||||||
set_tmux_conf_helper <<- HERE
|
|
||||||
set -g mode-keys vi
|
|
||||||
run-shell "$TPM_DIR/tpm"
|
|
||||||
HERE
|
|
||||||
|
|
||||||
manually_install_the_plugin
|
|
||||||
|
|
||||||
"$CURRENT_DIR/expect_successful_clean_plugins" ||
|
|
||||||
fail_helper "[key-binding] clean fails"
|
|
||||||
|
|
||||||
teardown_helper
|
|
||||||
}
|
|
||||||
|
|
||||||
# SCRIPT TESTS
|
|
||||||
|
|
||||||
test_plugin_uninstallation_via_script() {
|
|
||||||
set_tmux_conf_helper <<- HERE
|
|
||||||
set -g mode-keys vi
|
|
||||||
run-shell "$TPM_DIR/tpm"
|
|
||||||
HERE
|
|
||||||
|
|
||||||
manually_install_the_plugin
|
|
||||||
|
|
||||||
script_run_helper "$TPM_DIR/bin/clean_plugins" '"tmux-example-plugin" clean success' ||
|
|
||||||
fail_helper "[script] plugin cleaning fails"
|
|
||||||
|
|
||||||
teardown_helper
|
|
||||||
}
|
|
||||||
|
|
||||||
test_unsuccessful_plugin_uninstallation_via_script() {
|
|
||||||
set_tmux_conf_helper <<- HERE
|
|
||||||
set -g mode-keys vi
|
|
||||||
run-shell "$TPM_DIR/tpm"
|
|
||||||
HERE
|
|
||||||
|
|
||||||
manually_install_the_plugin
|
|
||||||
chmod 000 "$PLUGINS_DIR/tmux-example-plugin" # disable directory deletion
|
|
||||||
|
|
||||||
local expected_exit_code=1
|
|
||||||
script_run_helper "$TPM_DIR/bin/clean_plugins" '"tmux-example-plugin" clean fail' "$expected_exit_code" ||
|
|
||||||
fail_helper "[script] unsuccessful plugin cleaning doesn't fail"
|
|
||||||
|
|
||||||
chmod 755 "$PLUGINS_DIR/tmux-example-plugin" # enable directory deletion
|
|
||||||
|
|
||||||
teardown_helper
|
|
||||||
}
|
|
||||||
|
|
||||||
run_tests
|
|
||||||
@ -1,284 +1,28 @@
|
|||||||
#!/usr/bin/env bash
|
#!/usr/bin/env bash
|
||||||
|
|
||||||
CURRENT_DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
|
CURRENT_DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
|
||||||
PLUGINS_DIR="$HOME/.tmux/plugins"
|
|
||||||
TPM_DIR="$PWD"
|
|
||||||
|
|
||||||
CUSTOM_PLUGINS_DIR="$HOME/foo/plugins"
|
source $CURRENT_DIR/helpers.sh
|
||||||
ADDITIONAL_CONFIG_FILE_1="$HOME/.tmux/additional_config_file_1"
|
|
||||||
ADDITIONAL_CONFIG_FILE_2="$HOME/.tmux/additional_config_file_2"
|
|
||||||
|
|
||||||
source "$CURRENT_DIR/helpers/helpers.sh"
|
test_plugin_installation() {
|
||||||
source "$CURRENT_DIR/helpers/tpm.sh"
|
|
||||||
|
|
||||||
# TMUX KEY-BINDING TESTS
|
|
||||||
|
|
||||||
test_plugin_installation_via_tmux_key_binding() {
|
|
||||||
set_tmux_conf_helper <<- HERE
|
set_tmux_conf_helper <<- HERE
|
||||||
set -g mode-keys vi
|
set -g @tpm_plugins "bruno-/tmux_example_plugin"
|
||||||
set -g @plugin "tmux-plugins/tmux-example-plugin"
|
run-shell "~/tpm/tpm"
|
||||||
run-shell "$TPM_DIR/tpm"
|
|
||||||
HERE
|
HERE
|
||||||
|
|
||||||
"$CURRENT_DIR/expect_successful_plugin_download" ||
|
# opens tmux and test it with `expect`
|
||||||
fail_helper "[key-binding] plugin installation fails"
|
$CURRENT_DIR/expect_successful_plugin_download ||
|
||||||
|
fail_helper "Tmux plugin installation fails"
|
||||||
|
|
||||||
check_dir_exists_helper "$PLUGINS_DIR/tmux-example-plugin/" ||
|
# check plugin dir exists after download
|
||||||
fail_helper "[key-binding] plugin download fails"
|
check_dir_exists_helper "$HOME/.tmux/plugins/tmux_example_plugin/" ||
|
||||||
|
fail_helper "Plugin download fails"
|
||||||
|
|
||||||
teardown_helper
|
teardown_helper
|
||||||
}
|
}
|
||||||
|
|
||||||
test_plugin_installation_via_tmux_key_binding_set_option() {
|
main() {
|
||||||
set_tmux_conf_helper <<- HERE
|
test_plugin_installation
|
||||||
set -g mode-keys vi
|
exit_value_helper
|
||||||
set-option -g @plugin "tmux-plugins/tmux-example-plugin"
|
|
||||||
run-shell "$TPM_DIR/tpm"
|
|
||||||
HERE
|
|
||||||
|
|
||||||
"$CURRENT_DIR/expect_successful_plugin_download" ||
|
|
||||||
fail_helper "[key-binding][set-option] plugin installation fails"
|
|
||||||
|
|
||||||
check_dir_exists_helper "$PLUGINS_DIR/tmux-example-plugin/" ||
|
|
||||||
fail_helper "[key-binding][set-option] plugin download fails"
|
|
||||||
|
|
||||||
teardown_helper
|
|
||||||
}
|
}
|
||||||
|
main
|
||||||
test_plugin_installation_custom_dir_via_tmux_key_binding() {
|
|
||||||
set_tmux_conf_helper <<- HERE
|
|
||||||
set -g mode-keys vi
|
|
||||||
set-environment -g TMUX_PLUGIN_MANAGER_PATH '$CUSTOM_PLUGINS_DIR'
|
|
||||||
|
|
||||||
set -g @plugin "tmux-plugins/tmux-example-plugin"
|
|
||||||
run-shell "$TPM_DIR/tpm"
|
|
||||||
HERE
|
|
||||||
|
|
||||||
"$CURRENT_DIR/expect_successful_plugin_download" ||
|
|
||||||
fail_helper "[key-binding][custom dir] plugin installation fails"
|
|
||||||
|
|
||||||
check_dir_exists_helper "$CUSTOM_PLUGINS_DIR/tmux-example-plugin/" ||
|
|
||||||
fail_helper "[key-binding][custom dir] plugin download fails"
|
|
||||||
|
|
||||||
teardown_helper
|
|
||||||
rm -rf "$CUSTOM_PLUGINS_DIR"
|
|
||||||
}
|
|
||||||
|
|
||||||
test_non_existing_plugin_installation_via_tmux_key_binding() {
|
|
||||||
set_tmux_conf_helper <<- HERE
|
|
||||||
set -g mode-keys vi
|
|
||||||
set -g @plugin "tmux-plugins/non-existing-plugin"
|
|
||||||
run-shell "$TPM_DIR/tpm"
|
|
||||||
HERE
|
|
||||||
|
|
||||||
"$CURRENT_DIR/expect_failed_plugin_download" ||
|
|
||||||
fail_helper "[key-binding] non existing plugin installation doesn't fail"
|
|
||||||
|
|
||||||
teardown_helper
|
|
||||||
}
|
|
||||||
|
|
||||||
test_multiple_plugins_installation_via_tmux_key_binding() {
|
|
||||||
set_tmux_conf_helper <<- HERE
|
|
||||||
set -g mode-keys vi
|
|
||||||
set -g @plugin "tmux-plugins/tmux-example-plugin"
|
|
||||||
\ \ set -g @plugin 'tmux-plugins/tmux-copycat'
|
|
||||||
run-shell "$TPM_DIR/tpm"
|
|
||||||
HERE
|
|
||||||
|
|
||||||
"$CURRENT_DIR/expect_successful_multiple_plugins_download" ||
|
|
||||||
fail_helper "[key-binding] multiple plugins installation fails"
|
|
||||||
|
|
||||||
check_dir_exists_helper "$PLUGINS_DIR/tmux-example-plugin/" ||
|
|
||||||
fail_helper "[key-binding] plugin download fails (tmux-example-plugin)"
|
|
||||||
|
|
||||||
check_dir_exists_helper "$PLUGINS_DIR/tmux-copycat/" ||
|
|
||||||
fail_helper "[key-binding] plugin download fails (tmux-copycat)"
|
|
||||||
|
|
||||||
teardown_helper
|
|
||||||
}
|
|
||||||
|
|
||||||
test_plugins_installation_from_sourced_file_via_tmux_key_binding() {
|
|
||||||
set_tmux_conf_helper <<- HERE
|
|
||||||
set -g mode-keys vi
|
|
||||||
source '$ADDITIONAL_CONFIG_FILE_1'
|
|
||||||
set -g @plugin 'tmux-plugins/tmux-example-plugin'
|
|
||||||
run-shell "$TPM_DIR/tpm"
|
|
||||||
HERE
|
|
||||||
|
|
||||||
mkdir ~/.tmux
|
|
||||||
echo "set -g @plugin 'tmux-plugins/tmux-copycat'" > "$ADDITIONAL_CONFIG_FILE_1"
|
|
||||||
|
|
||||||
"$CURRENT_DIR/expect_successful_multiple_plugins_download" ||
|
|
||||||
fail_helper "[key-binding][sourced file] plugins installation fails"
|
|
||||||
|
|
||||||
check_dir_exists_helper "$PLUGINS_DIR/tmux-example-plugin/" ||
|
|
||||||
fail_helper "[key-binding][sourced file] plugin download fails (tmux-example-plugin)"
|
|
||||||
|
|
||||||
check_dir_exists_helper "$PLUGINS_DIR/tmux-copycat/" ||
|
|
||||||
fail_helper "[key-binding][sourced file] plugin download fails (tmux-copycat)"
|
|
||||||
|
|
||||||
teardown_helper
|
|
||||||
}
|
|
||||||
|
|
||||||
test_plugins_installation_from_multiple_sourced_files_via_tmux_key_binding() {
|
|
||||||
set_tmux_conf_helper <<- HERE
|
|
||||||
set -g mode-keys vi
|
|
||||||
\ \ source '$ADDITIONAL_CONFIG_FILE_1'
|
|
||||||
source-file '$ADDITIONAL_CONFIG_FILE_2'
|
|
||||||
run-shell "$TPM_DIR/tpm"
|
|
||||||
HERE
|
|
||||||
|
|
||||||
mkdir ~/.tmux
|
|
||||||
echo "set -g @plugin 'tmux-plugins/tmux-example-plugin'" > "$ADDITIONAL_CONFIG_FILE_1"
|
|
||||||
echo " set -g @plugin 'tmux-plugins/tmux-copycat'" > "$ADDITIONAL_CONFIG_FILE_2"
|
|
||||||
|
|
||||||
"$CURRENT_DIR/expect_successful_multiple_plugins_download" ||
|
|
||||||
fail_helper "[key-binding][multiple sourced files] plugins installation fails"
|
|
||||||
|
|
||||||
check_dir_exists_helper "$PLUGINS_DIR/tmux-example-plugin/" ||
|
|
||||||
fail_helper "[key-binding][multiple sourced files] plugin download fails (tmux-example-plugin)"
|
|
||||||
|
|
||||||
check_dir_exists_helper "$PLUGINS_DIR/tmux-copycat/" ||
|
|
||||||
fail_helper "[key-binding][multiple sourced files] plugin download fails (tmux-copycat)"
|
|
||||||
|
|
||||||
teardown_helper
|
|
||||||
}
|
|
||||||
|
|
||||||
# SCRIPT TESTS
|
|
||||||
|
|
||||||
test_plugin_installation_via_script() {
|
|
||||||
set_tmux_conf_helper <<- HERE
|
|
||||||
set -g mode-keys vi
|
|
||||||
set -g @plugin "tmux-plugins/tmux-example-plugin"
|
|
||||||
run-shell "$TPM_DIR/tpm"
|
|
||||||
HERE
|
|
||||||
|
|
||||||
script_run_helper "$TPM_DIR/bin/install_plugins" '"tmux-example-plugin" download success' ||
|
|
||||||
fail_helper "[script] plugin installation fails"
|
|
||||||
|
|
||||||
check_dir_exists_helper "$PLUGINS_DIR/tmux-example-plugin/" ||
|
|
||||||
fail_helper "[script] plugin download fails"
|
|
||||||
|
|
||||||
script_run_helper "$TPM_DIR/bin/install_plugins" 'Already installed "tmux-example-plugin"' ||
|
|
||||||
fail_helper "[script] plugin already installed message fail"
|
|
||||||
|
|
||||||
teardown_helper
|
|
||||||
}
|
|
||||||
|
|
||||||
test_plugin_installation_custom_dir_via_script() {
|
|
||||||
set_tmux_conf_helper <<- HERE
|
|
||||||
set -g mode-keys vi
|
|
||||||
set-environment -g TMUX_PLUGIN_MANAGER_PATH '$CUSTOM_PLUGINS_DIR'
|
|
||||||
|
|
||||||
set -g @plugin "tmux-plugins/tmux-example-plugin"
|
|
||||||
run-shell "$TPM_DIR/tpm"
|
|
||||||
HERE
|
|
||||||
|
|
||||||
script_run_helper "$TPM_DIR/bin/install_plugins" '"tmux-example-plugin" download success' ||
|
|
||||||
fail_helper "[script][custom dir] plugin installation fails"
|
|
||||||
|
|
||||||
check_dir_exists_helper "$CUSTOM_PLUGINS_DIR/tmux-example-plugin/" ||
|
|
||||||
fail_helper "[script][custom dir] plugin download fails"
|
|
||||||
|
|
||||||
script_run_helper "$TPM_DIR/bin/install_plugins" 'Already installed "tmux-example-plugin"' ||
|
|
||||||
fail_helper "[script][custom dir] plugin already installed message fail"
|
|
||||||
|
|
||||||
teardown_helper
|
|
||||||
rm -rf "$CUSTOM_PLUGINS_DIR"
|
|
||||||
}
|
|
||||||
|
|
||||||
test_non_existing_plugin_installation_via_script() {
|
|
||||||
set_tmux_conf_helper <<- HERE
|
|
||||||
set -g mode-keys vi
|
|
||||||
set -g @plugin "tmux-plugins/non-existing-plugin"
|
|
||||||
run-shell "$TPM_DIR/tpm"
|
|
||||||
HERE
|
|
||||||
|
|
||||||
local expected_exit_code=1
|
|
||||||
script_run_helper "$TPM_DIR/bin/install_plugins" '"non-existing-plugin" download fail' "$expected_exit_code" ||
|
|
||||||
fail_helper "[script] non existing plugin installation doesn't fail"
|
|
||||||
|
|
||||||
teardown_helper
|
|
||||||
}
|
|
||||||
|
|
||||||
test_multiple_plugins_installation_via_script() {
|
|
||||||
set_tmux_conf_helper <<- HERE
|
|
||||||
set -g mode-keys vi
|
|
||||||
set -g @plugin "tmux-plugins/tmux-example-plugin"
|
|
||||||
\ \ set -g @plugin 'tmux-plugins/tmux-copycat'
|
|
||||||
run-shell "$TPM_DIR/tpm"
|
|
||||||
HERE
|
|
||||||
|
|
||||||
script_run_helper "$TPM_DIR/bin/install_plugins" '"tmux-example-plugin" download success' ||
|
|
||||||
fail_helper "[script] multiple plugins installation fails"
|
|
||||||
|
|
||||||
check_dir_exists_helper "$PLUGINS_DIR/tmux-example-plugin/" ||
|
|
||||||
fail_helper "[script] plugin download fails (tmux-example-plugin)"
|
|
||||||
|
|
||||||
check_dir_exists_helper "$PLUGINS_DIR/tmux-copycat/" ||
|
|
||||||
fail_helper "[script] plugin download fails (tmux-copycat)"
|
|
||||||
|
|
||||||
script_run_helper "$TPM_DIR/bin/install_plugins" 'Already installed "tmux-copycat"' ||
|
|
||||||
fail_helper "[script] multiple plugins already installed message fail"
|
|
||||||
|
|
||||||
teardown_helper
|
|
||||||
}
|
|
||||||
|
|
||||||
test_plugins_installation_from_sourced_file_via_script() {
|
|
||||||
set_tmux_conf_helper <<- HERE
|
|
||||||
set -g mode-keys vi
|
|
||||||
source '$ADDITIONAL_CONFIG_FILE_1'
|
|
||||||
set -g @plugin 'tmux-plugins/tmux-example-plugin'
|
|
||||||
run-shell "$TPM_DIR/tpm"
|
|
||||||
HERE
|
|
||||||
|
|
||||||
mkdir ~/.tmux
|
|
||||||
echo "set -g @plugin 'tmux-plugins/tmux-copycat'" > "$ADDITIONAL_CONFIG_FILE_1"
|
|
||||||
|
|
||||||
script_run_helper "$TPM_DIR/bin/install_plugins" '"tmux-copycat" download success' ||
|
|
||||||
fail_helper "[script][sourced file] plugins installation fails"
|
|
||||||
|
|
||||||
check_dir_exists_helper "$PLUGINS_DIR/tmux-example-plugin/" ||
|
|
||||||
fail_helper "[script][sourced file] plugin download fails (tmux-example-plugin)"
|
|
||||||
|
|
||||||
check_dir_exists_helper "$PLUGINS_DIR/tmux-copycat/" ||
|
|
||||||
fail_helper "[script][sourced file] plugin download fails (tmux-copycat)"
|
|
||||||
|
|
||||||
script_run_helper "$TPM_DIR/bin/install_plugins" 'Already installed "tmux-copycat"' ||
|
|
||||||
fail_helper "[script][sourced file] plugins already installed message fail"
|
|
||||||
|
|
||||||
teardown_helper
|
|
||||||
}
|
|
||||||
|
|
||||||
test_plugins_installation_from_multiple_sourced_files_via_script() {
|
|
||||||
set_tmux_conf_helper <<- HERE
|
|
||||||
set -g mode-keys vi
|
|
||||||
\ \ source '$ADDITIONAL_CONFIG_FILE_1'
|
|
||||||
source-file '$ADDITIONAL_CONFIG_FILE_2'
|
|
||||||
set -g @plugin 'tmux-plugins/tmux-example-plugin'
|
|
||||||
run-shell "$TPM_DIR/tpm"
|
|
||||||
HERE
|
|
||||||
|
|
||||||
mkdir ~/.tmux
|
|
||||||
echo " set -g @plugin 'tmux-plugins/tmux-copycat'" > "$ADDITIONAL_CONFIG_FILE_1"
|
|
||||||
echo "set -g @plugin 'tmux-plugins/tmux-sensible'" > "$ADDITIONAL_CONFIG_FILE_2"
|
|
||||||
|
|
||||||
script_run_helper "$TPM_DIR/bin/install_plugins" '"tmux-sensible" download success' ||
|
|
||||||
fail_helper "[script][multiple sourced files] plugins installation fails"
|
|
||||||
|
|
||||||
check_dir_exists_helper "$PLUGINS_DIR/tmux-example-plugin/" ||
|
|
||||||
fail_helper "[script][multiple sourced files] plugin download fails (tmux-example-plugin)"
|
|
||||||
|
|
||||||
check_dir_exists_helper "$PLUGINS_DIR/tmux-copycat/" ||
|
|
||||||
fail_helper "[script][multiple sourced files] plugin download fails (tmux-copycat)"
|
|
||||||
|
|
||||||
check_dir_exists_helper "$PLUGINS_DIR/tmux-sensible/" ||
|
|
||||||
fail_helper "[script][multiple sourced files] plugin download fails (tmux-sensible)"
|
|
||||||
|
|
||||||
script_run_helper "$TPM_DIR/bin/install_plugins" 'Already installed "tmux-sensible"' ||
|
|
||||||
fail_helper "[script][multiple sourced files] plugins already installed message fail"
|
|
||||||
|
|
||||||
teardown_helper
|
|
||||||
}
|
|
||||||
|
|
||||||
run_tests
|
|
||||||
|
|||||||
@ -1,100 +0,0 @@
|
|||||||
#!/usr/bin/env bash
|
|
||||||
|
|
||||||
CURRENT_DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
|
|
||||||
PLUGINS_DIR="$HOME/.tmux/plugins"
|
|
||||||
TPM_DIR="$PWD"
|
|
||||||
|
|
||||||
source "$CURRENT_DIR/helpers/helpers.sh"
|
|
||||||
source "$CURRENT_DIR/helpers/tpm.sh"
|
|
||||||
|
|
||||||
# TMUX KEY-BINDING TESTS
|
|
||||||
|
|
||||||
test_plugin_installation_via_tmux_key_binding() {
|
|
||||||
set_tmux_conf_helper <<- HERE
|
|
||||||
set -g mode-keys vi
|
|
||||||
set -g @tpm_plugins "tmux-plugins/tmux-example-plugin"
|
|
||||||
run-shell "$TPM_DIR/tpm"
|
|
||||||
HERE
|
|
||||||
|
|
||||||
# opens tmux and test it with `expect`
|
|
||||||
$CURRENT_DIR/expect_successful_plugin_download ||
|
|
||||||
fail_helper "[key-binding] plugin installation fails"
|
|
||||||
|
|
||||||
# check plugin dir exists after download
|
|
||||||
check_dir_exists_helper "$PLUGINS_DIR/tmux-example-plugin/" ||
|
|
||||||
fail_helper "[key-binding] plugin download fails"
|
|
||||||
|
|
||||||
teardown_helper
|
|
||||||
}
|
|
||||||
|
|
||||||
test_legacy_and_new_syntax_for_plugin_installation_work_via_tmux_key_binding() {
|
|
||||||
set_tmux_conf_helper <<- HERE
|
|
||||||
set -g mode-keys vi
|
|
||||||
set -g @tpm_plugins " \
|
|
||||||
tmux-plugins/tmux-example-plugin \
|
|
||||||
"
|
|
||||||
set -g @plugin 'tmux-plugins/tmux-copycat'
|
|
||||||
run-shell "$TPM_DIR/tpm"
|
|
||||||
HERE
|
|
||||||
|
|
||||||
# opens tmux and test it with `expect`
|
|
||||||
"$CURRENT_DIR"/expect_successful_multiple_plugins_download ||
|
|
||||||
fail_helper "[key-binding] multiple plugins installation fails"
|
|
||||||
|
|
||||||
# check plugin dir exists after download
|
|
||||||
check_dir_exists_helper "$PLUGINS_DIR/tmux-example-plugin/" ||
|
|
||||||
fail_helper "[key-binding] plugin download fails (tmux-example-plugin)"
|
|
||||||
|
|
||||||
check_dir_exists_helper "$PLUGINS_DIR/tmux-copycat/" ||
|
|
||||||
fail_helper "[key-binding] plugin download fails (tmux-copycat)"
|
|
||||||
|
|
||||||
teardown_helper
|
|
||||||
}
|
|
||||||
|
|
||||||
# SCRIPT TESTS
|
|
||||||
|
|
||||||
test_plugin_installation_via_script() {
|
|
||||||
set_tmux_conf_helper <<- HERE
|
|
||||||
set -g mode-keys vi
|
|
||||||
set -g @tpm_plugins "tmux-plugins/tmux-example-plugin"
|
|
||||||
run-shell "$TPM_DIR/tpm"
|
|
||||||
HERE
|
|
||||||
|
|
||||||
script_run_helper "$TPM_DIR/bin/install_plugins" '"tmux-example-plugin" download success' ||
|
|
||||||
fail_helper "[script] plugin installation fails"
|
|
||||||
|
|
||||||
check_dir_exists_helper "$PLUGINS_DIR/tmux-example-plugin/" ||
|
|
||||||
fail_helper "[script] plugin download fails"
|
|
||||||
|
|
||||||
script_run_helper "$TPM_DIR/bin/install_plugins" 'Already installed "tmux-example-plugin"' ||
|
|
||||||
fail_helper "[script] plugin already installed message fail"
|
|
||||||
|
|
||||||
teardown_helper
|
|
||||||
}
|
|
||||||
|
|
||||||
test_legacy_and_new_syntax_for_plugin_installation_work_via_script() {
|
|
||||||
set_tmux_conf_helper <<- HERE
|
|
||||||
set -g mode-keys vi
|
|
||||||
set -g @tpm_plugins " \
|
|
||||||
tmux-plugins/tmux-example-plugin \
|
|
||||||
"
|
|
||||||
set -g @plugin 'tmux-plugins/tmux-copycat'
|
|
||||||
run-shell "$TPM_DIR/tpm"
|
|
||||||
HERE
|
|
||||||
|
|
||||||
script_run_helper "$TPM_DIR/bin/install_plugins" '"tmux-example-plugin" download success' ||
|
|
||||||
fail_helper "[script] multiple plugin installation fails"
|
|
||||||
|
|
||||||
check_dir_exists_helper "$PLUGINS_DIR/tmux-example-plugin/" ||
|
|
||||||
fail_helper "[script] plugin download fails (tmux-example-plugin)"
|
|
||||||
|
|
||||||
check_dir_exists_helper "$PLUGINS_DIR/tmux-copycat/" ||
|
|
||||||
fail_helper "[script] plugin download fails (tmux-copycat)"
|
|
||||||
|
|
||||||
script_run_helper "$TPM_DIR/bin/install_plugins" 'Already installed "tmux-copycat"' ||
|
|
||||||
fail_helper "[script] multiple plugins already installed message fail"
|
|
||||||
|
|
||||||
teardown_helper
|
|
||||||
}
|
|
||||||
|
|
||||||
run_tests
|
|
||||||
@ -1,41 +1,18 @@
|
|||||||
#!/usr/bin/env bash
|
#!/usr/bin/env bash
|
||||||
|
|
||||||
CURRENT_DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
|
CURRENT_DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
|
||||||
TPM_DIR="$PWD"
|
|
||||||
PLUGINS_DIR="$HOME/.tmux/plugins"
|
|
||||||
|
|
||||||
CUSTOM_PLUGINS_DIR="$HOME/foo/plugins"
|
source $CURRENT_DIR/helpers.sh
|
||||||
|
|
||||||
source "$CURRENT_DIR/helpers/helpers.sh"
|
|
||||||
source "$CURRENT_DIR/helpers/tpm.sh"
|
|
||||||
|
|
||||||
check_binding_defined() {
|
check_binding_defined() {
|
||||||
local binding="$1"
|
local binding="$1"
|
||||||
tmux list-keys | grep -q "$binding"
|
tmux list-keys | grep -q "$binding"
|
||||||
}
|
}
|
||||||
|
|
||||||
create_test_plugin_helper() {
|
|
||||||
local plugin_path="$PLUGINS_DIR/tmux_test_plugin/"
|
|
||||||
rm -rf "$plugin_path"
|
|
||||||
mkdir -p "$plugin_path"
|
|
||||||
|
|
||||||
while read line; do
|
|
||||||
echo "$line" >> "$plugin_path/test_plugin.tmux"
|
|
||||||
done
|
|
||||||
chmod +x "$plugin_path/test_plugin.tmux"
|
|
||||||
}
|
|
||||||
|
|
||||||
check_tpm_path() {
|
|
||||||
local correct_tpm_path="$1"
|
|
||||||
local tpm_path="$(tmux start-server\; show-environment -g TMUX_PLUGIN_MANAGER_PATH | cut -f2 -d=)"
|
|
||||||
[ "$correct_tpm_path" == "$tpm_path" ]
|
|
||||||
}
|
|
||||||
|
|
||||||
test_plugin_sourcing() {
|
test_plugin_sourcing() {
|
||||||
set_tmux_conf_helper <<- HERE
|
set_tmux_conf_helper <<- HERE
|
||||||
set -g mode-keys vi
|
set -g @tpm_plugins "doesnt_matter/tmux_test_plugin"
|
||||||
set -g @plugin "doesnt_matter/tmux_test_plugin"
|
run-shell "~/tpm/tpm"
|
||||||
run-shell "$TPM_DIR/tpm"
|
|
||||||
HERE
|
HERE
|
||||||
|
|
||||||
# manually creates a local tmux plugin
|
# manually creates a local tmux plugin
|
||||||
@ -50,29 +27,8 @@ test_plugin_sourcing() {
|
|||||||
teardown_helper
|
teardown_helper
|
||||||
}
|
}
|
||||||
|
|
||||||
test_default_tpm_path() {
|
main() {
|
||||||
set_tmux_conf_helper <<- HERE
|
test_plugin_sourcing
|
||||||
set -g mode-keys vi
|
exit_value_helper
|
||||||
run-shell "$TPM_DIR/tpm"
|
|
||||||
HERE
|
|
||||||
|
|
||||||
check_tpm_path "${PLUGINS_DIR}/" ||
|
|
||||||
fail_helper "Default TPM path not correct"
|
|
||||||
|
|
||||||
teardown_helper
|
|
||||||
}
|
}
|
||||||
|
main
|
||||||
test_custom_tpm_path() {
|
|
||||||
set_tmux_conf_helper <<- HERE
|
|
||||||
set -g mode-keys vi
|
|
||||||
set-environment -g TMUX_PLUGIN_MANAGER_PATH '$CUSTOM_PLUGINS_DIR'
|
|
||||||
run-shell "$TPM_DIR/tpm"
|
|
||||||
HERE
|
|
||||||
|
|
||||||
check_tpm_path "$CUSTOM_PLUGINS_DIR" ||
|
|
||||||
fail_helper "Custom TPM path not correct"
|
|
||||||
|
|
||||||
teardown_helper
|
|
||||||
}
|
|
||||||
|
|
||||||
run_tests
|
|
||||||
|
|||||||
@ -1,60 +0,0 @@
|
|||||||
#!/usr/bin/env bash
|
|
||||||
|
|
||||||
CURRENT_DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
|
|
||||||
TPM_DIR="$PWD"
|
|
||||||
PLUGINS_DIR="$HOME/.tmux/plugins"
|
|
||||||
|
|
||||||
source "$CURRENT_DIR/helpers/helpers.sh"
|
|
||||||
source "$CURRENT_DIR/helpers/tpm.sh"
|
|
||||||
|
|
||||||
manually_install_the_plugin() {
|
|
||||||
mkdir -p "$PLUGINS_DIR"
|
|
||||||
cd "$PLUGINS_DIR"
|
|
||||||
git clone --quiet https://github.com/tmux-plugins/tmux-example-plugin
|
|
||||||
}
|
|
||||||
|
|
||||||
# TMUX KEY-BINDING TESTS
|
|
||||||
|
|
||||||
test_plugin_update_via_tmux_key_binding() {
|
|
||||||
set_tmux_conf_helper <<- HERE
|
|
||||||
set -g mode-keys vi
|
|
||||||
set -g @plugin "tmux-plugins/tmux-example-plugin"
|
|
||||||
run-shell "$TPM_DIR/tpm"
|
|
||||||
HERE
|
|
||||||
|
|
||||||
manually_install_the_plugin
|
|
||||||
|
|
||||||
"$CURRENT_DIR/expect_successful_update_of_all_plugins" ||
|
|
||||||
fail_helper "[key-binding] 'update all plugins' fails"
|
|
||||||
|
|
||||||
"$CURRENT_DIR/expect_successful_update_of_a_single_plugin" ||
|
|
||||||
fail_helper "[key-binding] 'update single plugin' fails"
|
|
||||||
|
|
||||||
teardown_helper
|
|
||||||
}
|
|
||||||
|
|
||||||
# SCRIPT TESTS
|
|
||||||
|
|
||||||
test_plugin_update_via_script() {
|
|
||||||
set_tmux_conf_helper <<- HERE
|
|
||||||
set -g mode-keys vi
|
|
||||||
set -g @plugin "tmux-plugins/tmux-example-plugin"
|
|
||||||
run-shell "$TPM_DIR/tpm"
|
|
||||||
HERE
|
|
||||||
|
|
||||||
manually_install_the_plugin
|
|
||||||
|
|
||||||
local expected_exit_code=1
|
|
||||||
script_run_helper "$TPM_DIR/bin/update_plugins" 'usage' "$expected_exit_code" ||
|
|
||||||
fail_helper "[script] running update plugins without args should fail"
|
|
||||||
|
|
||||||
script_run_helper "$TPM_DIR/bin/update_plugins tmux-example-plugin" '"tmux-example-plugin" update success' ||
|
|
||||||
fail_helper "[script] plugin update fails"
|
|
||||||
|
|
||||||
script_run_helper "$TPM_DIR/bin/update_plugins all" '"tmux-example-plugin" update success' ||
|
|
||||||
fail_helper "[script] update all plugins fails"
|
|
||||||
|
|
||||||
teardown_helper
|
|
||||||
}
|
|
||||||
|
|
||||||
run_tests
|
|
||||||
62
tpm
62
tpm
@ -1,80 +1,42 @@
|
|||||||
#!/usr/bin/env bash
|
#!/usr/bin/env bash
|
||||||
|
|
||||||
CURRENT_DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
|
CURRENT_DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
|
||||||
BINDINGS_DIR="$CURRENT_DIR/bindings"
|
|
||||||
SCRIPTS_DIR="$CURRENT_DIR/scripts"
|
|
||||||
|
|
||||||
source "$SCRIPTS_DIR/variables.sh"
|
SUPPORTED_TMUX_VERSION="1.9"
|
||||||
|
|
||||||
get_tmux_option() {
|
|
||||||
local option="$1"
|
|
||||||
local default_value="$2"
|
|
||||||
local option_value="$(tmux show-option -gqv "$option")"
|
|
||||||
if [ -z "$option_value" ]; then
|
|
||||||
echo "$default_value"
|
|
||||||
else
|
|
||||||
echo "$option_value"
|
|
||||||
fi
|
|
||||||
}
|
|
||||||
|
|
||||||
tpm_path_set() {
|
|
||||||
tmux show-environment -g "$DEFAULT_TPM_ENV_VAR_NAME" >/dev/null 2>&1
|
|
||||||
}
|
|
||||||
|
|
||||||
# Check if configuration file exists at an XDG-compatible location, if so use
|
|
||||||
# that directory for TMUX_PLUGIN_MANAGER_PATH. Otherwise use $DEFAULT_TPM_PATH.
|
|
||||||
set_default_tpm_path() {
|
|
||||||
local xdg_tmux_path="${XDG_CONFIG_HOME:-$HOME/.config}/tmux"
|
|
||||||
local tpm_path="$DEFAULT_TPM_PATH"
|
|
||||||
|
|
||||||
if [ -f "$xdg_tmux_path/tmux.conf" ]; then
|
|
||||||
tpm_path="$xdg_tmux_path/plugins/"
|
|
||||||
fi
|
|
||||||
|
|
||||||
tmux set-environment -g "$DEFAULT_TPM_ENV_VAR_NAME" "$tpm_path"
|
|
||||||
}
|
|
||||||
|
|
||||||
# Ensures TMUX_PLUGIN_MANAGER_PATH global env variable is set.
|
# 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:
|
# Put this in `.tmux.conf` to override the default:
|
||||||
# `set-environment -g TMUX_PLUGIN_MANAGER_PATH "/some/other/path/"`
|
# `set-environment -g TMUX_PLUGIN_MANAGER_PATH "/some/other/path/"`
|
||||||
set_tpm_path() {
|
set_tpm_path() {
|
||||||
if ! tpm_path_set; then
|
$CURRENT_DIR/scripts/set_tpm_path.sh >/dev/null 2>&1
|
||||||
set_default_tpm_path
|
|
||||||
fi
|
|
||||||
}
|
}
|
||||||
|
|
||||||
# 1. Fetches plugin names from `@plugin` variables
|
# 1. Fetches plugin names from `@tpm_plugins` user variable.
|
||||||
# 2. Creates full plugin path
|
# 2. Creates full plugin path
|
||||||
# 3. Sources all *.tmux files from each of the plugin directories
|
# 3. Sources all *.tmux files from each of the plugin directories
|
||||||
# - no errors raised if directory does not exist
|
# - no errors raised if directory does not exist
|
||||||
# Files are sourced as tmux config files, not as shell scripts!
|
# Files are sourced as tmux config files, not as shell scripts!
|
||||||
source_plugins() {
|
source_plugins() {
|
||||||
"$SCRIPTS_DIR/source_plugins.sh" >/dev/null 2>&1
|
$CURRENT_DIR/scripts/source_plugins.sh >/dev/null 2>&1
|
||||||
}
|
}
|
||||||
|
|
||||||
# prefix + I - downloads TPM plugins and reloads TMUX environment
|
# Defines key binding:
|
||||||
# prefix + U - updates a plugin (or all of them) and reloads TMUX environment
|
# prefix + I - downloads TPM plugins and reloads TMUX environment.
|
||||||
# prefix + alt + u - remove unused TPM plugins and reloads TMUX environment
|
set_tpm_key_binding() {
|
||||||
set_tpm_key_bindings() {
|
$CURRENT_DIR/scripts/key_binding.sh
|
||||||
local install_key="$(get_tmux_option "$install_key_option" "$default_install_key")"
|
|
||||||
tmux bind-key "$install_key" run-shell "$BINDINGS_DIR/install_plugins"
|
|
||||||
|
|
||||||
local update_key="$(get_tmux_option "$update_key_option" "$default_update_key")"
|
|
||||||
tmux bind-key "$update_key" run-shell "$BINDINGS_DIR/update_plugins"
|
|
||||||
|
|
||||||
local clean_key="$(get_tmux_option "$clean_key_option" "$default_clean_key")"
|
|
||||||
tmux bind-key "$clean_key" run-shell "$BINDINGS_DIR/clean_plugins"
|
|
||||||
}
|
}
|
||||||
|
|
||||||
supported_tmux_version_ok() {
|
supported_tmux_version_ok() {
|
||||||
"$SCRIPTS_DIR/check_tmux_version.sh" "$SUPPORTED_TMUX_VERSION"
|
$CURRENT_DIR/scripts/check_tmux_version.sh "$SUPPORTED_TMUX_VERSION"
|
||||||
}
|
}
|
||||||
|
|
||||||
main() {
|
main() {
|
||||||
if supported_tmux_version_ok; then
|
if supported_tmux_version_ok; then
|
||||||
set_tpm_path
|
set_tpm_path
|
||||||
set_tpm_key_bindings
|
set_tpm_key_binding
|
||||||
source_plugins
|
source_plugins
|
||||||
fi
|
fi
|
||||||
}
|
}
|
||||||
|
|||||||
9
vagrant_provisioning.sh
Normal file
9
vagrant_provisioning.sh
Normal file
@ -0,0 +1,9 @@
|
|||||||
|
#!/usr/bin/env bash
|
||||||
|
|
||||||
|
sudo apt-get update
|
||||||
|
sudo apt-get install -y git-core expect python-software-properties software-properties-common
|
||||||
|
|
||||||
|
# install latest Tmux 1.9a
|
||||||
|
sudo add-apt-repository -y ppa:pi-rho/dev
|
||||||
|
sudo apt-get update
|
||||||
|
sudo apt-get install -y tmux=1.9a-1~ppa1~p
|
||||||
Loading…
x
Reference in New Issue
Block a user