Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/yuki-yano/zeno.zsh
zsh fuzzy completion and utility plugin with Deno.
https://github.com/yuki-yano/zeno.zsh
deno fzf typescript zsh
Last synced: 5 days ago
JSON representation
zsh fuzzy completion and utility plugin with Deno.
- Host: GitHub
- URL: https://github.com/yuki-yano/zeno.zsh
- Owner: yuki-yano
- License: mit
- Created: 2021-04-21T01:52:13.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-09-07T00:23:29.000Z (about 2 months ago)
- Last Synced: 2024-10-15T18:44:07.976Z (19 days ago)
- Topics: deno, fzf, typescript, zsh
- Language: TypeScript
- Homepage:
- Size: 179 KB
- Stars: 166
- Watchers: 1
- Forks: 9
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 
zsh fuzzy completion and utility plugin with [Deno](https://deno.land/).
## Features
- Insert snippet and abbrev snippet
- Completion with fzf
- Builtin git completion
- User defined completion
- ZLE utilities
## Demo
### Abbrev snippet
### Completion with fzf
## Requirements
- [Deno](https://deno.land/) latest
- [fzf](https://github.com/junegunn/fzf)
## Installation
### zinit
```zsh
zinit ice lucid depth"1" blockf
zinit light yuki-yano/zeno.zsh
```
### git clone
```sh
$ git clone https://github.com/yuki-yano/zeno.zsh.git
$ echo "source /path/to/dir/zeno.zsh" >> ~/.zshrc
```
## Usage
### Abbrev snippet
Require [user configuration file](#user-configuration-file-example)
```sh
$ gs
Insert
$ git status --short --branch
```
```sh
$ gs
Execute
$ git status --short --branch
```
### Completion
```sh
$ git add
Git Add Files> ...
```
### Insert snippet
Use zeno-insert-snippet zle
### Search history
Use zeno-history-completion zle
### Change ghq managed repository
Use zeno-ghq-cd zle
## Configuration example
### Completion and abbrev snippet
```zsh
# if defined load the configuration file from there
# export ZENO_HOME=~/.config/zeno
# if disable deno cache command when plugin loaded
# export ZENO_DISABLE_EXECUTE_CACHE_COMMAND=1
# if enable fzf-tmux
# export ZENO_ENABLE_FZF_TMUX=1
# if setting fzf-tmux options
# export ZENO_FZF_TMUX_OPTIONS="-p"
# Experimental: Use UNIX Domain Socket
export ZENO_ENABLE_SOCK=1
# if disable builtin completion
# export ZENO_DISABLE_BUILTIN_COMPLETION=1
# default
export ZENO_GIT_CAT="cat"
# git file preview with color
# export ZENO_GIT_CAT="bat --color=always"
# default
export ZENO_GIT_TREE="tree"
# git folder preview with color
# export ZENO_GIT_TREE="exa --tree"
if [[ -n $ZENO_LOADED ]]; then
bindkey ' ' zeno-auto-snippet
# fallback if snippet not matched (default: self-insert)
# export ZENO_AUTO_SNIPPET_FALLBACK=self-insert
# if you use zsh's incremental search
# bindkey -M isearch ' ' self-insert
bindkey '^m' zeno-auto-snippet-and-accept-line
bindkey '^i' zeno-completion
bindkey '^x ' zeno-insert-space
bindkey '^x^m' accept-line
bindkey '^x^z' zeno-toggle-auto-snippet
# fallback if completion not matched
# (default: fzf-completion if exists; otherwise expand-or-complete)
# export ZENO_COMPLETION_FALLBACK=expand-or-complete
fi
```
### ZLE widget
```zsh
if [[ -n $ZENO_LOADED ]]; then
bindkey '^r' zeno-history-selection
bindkey '^x^s' zeno-insert-snippet
bindkey '^x^f' zeno-ghq-cd
fi
```
## Builtin completion
- git
- add
- diff
- diff file
- checkout
- checkout file
- switch
- reset
- reset file
- restore
- fixup and squash commit
- rebase
- merge
See: https://github.com/yuki-yano/zeno.zsh/blob/main/src/completion/source/git.ts
## User configuration file
The configuration file is searched from the following.
- `$ZENO_HOME/config.yml`
- `$XDG_CONFIG_HOME/zeno/config.yml` or `~/.config/zeno/config.yml`
- Find `.../zeno/config.yml` from each in `$XDG_CONFIG_DIRS`
### Example
```sh
$ touch ~/.config/zeno/config.yml
```
and
```yaml
snippets:
# snippet and keyword abbrev
- name: git status
keyword: gs
snippet: git status --short --branch
# snippet with placeholder
- name: git commit message
keyword: gcim
snippet: git commit -m '{{commit_message}}'
- name: "null"
keyword: "null"
snippet: ">/dev/null 2>&1"
# auto expand condition
# If not defined, it is only valid at the beginning of a line.
context:
# buffer: ''
lbuffer: '.+\s'
# rbuffer: ''
- name: branch
keyword: B
snippet: git symbolic-ref --short HEAD
context:
lbuffer: '^git\s+checkout\s+'
evaluate: true # eval snippet
completions:
# simple sourceCommand, no callback
- name: kill signal
patterns:
- "^kill -s $"
sourceCommand: "kill -l | tr ' ' '\\n'"
options:
--prompt: "'Kill Signal> '"
# use excludePatterns and callback
- name: kill pid
patterns:
- "^kill( .*)? $"
excludePatterns:
# -l, -n or -s is followed by SIGNAL instead of PID
- " -[lns] $"
sourceCommand: "LANG=C ps -ef | sed 1d"
options:
--multi: true
--prompt: "'Kill Process> '"
callback: "awk '{print $2}'"
# Use null (\0) termination Input / Output
- name: chdir
patterns:
- "^cd $"
sourceCommand: "find . -path '*/.git' -prune -o -maxdepth 5 -type d -print0"
options:
# Added --read0 if null termination is used in `sourceCommand` output.
--read0: true
--prompt: "'Chdir> '"
--preview: "cd {} && ls -a | sed '/^[.]*$/d'"
callback: "cut -z -c 3-"
callbackZero: true # null termination is used in `callback` I/O
```
## FAQ
Q: [zsh-syntax-highlighting](https://github.com/zsh-users/zsh-syntax-highlighting) does not work well.
A: Use [fast-syntax-highlighting](https://github.com/zdharma-continuum/fast-syntax-highlighting) instead.
## Related project
- [fzf](https://github.com/junegunn/fzf)
- [fzf-tab](https://github.com/Aloxaf/fzf-tab)
- [fzf-zsh-completions](https://github.com/chitoku-k/fzf-zsh-completions)
- [pmy](https://github.com/relastle/pmy/)
- [zabrze](https://github.com/Ryooooooga/zabrze)