Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/b0o/zsh-extras
Extra completions and functions for zsh!
https://github.com/b0o/zsh-extras
arch-linux neovim pacman vim zsh zsh-completions
Last synced: 3 days ago
JSON representation
Extra completions and functions for zsh!
- Host: GitHub
- URL: https://github.com/b0o/zsh-extras
- Owner: b0o
- License: mit
- Created: 2021-04-24T09:54:09.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2021-06-13T03:01:10.000Z (over 3 years ago)
- Last Synced: 2024-12-16T20:24:15.257Z (about 2 months ago)
- Topics: arch-linux, neovim, pacman, vim, zsh, zsh-completions
- Language: Shell
- Homepage:
- Size: 36.1 KB
- Stars: 3
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# zsh-extras
## general
The following general helper functions are included:
| File | Usage | Mnemonic | Description |
| ----------------------------- | --------------------- | -------------------------- | ----------------------------------------------------------------------------------------------------------------- |
| [`mg`](/functions/mg) | `mg ` | _**m**an **g**rep_ | Search inside of all manpages found in your `MANPATH` (requires [ripgrep](https://github.com/BurntSushi/ripgrep)) |
| [`putfn`](/functions/putfn) | `putfn ` | _**put** **f**u**n**ction_ | Puts the source of `` into the file ``. Useful for quickly saving interactively-defined functions |
| [`_putfn`](/functions/_putfn) | | | Provides completions for the putfn function |
## pacman
The following pacman-related helper functions are included:
| File | Usage | Mnemonic | Description |
| --------------------------------------------- | ------------------------- | ----------------------------------------------- | --------------------------------------------------- |
| [`pacopen`](/functions/pacopen) | `pacopen ` | _**pac**man **open**_ | Open the URL associated with `` |
| [`pqlm`](/functions/pqlm) | `pqlm ..` | _**p**acman **q**uery **l**ist **m**anpages_ | List man pages owned by `..` |
| [`pqlmg`](/functions/pqlmg) | `pqlmg ..` | _**pqlm** **g**rep_ | Search inside all man pages owned by `..` |
| [`pqlx`](/functions/pqlx) | `pqlx ..` | _**p**acman **q**uery **l**ist e**x**ecutables_ | List executable files owned by `..` |
| [`pqoc`](/functions/pqoc) | `pqoc ..` | _**p**acman **q**uery **o**wner of **c**ommand_ | Show the package that owns `..` |
| [`_pacman_extras`](/functions/_pacman_extras) | | | Provides completions for the other pacman functions |
## vim-help
https://user-images.githubusercontent.com/21299126/115955030-142f3b00-a4a9-11eb-9595-4d940e7f2adf.mp4
The following vim-related helper functions are included:
| File | Usage | Description |
| ----------------------------------- | ----------------------- | ------------------------------------------------------------- |
| [`nvim-help`](/functions/nvim-help) | `nvim-help ..` | Open the neovim help tag (like running `:h `) in neovim. |
| [`vim-help`](/functions/vim-help) | `vim-help ..` | Open the vim help tag (like running `:h `) in vim. |
| [`_vim-help`](/functions/_vim-help) | | Provides completions for the other vim functions |
The [`vim-help`](/functions/vim-help) and [`nvim-help`](/functions/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`](/functions/_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`:
```zsh
alias vh=nvim-help
```
## Installation
#### antigen
```zsh
antigen bundle 'b0o/zsh-extras'
```
#### zinit
```zsh
zinit ice wait'0b' lucid # Optional: enable lazy loading
zinit light 'b0o/zsh-extras'
```
#### zplug
```zsh
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:
```zsh
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:
```zsh
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