zsh fuzzy completion and utility plugin with Deno.
Features
- Insert snippet and abbrev snippet
- Completion with fzf
- Builtin git completion
- User defined completion
- ZLE utilities
Demo
Abbrev snippet
Completion with fzf
Requirements
Installation
zinit
zinit ice lucid depth"1" blockf
zinit light yuki-yano/zeno.zshgit clone
$ git clone https://github.com/yuki-yano/zeno.zsh.git
$ echo "source /path/to/dir/zeno.zsh" >> ~/.zshrcUsage
Abbrev snippet
Require user configuration file
$ gs<Space>
Insert
$ git status --short --branch$ gs<Enter>
Execute
$ git status --short --branchCompletion
$ git add <Tab>
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
# 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
fiZLE widget
if [[ -n $ZENO_LOADED ]]; then
bindkey '^r' zeno-history-selection
bindkey '^x^s' zeno-insert-snippet
bindkey '^x^f' zeno-ghq-cd
fiBuiltin 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.ymlor~/.config/zeno/config.yml- Find
.../zeno/config.ymlfrom each in$XDG_CONFIG_DIRS
Example
$ touch ~/.config/zeno/config.ymland
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/OFAQ
Q: zsh-syntax-highlighting does not work well.
A: Use fast-syntax-highlighting instead.