Add .tmux.conf
Add .tmux/plugins/tmux-sensible/CHANGELOG.md Add .tmux/plugins/tmux-sensible/LICENSE.md Add .tmux/plugins/tmux-sensible/README.md Add .tmux/plugins/tmux-sensible/.git/HEAD Add .tmux/plugins/tmux-sensible/.git/config Add .tmux/plugins/tmux-sensible/.git/description Add .tmux/plugins/tmux-sensible/.git/hooks/applypatch-msg.sample Add .tmux/plugins/tmux-sensible/.git/hooks/commit-msg.sample Add .tmux/plugins/tmux-sensible/.git/hooks/fsmonitor-watchman.sample Add .tmux/plugins/tmux-sensible/.git/hooks/post-update.sample Add .tmux/plugins/tmux-sensible/.git/hooks/pre-applypatch.sample Add .tmux/plugins/tmux-sensible/.git/hooks/pre-commit.sample Add .tmux/plugins/tmux-sensible/.git/hooks/pre-merge-commit.sample Add .tmux/plugins/tmux-sensible/.git/hooks/pre-push.sample Add .tmux/plugins/tmux-sensible/.git/hooks/pre-rebase.sample Add .tmux/plugins/tmux-sensible/.git/hooks/pre-receive.sample Add .tmux/plugins/tmux-sensible/.git/hooks/prepare-commit-msg.sample Add .tmux/plugins/tmux-sensible/.git/hooks/push-to-checkout.sample Add .tmux/plugins/tmux-sensible/.git/hooks/update.sample Add .tmux/plugins/tmux-sensible/.git/index Add .tmux/plugins/tmux-sensible/.git/info/exclude Add .tmux/plugins/tmux-sensible/.git/logs/HEAD Add .tmux/plugins/tmux-sensible/.git/logs/refs/heads/master Add .tmux/plugins/tmux-sensible/.git/logs/refs/remotes/origin/HEAD Add .tmux/plugins/tmux-sensible/.git/objects/info/.keep Add .tmux/plugins/tmux-sensible/.git/objects/pack/pack-2a598c9f31f588f92fc2a83b1ab7a1ae38767c16.idx Add .tmux/plugins/tmux-sensible/.git/objects/pack/pack-2a598c9f31f588f92fc2a83b1ab7a1ae38767c16.pack Add .tmux/plugins/tmux-sensible/.git/packed-refs Add .tmux/plugins/tmux-sensible/.git/refs/heads/master Add .tmux/plugins/tmux-sensible/.git/refs/remotes/origin/HEAD Add .tmux/plugins/tmux-sensible/.git/refs/tags/v1.0.0 Add .tmux/plugins/tmux-sensible/.git/refs/tags/v1.1.0 Add .tmux/plugins/tmux-sensible/.git/refs/tags/v2.0.0 Add .tmux/plugins/tmux-sensible/.git/refs/tags/v2.1.0 Add .tmux/plugins/tmux-sensible/.git/refs/tags/v2.2.0 Add .tmux/plugins/tmux-sensible/.git/refs/tags/v2.3.0 Add .tmux/plugins/tmux-sensible/.git/refs/tags/v3.0.0 Add .tmux/plugins/tmux-sensible/.gitattributes Add .tmux/plugins/tmux-sensible/sensible.tmux Add .tmux/plugins/tmux/LICENSE Add .tmux/plugins/tmux/README.md Add .tmux/plugins/tmux/assets/frappe.webp Add .tmux/plugins/tmux/assets/latte.webp Add .tmux/plugins/tmux/assets/macchiato.webp Add .tmux/plugins/tmux/assets/mocha.webp Add .tmux/plugins/tmux/assets/preview.webp Add .tmux/plugins/tmux/catppuccin-frappe.tmuxtheme Add .tmux/plugins/tmux/catppuccin-latte.tmuxtheme Add .tmux/plugins/tmux/catppuccin-macchiato.tmuxtheme Add .tmux/plugins/tmux/catppuccin-mocha.tmuxtheme Add .tmux/plugins/tmux/.editorconfig Add .tmux/plugins/tmux/.git/HEAD Add .tmux/plugins/tmux/.git/config Add .tmux/plugins/tmux/.git/description Add .tmux/plugins/tmux/.git/hooks/applypatch-msg.sample Add .tmux/plugins/tmux/.git/hooks/commit-msg.sample Add .tmux/plugins/tmux/.git/hooks/fsmonitor-watchman.sample Add .tmux/plugins/tmux/.git/hooks/post-update.sample Add .tmux/plugins/tmux/.git/hooks/pre-applypatch.sample Add .tmux/plugins/tmux/.git/hooks/pre-commit.sample Add .tmux/plugins/tmux/.git/hooks/pre-merge-commit.sample Add .tmux/plugins/tmux/.git/hooks/pre-push.sample Add .tmux/plugins/tmux/.git/hooks/pre-rebase.sample Add .tmux/plugins/tmux/.git/hooks/pre-receive.sample Add .tmux/plugins/tmux/.git/hooks/prepare-commit-msg.sample Add .tmux/plugins/tmux/.git/hooks/push-to-checkout.sample Add .tmux/plugins/tmux/.git/hooks/sendemail-validate.sample Add .tmux/plugins/tmux/.git/hooks/update.sample Add .tmux/plugins/tmux/.git/index Add .tmux/plugins/tmux/.git/info/exclude Add .tmux/plugins/tmux/.git/logs/HEAD Add .tmux/plugins/tmux/.git/logs/refs/heads/main Add .tmux/plugins/tmux/.git/logs/refs/remotes/origin/HEAD Add .tmux/plugins/tmux/.git/objects/info/.keep Add .tmux/plugins/tmux/.git/objects/pack/pack-ca2499aaebdbbc41d6409686c32c5c7e0d6988c8.idx Add .tmux/plugins/tmux/.git/objects/pack/pack-ca2499aaebdbbc41d6409686c32c5c7e0d6988c8.pack Add .tmux/plugins/tmux/.git/objects/pack/pack-ca2499aaebdbbc41d6409686c32c5c7e0d6988c8.rev Add .tmux/plugins/tmux/.git/packed-refs Add .tmux/plugins/tmux/.git/refs/heads/main Add .tmux/plugins/tmux/.git/refs/remotes/origin/HEAD Add .tmux/plugins/tmux/.git/refs/tags/.keep Add .tmux/plugins/tmux/.gitignore Add .tmux/plugins/tmux/catppuccin.tmux Add .tmux/plugins/tpm/CHANGELOG.md Add .tmux/plugins/tpm/HOW_TO_PLUGIN.md Add .tmux/plugins/tpm/LICENSE.md Add .tmux/plugins/tpm/README.md Add .tmux/plugins/tpm/bin/clean_plugins Add .tmux/plugins/tpm/bin/install_plugins Add .tmux/plugins/tpm/bin/update_plugins Add .tmux/plugins/tpm/bindings/clean_plugins Add .tmux/plugins/tpm/bindings/install_plugins Add .tmux/plugins/tpm/bindings/update_plugins Add .tmux/plugins/tpm/docs/automatic_tpm_installation.md Add .tmux/plugins/tpm/docs/changing_plugins_install_dir.md Add .tmux/plugins/tpm/docs/how_to_create_plugin.md Add .tmux/plugins/tpm/docs/managing_plugins_via_cmd_line.md Add .tmux/plugins/tpm/docs/tpm_not_working.md Add .tmux/plugins/tpm/.git/HEAD Add .tmux/plugins/tpm/.git/config Add .tmux/plugins/tpm/.git/description Add .tmux/plugins/tpm/.git/hooks/applypatch-msg.sample Add .tmux/plugins/tpm/.git/hooks/commit-msg.sample Add .tmux/plugins/tpm/.git/hooks/fsmonitor-watchman.sample Add .tmux/plugins/tpm/.git/hooks/post-update.sample Add .tmux/plugins/tpm/.git/hooks/pre-applypatch.sample Add .tmux/plugins/tpm/.git/hooks/pre-commit.sample Add .tmux/plugins/tpm/.git/hooks/pre-merge-commit.sample Add .tmux/plugins/tpm/.git/hooks/pre-push.sample Add .tmux/plugins/tpm/.git/hooks/pre-rebase.sample Add .tmux/plugins/tpm/.git/hooks/pre-receive.sample Add .tmux/plugins/tpm/.git/hooks/prepare-commit-msg.sample Add .tmux/plugins/tpm/.git/hooks/push-to-checkout.sample Add .tmux/plugins/tpm/.git/hooks/update.sample Add .tmux/plugins/tpm/.git/index Add .tmux/plugins/tpm/.git/info/exclude Add .tmux/plugins/tpm/.git/logs/HEAD Add .tmux/plugins/tpm/.git/logs/refs/heads/master Add .tmux/plugins/tpm/.git/logs/refs/remotes/origin/HEAD Add .tmux/plugins/tpm/.git/objects/info/.keep Add .tmux/plugins/tpm/.git/objects/pack/pack-17625ffcf71a446997741831332005307218a33a.idx Add .tmux/plugins/tpm/.git/objects/pack/pack-17625ffcf71a446997741831332005307218a33a.pack Add .tmux/plugins/tpm/.git/packed-refs Add .tmux/plugins/tpm/.git/refs/heads/master Add .tmux/plugins/tpm/.git/refs/remotes/origin/HEAD Add .tmux/plugins/tpm/.git/refs/tags/.keep Add .tmux/plugins/tpm/.gitattributes Add .tmux/plugins/tpm/.gitignore Add .tmux/plugins/tpm/.gitmodules Add .tmux/plugins/tpm/.travis.yml Add .tmux/plugins/tpm/tpm Add .tmux/plugins/tpm/lib/tmux-test/.keep Add .tmux/plugins/tpm/scripts/check_tmux_version.sh Add .tmux/plugins/tpm/scripts/clean_plugins.sh Add .tmux/plugins/tpm/scripts/install_plugins.sh Add .tmux/plugins/tpm/scripts/source_plugins.sh Add .tmux/plugins/tpm/scripts/update_plugin.sh Add .tmux/plugins/tpm/scripts/update_plugin_prompt_handler.sh Add .tmux/plugins/tpm/scripts/helpers/plugin_functions.sh Add .tmux/plugins/tpm/scripts/helpers/shell_echo_functions.sh Add .tmux/plugins/tpm/scripts/helpers/tmux_echo_functions.sh Add .tmux/plugins/tpm/scripts/helpers/tmux_utils.sh Add .tmux/plugins/tpm/scripts/helpers/utility.sh Add .tmux/plugins/tpm/scripts/variables.sh Add .tmux/plugins/tpm/tests/expect_failed_plugin_download Add .tmux/plugins/tpm/tests/expect_successful_clean_plugins Add .tmux/plugins/tpm/tests/expect_successful_multiple_plugins_download Add .tmux/plugins/tpm/tests/expect_successful_plugin_download Add .tmux/plugins/tpm/tests/expect_successful_update_of_a_single_plugin Add .tmux/plugins/tpm/tests/expect_successful_update_of_all_plugins Add .tmux/plugins/tpm/tests/test_plugin_clean.sh Add .tmux/plugins/tpm/tests/test_plugin_installation.sh Add .tmux/plugins/tpm/tests/test_plugin_installation_legacy.sh Add .tmux/plugins/tpm/tests/test_plugin_sourcing.sh Add .tmux/plugins/tpm/tests/test_plugin_update.sh Add .tmux/plugins/tpm/tests/helpers/tpm.sh Add .tmux/plugins/vim-tmux-navigator/License.md Add .tmux/plugins/vim-tmux-navigator/README.md Add .tmux/plugins/vim-tmux-navigator/doc/tmux-navigator.txt Add .tmux/plugins/vim-tmux-navigator/.git/HEAD Add .tmux/plugins/vim-tmux-navigator/.git/config Add .tmux/plugins/vim-tmux-navigator/.git/description Add .tmux/plugins/vim-tmux-navigator/.git/hooks/applypatch-msg.sample Add .tmux/plugins/vim-tmux-navigator/.git/hooks/commit-msg.sample Add .tmux/plugins/vim-tmux-navigator/.git/hooks/fsmonitor-watchman.sample Add .tmux/plugins/vim-tmux-navigator/.git/hooks/post-update.sample Add .tmux/plugins/vim-tmux-navigator/.git/hooks/pre-applypatch.sample Add .tmux/plugins/vim-tmux-navigator/.git/hooks/pre-commit.sample Add .tmux/plugins/vim-tmux-navigator/.git/hooks/pre-merge-commit.sample Add .tmux/plugins/vim-tmux-navigator/.git/hooks/pre-push.sample Add .tmux/plugins/vim-tmux-navigator/.git/hooks/pre-rebase.sample Add .tmux/plugins/vim-tmux-navigator/.git/hooks/pre-receive.sample Add .tmux/plugins/vim-tmux-navigator/.git/hooks/prepare-commit-msg.sample Add .tmux/plugins/vim-tmux-navigator/.git/hooks/push-to-checkout.sample Add .tmux/plugins/vim-tmux-navigator/.git/hooks/update.sample Add .tmux/plugins/vim-tmux-navigator/.git/index Add .tmux/plugins/vim-tmux-navigator/.git/info/exclude Add .tmux/plugins/vim-tmux-navigator/.git/logs/HEAD Add .tmux/plugins/vim-tmux-navigator/.git/logs/refs/heads/master Add .tmux/plugins/vim-tmux-navigator/.git/logs/refs/remotes/origin/HEAD Add .tmux/plugins/vim-tmux-navigator/.git/objects/info/.keep Add .tmux/plugins/vim-tmux-navigator/.git/objects/pack/pack-d18103c902c90ca8df5435292ec0cf5b50bd3683.idx Add .tmux/plugins/vim-tmux-navigator/.git/objects/pack/pack-d18103c902c90ca8df5435292ec0cf5b50bd3683.pack Add .tmux/plugins/vim-tmux-navigator/.git/packed-refs Add .tmux/plugins/vim-tmux-navigator/.git/refs/heads/master Add .tmux/plugins/vim-tmux-navigator/.git/refs/remotes/origin/HEAD Add .tmux/plugins/vim-tmux-navigator/.git/refs/tags/v1.0 Add .tmux/plugins/vim-tmux-navigator/.gitignore Add .tmux/plugins/vim-tmux-navigator/vim-tmux-navigator.tmux Add .tmux/plugins/vim-tmux-navigator/pattern-check Add .tmux/plugins/vim-tmux-navigator/plugin/tmux_navigator.vim Add revive.toml
This commit is contained in:
108
dot_tmux/plugins/tpm/docs/how_to_create_plugin.md
Normal file
108
dot_tmux/plugins/tpm/docs/how_to_create_plugin.md
Normal file
@@ -0,0 +1,108 @@
|
||||
# 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.
|
Reference in New Issue
Block a user