DEV Community: ❮ ZI ❯

✨〰️A Swiss Army Knife for Zsh〰️Unix Shell〰️✨

❮ ZI ❯ — Tue, 31 May 2022 07:54:58 +0000

❮ ZI ❯ 🧙‍‍♀️ A Swiss Army Knife for Zsh.

Designed to glue everything together. 🔗

https://z.digitalclouds.dev | GitHub | Discussions | Localize

⚡️ Fast and feature-rich

✴️ 🌀Meta-plugins installs a group of complex plugins via a simple label, curated and optimal settings which are automatically applied.

✴️ 🌀Packages offloads from complex configurations and stores them as an easy to swap & share profiles.

✴️ 🌀Annexes are extensions that are installed when required to provide additional functionality, and capabilities.

✴️ 🌀Turbo mode yields 50–80% faster Zsh startup, just because no one likes to wait for someone :)

🥵 Currently biggest issue is that it seems to be too complex for new users and recently made some adjustments which are now starting to provide the results.

☑️ Neat and flexible

✴️ Customize the paths, use multiple prompts in the same sessions by setting the triggers or create your own plugins to simplify or improve the routine.

✴️ Supports Oh My Zsh and Prezto plugins and libraries. ( migration).

✴️ Does not use $FPATH , loading multiple plugins doesn't clutter $FPATH with the same number of entries, e.g: 10, 15, even, or more.

✴️ Code is immune to KSH_ARRAYS and other options, which typically cause compatibility problems.

✴️ Do not require sudo , and provide many ways & workarounds to set up a clean and safe environment. e.g: setting so-called shims locally.

If there is something that is not supported yet, I am pretty confident that if there will be reasonable demand - it will be implemented. 🔨

📈 Familiarize and control

✴️ Quickly familiarize oneself with a new plugin and provides rich and easy-to-digest information that might be helpful on various occasions.

✴️ Load, unload plugins when required, use the ability to manage completions.

✴️ Docker playground to test, view, or propose configurations.

✴️ 💫Gallery of the user favorites.

Is only limited to your own 🤦‍♂️ imagination… 🧙‍‍♀️ We need the support to make it better and more approachable to new users, become a 💞 friend of the DEV 💞, and more ☁️ cloud-native ☁️.

❮ ZI ❯ Vim Syntax

❮ ZI ❯ — Thu, 28 Apr 2022 08:52:00 +0000

❮ ZI ❯ Vim Syntax

Wiki | GitHub | Discussions | Localize

A Vim syntax definition for ZI commands in any file of type zsh.

Installation

Load as a Vim plugin. E.g. when using vim-plug, add to ~/.vimrc:

Plug 'z-shell/zi-vim-syntax'

and then issue the :PlugInstall command.

Manual Installation

To install the syntax copy the file after/syntax/zsh.vim under the path ~/.vim/syntax/after.

Examples

The default theme:

The theme flrnprz/plastic.vim:

The theme slate:

The theme murphy:

The theme lucasprag/simpleblack:

🚀 Valgrind automatic test suite

❮ ZI ❯ — Mon, 18 Apr 2022 11:55:00 +0000

❮ ZI ❯ - VATS

Valgrind automatic test suite

Wiki | GitHub | Discussions | Localize

Runs sequence of tests, preceded by valgrind call, with a command and arguments taken from file vtest.conf.

The arguments are dynamic because the vtest.conf entry can look like this:

# Arguments passed to $test_bin, evaluated at use (i.e. for each test separately)
test_bin_args='+Z -f $ZTST_srcdir/ztst.zsh $file'   # runs ztst.zsh on given $file
test_bin="local-zsh"                                # expands to ../Src/zsh

The variable $file is set to current test-file for each test-run. For Zsh-integrated valgrind tests, $file is just passed as argument to ztst.zsh. It comes from the outer loop in vruntests.zsh. So it is A01grammar.ztst, for example.

Error Definitions

You can define errors so that they are skipped from test result (i.e. from Valgrind output). This is
the main feature of VATS because it allows to quickly check if changes broke anything. Usage is very
much like of unit tests – run make TESTNUM=A01, look for any red color, done. Zero parsing with
eyes. A typical definition for Zshell can look like this:

errors1+=( "* / zsh_main / setupvals / gettimeofday / *" )

and is placed in __error1.def or other such file with index.

Integrating With Project

Following patch applied to the Test/Makefile solves the integration of VATS to Zsh:

──────────────────────────────────────────────────────────────────────────────────────────
modified: Test/Makefile.in
──────────────────────────────────────────────────────────────────────────────────────────
@@ -35,6 +35,7 @@ VPATH           = @srcdir@
 sdir            = @srcdir@
 sdir_top        = @top_srcdir@
 INSTALL         = @INSTALL@
+VLGRND                 = $(VALGRIND:1=v)
 @DEFS_MK@
@@ -49,7 +50,7 @@ check test:
            do echo $$f; done`" \
         ZTST_srcdir="$(sdir)" \
         ZTST_exe=$(dir_top)/Src/zsh@EXEEXT@ \
-        $(dir_top)/Src/zsh@EXEEXT@ +Z -f $(sdir)/runtests.zsh; then \
+        $(dir_top)/Src/zsh@EXEEXT@ +Z -f $(sdir)/$(VLGRND)runtests.zsh; then \
         stat=0; \
        else \
         stat=1; \

Basic Test-Configuration

The configuration-file of tests is vtest.conf. It defines two settings:

test_bin="../Src/cgiturl"   # Binary that runs any test (is the tested program itself)
zsh_control_bin="zsh"       # Binary used when scheduling tests & interpreting Valgrind output

Variable zsh_control_bin is used to implement special #! behavior: runtests.zsh
starts with #!/bin/sh, reads vtest.conf, and restarts with $zsh_control_bin. This way
user can define shebang interpreter via separate configuration file (vtest.conf).

Remaining Test-Configuration

The setting tkind is used to set a test-kind. These are modes of Valgrind operation.
Allowed values are: error (only detect read/write errors), leak (also detect memory leaks),
nopossiblylost (detect memory leaks, but not possibly lost blocks).

test_kind="leak"             # Test kind: error, (leak|full - the same meaning), nopossiblylost

Valgrind messages of type summary and info are muted via lines:

summaries="no"               # show valgrind summaries?
info="no"                    # show info messages?

The vtest.conf pasted

# -*- Mode: sh; indent-tabs-mode: nil; -*-
# vim:ft=zsh:sw=4:sts=4:et
# Main
test_bin="local-zsh"         # Binary that runs any test (local-zsh: ../Src/zsh)
zsh_control_bin="zsh"        # Binary used when scheduling tests & interpreting Valgrind output
main_operation_parsing="yes" # The main feature, whether to use it (i.e. whether to parse valgrind's output)
valgrind_path="valgrind"     # Find the valgrind binary to run through $PATH
# Valgrind run modes
test_kind="leak"             # Test kind: error, (leak|full - the same meaning), nopossiblylost
track_origins="no"           # Whether to pass --track-origns=yes to valgrind binary
# Gating of Valgrind's and other output
summaries="no"               # Show valgrind summaries?
info="no"                    # Show info messages?
test_desc="yes"              # Whether to print Zsh test-description during operation
# DEBUG, especially interested_in="a-function" helps to check why e.g. your
# error definition that targets `a-function' doesn't match
mdebug="no"                  # Match-debug, use to debug error definition matching
interested_in=""             # As if mdebug=1 (i.e. debugging of why an error-def matches
                             # or not), but only active if: stack trace and error definition
                             # contain $interested_in
#interested_in="*mk*temp"    # Example value, will match error def:
                             # "* / (_|)mk(s|)temp / * / find_temp_path"
#interested_in="(*locale*|*fork*|*printf*)" # Other example value - debugging multiple error-defs at once
# Arguments passed to $test_bin (i.e. ../Src/zsh most of the time), evaluated
# at use (i.e. getting the value of $file will be done at each loop cycle).
test_bin_args='+Z -f $ZTST_srcdir/ztst.zsh $file'

🥷 A tool-chain that works for you and not against you

❮ ZI ❯ — Sun, 17 Apr 2022 07:54:58 +0000

❮ ZI ❯ _ 🧙‍‍♀️ _ A Swiss Army Knife for Zsh.
Designed to glue everything together.

z.digitalclouds.dev | GitHub | Discussions | Localize

⚡️ Fast and feature-rich

Meta plugins allow installing groups of plugins via a single, friendly label.
Packages offload the user from providing long and complex commands.
Annexes allow to extend the plugin manager with new commands.
Turbo mode yields 50-80% faster Zsh startup.

☑️ Neat and flexible

Customize paths, use multiple prompts or create your own plugins.
Supports Oh My Zsh and Prezto plugins and libraries. (migration).
Does not use $FPATH, loading multiple plugins doesn't clutter $FPATH with the same number of entries, e.g: 10, 15,
or more.
Code is immune to KSH_ARRAYS and other options typically causing compatibility problems.
Do not require sudo, and provide many workarounds e.g: setting so-called shims locally.

📈 Familiarize and control

Visualise data: aliases, functions, bindkeys, Zle widgets, zstyles, completions,
variables, $PATH, and $FPATH elements a plugin has set up.
Quickly familiarize oneself with a new plugin and provides rich and easy-to-digest information that might be helpful
on various occasions.
Load or unload plugins, use the ability to manage completions.
Docker playground, test or propose configurations, preview at
asciinema.org.
https://z.digitalclouds.dev/docs/gallery/collection

Limited to your own imagination... 🧙‍‍♀️

❮ ZI Annex - LinkBin ❯

❮ ZI ❯ — Sat, 09 Apr 2022 15:57:45 +0000

❮ ZI ❯ Annex - LinkBin

Run programs and scripts without adding anything to `$PATH` via the automated links to `$ZPFX/bin`

z.digitalclouds.dev | GitHub | Discussions | Localize

Install

zi light z-shell/z-a-linkbin

💡 Wiki

annexes

How it works

Exposing a binary program without modifying $PATH – z-a-linkbin will automatically create a hard or soft link to the binary in $ZPFX/bin exposing the program to the command line as if it were being placed in $PATH.

The command can then be accessed normally – not only in the live Zsh session, but also from any Zsh script.

The ice-modifier lbin'' provided by the annex creates links for binaries and scripts.

It creates the link that calls the actual binary.
The link is created always under the same, standard and single $PATH entry: $ZPFX/bin

The optional preceding ! flag means create a soft link instead of a hard link.

Example:

zi ice from'gh-r' lbin'!fzf'
zi load junegunn/fzf

Check the output:

ls -l $ZPFX/bin/ | awk '{print $(NF-2),$(NF-1),$NF}'
fzf --version

The ice can contain globs. It will expand these when searching for the binary.

Example:

zi ice from'gh-r' lbin'**fzf -> myfzf'
zi load junegunn/fzf

Check the output:

ls $ZPFX/bin
myfzf --version

The ice can be empty. It will then try to create the link:

trailing component of the id_as ice, e.g.: id_as'exts/git-my' → it will check if a file git-my exists and if yes, create the link git-my,
the plugin name, e.g.: for paulirish/git-open it'll check if a file git-open exists and if yes, create the link git-open,
trailing component of the snippet URL,
for any alphabetically first executable file.

Above also applies if just ! were passed.

This repository compatible with ZI.

Have the best and leave the rest!

❮ ZI Annex - Eval ❯

❮ ZI ❯ — Sat, 09 Apr 2022 09:09:29 +0000

❮ ZI ❯ Annex - Eval

Allows to cache the output of arbitrarily slow initialization command to speed up shell startup time.

z.digitalclouds.dev | GitHub | Discussions | Localize

Annex provides a completion file with the prefix _zi, the 'shim' below which will run all available zi completions and the shim is assigned as ZIs completion with a compdef call

Synopsis:

zi recache <plugin/snippet>

💡 Wiki

annexes

Installation

Simply load like a regular plugin:

zi light z-shell/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.

The ice-modifier eval'' provided and handled by this annex 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 ZI 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

Without z-a-eval

zi ice as"command" from"gh-r" mv"zoxide* -> zoxide"  \
  atclone"./zoxide init zsh > init.zsh"  atpull"%atclone" src"init.zsh" nocompile'!'
zi light ajeetdsouza/zoxide

zi ice atclone"dircolors -b LS_COLORS > init.zsh" \
  atpull"%atclone" pick"init.zsh" nocompile'!' \
  atload'zstyle ":completion:*" list-colors “${(s.:.)LS_COLORS}”'
zi light trapd00r/LS_COLORS

With z-a-eval

zi ice as"command" from"gh-r" mv"zoxide* -> zoxide" \
  eval"./zoxide init zsh"
zi light ajeetdsouza/zoxide

zi ice eval"dircolors -b LS_COLORS" \
  atload'zstyle ":completion:*" list-colors “${(s.:.)LS_COLORS}”'
zi light trapd00r/LS_COLORS

Without ZI

if [[ "${+commands[kubectl]}" == 1 ]]; then
  eval $(kubectl completion zsh)
fi

With ZI and z-a-eval

## Updated during `zi update`
zi ice id-as"kubectl_completion" has"kubectl" \
  eval"kubectl completion zsh" run-atpull
zi light z-shell/null

This repository compatible with ZI.

Have the best and leave the rest!

❮Doxygen For Shell Scripts❯

❮ ZI ❯ — Fri, 08 Apr 2022 02:57:04 +0000

z.digitalclouds.dev | GitHub | Discussions | Localize

If there was a tool that parses scripts and extracts comments so it can be documented, collaborated, or used as a manual? If all can be automated so you can concentrate on the code while docs are made on the go? We got your back...

Contribute to make it better and get extra tools from our projects which are shared between contributors.
Code-newbies with the right attitude is always welcome.

Doxygen For Shell Scripts**

Example of our Z Shell code - https://z.digitalclouds.dev/docs/code

Parses Zsh and Bash scripts, outputs Asciidoc document with:

list of functions, including auto-loading functions,
call trees of functions and script body,
comments for functions,
features used for each function and for script body (features like: eval, read, vared, shopt, etc.),
distinct marks for hooks registered with add-zsh-hook (Zsh),
list of exported variables,
list of used exported variables, together with the variable's origin (i.e. possibly another script).

Call trees support cross-file invocations, i.e. when a script calls a function defined in another file.

Written in Zshell language.

Installation

Default install path-prefix is /usr/local.

git clone https://github.com/z-shell/zsdoc
cd doc
make
sudo make install

For custom PREFIX variable in make invocation:

# 'sudo' may be required to install

make install PREFIX=~/opt/local
install -c -d ~/opt/local/share/zsdoc
install -c -d ~/opt/local/share/doc/zsdoc

cp build/zsd build/zsd-transform build/zsd-detect build/zsd-to-adoc ~/opt/local/bin
cp README.md NEWS LICENSE ~/opt/local/share/doc/zsdoc
cp zsd.config ~/opt/local/share/zsdoc

➜ cd ~/opt/local

➜ tree.
        ├── bin
        │   ├── zsd
        │   ├── zsd-detect
        │   ├── zsd-to-adoc
        │   └── zsd-transform
        │
        └── share
           ├── doc
           │   └── zsdoc
           │       ├── LICENSE
           │       ├── NEWS
           │       └── README.md
           │
           └── zsdoc
               └── zsd.config

Other available make variables are: INSTALL (to customize install command), BIN_DIR, SHARE_DIR, DOC_DIR.

Usage

zsd [-h/--help] [-v/--verbose] [-q/--quiet] [-n/--noansi] [--cignore <pattern>] {file1} [file2] ...

The files will be processed and their documentation will be generated in subdirectory `zsdoc' (with meta-data in subdirectory `data').

Options:
-h/--help      Usage information
-v/--verbose   More verbose operation-status output
-q/--quiet     No status messages
-n/--noansi    No colors in terminal output
--cignore      Specify which comment lines should be ignored
-f/--fpath     Paths are separated by: pointing to directories with functions
--synopsis     Text to be used in the SYNOPSIS section. Line break "... +\n", paragraph "...\n\n"
--scomm        Strip comment char "#" from function comments
--bash         Output is slightly tailored to Bash specifics (instead of Zsh specifics)

Example --cignore options:

--cignore '\#*FUNCTION:*{{{*'                 - ignore comments like # FUNCTION: usage {{{
--cignore '(\#*FUNCTION:*{{{*|\#*FUN:*{{{*)'  - also ignore comments like: # FUN: usage {{{

The file is parsed for synopsis block, which can be e.g.:
# synopsis {{{my synopsis, can be multi-line}}}

Another block that is parsed is commenting on environment variables. It consists of multiple
"VAR_NAME -> var description" lines and results in a table in the output AsciiDoc document.

Example:

# env-vars {{{
# PATH -> paths to executables
# MANPATH -> paths to manuals }}}

Change the default brace block-delimiters with --blocka, --blockb. Block body should be AsciiDoc.

Examples

example 1,
example 2
(also in PDF:
example 1,
example 2).

Few Rules

Few rules helping to use zsdoc in your project:

Write function comments before function. Empty lines between comment and function are allowed.
If you use special comments, e.g. vim (or emacs-origami) folds, you can ignore these lines with --cignore (see Usage).
If it's possible to avoid eval, then do that – zsdoc will analyze more code.
Currently, functions defined in functions are ignored, but this will change shortly.
I've greatly optimized the new Zsh version (5.4.2) for data processing – zsdoc parse long sources very fast starting from that Zsh version.
If you have multiple Zsh versions installed, then (for example) set zsh_control_bin="/usr/local/bin/zsh-5.4.2" in /usr/local/share/zsdoc/zsd.config.
Be aware that to convert a group of scripts, you simply need zsd file1.zsh file2.zsh ... – cross-file function invocations will work automatically, and multiple *.adoc files will be created.
Create Makefile with doc target, that does rm -rf zsdoc/data; zsd -v file1.zsh .... Documentation will land in zsdoc directory.
Directory zsdoc/data holds meta-data used to create asciidoc documents (*.adoc files). You can remove it or analyze it yourself.
Obtain PDFs with Asciidoctor tool via: asciidoctor -b pdf -r asciidoctor-pdf file1.zsh.adoc. Install Asciidoctor with: gem install asciidoctor-pdf --pre. (Check out ZI's Makefile.)
HTML: asciidoctor script.adoc.
Obtain manual pages with Asciidoc package via: a2x -L --doctype manpage --format manpage file1.zsh.adoc (asciidoc is a common package; its a2x command is little slow).
Github supports Asciidoc documents and renders them automatically.

❮ ZI Annex - Test ❯

❮ ZI ❯ — Thu, 07 Apr 2022 07:46:47 +0000

z.digitalclouds.dev | GitHub | Discussions | Localize

Run tests after install, setup your own or propose missing.
With always go like pro.

❮ ZI ❯ Annex - Test

An annex that runs tests via make or zunit

If any found – after installing and updating a plugin or snippet.

Install

Zunit install if missing:

zi for @zunit

zi light z-shell/z-a-test

Configuration

To run the tests in a verbose mode, issue:

zstyle :zi:annex:test quiet 0

before installing or updating the plugin. To skip tests for a single plugin,
add notest ice:

zi ice notest
zi load …

Examples

Example activation in the default quiet mode:

Example activation in non-quiet mode:

❮ ZI - Zsh String Lib ❯

❮ ZI ❯ — Thu, 31 Mar 2022 02:26:04 +0000

❮ ZI ❯ Zsh String Lib

https://z.digitalclouds.dev | GitHub | Twitter

JSON Parsing

❮ ZI ❯ has it's own ecosystem of packages, and here is how you can create your own - 'package.json'.

A string library for Zsh. Its founding function was parsing of JSON.

List Of The Functions

@str-parse-json

Parses the buffer ($1) with JSON and returns:

Fields for the given key ($2) in the given hash ($3).
The hash looks like follows:

   1/1 → strings at the level 1 of the 1st object
   1/2 → strings at the level 1 of the 2nd object
   …
   2/1 → strings at 2nd level of the 1st object
   …

The strings are parse-able with "${(@Q)${(@z)value}", i.e.: they're concatenated and quoted strings found in the JSON.

Example:

{
  "zi-ices": {
    "default": {
      "wait": "1",
      "lucid": "",
      "as": "program",
      "pick": "fzy",
      "make": ""
    },
    "bgn": {
      "wait": "1",
      "lucid": "",
      "as": "null",
      "make": "",
      "sbin": "fzy;contrib/fzy-*"
    }
  }
}

Will result in:

local -A Strings
Strings[1/1]="zi-ices"
Strings[2/1]="default $'\0'--object--$'\0' bgn $'\0'--object--$'\0'"
Strings[3/1]='wait 1 lucid \  as program pick fzy make \ '
Strings[3/2]='wait 1 lucid \  as null make \  sbin fzy\;contrib/fzy-\*'

So that when you e.g.: expect a key bgn but don't know at which position, you can do:

local -A Strings
@str-parse-json "$json" "zi-ices" Strings
integer pos
# (I) flag returns index at which the `bgn' string
# has been found in the array – the result of the
# (z)-split of the Strings[2/1] string
pos=${${(@Q)${(@z)Strings[2/1]}}[(I)bgn]}
if (( pos )) {
  local -A ices
  ices=( "${(@Q)${(@z)Strings[3/$(( (pos+1) / 2 ))]}}" )
  # Use the `ices' hash holding the values of the `bgn' object
  …
}

Note that the $'\0' is correctly dequoted by Q flag into the null byte.

Arguments:

The buffer with JSON.
The key in the JSON that should be mapped to the result (i.e.: it's possible to map only a subset of the input). It must be the first key in the object to map.
The name of the output hash parameter.

@str-read-all

Consumes whole data from given file descriptor and stores the string under the
given ($2) parameter, which is REPLY by default.

The reason to create this function is speed – it's much faster than read -d ''.

It can try hard to read the whole data by retrying multiple times (10 by
default) and sleeping before each retry (not done by default).

Arguments:

File descriptor (a number; use 1 for stdin) to be read from.
Name of output variable (default: REPLY).
Numer of retries (default: 10).
Sleep time after each retry (a float; default: 0).

Example:

exec {FD}< =( cat /etc/motd )
@str-read-all $FD
print -r -- $REPLY
…

@str-ng-match

Returns a non-greedy match of the given pattern ($2) in the given string ($1).

The string to match in.
The pattern to match in the string.

Return value:

$REPLY – the matched string, if found,
return code: 0 if there was a match found, otherwise 1.

Example:

if @str-ng-match "abb" "a*b"; then
  print -r -- $REPLY
fi
Output: ab

@str-ng-matches

Returns all non-greedy matches of the given pattern in the given list of
strings.

Input:

$1 … $n-1 - the strings to match in,
$n - the pattern to match in the strings.

Return value:

$reply – contains all the matches,
$REPLY - holds the first match,
return code: 0 if there was any match found, otherwise 1.

Example:

arr=( a1xx ayy a2xx )
if @str-ng-matches ${arr[@]} "a*x"; then
   print -rl -- $reply
fi
Outout:
a1x
a2x

@str-read-ini

Reads an INI file.

Arguments:

Path to the ini file to parse.
Name of output hash (INI by default).
Prefix for keys in the hash (can be empty).

Writes to given hash under keys built in following way: ${3}<section>_field.
Values are the values from the ini file.

@str-read-toml

Reads a TOML file with support for single-level array.

Path to the TOML file to parse.
Name of output hash (TOML by default).
Prefix for keys in the hash (can be empty).

Writes to given hash under keys built in following way: ${3}<section>_field.
Values are the values from the TOML file.

The values can be quoted and concatenated strings if they're an array. For
example:

[sec]
array = [ val1, "value 2", value&3 ]

Then the fields of the hash will be:

TOML[<sec>_array]="val1 value\ 2 value\&3"

To retrieve the array stored in such way, use the substitution "${(@Q)${(@z)TOML[<sec>_array]}}":

local -a array
array=( "${(@Q)${(@z)TOML[<sec>_array]}}" )

(The substitution first splits the input string as if Zsh would split it on the command line – with the (z) flag, and then removes one level of quoting with the (Q) flag).

@str-dump

Dumps the contents of the variable, whether it's being a scalar, an array or
a hash. The contents of the hash are sorted on the keys numerically, i.e.: by
using (on) flags.

An option -q can be provided: it'll enable quoting of the printed data with
the q-flag (i.e.: backslash quoting).

Basically, the function Is an alternative to declare -p, with a different
output format, more dump-like.

Arguments:

The name of the variable of which contents should be dumped.

Example:

array=( "" "a value" "test" )
@str-dump -q array

Output:

''
a\ value
test

typeset -A hash=( "a key" "a value" key value )
@str-dump -q hash

Output:

a\ key: a\ value
key: value

✨ ❮ Feature-rich Syntax Highlighting ❯

❮ ZI ❯ — Wed, 30 Mar 2022 07:21:00 +0000

Fast-Syntax-Highlighting Themes (Zshell)

Recursive fast-syntax-highlighting, highlights code passed to sh -c

Installation
- Manual
- ZI
Features
- Themes
- Variables
- Brackets
- Conditions
- Strings
- here-strings
- exec descriptor-variables
- for-loops and alternate syntax (brace {/} blocks)
- Function definitions
- Recursive eval and $( ) highlighting
- Chroma functions
- Math-mode highlighting
- Zcalc highlighting
Performance

Installation

Post install try: fast-theme -t z-shell. To enable: fast-theme z-shell.

Manual

Clone the Repository.

git clone https://github.com/z-shell/F-Sy-H ~/path/to/fsh

And add the following to your zshrc file.

source ~/path/to/fsh/F-Sy-H.plugin.zsh

ZI

Add the following to your zshrc file.

zi light z-shell/F-Sy-H

Here's an example of how to load the plugin together with a few other popular ones with the use of Turbo mode, i.e.: speeding up the Zsh startup by loading the plugin right after the first prompt, in background:

zi wait lucid for \
 atinit"ZI[COMPINIT_OPTS]=-C; zicompinit; zicdreplay" \
    z-shell/F-Sy-H \
 blockf \
    zsh-users/zsh-completions \
 atload"!_zsh_autosuggest_start" \
    zsh-users/zsh-autosuggestions

Features

Themes

Switch themes via fast-theme {theme-name}.

Run fast-theme -t {theme-name} option to obtain the snippet above.

Run fast-theme -l to list available themes.

Variables

Comparing to the project zsh-users/zsh-syntax-highlighting (the upper line):

Brackets

Conditions

Comparing to the project zsh-users/zsh-syntax-highlighting (the upper line):

Strings

Exact highlighting that recognizes quotings.

here-strings

`exec` descriptor-variables

Comparing to the project zsh-users/zsh-syntax-highlighting (the upper line):

for-loops and alternate syntax (brace `{`/`}` blocks)

Function definitions

Comparing to the project zsh-users/zsh-syntax-highlighting (the upper 2 lines):

Recursive `eval` and `$( )` highlighting

Comparing to the project zsh-users/zsh-syntax-highlighting (the upper line):

Chroma functions

Highlighting that is specific for a given command.

alt="image could not be loaded"
style="color:red;background-color:black;font-weight:bold" />

The chromas
that are enabled by default can be found
here.

Math-mode highlighting

Zcalc highlighting

Performance

Performance differences can be observed in this Asciinema recording, where a 10 kB function is being edited.

⚙️ ❮ Zsh-Py3-HTTP ❯ | Auto Spawned service

❮ ZI ❯ — Sun, 27 Mar 2022 22:16:33 +0000

❮ ZI ❯ Service - Py3HTTP

https://z.digitalclouds.dev | GitHub | Twitter

This Zsh service-plugin will serve given directory (plugin's directory by default) using Python's 3 HTTP server.

Install with ❮ ZI ❯

The service-plugin supports loading single plugin instance per all active Zsh sessions, in background.

zi ice service'py3http'
zi light z-shell/zservice-py3http

Explanation of Zsh-spawned services

First Zsh instance that will gain a lock will spawn the service.
Other Zsh instances will wait.
When you close the initial Zsh session, another Zsh will gain lock and resume the service.

⚙️ ❮ Gems & Node Modules With ZI ❯

❮ ZI ❯ — Sun, 27 Mar 2022 22:07:30 +0000

https://z.digitalclouds.dev | GitHub | Twitter

With use of the bin-gem-node annex you can install Ruby Gems and Node modules in an interesting way:

they'll be installed in the plugin's or snippet's directory,
an automatic function will be provided to run the binary that's provided by the package.

This has several benefits. For example, no $PATH alteration is required in the .zprofile file. Also, the package will be automatically updated on zi update. Plus, the installation will be isolated from other packages – multiple packages not be put in a single place.

An example ZI invocation that installs the remark tool that can be used to convert Markdown documents into man pages:

zi ice wait'2' lucid id-as'remark' node'remark <- !remark-cli; remark-man'
zi snippet /dev/null

It is snippet-based. An example plugin-based invocation:

zi ice wait'2' lucid id-as'remark' node'remark <- !remark-cli; remark-man'
zi load z-shell/null

It has an advantage – it will delete the remark function when unloading the plugin.

The exclamation-mark before !remark-cli is important – it causes the automatic function invoking the binary to be created.

More information can be found on the bin-gem-node annex page.

The command installs 2 node modules – remark-cli and remark-man (the backend for the remark converter – remark can convert also to other formats).

By using the exclamation-mark and the <- pointer it also requests the function that will run the remark binary to be created. The function has the following body:

remark () {
    local bindir="/root/.zi/plugins/remark/node_modules/.bin"
        local -x NODE_PATH="/root/.zi/plugins/remark2"/node_modules
        "$bindir"/"remark" "$@"
}

As it can be seen it ultimately provides the remark tool to the command line.

DEV Community: ❮ ZI ❯

✨〰️A Swiss Army Knife for Zsh〰️Unix Shell〰️✨

❮ ZI ❯ 🧙‍‍♀️ A Swiss Army Knife for Zsh.

⚡️ Fast and feature-rich

☑️ Neat and flexible

📈 Familiarize and control

❮ ZI ❯ Vim Syntax

❮ ZI ❯ Vim Syntax

Installation

Manual Installation

Examples

🚀 Valgrind automatic test suite

❮ ZI ❯ - VATS

Valgrind automatic test suite

Error Definitions

Integrating With Project

Basic Test-Configuration

Remaining Test-Configuration

The vtest.conf pasted

🥷 A tool-chain that works for you and not against you

❮ ZI ❯ _ 🧙‍‍♀️ _ A Swiss Army Knife for Zsh. Designed to glue everything together.

⚡️ Fast and feature-rich

☑️ Neat and flexible

📈 Familiarize and control

❮ ZI Annex - LinkBin ❯

❮ ZI ❯ Annex - LinkBin

Run programs and scripts without adding anything to $PATH via the automated links to $ZPFX/bin

Install

💡 Wiki

How it works

❮ ZI Annex - Eval ❯

❮ ZI ❯ Annex - Eval

Allows to cache the output of arbitrarily slow initialization command to speed up shell startup time.

💡 Wiki

Installation

How it works

Example Invocations

Without z-a-eval

With z-a-eval

Without ZI

With ZI and z-a-eval

❮Doxygen For Shell Scripts❯

Doxygen For Shell Scripts**

Installation

Usage

Examples

Few Rules

❮ ZI Annex - Test ❯

Install

Configuration

Examples

❮ ZI - Zsh String Lib ❯

❮ ZI ❯ Zsh String Lib

JSON Parsing

List Of The Functions

@str-parse-json

@str-read-all

@str-ng-match

@str-ng-matches

@str-read-ini

@str-read-toml

@str-dump

✨ ❮ Feature-rich Syntax Highlighting ❯

Fast-Syntax-Highlighting Themes (Zshell)

Recursive fast-syntax-highlighting, highlights code passed to sh -c

Installation

Manual

ZI

Features

Themes

Variables

Brackets

Conditions

Strings

here-strings

exec descriptor-variables

for-loops and alternate syntax (brace {/} blocks)

Function definitions

Recursive eval and $( ) highlighting

Chroma functions

❮ ZI ❯ _ 🧙‍‍♀️ _ A Swiss Army Knife for Zsh.
Designed to glue everything together.

Run programs and scripts without adding anything to `$PATH` via the automated links to `$ZPFX/bin`

`exec` descriptor-variables

for-loops and alternate syntax (brace `{`/`}` blocks)

Recursive `eval` and `$( )` highlighting