https://github.com/curusarn/bash-zsh-compat-widgets
Use the same function as both Zsh ZLE widget and Bash readline "widget"
https://github.com/curusarn/bash-zsh-compat-widgets
bash compatibility readline zle-widgets zsh
Last synced: 2 months ago
JSON representation
Use the same function as both Zsh ZLE widget and Bash readline "widget"
- Host: GitHub
- URL: https://github.com/curusarn/bash-zsh-compat-widgets
- Owner: curusarn
- License: mit
- Created: 2019-09-30T22:59:40.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2019-12-29T14:17:36.000Z (over 5 years ago)
- Last Synced: 2025-02-12T11:14:03.551Z (4 months ago)
- Topics: bash, compatibility, readline, zle-widgets, zsh
- Language: Shell
- Homepage:
- Size: 31.3 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# bash-zsh-compat-widgets
This project enables you to use the same function as both:
- Zsh ZLE widget
- Bash readline "widget"
## Bindfunc
Bash uses `bind -x ...` to bind "widgets".
Zsh uses `zle -N ...` and then `keybind ...` to bind widgets.
`bindfunc` is a wrapper around these commands that binds widgets in both bash and zsh.
Use it like this:
```sh
source bindfunc.sh
bindfunc KEY_SEQUENCE SHELL_FUNCTION
```
When you need binding for a specific keymap (e.g. vi mode) use `-m`/`-M` option with zsh or bash keymap:
```sh
source bindfunc.sh
bindfunc -M vi-command KEY_SEQUENCE SHELL_FUNCTION
```
If you need to be able to revert the binding later do it like this:
```sh
source bindfunc.sh
bindfunc --revert KEY_SEQUENCE SHELL_FUNCTION
# using --revert options sets _bindfunc_revert variable to a command
# that can be evaluated to revert the bindfunc call
revert_bind=$_bindfunc_revert
# do whatever
eval $revert_bind
```
*I know what you are thinking. Using `eval` is ugly and dangerous but just as in the case of `eval $(ssh-agent)` using `eval` is the best solution here.*
You can find more examples at the bottom of this page.
## Compatibility wrapper
Part of this project is a very simple compatibility layer that makes it possible to use simple zsh zle widgets in bash and all bash "widgets" in zsh.
Use it like this:
```sh
mywidget_compat() {
__bindfunc_compat_wrapper mywidget_zsh
}
```
## Example
Full example showing how to use this project:
```sh
source bindfunc.sh
mywidget_bash() {
READLINE_LINE="# This was written by a bash readline \"widget\""
}
mywidget_zsh() {
BUFFER="# This was written by a zsh zle widget"
}
mywidget_compat() {
__bindfunc_compat_wrapper mywidget_bash
}
mywidget_compat2() {
__bindfunc_compat_wrapper mywidget_zsh
}
bindfunc '\C-o' "mywidget_compat"
bindfunc '\C-p' "mywidget_compat2"
```
Just run `source example.sh` in your terminal and press `Control-O` or `Control-P` to see it in practice.
There is a second `example_revert.sh` that shows how you can revert the bindings.
1) activate the bindings by running `source example_revert.sh`
1) press `Control-R` or `Control-P` to use them
1) revert the bindings with `eval $revert_ctrl_r` and `eval $revert_ctrl_p`
There is yet another example `example_keymaps.sh` that shows how to bind to a specific keymap.
## Dependencies
bash 4.3+
Pretty much only OS that ships with bash older than this is macOS with bash 3.2.57
zsh supports widgets since forever