yage
76a746a53e
=====================================================================
Notice the major version change which comes with breaking changes to
2.x! Reconstructs "library" functions for both python and zsh scwrypts,
with changes to virtualenv naming conventions (you'll need to refresh
all virtualenv with the appropriate scwrypt).
--- Changes ------------------------------
- changed a naming convention across zsh scripts, particularly
removing underscores where there is no need to avoid naming clash
(e.g. 'zsh/lib/utils/io.zsh' renames '__STATUS' to 'STATUS')
- moved clients reliant on py.lib.http to the py.lib.http module
- python scripts now rely on py.lib.scwrypts.execute
- updated package.json in zx scripts to include `type = module`
- 'scwrypts --list' commandline argument now includes additional
relevant data for each scwrypt
- environment variables no longer add themselves to be staged in the
'.env.template'
--- New Features -------------------------
- new 'use' syntax for disjoint import within zsh scripts; took me
a very long time to convince myself this would be necessary
- introduced scwrypt "groups" to allow portable module creation;
(i.e. ability add your own scripts from another repo!)
- py.lib.scwrypts.io provides a combined IO stream for quick, hybrid
use of input/output files and stdin/stdout
- py.lib.fzf provides a wrapper to provide similar functionality to
zsh/utils/io.zsh including fzf_(head|tail)
- improved efficiency of various scwrypts; notably reducing runtime
of scwrypts/environment sync
- improved scwrypts CLI by adding new options for exact scwrypt
matching, better filtering, and prettier/more-detailed interfaces
--- New Scripts --------------------------
- py/twilio )
basic SMS integration with twilio
- send-sms
- py/directus )
interactive directus GET query
- get-items
- py/discord )
post message to discord channel or webhook
- post-message
1.9 KiB
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"