b0o / zsh-extras

Extra completions and functions for zsh!

zsh-extras

general

The following general helper functions are included:

File	Usage	Mnemonic	Description
mg	mg <pat>	man grep	Search inside of all manpages found in your MANPATH (requires ripgrep)
putfn	putfn <func> <dest>	put function	Puts the source of <func> into the file <dest>. Useful for quickly saving interactively-defined functions
_putfn			Provides completions for the putfn function

pacman

The following pacman-related helper functions are included:

File	Usage	Mnemonic	Description
pacopen	pacopen <package>	pacman open	Open the URL associated with <package>
pqlm	pqlm <package>..	pacman query list manpages	List man pages owned by <package>..
pqlmg	pqlmg <pat> <package>..	pqlm grep	Search inside all man pages owned by <package>..
pqlx	pqlx <package>..	pacman query list executables	List executable files owned by <package>..
pqoc	pqoc <command>..	pacman query owner of command	Show the package that owns <command>..
_pacman_extras			Provides completions for the other pacman functions

vim-help

vim-help.mp4

The following vim-related helper functions are included:

File	Usage	Description
nvim-help	nvim-help <helptag>..	Open the neovim help tag (like running :h <tag>) in neovim.
vim-help	vim-help <helptag>..	Open the vim help tag (like running :h <tag>) in vim.
_vim-help		Provides completions for the other vim functions

The vim-help and nvim-help zsh functions launch {,neo}vim directly from the shell into the help view for the given help tags, one per tab.

The _vim-help file adds completions for the {,n}vim-help functions for all vim help tags found on your system.

As a Neovim user, I also like to alias nvim-help to vh:

alias vh=nvim-help

Installation

antigen

antigen bundle 'b0o/zsh-extras'

zinit

zinit ice wait'0b' lucid # Optional: enable lazy loading
zinit light 'b0o/zsh-extras'

zplug

zplug 'b0o/zsh-extras'

oh-my-zsh

Clone the repository inside your oh-my-zsh repo:

$ git clone https://github.com/b0o/zsh-extras "${ZSH_CUSTOM:=~/.oh-my-zsh/custom}/plugins/zsh-extras"

Enable it in your zshrc by adding it to your plugin list and reloading the completion:

plugins=(… 'zsh-extras')
autoload -U compinit && compinit

Manual installation

Clone the repository:

$ git clone git://github.com/b0o/zsh-extras.git

Then, either source the zsh-extras.plugin.zsh in your zshrc:

source "path/to/zsh-extras/zsh-extras.plugin.zsh"

Or, include the functions directory in your $fpath and autoload the non-completion functions:

fpath+=("path/to/zsh-extras/functions")

# Autoload non-completion functions
for f in path/to/zsh-extras/functions/[^_]*
  autoload -Uz "$(basename "$f")"
done

You may have to force rebuild zcompdump:

$ rm -f ~/.zcompdump; compinit

If you only want to install a subset of scripts, please note that some scripts depend on others.

License

© 2021 Maddison Hellstrom

MIT License