wrynegade/scwrypts
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

v3.0.0 "The Great Overhaul"

Browse Source 
=====================================================================

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
This commit is contained in:
Wryn (yage) Wagner
2023-02-21 18:44:27 -07:00
parent 7617c938b1
commit 76a746a53e
196 changed files with 3472 additions and 2053 deletions
Download Patch File Download Diff File Expand all files Collapse all files

21
zsh/lib/cloud/aws/cli.module.zsh Normal file
View File

@ -0,0 +1,21 @@
#####################################################################
DEPENDENCIES+=(
aws
)
REQUIRED_ENV+=(
AWS_ACCOUNT
AWS_PROFILE
AWS_REGION
)
#####################################################################
AWS() {
aws \
--profile $AWS_PROFILE \
--region $AWS_REGION \
--output json \
$@
}

28
zsh/lib/cloud/aws/ecr.module.zsh Normal file
View File

@ -0,0 +1,28 @@
#####################################################################
DEPENDENCIES+=(
docker
)
REQUIRED_ENV+=(
AWS_ACCOUNT
AWS_REGION
)
use cloud/aws/cli
#####################################################################
ECR_LOGIN() {
STATUS "performing AWS ECR docker login"
AWS ecr get-login-password \
| docker login \
--username AWS \
--password-stdin \
"$AWS_ACCOUNT.dkr.ecr.$AWS_REGION.amazonaws.com" \
&& SUCCESS "authenticated docker for '$AWS_ACCOUNT' in '$AWS_REGION'" \
|| {
ERROR "unable to authenticate docker for '$AWS_ACCOUNT' in '$AWS_REGION'"
return 1
}
}

60
zsh/lib/cloud/aws/eks.module.zsh Normal file
View File

@ -0,0 +1,60 @@
#####################################################################
DEPENDENCIES+=(
kubectl
)
REQUIRED_ENV+=(
AWS_ACCOUNT
AWS_REGION
)
use cloud/aws/cli
#####################################################################
EKS_CLUSTER_LOGIN() {
local USAGE="
usage: [...options...]
options
-c, --cluster-name <string> (optional) login a specific cluster
Interactively sets the default kubeconfig to match the selected
cluster in EKS. Also creates the kubeconfig entry if it does not
already exist.
"
local CLUSTER_NAME
while [[ $# -gt 0 ]]
do
case $1 in
-c | --cluster-name ) CLUSTER_NAME="$2"; shift 1 ;;
* ) [ ! $APPLICATION ] && APPLICATION="$1" \
|| ERROR "extra positional argument '$1'"
;;
esac
shift 1
done
[ ! $CLUSTER_NAME ] && CLUSTER_NAME=$(\
AWS eks list-clusters \
| jq -r '.[] | .[]' \
| FZF 'select a cluster'
)
[ ! $CLUSTER_NAME ] && ERROR 'must select a valid cluster or use -c flag'
CHECK_ERRORS
##########################################
STATUS 'creating / updating kubeconfig for EKS cluster'
STATUS "updating kubeconfig for '$CLUSTER_NAME'"
AWS eks update-kubeconfig --name $CLUSTER_NAME \
&& SUCCESS "kubeconfig updated with '$CLUSTER_NAME'" \
|| ERROR "failed to update kubeconfig; do you have permissions to access '$CLUSTER_NAME'?"
}

140
zsh/lib/cloud/aws/rds.module.zsh Normal file
View File

@ -0,0 +1,140 @@
#####################################################################
DEPENDENCIES+=(
docker
)
REQUIRED_ENV+=(
AWS_ACCOUNT
AWS_REGION
)
use cloud/aws/cli
#####################################################################
RDS__SELECT_DATABASE() {
local DATABASES=$(_RDS__GET_AVAILABLE_DATABASES)
[ ! $DATABASES ] && FAIL 1 'no databases available'
local ID=$(\
echo $DATABASES | jq -r '.instance + " @ " + .cluster' \
| FZF 'select a database (instance@cluster)' \
)
[ ! $ID ] && ABORT
local INSTANCE=$(echo $ID | sed 's/ @ .*$//')
local CLUSTER=$(echo $ID | sed 's/^.* @ //')
echo $DATABASES | jq "select (.instance == \"$INSTANCE\" and .cluster == \"$CLUSTER\")"
}
_RDS__GET_AVAILABLE_DATABASES() {
AWS rds describe-db-instances \
| jq -r '.[] | .[] | {
instance: .DBInstanceIdentifier,
cluster: .DBClusterIdentifier,
type: .Engine,
host: .Endpoint.Address,
port: .Endpoint.Port,
user: .MasterUsername,
database: .DBName
}'
}
RDS__GET_DATABASE_CREDENTIALS() {
local PRINT_PASSWORD=0
local ERRORS=0
while [[ $# -gt 0 ]]
do
case $1 in
--print-password ) PRINT_PASSWORD=1 ;;
* )
WARNING "unrecognized argument $1"
ERRORS+=1
;;
esac
shift 1
done
CHECK_ERRORS
##########################################
local DATABASE=$(RDS__SELECT_DATABASE)
[ ! $DATABASE ] && ABORT
DB_HOST="$(echo $DATABASE | jq -r '.host')"
[ ! $DB_HOST ] && { ERROR 'unable to find host'; return 2; }
DB_PORT="$(echo $DATABASE | jq -r '.port')"
[ ! $DB_PORT ] && DB_PORT=5432
[[ $DB_PORT =~ ^null$ ]] && DB_PORT=5432
##########################################
local AUTH_METHOD=$(\
echo "iam\nsecretsmanager\nuser-input" \
| FZF 'select an authentication method' \
)
[ ! $AUTH_METHOD ] && ABORT
case $AUTH_METHOD in
iam ) _RDS_AUTH__iam ;;
secretsmanager ) _RDS_AUTH__secretsmanager ;;
user-input ) _RDS_AUTH__userinput ;;
esac
STATUS
STATUS "host : $DB_HOST"
STATUS "type : $DB_TYPE"
STATUS "port : $DB_PORT"
STATUS "database : $DB_NAME"
STATUS "username : $DB_USER"
[[ $PRINT_PASSWORD -eq 1 ]] && STATUS "password : $DB_PASS"
STATUS
}
_RDS_AUTH__iam() {
DB_PASS=$(\
AWS rds generate-db-auth-token \
--hostname $DB_HOST \
--port $DB_PORT \
--username $DB_USER \
)
}
_RDS_AUTH__secretsmanager() {
local CREDENTIALS=$(_RDS__GET_SECRETSMANAGER_CREDENTIALS)
echo $CREDENTIALS | jq -e '.pass' >/dev/null 2>&1 \
&& DB_PASS="'$(echo $CREDENTIALS | jq -r '.pass' | sed "s/'/'\"'\"'/g")'"
echo $CREDENTIALS | jq -e '.password' >/dev/null 2>&1 \
&& DB_PASS="'$(echo $CREDENTIALS | jq -r '.password' | sed "s/'/'\"'\"'/g")'"
echo $CREDENTIALS | jq -e '.user' >/dev/null 2>&1 \
&& DB_USER=$(echo $CREDENTIALS | jq -r '.user')
echo $CREDENTIALS | jq -e '.username' >/dev/null 2>&1 \
&& DB_USER=$(echo $CREDENTIALS | jq -r '.username')
echo $CREDENTIALS | jq -e '.name' >/dev/null 2>&1 \
&& DB_NAME=$(echo $CREDENTIALS | jq -r '.name')
echo $CREDENTIALS | jq -e '.dbname' >/dev/null 2>&1 \
&& DB_NAME=$(echo $CREDENTIALS | jq -r '.dbname')
}
_RDS__GET_SECRETSMANAGER_CREDENTIALS() {
local ID=$(\
AWS secretsmanager list-secrets \
| jq -r '.[] | .[] | .Name' \
| FZF 'select a secret' \
)
[ ! $ID ] && return 1
AWS secretsmanager get-secret-value --secret-id "$ID" \
| jq -r '.SecretString' | jq
}

69
zsh/lib/cloud/media-sync.module.zsh Normal file
View File

@ -0,0 +1,69 @@
#####################################################################
DEPENDENCIES+=()
REQUIRED_ENV+=(
MEDIA_SYNC__TARGETS
MEDIA_SYNC__S3_BUCKET
)
use cloud/aws/cli
#####################################################################
MEDIA_SYNC__PUSH() {
local FLAGS=($@)
local FAILED_COUNT=0
STATUS 'starting media upload to s3'
local TARGET
for TARGET in ${MEDIA_SYNC__TARGETS[@]}
do
_MEDIA_SYNC push $TARGET $FLAGS || ((FAILED_COUNT+=1))
done
[[ $FAILED_COUNT -eq 0 ]] \
&& SUCCESS 's3 media files now up-to-date' \
|| FAIL $FAILED_COUNT 'unable to upload one or more targets' \
;
}
MEDIA_SYNC__PULL() {
local FLAGS=($@)
local FAILED_COUNT=0
STATUS 'starting media download from s3'
local TARGET
for TARGET in ${MEDIA_SYNC__TARGETS[@]}
do
_MEDIA_SYNC pull $TARGET $FLAGS || ((FAILED_COUNT+=1))
done
[[ $FAILED_COUNT -eq 0 ]] \
&& SUCCESS 'local media files now up-to-date' \
|| FAIL $FAILED_COUNT 'unable to download one or more targets' \
;
}
_MEDIA_SYNC() {
local ACTION="$1"
local REMOTE_TARGET="s3://$MEDIA_SYNC__S3_BUCKET/$2"
local LOCAL_TARGET="$HOME/$2"
local A B
case $ACTION in
push ) A="$LOCAL_TARGET"; B="$REMOTE_TARGET" ;;
pull ) A="$REMOTE_TARGET"; B="$LOCAL_TARGET" ;;
* ) ERROR "unknown action '$1'"; return 1 ;;
esac
local FLAGS=(${@:3})
STATUS "${ACTION}ing $2"
AWS s3 sync $A $B $FLAGS \
&& SUCCESS "$2 up-to-date" \
|| { ERROR "unable to sync $2 (see above)"; return 1; }
}

15
zsh/lib/config.group.zsh Normal file
View File

@ -0,0 +1,15 @@
export SCWRYPTS_ROOT__scwrypts="$SCWRYPTS_ROOT"
export SCWRYPTS_LIBRARY_ROOT__scwrypts="$SCWRYPTS_ROOT/zsh/lib"
export SCWRYPTS_COLOR__scwrypts='\033[0;32m'
export SCWRYPTS_ENV_PATH__scwrypts="$SCWRYPTS_CONFIG_PATH/scwrypts/env"
[ ! -d "$SCWRYPTS_ENV_PATH__scwrypts" ] && mkdir -p "$SCWRYPTS_ENV_PATH__scwrypts"
export SCWRYPTS_ENV_TEMPLATE__scwrypts="$SCWRYPTS_ROOT__scwrypts/.env.template"
export SCWRYPTS_ENV_TEMPLATE_DESCRIPTIONS__scwrypts="$SCWRYPTS_ROOT__scwrypts/.env.template.descriptions"
export SCWRYPTS_VIRTUALENV_PATH__scwrypts="$SCWRYPTS_DATA_PATH/virtualenv"
[ ! -d "$SCWRYPTS_VIRTUALENV_PATH__scwrypts" ] && mkdir -p "$SCWRYPTS_VIRTUALENV_PATH__scwrypts"
export SCWRYPTS_PREFERRED_PYTHON_VERSIONS__scwrypts=(3.11 3.10 3.9)
export SCWRYPTS_NODE_VERSION__scwrypts=18.0.0

BIN
zsh/lib/config.user.zsh Normal file
View File

Binary file not shown.

42
zsh/lib/config.zsh Normal file
View File

@ -0,0 +1,42 @@
[[ $__SCWRYPT -eq 1 ]] && return 0
#####################################################################
[ ! $SCWRYPTS_ROOT ] \
&& SCWRYPTS_ROOT="$(cd $(dirname "${0:a:h}"); git rev-parse --show-toplevel)"
#####################################################################
DEFAULT_CONFIG="$SCWRYPTS_ROOT/zsh/lib/config.user.zsh"
source "$DEFAULT_CONFIG"
USER_CONFIG_OVERRIDES="$SCWRYPTS_CONFIG_PATH/config.zsh"
[ ! -f "$USER_CONFIG_OVERRIDES" ] && {
mkdir -p $(dirname "$USER_CONFIG_OVERRIDES")
cp "$DEFAULT_CONFIG" "$USER_CONFIG_OVERRIDES"
}
source "$USER_CONFIG_OVERRIDES"
[ ! -d $SCWRYPTS_CONFIG_PATH ] && mkdir -p $SCWRYPTS_CONFIG_PATH
[ ! -d $SCWRYPTS_DATA_PATH ] && mkdir -p $SCWRYPTS_DATA_PATH
[ ! -d $SCWRYPTS_ENV_PATH ] && mkdir -p $SCWRYPTS_ENV_PATH
[ ! -d $SCWRYPTS_LOG_PATH ] && mkdir -p $SCWRYPTS_LOG_PATH
[ ! -d $SCWRYPTS_OUTPUT_PATH ] && mkdir -p $SCWRYPTS_OUTPUT_PATH
export \
SCWRYPTS_GROUPS \
SCWRYPTS_CONFIG_PATH \
SCWRYPTS_DATA_PATH \
SCWRYPTS_SHORTCUT \
SCWRYPTS_ENV_SHORTCUT \
SCWRYPTS_LOG_PATH \
SCWRYPTS_OUTPUT_PATH \
;
SCWRYPTS_GROUPS+=(scwrypts) # 'scwrypts' group is required!
SCWRYPTS_GROUPS=($(echo $SCWRYPTS_GROUPS | sed 's/\s\+/\n/g' | sort -u))
source "$SCWRYPTS_ROOT/zsh/lib/config.group.zsh" \
|| FAIL 69 'failed to set up scwrypts group; aborting'
#####################################################################
__SCWRYPT=1 # arbitrary; indicates currently inside a scwrypt

158
zsh/lib/db/postgres.module.zsh Normal file
View File

@ -0,0 +1,158 @@
#####################################################################
DEPENDENCIES+=(
pg_dump
pg_restore
psql
pgcli
)
REQUIRED_ENV+=()
#####################################################################
PSQL() {
[[ ${#ARGS[@]} -eq 0 ]] && POSTGRES__SET_LOGIN_ARGS $@
eval PGPASSWORD=$_PASS psql ${_ARGS[@]}
}
#####################################################################
PG_DUMP() {
local _HOST _NAME _PORT _USER _FILE
local DATA_DIR _PASS _ARGS=()
POSTGRES__SET_LOGIN_ARGS --verbose $@
local OUTPUT_FILE="$DATA_DIR/backup.$(date '+%Y-%m-%d.%H-%M')"
STATUS "
making backup of : $_USER@$_HOST:$_PORT/$_NAME
(compressed) : '$OUTPUT_FILE.dump'
(safe-raw) : '$OUTPUT_FILE.sql'
(raw) : '$OUTPUT_FILE.raw.sql'
"
: \
&& STATUS "creating compressed backup..." \
&& eval PGPASSWORD=$_PASS pg_dump ${_ARGS[@]} --format custom --file "$OUTPUT_FILE.dump" \
&& SUCCESS "completed compressed backup" \
&& STATUS "creating raw backup..." \
&& eval PGPASSWORD=$_PASS pg_dump ${_ARGS[@]} > "$OUTPUT_FILE.raw.sql" \
&& SUCCESS "completed raw backup" \
&& STATUS "creating single-transaction raw backup..." \
&& { echo "BEGIN;"; cat "$OUTPUT_FILE.raw.sql"; echo "END;" } > "$OUTPUT_FILE.sql" \
&& SUCCESS "completed single-transaction raw backup" \
|| { ERROR "error creating backup for '$_HOST/$_NAME' (see above)"; return 1; }
}
#####################################################################
PG_RESTORE() {
local _HOST _NAME _PORT _USER
local _PASS _ARGS=()
local _FILE
POSTGRES__SET_LOGIN_ARGS $@
local INPUT_FILE=$(find "$DATA_DIR"/backup.* -type f | FZF 'select database file to restore')
[ $INPUT_FILE ] && [ -f "$INPUT_FILE" ] || {
ERROR 'no file selected or missing backup file; aborting'
REMINDER "
backups must be *.sql or *.dump files starting with the prefix 'backup.'
in the following directory:
'$DATA_DIR'
"
return 1
}
local RAW=1
[[ $INPUT_FILE =~ \\.dump$ ]] && RAW=0
STATUS "
loading backup for : $_USER@$_HOST:$_PORT/$_NAME
file : '$INPUT_FILE'
"
local EXIT_CODE
[[ $RAW -eq 1 ]] && {
REMINDER "
loading a backup from a raw sql dump may result in data loss
make sure your database is ready to accept the database file!
"
yN 'continue?' || ABORT
PSQL < "$INPUT_FILE"
EXIT_CODE=$?
}
[[ $RAW -eq 0 ]] && {
PGPASSWORD="$_PASS" pg_restore ${_ARGS[@]} \
--verbose \
--format custom \
--single-transaction \
"$INPUT_FILE"
EXIT_CODE=$?
}
[[ $EXIT_CODE -eq 0 ]] \
&& SUCCESS "finished restoring backup for '$_HOST/$_NAME'" \
|| ERROR "error restoring backup for '$_HOST/$_NAME' (see above)" \
;
return $EXIT_CODE
}
#####################################################################
POSTGRES__LOGIN_INTERACTIVE() {
local _PASS _ARGS=()
POSTGRES__SET_LOGIN_ARGS $@
STATUS "performing login : $_USER@$_HOST:$_PORT/$_NAME"
STATUS "working directory : $DATA_DIR"
eval PGPASSWORD=$_PASS pgcli ${_ARGS[@]}
}
#####################################################################
POSTGRES__SET_LOGIN_ARGS() {
while [[ $# -gt 0 ]]
do
case $1 in
--host ) _ARGS+=(-h $2); _HOST="$2"; shift 1 ;;
--name ) _ARGS+=(-d $2); _NAME="$2"; shift 1 ;;
--port ) _ARGS+=(-p $2); _PORT="$2"; shift 1 ;;
--user ) _ARGS+=(-U $2); _USER="$2"; shift 1 ;;
--pass ) _PASS="$2"; shift 1 ;;
--file ) _FILE="$2"; shift 1 ;;
* ) _ARGS+=($1) ;;
esac
shift 1
done
[ $_FILE ] && [ ! -f "$_FILE" ] && {
ERROR "no such file '$_FILE'"
exit 1
}
[ $_HOST ] && [ $_NAME ] \
&& DATA_DIR="$SCWRYPTS_DATA_PATH/db/$_HOST/$_NAME" \
|| DATA_DIR="$EXECUTION_DIR/temp-db" \
;
[ ! -d "$DATA_DIR" ] && mkdir -p "$DATA_DIR"
cd "$DATA_DIR"
return 0
}

147
zsh/lib/import.driver.zsh Normal file
View File

@ -0,0 +1,147 @@
[[ $SCWRYPTS_IMPORT_DRIVER_READY -eq 1 ]] && return 0
###################################################################
# #
# usage: use [OPTIONS ...] zsh/module/path #
# #
###################################################################
# #
# OPTIONS: #
# #
# -g, --group lookup library root from friendly group #
# name (requires configuration) #
# (default: scwrypts) #
# #
# -r, --library-root fully qualified path to a library root #
# #
# --check-environment check environment immediately rather than #
# wait for downstream CHECK_ENVIRONMENT call #
# #
# #
# Allows for import-style library loading in zsh. No matter what #
# scwrypt is run, this function (and required helpers) are *also* #
# loaded, ensuring that 'use' is always available in scwrypts #
# context. #
# #
# #
# Friendly group-names can be configured by setting the variable #
# 'SCWRYPTS_LIBRARY_ROOT__<group-name>' to the fully qualified path #
# to the root directory of the modules library. #
# #
# #
###################################################################
source "${0:a:h}/config.zsh"
use() {
local SCWRYPTS_LIBRARY SCWRYPTS_LIBRARY_ROOT SCWRYPTS_LIBRARY_GROUP
local DEFER_ENVIRONMENT_CHECK=1
while [[ $# -gt 0 ]]
do
case $1 in
-g | --group )
[ $SCWRYPTS_LIBRARY_ROOT ] && ERROR 'specify only one of {(-g), (-r)}'
SCWRYPTS_LIBRARY_GROUP=$2
shift 1
;;
-r | --library-root )
[ $SCWRYPTS_LIBRARY_GROUP ] && ERROR 'specify only one of {(-g), (-r)}'
SCWRYPTS_LIBRARY_ROOT=$2
shift 1
;;
--check-environment )
DEFER_ENVIRONMENT_CHECK=0
;;
* )
[ ! $SCWRYPTS_LIBRARY ] \
&& SCWRYPTS_LIBRARY=$1 \
|| ERROR 'too many arguments; expected exactly 1 argument' \
;;
esac
shift 1
done
[ ! $SCWRYPTS_LIBRARY ] && ERROR 'no library specified for import'
: \
&& [ ! $SCWRYPTS_LIBRARY_GROUP ] \
&& [ ! $SCWRYPTS_LIBRARY_ROOT ] \
&& SCWRYPTS_LIBRARY_GROUP=scwrypts
[ ! $SCWRYPTS_LIBRARY_ROOT ] && SCWRYPTS_LIBRARY_ROOT=$(GET_SCWRYPTS_LIBRARY_ROOT)
[ ! $SCWRYPTS_LIBRARY_ROOT ] && ERROR "unable to determine library root from group name '$SCWRYPTS_LIBRARY_GROUP'"
#####################################################################
local LIBRARY_FILE LIBRARY_FILE_TEMP
[ ! $LIBRARY_FILE ] \
&& LIBRARY_FILE_TEMP="$SCWRYPTS_LIBRARY_ROOT/$SCWRYPTS_LIBRARY.module.zsh" \
&& [ -f "$LIBRARY_FILE_TEMP" ] \
&& LIBRARY_FILE="$LIBRARY_FILE_TEMP"
[ ! $LIBRARY_FILE ] \
&& LIBRARY_FILE_TEMP="$SCWRYPTS_LIBRARY_ROOT/$SCWRYPTS_LIBRARY/$(echo $SCWRYPTS_LIBRARY | sed 's/.*\///').module.zsh" \
&& [ -f "$LIBRARY_FILE_TEMP" ] \
&& LIBRARY_FILE="$LIBRARY_FILE_TEMP" \
[ ! $LIBRARY_FILE ] \
&& ERROR "no such library '$SCWRYPTS_LIBRARY_GROUP/$SCWRYPTS_LIBRARY'"
#####################################################################
CHECK_ERRORS --no-fail || {
((IMPORT_ERRORS+=1))
return 1
}
#####################################################################
IS_LOADED && return 0
source "$LIBRARY_FILE" || {
((IMPORT_ERRORS+=1))
ERROR "import error for '$SCWRYPTS_LIBRARY_GROUP/$SCWRYPTS_LIBRARY'"
return 1
}
[[ $DEFER_ENVIRONMENT_CHECK -eq 0 ]] && {
CHECK_ENVIRONMENT || {
((IMPORT_ERRORS+=1))
ERROR "import error for '$SCWRYPTS_LIBRARY_GROUP/$SCWRYPTS_LIBRARY'"
return 1
}
}
IS_LOADED --set
}
GET_SCWRYPTS_LIBRARY_ROOT() {
eval echo '$SCWRYPTS_LIBRARY_ROOT__'$SCWRYPTS_LIBRARY_GROUP
}
IS_LOADED() {
local VARIABLE_NAME="SCWRYPTS_LIBRARY_LOADED__${SCWRYPTS_LIBRARY_GROUP}__$(echo $SCWRYPTS_LIBRARY | sed 's|[/-]|_|g')"
[[ $1 =~ ^--set$ ]] \
&& eval $VARIABLE_NAME=1 \
[[ $(eval echo '$'$VARIABLE_NAME || echo 0) -eq 1 ]]
}
# temporary definitions for first load
CHECK_ERRORS() { return 0; unset -f CHECK_ERRORS; }
CHECK_ENVIRONMENT() { return 0; unset -f CHECK_ENVIRONMENT; }
ERROR() { echo $@ >&2; exit 1; }
#####################################################################
# ensures that zsh/utils and zsh/scwrypts/meta are always present!
use utils
use scwrypts/meta
#####################################################################
SCWRYPTS_IMPORT_DRIVER_READY=1

48
zsh/lib/media/youtube.module.zsh Normal file
View File

@ -0,0 +1,48 @@
#####################################################################
DEPENDENCIES+=(
ffmpeg
youtube-dl
)
REQUIRED_ENV+=()
#####################################################################
YT__GLOBAL_ARGS=(
--no-call-home
--restrict-filenames
)
YT__OUTPUT_DIR="$SCWRYPTS_DATA_PATH/youtube"
YT__GET_INFO() {
youtube-dl --dump-json ${YT__GLOBAL_ARGS[@]} $@
}
YT__GET_FILENAME() {
YT__GET_INFO $@ \
| jq -r '._filename' \
| sed 's/\.[^.]*$/\.mp4/' \
;
}
YT__DOWNLOAD() {
local OUTPUT_DIR="$SCWRYPTS_DATA_PATH/youtube"
[ ! -d $YT__OUTPUT_DIR ] && mkdir -p $YT__OUTPUT_DIR
cd "$YT__OUTPUT_DIR"
youtube-dl ${YT__GLOBAL_ARGS[@]} $@ \
--format 'bestvideo[ext=mp4]+bestaudio[ext=m4a]/mp4' \
;
}
GET_VIDEO_LENGTH() {
local FILENAME="$1"
ffprobe \
-v quiet \
-show_entries format=duration \
-of default=noprint_wrappers=1:nokey=1 \
-i $FILENAME \
;
}

26
zsh/lib/misc/k8s-helper.plugin.zsh Normal file
View File

@ -0,0 +1,26 @@
K8s_HELPER__NAMESPACE_KEY='k8s-helper'
K8s_HELPER__REDIS_HOST=127.0.0.1
K8s_HELPER__REDIS_PORT=6379
K8s_HELPER__REDIS_AUTH=
REDIS_CLI() {
local ARGS=()
[ $K8s_HELPER__REDIS_HOST ] && ARGS+=(-h $K8s_HELPER__REDIS_HOST)
[ $K8s_HELPER__REDIS_PORT ] && ARGS+=(-p $K8s_HELPER__REDIS_PORT)
[ $K8s_HELPER__REDIS_AUTH ] && ARGS+=(-a $K8s_HELPER__REDIS_AUTH --no-auth-warning)
redis-cli ${ARGS[@|} $@
}
K8s_HELPER__SET_NAMESPACE() {
REDIS_CLI hset $K8s_HELPER__NAMESPACE_KEY namespace $@
}
K8s_HELPER__GET_NAMESPACE() {
REDIS_CLI hget $K8s_HELPER__NAMESPACE_KEY namespace
}
K8s_HELPER__KUBECTL() {
kubectl -n $(K8s_HELPER__GET_NAMESPACE) $@
}
alias k='K8s_HELPER__PREFIX '

44
zsh/lib/office/latex.module.zsh Normal file
View File

@ -0,0 +1,44 @@
#####################################################################
DEPENDENCIES+=(
rg
pdflatex
)
REQUIRED_ENV+=()
#####################################################################
LATEX__GET_MAIN_FILENAME() {
local FILENAME=$(SCWRYPTS__GET_PATH_TO_RELATIVE_ARGUMENT "$1")
local DIRNAME="$FILENAME"
for _ in {1..3}
do
CHECK_IS_MAIN_LATEX_FILE && return 0
DIRNAME="$(dirname "$FILENAME")"
STATUS "checking '$DIRNAME'"
[[ $DIRNAME =~ ^$HOME$ ]] && break
FILENAME=$(
rg -l --max-depth 1 'documentclass' "$DIRNAME/" \
| grep '\.tex$' \
| head -n1 \
)
STATUS "here is '$FILENAME'"
done
WARNING 'unable to find documentclass; pdflatex will probably fail'
echo "$1"
}
LATEX__CHECK_IS_MAIN_FILE() {
[ ! $FILENAME ] && return 1
grep -q 'documentclass' $FILENAME 2>/dev/null && echo $FILENAME || return 3
}
LATEX__GET_PDF() {
local FILENAME=$(LATEX__GET_MAIN_FILENAME "$1" | sed 's/\.[^.]*$/.pdf/')
[ $FILENAME ] && [ -f $FILENAME ] || FAIL 1 "no compiled pdf found for '$1'; have you run 'build-pdf'?"
SUCCESS 'found main pdf'
echo $FILENAME
}

15
zsh/lib/office/memo.module.zsh Normal file
View File

@ -0,0 +1,15 @@
#####################################################################
DEPENDENCIES+=()
REQUIRED_ENV+=()
#####################################################################
set +o noglob
MEMO__FILETYPE=md
MEMO__DIR="$SCWRYPTS_DATA_PATH/memo"
[ ! -d $MEMO__DIR ] && mkdir -p $MEMO__DIR
MEMO__LIST_ALL() { ls $MEMO__DIR | sed "s/\.$MEMO__FILETYPE$//" | sort; }

43
zsh/lib/redis/redis.module.zsh Normal file
View File

@ -0,0 +1,43 @@
#####################################################################
DEPENDENCIES+=(
redis-cli
)
REQUIRED_ENV+=()
#####################################################################
REDIS() {
[[ ${#ARGS[@]} -eq 0 ]] && REDIS__SET_LOGIN_ARGS $@
redis-cli ${#ARGS[@]}
}
REDIS__SET_LOGIN_ARGS() {
while [[ $# -gt 0 ]]
do
case $1 in
--host ) _ARGS+=(-h $2); _HOST="$2"; shift 1 ;;
--port ) _ARGS+=(-p $2); _PORT="$2"; shift 1 ;;
--pass ) _ARGS+=(-a $2); _PASS="$2"; shift 1 ;;
--file ) _FILE="$2"; shift 1 ;;
* ) _ARGS+=($1) ;;
esac
shift 1
done
[ $_FILE ] && [ ! -f "$_FILE" ] && {
ERROR "no such file '$_FILE'"
exit 1
}
return 0
}
REDIS__ENABLED() {
REDIS ping 2>&1 | grep -qi pong
}

94
zsh/lib/scwrypts/environment-files.module.zsh Normal file
View File

@ -0,0 +1,94 @@
#####################################################################
DEPENDENCIES+=()
REQUIRED_ENV+=()
use utils
#####################################################################
SCWRYPTS__SELECT_ENV() {
SCWRYPTS__GET_ENV_NAMES | FZF 'select an environment'
}
SCWRYPTS__SELECT_OR_CREATE_ENV() {
SCWRYPTS__GET_ENV_NAMES | FZF_TAIL 'select / create an environment'
}
SCWRYPTS__GET_ENV_FILE() {
local NAME="$1"
echo "$SCWRYPTS_ENV_PATH/$NAME"
SCWRYPTS__GET_ENV_NAMES | grep -q $NAME \
|| { ERROR "no environment '$NAME' exists"; return 1; }
}
SCWRYPTS__GET_ENV_TEMPLATE_FILES() {
local GROUP
for GROUP in ${SCWRYPTS_GROUPS[@]}
do
eval echo '$SCWRYPTS_ENV_TEMPLATE__'$GROUP
done
}
SCWRYPTS__GET_ENV_NAMES() {
SCWRYPTS__INIT_ENVIRONMENTS || {
ERROR 'environment initialization error'
return 1
}
ls "$SCWRYPTS_ENV_PATH" | sort -r
}
SCWRYPTS__INIT_ENVIRONMENTS() {
[ ! -d "$SCWRYPTS_ENV_PATH" ] && mkdir -p "$SCWRYPTS_ENV_PATH"
[[ $(ls "$SCWRYPTS_ENV_PATH" | wc -l) -gt 0 ]] && return 0
STATUS "initializing environments for scwrypts"
local BASIC_ENV
for BASIC_ENV in local dev prod
do
GENERATE_TEMPLATE > "$SCWRYPTS_ENV_PATH/$BASIC_ENV"
done
}
#####################################################################
_SED() { sed --follow-symlinks $@; }
GENERATE_TEMPLATE() {
echo "#!/bin/zsh"
echo '#####################################################################'
echo "### scwrypts runtime configuration ##################################"
echo '#####################################################################'
local FILE GROUP CONTENT
local VARIABLE DESCRIPTION
for GROUP in ${SCWRYPTS_GROUPS[@]}
do
FILE=$(eval echo '$SCWRYPTS_ENV_TEMPLATE__'$GROUP)
CONTENT=$(GET_VARIABLE_NAMES "$FILE" | sed 's/^/export /; s/$/=/')
while read DESCRIPTION_LINE
do
VARIABLE=$(echo $DESCRIPTION_LINE | sed 's/ \+| .*$//')
DESCRIPTION=$(echo $DESCRIPTION_LINE | sed 's/^.* | //')
[ ! $DESCRIPTION ] && continue
CONTENT=$(echo "$CONTENT" | sed "/^export $VARIABLE=/i #" | sed "/^export $VARIABLE=/i # $DESCRIPTION")
done < <(_SED -n '/^[^ ]\+ \+| /p' "$FILE.descriptions")
echo "$CONTENT" | sed 's/^#$//'
echo '\n#####################################################################'
done
}
GET_VARIABLE_NAMES() {
local FILE="$1"
grep '^export' "$FILE" \
| sed 's/^export //; s/=.*//' \
| grep -v '__[a-z]\+$' \
;
}

22
zsh/lib/scwrypts/meta.module.zsh Normal file
View File

@ -0,0 +1,22 @@
#####################################################################
DEPENDENCIES+=()
REQUIRED_ENV+=()
use scwrypts/environment-files
use scwrypts/run
#####################################################################
SCWRYPTS__RUN() {
local EXIT_CODE=0
((SUBSCWRYPT+=1))
echo "--- START SUBSCWRYPT=$SUBSCWRYPT $@"
SUBSCWRYPT=$SUBSCWRYPT $SCWRYPTS_ROOT/run $@
EXIT_CODE=$?
((SUBSCWRYPT-=1))
return $EXIT_CODE
echo "--- END SUBSCWRYPT=$SUBSCWRYPT $@"
}

120
zsh/lib/scwrypts/run.module.zsh Normal file
View File

@ -0,0 +1,120 @@
#####################################################################
DEPENDENCIES+=()
REQUIRED_ENV+=()
use scwrypts/environment-files
#####################################################################
SCWRYPTS__GET_AVAILABLE_SCWRYPTS() {
local TYPE_COLOR='\033[0;37m'
local GROUP GROUP_PATH GROUP_COLOR LOOKUP_PIDS=()
{
echo 'NAME^TYPE^GROUP'
for GROUP in ${SCWRYPTS_GROUPS}
do
GROUP_PATH=$(eval echo '$SCWRYPTS_ROOT__'$GROUP)
GROUP_COLOR=$(eval echo '$SCWRYPTS_COLOR__'$GROUP)
{
cd "$GROUP_PATH"
find . -mindepth 2 -type f -executable \
| grep -v '\.git' \
| grep -v 'node_modules' \
| sed "s/^\\.\\///; s/\\.[^.]*$//" \
| sed "s|\\([^/]*\\)/\(.*\)$|$(printf $__COLOR_RESET)\\2^$(printf $TYPE_COLOR)\\1^$(printf $GROUP_COLOR)$GROUP$(printf $__COLOR_RESET)|" \
;
} &
LOOKUP_PIDS+=($!)
done
for p in ${LOOKUP_PIDS[@]}; do wait $p; done
} | column -t -s '^'
}
SCWRYPTS__SEPARATE_SCWRYPT_SELECTION() {
set -- $(echo $@ | sed -e 's/\x1b\[[0-9;]*m//g')
while [[ $# -gt 0 ]]
do
[ ! $NAME ] && NAME=$1 && shift 1 && continue
[ ! $TYPE ] && TYPE=$1 && shift 1 && continue
[ ! $GROUP ] && GROUP=$1 && shift 1 && continue
shift 1
done
}
SCWRYPTS__GET_RUNSTRING() {
# accepts a selected line from SCWRYPTS__GET_AVAILABLE_SCWRYPTS
local NAME="$1"
local TYPE="$2"
local GROUP="$3"
local GROUP_PATH=$(eval echo '$SCWRYPTS_ROOT__'$GROUP)
local RUNSTRING
[ $NAME ] && [ $TYPE ] && [ $GROUP ] || {
ERROR 'missing required information to get runstring'
return 1
}
[ $ENV_REQUIRED ] && [[ $ENV_REQUIRED -eq 1 ]] && [ ! $ENV_NAME ] && {
ERROR 'missing required information to get runstring'
return 1
}
typeset -f SCWRYPTS__GET_RUNSTRING__${GROUP}__${TYPE} >/dev/null 2>&1 && {
RUNSTRING=$(SCWRYPTS__GET_RUNSTRING__${GROUP}__${TYPE})
[ ! $RUNSTRING ] && {
ERROR "SCWRYPTS__GET_RUNSTRING__${GROUP}__${TYPE} error"
return 2
}
}
typeset -f SCWRYPTS__GET_RUNSTRING__${TYPE} >/dev/null 2>&1 && {
RUNSTRING=$(SCWRYPTS__GET_RUNSTRING__${TYPE})
[ ! $RUNSTRING ] && {
ERROR "SCWRYPTS__GET_RUNSTRING__${TYPE} error"
return 3
}
}
[ ! $RUNSTRING ] && {
ERROR "type ${TYPE} (group ${GROUP}) has no supported runstring generator"
return 4
}
RUNSTRING="SCWRYPTS_ENV=$ENV_NAME; $RUNSTRING"
RUNSTRING="source $SCWRYPTS_ROOT/zsh/lib/import.driver.zsh; $RUNSTRING"
local _VIRTUALENV=$(eval echo '$SCWRYPTS_VIRTUALENV_PATH__'$GROUP'/$TYPE/bin/activate')
[ -f $_VIRTUALENV ] && RUNSTRING="source $_VIRTUALENV; $RUNSTRING"
local G SCWRYPTSENV
for G in ${SCWRYPTS__GROUPS[@]}
do
SCWRYPTSENV=$(eval echo '$SCWRYPTS_ENV_PATH__'$GROUP'/$ENV_NAME')
[ -f $SCWRYPTSENV ] && RUNSTRING="source $SCWRYPTSENV; $RUNSTRING"
done
echo "$RUNSTRING"
}
SCWRYPTS__GET_RUNSTRING__zsh() {
__CHECK_DEPENDENCY zsh || return 1
echo "source $GROUP_PATH/$TYPE/$NAME"
}
SCWRYPTS__GET_RUNSTRING__py() {
__CHECK_DEPENDENCY python || return 1
CURRENT_PYTHON_VERSION=$(python --version | sed 's/^[^0-9]*\(3\.[^.]*\).*$/\1/')
echo $SCWRYPTS_PREFERRED_PYTHON_VERSIONS__scwrypts | grep -q $CURRENT_PYTHON_VERSION || {
WARNING "only tested on the following python versions: $(printf ', %s.x' ${SCWRYPTS_PREFERRED_PYTHON_VERSIONS__scwrypts[@]} | sed 's/^, //')"
WARNING 'compatibility may vary'
}
echo "cd $GROUP_PATH; python -m $(echo $TYPE/$NAME | sed 's/\//./g; s/\.py$//; s/\.\.//')"
}
SCWRYPTS__GET_RUNSTRING__zx() {
__CHECK_DEPENDENCY zx || return 1
echo "FORCE_COLOR=3; cd $GROUP_PATH; ./$TYPE/$NAME.js"
}

0
zsh/lib/scwrypts/scwrypts.module.zsh Normal file
View File

127
zsh/lib/scwrypts/virtualenv.module.zsh Normal file
View File

@ -0,0 +1,127 @@
#####################################################################
DEPENDENCIES+=(
virtualenv
nodeenv
)
REQUIRED_ENV+=()
use utils
#####################################################################
AVAILABLE_VIRTUALENVS=(py zx)
REFRESH_VIRTUALENV() {
local GROUP="$1"
local TYPE="$2"
[ ! $TYPE ] && {
ERROR 'no virtualenv type specified'
return 1
}
STATUS "refreshing $GROUP/$TYPE virtual environment"
DELETE_VIRTUALENV $GROUP $TYPE \
&& UPDATE_VIRTUALENV $GROUP $TYPE \
&& SUCCESS 'successfully refreshed virtual environment' \
|| { ERROR 'something went wrong during refresh (see above)'; return 1; } \
;
}
UPDATE_VIRTUALENV() {
local GROUP="$1"
local TYPE="$2"
[ ! $TYPE ] && {
ERROR 'no virtualenv type specified'
return 1
}
local VIRTUALENV_PATH=$(GET_VIRTUALENV_PATH $GROUP $TYPE)
[ ! -d $VIRTUALENV_PATH ] && CREATE_VIRTUALENV__${GROUP}__${TYPE} $VIRTUALENV_PATH
STATUS "updating $TYPE virtual environment"
source $VIRTUALENV_PATH/bin/activate || {
ERROR 'failed to activate virtualenv; did create fail?'
return 1
}
cd $SCWRYPTS_ROOT
local UPDATE_CODE=0
case $TYPE in
py ) cd py; pip install -r requirements.txt; UPDATE_CODE=$? ;;
zx ) cd zx; npm install ;;
esac
UPDATE_CODE=$?
[[ $UPDATE_CODE -eq 0 ]] \
&& SUCCESS "$TYPE virtual environment up-to-date" \
|| ERROR "failed to update $TYPE virtual environment (see errors above)" \
;
deactivate_node >/dev/null 2>&1
deactivate >/dev/null 2>&1
return $UPDATE_CODE
}
DELETE_VIRTUALENV() {
local GROUP="$1"
local TYPE="$2"
local VIRTUALENV_PATH="$(GET_VIRTUALENV_PATH $GROUP $TYPE)"
STATUS "dropping $TYPE virtual environment artifacts"
[ ! -d $VIRTUALENV_PATH ] && {
SUCCESS "no $TYPE environment detected"
return 0
}
rm -rf $VIRTUALENV_PATH \
&& SUCCESS "succesfully cleaned up $TYPE virtual environment" \
|| { ERROR "unabled to remove '$VIRTUALENV_PATH'"; return 1; }
}
GET_VIRTUALENV_PATH() {
local GROUP="$1"
local TYPE="$2"
eval echo '$SCWRYPTS_VIRTUALENV_PATH__'$GROUP/$TYPE
}
#####################################################################
CREATE_VIRTUALENV__scwrypts__py() {
local VIRTUALENV_PATH="$1"
STATUS 'creating python virtual environment'
local PY PYTHON
for PY in $(echo $SCWRYPTS_PREFERRED_PYTHON_VERSIONS__scwrypts)
do
which python$PY >/dev/null 2>&1 && {
PYTHON=$(which python$PY)
break
}
done
[ ! $PYTHON ] && {
ERROR 'python>=3.9 not available; skipping python env'
return 1
}
STATUS 'setting up virtualenv'
virtualenv $VIRTUALENV_PATH --python="$PYTHON" \
&& SUCCESS 'python virtualenv created' \
|| {
ERROR "unable to create '$VIRTUALENV_PATH' with '$PYTHON'"
return 2
}
}
CREATE_VIRTUALENV__scwrypts__zx() {
local VIRTUALENV_PATH="$1"
STATUS 'setting up nodeenv'
nodeenv $VIRTUALENV_PATH --node=$SCWRYPTS_NODE_VERSION__scwrypts \
&& SUCCESS 'node virtualenv created' \
|| {
ERROR "unable to create '$VIRTUALENV_PATH' with '$SCWRYPTS__NODE_VERSION'"
return 2
}
}

18
zsh/lib/system/config/config.module.zsh Normal file
View File

@ -0,0 +1,18 @@
#####################################################################
DEPENDENCIES+=()
REQUIRED_ENV+=()
#####################################################################
DEFAULT_CONFIG="${0:a:h}/default.conf.zsh"
SAFE_SYMLINKS=1
# in case dotfiles.zsh is sourced; allows users to provide initial config
[ ! $CONFIG__USER_SETTINGS ] \
&& CONFIG__USER_SETTINGS="$SCWRYPTS_CONFIG_PATH/dotfiles.zsh"
[ ! -f "$CONFIG__USER_SETTINGS" ] && cp "$DEFAULT_CONFIG" "$CONFIG__USER_SETTINGS"
source "$CONFIG__USER_SETTINGS"

19
zsh/lib/system/config/default.conf.zsh Normal file
View File

@ -0,0 +1,19 @@
#
# scwrypts dot-files config
#
#TERMINFO_PATH=/path/to/sourced/terminfo/files
#
# SAFE_SYMLINKS=1, makes a backup of config files that already exist
# SAFE_SYMLINKS=0, deletes existing config file
#
#SAFE_SYMLINKS=1
# lines which begin with '#' are ignored
SYMLINKS="
# fully qualified path ~/.config/THE-REST
# ---------------------------------------------
# /path/to/your/kitty.conf kitty/kitty.conf
"

16
zsh/lib/system/desktop/notify.module.zsh Normal file
View File

@ -0,0 +1,16 @@
#####################################################################
DEPENDENCIES+=(
notify-send
)
REQUIRED_ENV+=()
#####################################################################
NOTIFY() {
local D=$DISPLAY
[ ! $D ] && D=:0
DISPLAY=$D notify-send "SCWRYPTS $SCWRYPT_NAME" $@
}

78
zsh/lib/system/packages/git.module.zsh Normal file
View File

@ -0,0 +1,78 @@
#####################################################################
DEPENDENCIES+=(
git
make
)
REQUIRED_ENV+=()
#####################################################################
PACKAGE_INSTALL_DIR="$HOME/.local/share/source-packages"
[ ! -d "$PACKAGE_INSTALL_DIR" ] && mkdir -p "$PACKAGE_INSTALL_DIR"
#####################################################################
CLONE() {
cd "$PACKAGE_INSTALL_DIR"
STATUS "downloading $NAME"
git clone "$TARGET" "$NAME" \
&& SUCCESS "successfully downloaded '$NAME'" \
|| FAIL 1 "failed to download '$NAME'" \
;
}
PULL() {
STATUS "updating '$NAME'"
cd "$PACKAGE_INSTALL_DIR/$NAME"
git pull origin $(git rev-parse --abbrev-ref HEAD) \
&& SUCCESS "successfully updated '$NAME'" \
|| FAIL 1 "failed to update '$NAME'" \
;
}
#####################################################################
BUILD() {
cd "$PACKAGE_INSTALL_DIR/$NAME"
CHECK_MAKE && { MAKE && return 0 || return 1; }
CHECK_MAKEPKG && { MAKEPKG && return 0 || return 2; }
WARNING 'could not detect supported installation method'
REMINDER 'complete manual installation in the directory below:'
REMINDER "$PACKAGE_INSTALL_DIR/$NAME"
}
CHECK_MAKE() { [ -f ./Makefile ]; }
CHECK_MAKEPKG() { [ -f ./PKGBUILD ]; }
MAKE() {
[[ $CLEAN -eq 1 ]] && {
STATUS "cleaning '$NAME'"
make clean
}
STATUS "building '$NAME'"
make \
&& SUCCESS "finished building '$NAME'" \
|| FAIL 1 "build failed for '$NAME' (see above)"\
;
STATUS "installing '$NAME'"
GETSUDO
sudo make install \
&& SUCCESS "succesfully installed '$NAME'" \
|| FAIL 2 "failed to install '$NAME' (see above)"\
;
}
MAKEPKG() {
STATUS "installing '$NAME'"
yes | makepkg -si \
&& SUCCESS "succesfully installed '$NAME'" \
|| FAIL 1 "failed to install '$NAME' (see above)"\
;
}

11
zsh/lib/system/vim/vim.module.zsh Normal file
View File

@ -0,0 +1,11 @@
#####################################################################
DEPENDENCIES+=(
vim
)
REQUIRED_ENV+=()
#####################################################################
VIM() { vim $@ </dev/tty >/dev/tty; }

53
zsh/lib/system/vim/vundle.module.zsh Normal file
View File

@ -0,0 +1,53 @@
#####################################################################
DEPENDENCIES+=()
REQUIRED_ENV+=()
use system/vim
#####################################################################
VUNDLE__PLUGIN_DIR="$HOME/.vim/bundle"
VUNDLE__BUILD_DEFINITIONS="$SCWRYPTS_CONFIG_PATH/vundle.zsh"
[ ! -f $VUNDLE__BUILD_DEFINITIONS ] && {
{
echo -e "#\n# Scwrypts Build Definitions\n#\n"
} > $VUNDLE__BUILD_DEFINITIONS
}
VUNDLE__PLUGIN_LIST=$(ls $VUNDLE__PLUGIN_DIR | grep -v 'Vundle.vim' | grep -v 'build.zsh')
source $VUNDLE__BUILD_DEFINITIONS
for PLUGIN in $(echo $VUNDLE__PLUGIN_LIST)
do
typeset -f VUNDLE__BUILD__$PLUGIN >/dev/null 2>/dev/null || {
echo -e "\nVUNDLE__BUILD__$PLUGIN() {\n # ... build steps from $HOME/.vim/$PLUGIN \n}" \
>> $VUNDLE__BUILD_DEFINITIONS
VUNDLE__BUILD__$PLUGIN() {}
}
done
#####################################################################
VUNDLE__PLUGIN_INSTALL() {
VIM +PluginInstall +qall \
&& SUCCESS 'successfully installed Vundle.vim plugins' \
|| FAIL 1 'failed to install Vundle.vim plugins'
}
VUNDLE__REBUILD_PLUGINS() {
local ERRORS=0
local PLUGIN
for PLUGIN in $(echo $VUNDLE__PLUGIN_LIST)
do
cd "$VUNDLE__PLUGIN_DIR/$PLUGIN"
STATUS "building '$PLUGIN'"
VUNDLE__BUILD__$PLUGIN \
&& SUCCESS "finished building '$PLUGIN'" \
|| ERROR "failed to build '$PLUGIN' (see above)" \
;
done
return $ERRORS
}

57
zsh/lib/utils/README.md Normal file
View File

@ -0,0 +1,57 @@
# 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](#dependencies) and [Environment](#environment) below).
```shell
#!/bin/zsh
source ./path/to/utils.plugin.zsh
SUCCESS 'ZSH utilities online!'
```
Checkout [io](./io.zsh) and [os](./os.zsh) 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`.
```shell
#!/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](#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*).
```shell
#!/bin/zsh
REQUIRED_ENV+=(
AWS_PROFILE
AWS_REGION
)
source ./path/to/utils.plugin.zsh
echo "missing $ENV_ERROR_COUNT required environment variables"
```

44
zsh/lib/utils/colors.zsh Normal file
View File

@ -0,0 +1,44 @@
__BLACK='\033[0;30m'
__DARK_GRAY='\033[1;30m'
__RED='\033[0;31m'
__LIGHT_RED='\033[1;31m'
__GREEN='\033[0;32m'
__LIGHT_GREEN='\033[1;32m'
__ORANGE='\033[0;33m'
__YELLOW='\033[1;33m'
__BLUE='\033[1;34m'
__DARK_BLUE='\033[0;34m'
__PURPLE='\033[1;35m'
__DARK_PURPLE='\033[0;35m'
__CYAN='\033[1;36m'
__DARK_CYAN='\033[0;36m'
__WHITE='\033[1;37m'
__LIGHT_GRAY='\033[0;37m'
__COLOR_RESET='\033[0m'
__GET_RANDOM_COLOR() {
local COLORS=(
$__RED
$__LIGHT_RED
$__GREEN
$__LIGHT_GREEN
$__ORANGE
$__YELLOW
$__BLUE
$__DARK_BLUE
$__PURPLE
$__DARK_PURPLE
$__CYAN
$__DARK_CYAN
$__WHITE
)
print "$__COLOR_RESET${COLORS[$(shuf -i 1-${#COLORS[@]} -n 1)]}"
}

11
zsh/lib/utils/credits.zsh Normal file
View File

@ -0,0 +1,11 @@
__CREDITS() {
# scwrypts exclusive ("credits" pulled from README files)
[ ! $SCWRYPTS_ROOT ] && return 0
local COMMAND="$1"
[[ $COMMAND =~ - ]] && COMMAND=$(echo $COMMAND | sed 's/-/--/g')
cd $SCWRYPTS_ROOT
cat ./**/README.md \
| grep 'Generic Badge' \
| sed -n "s/.*Generic Badge.*-$COMMAND-.*(/(/p"
}

43
zsh/lib/utils/dependencies.zsh Normal file
View File

@ -0,0 +1,43 @@
__CHECK_DEPENDENCIES() {
local DEP ERROR=0
DEPENDENCIES=($(echo $DEPENDENCIES | sed 's/ \+/\n/g' | sort -u))
for DEP in ${DEPENDENCIES[@]}; do __CHECK_DEPENDENCY $DEP || ((ERROR+=1)); done
__CHECK_COREUTILS || ((ERROR+=$?))
return $ERROR
}
__CHECK_DEPENDENCY() {
local DEPENDENCY="$1"
[ ! $DEPENDENCY ] && return 1
command -v $DEPENDENCY >/dev/null 2>&1 || {
ERROR "'$1' required but not available on PATH $(__CREDITS $1)"
return 1
}
}
__CHECK_COREUTILS() {
local COREUTILS=(awk find grep sed readlink)
local MISSING_DEPENDENCY_COUNT=0
local NON_GNU_DEPENDENCY_COUNT=0
local UTIL
for UTIL in $(echo $COREUTILS)
do
__CHECK_DEPENDENCY $UTIL || { ((MISSING_DEPENDENCY_COUNT+=1)); continue; }
$UTIL --version 2>&1 | grep -q 'GNU' || {
WARNING "non-GNU version of $UTIL detected"
((NON_GNU_DEPENDENCY_COUNT+=1))
}
done
[[ $NON_GNU_DEPENDENCY_COUNT -gt 0 ]] && {
WARNING 'scripts rely on GNU coreutils; functionality may be limited'
IS_MACOS && REMINDER 'GNU coreutils can be installed and linked through Homebrew'
}
return $MISSING_DEPENDENCY_COUNT
}

38
zsh/lib/utils/environment.zsh Normal file
View File

@ -0,0 +1,38 @@
__CHECK_REQUIRED_ENV() {
local VAR ERROR=0
REQUIRED_ENV=($(echo $REQUIRED_ENV | sed 's/\s\+/\n/g' | sort -u))
for VAR in ${REQUIRED_ENV[@]}; do __CHECK_ENV_VAR $VAR || ((ERROR+=1)); done
return $ERROR
}
__CHECK_ENV_VAR() {
local NAME="$1"
[ ! $NAME ] && return 1
local OVERRIDE_VALUE=$(eval echo '$'$NAME'__override')
[ $OVERRIDE_VALUE ] && export $NAME=$OVERRIDE_VALUE && return 0
local OPTIONAL="$2"
local DEFAULT_VALUE="$3"
local VALUE=$(eval echo '$'$NAME)
[ $VALUE ] && return 0
local SELECTION_VALUES=$(eval echo '$'$NAME'__select' | sed 's/,/\n/g; s/ /\n/g')
[[ $ERROR -eq 0 ]] && [[ ${#SELECTION_VALUES[@]} -gt 0 ]] && {
local SELECTION=$(echo $SELECTION_VALUES | FZF "select a value for '$NAME'")
[ $SELECTION ] && {
export $NAME=$SELECTION
return 0
}
}
[ $VALUE ] && return 0
[ $OPTIONAL ] && {
[ $DEFAULT_VALUE ] && $NAME="$DEFAULT_VALUE"
return 0
} || {
ERROR "'$NAME' required"
return 1
}
}

152
zsh/lib/utils/io.zsh Normal file
View File

@ -0,0 +1,152 @@
PRINT() {
local MESSAGE
local LAST_LINE_END='\n'
local STDERR=1
local STDOUT=0
local LTRIM=1
while [[ $# -gt 0 ]]
do
case $1 in
-n | --no-trim-tabs ) LTRIM=0 ;;
-x | --no-line-end ) LAST_LINE_END='' ;;
-o | --use-stdout ) STDOUT=1; STDERR=0 ;;
* ) MESSAGE+="$(echo $1) " ;;
esac
shift 1
done
local STYLED_MESSAGE="${COLOR}$({
printf "${COLOR}"
while IFS='' read line
do
[[ $PREFIX =~ ^[[:space:]]\+$ ]] && printf '\n'
printf "${PREFIX} : $(echo "$line" | sed 's/^ \+//; s/ \+$//')"
PREFIX=$(echo $PREFIX | sed 's/./ /g')
done <<< $MESSAGE
})${__COLOR_RESET}${LAST_LINE_END}"
[[ $STDERR -eq 1 ]] && printf $STYLED_MESSAGE >&2
[[ $STDOUT -eq 1 ]] && printf $STYLED_MESSAGE
return 0
}
[ ! $ERRORS ] && ERRORS=0
ERROR() { PREFIX="ERROR ✖" COLOR=$__RED PRINT "$@"; ((ERRORS+=1)); }
SUCCESS() { PREFIX="SUCCESS ✔" COLOR=$__GREEN PRINT "$@"; }
WARNING() { PREFIX="WARNING " COLOR=$__ORANGE PRINT "$@"; }
STATUS() { PREFIX="STATUS " COLOR=$__BLUE PRINT "$@"; }
REMINDER() { PREFIX="REMINDER " COLOR=$__PURPLE PRINT "$@"; }
INFO() { PREFIX="INFO " COLOR=$__WHITE PRINT "$@"; }
PROMPT() {
PREFIX="PROMPT " COLOR=$__CYAN PRINT "$@"
PREFIX="USER " COLOR=$__CYAN PRINT '' --no-line-end
}
FAIL() { ERROR "${@:2}"; exit $1; }
ABORT() { FAIL 69 'user abort'; }
CHECK_ERRORS() {
local FAIL_OUT=1
while [[ $# -gt 0 ]]
do
case $1 in
-n | --no-fail ) FAIL_OUT=0 ;;
esac
shift 1
done
[ ! $ERRORS ] && ERRORS=0
[[ $ERRORS -ne 0 ]] && USAGE
[[ $ERRORS -eq 0 ]] || {
[[ $FAIL_OUT -eq 1 ]] \
&& exit $ERRORS \
|| return $ERRORS
}
}
USAGE() {
[ ! $USAGE ] && return 0
USAGE=$(echo $USAGE | sed "s/^\t\+//; s/\s\+$//")
local USAGE_LINE=$(\
echo $USAGE \
| grep -i '^ *usage *:' \
| sed "s;^[^:]*:;& scwrypts $SCWRYPT_NAME --;" \
| sed 's/ \{2,\}/ /g; s/scwrypts -- scwrypts/scwrypts/' \
)
local THE_REST=$(echo $USAGE | grep -vi '^ *usage *:' | sed 'N;/^\n$/D;P;D;')
{ echo; printf "$__DARK_BLUE $USAGE_LINE$__COLOR_RESET\n"; echo $THE_REST; echo } >&2
}
INPUT() {
PROMPT "${@:2}"
READ $1
local VALUE=$(eval echo '$'$1)
[ $VALUE ]
}
Yn() {
PROMPT "$@ [Yn]"
[ $CI ] && { echo y; return 0; }
local Yn; READ -k Yn; echo
[[ $Yn =~ [nN] ]] && return 1 || return 0
}
yN() {
PROMPT "$@ [yN]"
[ $CI ] && { echo y; return 0; }
local yN; READ -k yN; echo
[[ $yN =~ [yY] ]] && return 0 || return 1
}
#####################################################################
GETSUDO() {
echo "\\033[1;36mPROMPT  : checking sudo password...\\033[0m" >&2
sudo echo hi >/dev/null 2>&1 </dev/tty \
&& SUCCESS '...authenticated!' \
|| { ERROR 'failed :c'; return 1; }
}
LESS() { less -R $@ </dev/tty >/dev/tty; }
FZF() {
[ $CI ] && {
ERROR 'currently in CI, but FZF requires user input'
exit 1
}
local SELECTION=$(fzf -i --height=30% --layout=reverse --prompt "$1 : " ${@:2})
PROMPT "$1"
echo $SELECTION >&2
echo $SELECTION
}
FZF_HEAD() { FZF $@ --print-query | sed '/^$/d' | head -n1; } # prefer user input over selected
FZF_TAIL() { FZF $@ --print-query | sed '/^$/d' | tail -n1; } # prefer selected over user input
READ() {
[ $CI ] && {
INFO 'currently in CI, skipping READ'
return 0
}
read $@ </dev/tty
}
EDIT() {
[ $CI ] && {
INFO 'currently in CI, skipping EDIT'
return 0
}
STATUS "opening '$1' for editing"
$EDITOR $@ </dev/tty >/dev/tty
SUCCESS "finished editing '$1'!"
}

12
zsh/lib/utils/os.zsh Normal file
View File

@ -0,0 +1,12 @@
IS_MACOS() { uname -s | grep -q 'Darwin'; }
OPEN() {
local OPEN=''
{
command -v xdg-open && OPEN=xdg-open
command -v open && OPEN=open
} >/dev/null 2>&1
[ ! $OPEN ] && { ERROR 'unable to detect default open command (e.g. xdg-open)'; return 1 }
$OPEN $@
}

76
zsh/lib/utils/utils.module.zsh Normal file
View File

@ -0,0 +1,76 @@
#####################################################################
DEPENDENCIES+=(fzf) # (extensible) list of PATH dependencies
REQUIRED_ENV+=() # (extensible) list of required environment variables
#####################################################################
source ${0:a:h}/colors.zsh
source ${0:a:h}/io.zsh
source ${0:a:h}/os.zsh
source ${0:a:h}/credits.zsh
#####################################################################
source ${0:a:h}/dependencies.zsh
source ${0:a:h}/environment.zsh
#####################################################################
CHECK_ENVIRONMENT() {
local ENVIRONMENT_STATUS=0
__CHECK_DEPENDENCIES $DEPENDENCIES
local MISSING_DEPENDENCIES=$?
__CHECK_REQUIRED_ENV $REQUIRED_ENV
local MISSING_ENVIRONMENT_VARIABLES=$?
##########################################
local ERROR_MESSAGE=""
[[ $MISSING_DEPENDENCIES -ne 0 ]] && {
((ENVIRONMENT_STATUS+=1))
ERROR_MESSAGE+="\n$MISSING_DEPENDENCIES missing "
[[ $MISSING_DEPENDENCIES -eq 1 ]] \
&& ERROR_MESSAGE+='dependency' \
|| ERROR_MESSAGE+='dependencies' \
;
}
[[ $MISSING_ENVIRONMENT_VARIABLES -ne 0 ]] && {
((ENVIRONMENT_STATUS+=2))
ERROR_MESSAGE+="\n$MISSING_ENVIRONMENT_VARIABLES missing environment variable"
[[ $MISSING_ENVIRONMENT_VARIABLES -gt 1 ]] && ERROR_MESSAGE+=s
}
[ $IMPORT_ERRORS ] && [[ $IMPORT_ERRORS -ne 0 ]] && {
((ENVIRONMENT_STATUS+=4))
ERROR_MESSAGE+="\n$IMPORT_ERRORS import error"
[[ $IMPORT_ERRORS -gt 1 ]] && ERROR_MESSAGE+=s
}
##########################################
[[ ENVIRONMENT_STATUS -eq 0 ]] || {
ERROR_MESSAGE=$(echo $ERROR_MESSAGE | sed '1d; s/^/ /')
ERROR "environment errors found (see above)\n$ERROR_MESSAGE"
}
[[ $MISSING_ENVIRONMENT_VARIABLES -ne 0 ]] && {
REMINDER "
to quickly update missing environment variables, run:
'scwrypts zsh/scwrypts/environment/edit'
"
}
[[ $ENVIRONMENT_STATUS -eq 0 ]] || {
[[ $NO_EXIT -eq 1 ]] && return $ENVIRONMENT_STATUS
exit $ENVIRONMENT_STATUS
}
}
CHECK_ENVIRONMENT