yage
a739d3b5a2
=====================================================================
Big day! V4 is finally live. This INCLUDES some BREAKING CHANGES to ZSH
TYPE scwrypts! Please refer to the readme for upgrade details
(more specifically docs/upgrade/v3-to-v4.md)
Upgrade is SUPER EASY, so please take the time to do so.
--- New Features ----------------------------------------------------
- zsh type scwrypts have an upgraded runstring to improve context setup
and simplicity to the scwrypt-writer
- scwrypts now publishes the package (scwrypts) to PyPi; this provides a
simple way to invoke scwrypts from python-based environments as well
as the entire scwrypts python library suite
pip install scwrypts
- scwrypts now publishes the package (scwrypts) to npm; this provides a
simple way to invoke scwrypts from nodesjs environments
npm install scwrypts
--- Bug Fixes -------------------------------------------------------
- scwrypts runner prompts which use the zshbuiltin "read" now
appropriately read input from tty, pipe, files, and user input
- virtualenv refresh now loads and prepares the scwrypts virtual
environments correctly
--- Changes ---------------------------------------------------------
- created the (-v, --log-level) scwrypts arguments as improvements of
and replacements to the --verbose and --no-log flags
- (-n) is now an alias for (--log-level 0)
- (--no-log) is the same as (-n) for compatibility, but will be removed in 4.2
- zsh/lib/utils/io print functions now *interact with log-level* various
log levels will now only display the appropriate console prints for
the specified log level
- zsh/lib/utils/io:INFO has been renamed to DEBUG to align with
log-level output; please use DEBUG for debug messages and REMINDER for
important user messages
- created zsh/lib/utils/io:FZF_USER_INPUT as a *drop-in replacement* for
the confusing FZF_HEAD and FZF_TAIL commands. Update by literally
changing any instances of FZF_HEAD or FZF_TAIL with FZF_USER_INPUT
- FZF_HEAD and FZF_TAIL will be removed in 4.2
- zsh/lib/utils/io:READ (and other zshbuiltin/read-based prompts) now
accept a --force-user-input flag in case important checks should
require an admin's approval. This flag will ensure that piped input
and the `scwrypts -y` flag are ignored for the single prompt.
- zsh/lib/utils/color has been updated to use color names which match
the ANSI color names
- zsh/hello-world has been reduced to a minimal example; this is to
emphasize ease-of-use with v4
- zsh/sanity-check is a scwrypts/run testing helper and detailed
starting reference (helpful since hello-world is now minimal)
- various refactor, updates, and improvements to the scwrypts runner
- migrated all zsh scwrypts and plugins to use v4 runner syntax
- zsh
- plugins/kubectl
- plugins/ci
- refactored py/lib into py/lib/scwrypts (PyPi)
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"