Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/NICHOLAS85/z-a-eval
A Zsh-Zinit annex (i.e. an extension), which caches arbitrarily slow command output to speed up shell startup.
https://github.com/NICHOLAS85/z-a-eval
shell-plugin shell-script terminal zinit zinit-annex zsh zsh-plugin
Last synced: about 10 hours ago
JSON representation
A Zsh-Zinit annex (i.e. an extension), which caches arbitrarily slow command output to speed up shell startup.
- Host: GitHub
- URL: https://github.com/NICHOLAS85/z-a-eval
- Owner: NICHOLAS85
- License: other
- Created: 2021-03-05T12:09:02.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2023-02-28T16:24:29.000Z (over 1 year ago)
- Last Synced: 2024-08-02T13:29:30.210Z (3 months ago)
- Topics: shell-plugin, shell-script, terminal, zinit, zinit-annex, zsh, zsh-plugin
- Language: Shell
- Homepage:
- Size: 50.8 KB
- Stars: 22
- Watchers: 3
- Forks: 7
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
**Table of Contents** *generated with [DocToc](https://github.com/thlorenz/doctoc)*
- [z-a-eval](#z-a-eval)
- [Introduction](#introduction)
- [Installation](#installation)
- [How it works](#how-it-works)
- [Ice Modifiers Provided By The Annex](#ice-modifiers-provided-by-the-annex)
- [1. **`eval'[!]{command}…'`**](#1-evalcommand)
- [Example Invocations](#example-invocations)
- [Additional Zinit commands](#additional-zinit-commands)
- [Zinit tab completion support](#zinit-tab-completion-support)
# z-a-eval
## Introduction
A Zsh-Zinit annex (i.e. an extension) that provides functionality, which
allows to:
1. Cache the output of arbitrarily slow initialization command to speed up shell startup time.
## Installation
Simply load like a regular plugin, i.e.:
```zsh
zinit light NICHOLAS85/z-a-eval
```
After executing this command you can then use the new ice-mods provided by
the annex.
## How it works
The output of a slow initialization command is redirected to a file located within the plugin/snippets directory and sourced while loading. The next time the plugin/snippet is loaded, this file will be sourced skipping the need to run the initialization command.
## Ice Modifiers Provided By The Annex
There is 1 ice-modifier provided and handled by this annex. They are:
1. `eval''` – creates a `cache` containing the output of a command.
**The ice-modifier in detail:**
---
### 1. **`eval'[!]{command}…'`**
It creates a `cache` in the plugin/snippets root directory which stores the commands output. This cache is regenerated when:
- The plugin/snippet is updated.
- The cache file is removed.
- With the new Zinit subcommand `recache`.
The optional preceding `!` flag means to store command output regardless of exit code. Otherwise `eval''` will avoid caching ouput of code which returns a non-zero exit code.
## Example Invocations
```zsh
## Without z-a-eval
zinit ice as"command" from"gh-r" mv"zoxide* -> zoxide" \
atclone"./zoxide init zsh > init.zsh" atpull"%atclone" src"init.zsh" nocompile'!'
zinit light ajeetdsouza/zoxide
## With z-a-eval
zinit ice as"command" from"gh-r" mv"zoxide* -> zoxide" \
eval"./zoxide init zsh"
zinit light ajeetdsouza/zoxide
```
```zsh
## Without z-a-eval
zinit ice atclone"dircolors -b LS_COLORS > init.zsh" \
atpull"%atclone" pick"init.zsh" nocompile'!' \
atload'zstyle ":completion:*" list-colors “${(s.:.)LS_COLORS}”'
zinit light trapd00r/LS_COLORS
## With z-a-eval
zinit ice eval"dircolors -b LS_COLORS" \
atload'zstyle ":completion:*" list-colors “${(s.:.)LS_COLORS}”'
zinit light trapd00r/LS_COLORS
```
```zsh
## Without Zinit
if [[ "${+commands[kubectl]}" == 1 ]]; then
eval $(kubectl completion zsh)
fi
## With Zinit and z-a-eval
## Updated during `zinit update`
zinit ice id-as"kubectl_completion" has"kubectl" \
eval"kubectl completion zsh" run-atpull
zinit light zdharma/null
```
See https://github.com/NICHOLAS85/z-a-eval/issues/2#issuecomment-793374468 for more examples.
# Additional Zinit commands
There's an additional Zinit command that's provided by this annex
–`recache`. It recaches all your plugins/snippets eval outputs on demand. Useful for when you change the value of the `eval''` ice but do not want to redownload the plugin/snippet to update its ices, or rm the cache manually:
Available options are:
```zsh
zinit recache [plugin/snippet]
```
When run without an argument, it will iterate through all plugin/snippets who have caches and regenerate them based on the current value of `eval''`. If `eval''` is missing, it will simply delete the cache file.
When run with a plugin/snippet argument, it will only regenerate that single plugin/snippets cache based on the current value of `eval''`.
# Zinit tab completion support
Zinit currently does not support extending the subcommands available via tab completion. I however, have implemented experimental support for this which should be duplicable across any annex.
In order to enable tab completion for the new subcommand set the value `Z_A_USECOMP=1` somewhere **before** loading this plugin. For example:
```zsh
zinit atinit'Z_A_USECOMP=1' light-mode for NICHOLAS85/z-a-eval
```
If you're interested in seeing how it works some more detail can be seen at the bottom of `z-a-eval.plugin.zsh`. I'd love to hear feedback on its implementation.