History

yage fec8c5e560 basic runner format; write a MAIN function introduce --verbosity flag rather than mixed logging settings; correct color misnaming to ANSI convention; added sanity-check; simplified hello-world; created FZF_USER_INPUT to replace the confusing FZF_HEAD and FZF_TAIL swap INFO for DEBUG v3-to-v4 upgrade docs bring some much-needed tender love and care to the scwrypts runner improved i/o handling on the run executable means this is no longer relevant FINALLY fix the weird cases for zsh/read builtin (particularly around reading one character from tty/pipe/file); also gave a --force-user-input flag in case you want to require user input on a yn prompt update ZLE plugin so it no more make errors FZF_(HEAD\|TAIL) refactor to FZF_USER_INPUT plugins/kubectl migration from v3 to v4 plugins/ci migration from v3 to v4 refactor py/lib into python-scwrypts subproject verbosity is stupid lets call it log-level fix bug with virtualenv loading mergedeep to slow so I made my options dict shallow hokay first iteration of python-dudes is ready circleci configuration for python builds npm package for scwrypts 3.9.1 initial build/test steps for nodejs go go ok ok fix output ok ok finalize publish steps		2024-02-20 23:08:55 -07:00
..
colors.zsh	basic runner format; write a MAIN function	2024-02-20 23:08:55 -07:00
credits.zsh	v3.0.0 "The Great Overhaul"	2023-06-21 20:04:30 -06:00
dependencies.zsh	basic runner format; write a MAIN function	2024-02-20 23:08:55 -07:00
environment.zsh	basic runner format; write a MAIN function	2024-02-20 23:08:55 -07:00
io.fzf.zsh	basic runner format; write a MAIN function	2024-02-20 23:08:55 -07:00
io.print.zsh	basic runner format; write a MAIN function	2024-02-20 23:08:55 -07:00
io.usage.zsh	basic runner format; write a MAIN function	2024-02-20 23:08:55 -07:00
io.zsh	basic runner format; write a MAIN function	2024-02-20 23:08:55 -07:00
os.zsh	v3.0.0 "The Great Overhaul"	2023-06-21 20:04:30 -06:00
README.md	v3.0.0 "The Great Overhaul"	2023-06-21 20:04:30 -06:00
utils.module.zsh	v3.7.0	2023-11-10 16:32:05 -07:00

README.md

ZSH Utilities

A shell-scripting utilities module made for ZSH. This module is definitely a major component of Scwrypts, but is also standalone and can be sourced by any ZSH script to utilize (almost) all of the features.

Usage

Import utils.module.zsh to activate all of the features. Doing so will also check for path dependencies and required environment variables (see Dependencies and Environment below).

#!/bin/zsh
source ./path/to/utils.plugin.zsh
SUCCESS 'ZSH utilities online!'

Checkout io and os for available simple functions.

Dependencies

Ensures dependent programs are available for execution. Specify a simple name to check the current PATH, or give a fully-qualified path for arbitrary dependency inclusion.

Include a dependency by adding to the DEPENDENCIES array. Always using += makes your dependencies extensible to other scripts :)

If any dependencies are missing, source utils.module.zsh will return an error code and count the number of missing dependencies in the variable DEP_ERROR_COUNT.

#!/bin/zsh
DEPENDENCIES+=(
	path-executable-1
	path-executable-2
	/path/to/arbitrary/program
)
source ./path/to/utils.plugin.zsh
echo "missing $DEP_ERROR required dependencies"

Environment

Similar to Dependencies, environment.zsh ensures a list of environment variables are set to non-empty values.

Include an environment variable by adding to the REQUIRED_ENV array. Something something use += here too ;)

If any environment variables are missing, source utils.module.zsh will return an error code and count the number of missing variables in ENV_ERROR_COUNT.

Missing environment variables will be added to the environment template (exclusive to Scwrypts).

#!/bin/zsh
REQUIRED_ENV+=(
	AWS_PROFILE
	AWS_REGION
)
source ./path/to/utils.plugin.zsh
echo "missing $ENV_ERROR_COUNT required environment variables"