https://github.com/ryooooooga/zabrze
zsh abbreviation expansion plugin
https://github.com/ryooooooga/zabrze
zle-widgets zsh zsh-plugin zsh-plugins
Last synced: 3 months ago
JSON representation
zsh abbreviation expansion plugin
- Host: GitHub
- URL: https://github.com/ryooooooga/zabrze
- Owner: Ryooooooga
- License: mit
- Created: 2021-08-14T08:38:22.000Z (almost 5 years ago)
- Default Branch: main
- Last Pushed: 2024-10-12T14:04:32.000Z (over 1 year ago)
- Last Synced: 2025-03-30T12:06:48.089Z (about 1 year ago)
- Topics: zle-widgets, zsh, zsh-plugin, zsh-plugins
- Language: Rust
- Homepage:
- Size: 174 KB
- Stars: 40
- Watchers: 3
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# zabrze
[](https://github.com/Ryooooooga/zabrze/actions/workflows/build.yml)
[](https://crates.io/crates/zabrze)
ZSH abbreviation expansion plugin
## Usage
### Simple abbreviation
```toml
# ~/.config/zabrze/config.toml
[[snippets]]
name = "git"
trigger = "g"
snippet = "git"
[[snippets]]
name = "awk '{print $1}'"
trigger = ".1"
snippet = "awk '{print $1}'"
```
```zsh
$ eval "$(zabrze init --bind-keys)"
```
then
```zsh
$ g
# ↓ expanded
$ git
$ cat a.txt | .1
# ↓ expanded and executed
$ cat a.txt | awk '{print $1}'
```
### Global abbreviation
```toml
[[snippets]]
name = ">/dev/null 2>&1"
trigger = "null"
snippet = ">/dev/null 2>&1"
global = true
```
```zsh
$ echo a null
# ↓ expanded
$ echo a >/dev/null 2>&1
```
### Global abbreviation with context
```toml
[[snippets]]
name = "git commit"
trigger = "c"
snippet = "commit"
global = true
context = '^git\s'
[[snippets]]
name = "git commit -m"
trigger = "cm"
snippet = "commit -m '{}'"
cursor = "{}" # optional; defaults to "{}"
global = true
context = '^git\s'
[[snippets]]
name = "branch name"
trigger = "B"
snippet = "$(git symbolic-ref --short HEAD)"
evaluate = true
global = true
context = '^git\s'
```
```zsh
$ git c
# ↓ expanded
$ git commit
$ git cm
# ↓ expanded and move into quotes
$ git commit -m '|'
$ git push -d origin B
# ↓ expanded and executed
$ git push -d origin main
```
### Conditional abbreviation
```toml
[[snippets]]
name = "chrome"
trigger = "chrome"
snippet = "open -a 'Google Chrome'"
if = '[[ "$OSTYPE" =~ darwin ]]' # only available in macOS
[[snippets]]
name = "trash"
trigger = "rm"
snippet = "trash"
if = "(( ${+commands[trash]} ))" # available if trash is installed
[[snippets]]
name = "rm -r"
trigger = "rm"
snippet = "rm -r" # fallback
```
### Suffix alias
```toml
[[snippets]]
name = "python3 *.py"
trigger-pattern = '^(?.+\.py)$'
snippet = "python3 $file"
evaluate = true
# or
[[snippets]]
name = "python3 *.py"
trigger-pattern = '\.py$'
snippet = "python3 $trigger"
evaluate = true
```
```zsh
$ ./a.py
# ↓ expanded and executed
$ python3 ./a.py
```
## Installation
### From prebuilt binary
You can download a binary release [here](https://github.com/Ryooooooga/zabrze/releases).
### zinit
```zsh
zinit blockf light-mode as"program" from"gh-r" for \
atload'eval "$(zabrze init --bind-keys)"' \
Ryooooooga/zabrze
```
### Cargo
```zsh
$ cargo install zabrze
```
### Homebrew
```zsh
$ brew install ryooooooga/tap/zabrze
```
## Configuration
> ⚠️ **Note:** YAML configuration format is deprecated. Please use TOML instead.
zabrze reads configuration files from the following locations:
- `$ZABRZE_CONFIG_HOME` if set, otherwise `$XDG_CONFIG_HOME/zabrze` (defaults to `$HOME/.config/zabrze`)
- Configuration files are read in lexicographical order.
- Supported file extensions are `toml` (recommended), `yaml` (deprecated), and `yml` (deprecated).
The configuration file (TOML) defines a list of abbreviations. Each abbreviation has the following properties:
- `name` (string): A descriptive name for the abbreviation.
- `trigger` (string, required, mutually exclusive with `trigger-pattern`): The abbreviation to expand.
- `trigger-pattern` (string, required, mutually exclusive with `trigger`): A regular expression to match the abbreviation.
- `snippet` (string, required): The text to replace the abbreviation with.
- `global` (boolean): A boolean value indicating whether the abbreviation should be expanded globally. Defaults to `false`.
- `context` (string): A regular expression that must match the beginning of the line for the abbreviation to be expanded.
- `evaluate` (boolean): A boolean value indicating whether the snippet should be evaluated as a shell command. Defaults to `false`.
- `if` (string): A conditional expression that must evaluate to true for the abbreviation to be expanded.
- `cursor` (string or `null`): A string that specifies the cursor position after expansion. Defaults to `{}`.
- `abort-on-error` (boolean): **Experimental:** When `evaluate` is `true`, this option controls the behavior when a command inside the snippet fails. If `true`, the snippet expansion will be aborted if the command substitution fails. Defaults to `false`.
## Alternatives
- [zsh-abbrev-alias](https://github.com/momo-lab/zsh-abbrev-alias)
- [zeno.zsh](https://github.com/yuki-yano/zeno.zsh)