v4.0.0
=====================================================================
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)
This commit is contained in:
@ -86,7 +86,7 @@ RDS__GET_DATABASE_CREDENTIALS() {
|
||||
user-input ) _RDS_AUTH__userinput ;;
|
||||
esac
|
||||
|
||||
[[ $PRINT_PASSWORD -eq 1 ]] && INFO "password : $DB_PASS"
|
||||
[[ $PRINT_PASSWORD -eq 1 ]] && DEBUG "password : $DB_PASS"
|
||||
|
||||
return 0
|
||||
}
|
||||
|
||||
@ -99,8 +99,8 @@ TALLY() {
|
||||
true ) printf "$NEW_VALUE" ;;
|
||||
false )
|
||||
case $TALLY_NAME in
|
||||
default ) INFO "current tally : $NEW_VALUE" ;;
|
||||
* ) INFO "$TALLY_NAME : $NEW_VALUE" ;;
|
||||
default ) SUCCESS "current tally : $NEW_VALUE" ;;
|
||||
* ) SUCCESS "$TALLY_NAME : $NEW_VALUE" ;;
|
||||
esac
|
||||
esac
|
||||
}
|
||||
|
||||
@ -12,7 +12,7 @@ SCWRYPTS__SELECT_ENV() {
|
||||
}
|
||||
|
||||
SCWRYPTS__SELECT_OR_CREATE_ENV() {
|
||||
SCWRYPTS__GET_ENV_NAMES | FZF_TAIL 'select / create an environment'
|
||||
SCWRYPTS__GET_ENV_NAMES | FZF_USER_INPUT 'select / create an environment'
|
||||
}
|
||||
|
||||
SCWRYPTS__GET_ENV_FILES() {
|
||||
|
||||
@ -8,15 +8,13 @@ use scwrypts/run
|
||||
|
||||
#####################################################################
|
||||
|
||||
SCWRYPTS__RUN() {
|
||||
SCWRYPTS__RUN() { # context wrapper to run scwrypts within scwrypts
|
||||
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 $@"
|
||||
}
|
||||
|
||||
@ -112,6 +112,58 @@ SCWRYPTS__GET_RUNSTRING() {
|
||||
SCWRYPTS__GET_RUNSTRING__zsh() {
|
||||
__CHECK_DEPENDENCY zsh || return 1
|
||||
|
||||
local SCWRYPT_FILENAME
|
||||
|
||||
[ $(eval echo '$SCWRYPTS_TYPE__'$SCWRYPT_GROUP) ] \
|
||||
&& SCWRYPT_FILENAME="$GROUP_PATH/$SCWRYPT_NAME" \
|
||||
|| SCWRYPT_FILENAME="$GROUP_PATH/$SCWRYPT_TYPE/$SCWRYPT_NAME" \
|
||||
;
|
||||
|
||||
printf "
|
||||
source '$SCWRYPT_FILENAME'
|
||||
CHECK_ENVIRONMENT
|
||||
ERRORS=0
|
||||
|
||||
export USAGE=\"
|
||||
usage: -
|
||||
|
||||
args: -
|
||||
|
||||
options: -
|
||||
-h, --help display this message and exit
|
||||
|
||||
description: -
|
||||
\"
|
||||
|
||||
[ ! \$USAGE__usage ] && export USAGE__usage='[...options...]'
|
||||
|
||||
() {
|
||||
local MAIN_ARGS=()
|
||||
local VARSPLIT
|
||||
while [[ \$# -gt 0 ]]
|
||||
do
|
||||
case \$1 in
|
||||
-[a-z][a-z]* )
|
||||
VARSPLIT=\$(echo \"\$1 \" | sed 's/^\\\\(-.\\\\)\\\\(.*\\\\) /\\\\1 -\\\\2/')
|
||||
set -- throw-away \$(echo \" \$VARSPLIT \") \${@:2}
|
||||
;;
|
||||
-h | --help ) USAGE; exit 0 ;;
|
||||
* ) MAIN_ARGS+=(\$1) ;;
|
||||
esac
|
||||
shift 1
|
||||
done
|
||||
MAIN \${MAIN_ARGS[@]}
|
||||
} "
|
||||
|
||||
|
||||
return 0
|
||||
}
|
||||
|
||||
SCWRYPTS__GET_RUNSTRING__zsh_v3() {
|
||||
WARNING "scwrypts zsh/v3 runstrings are now deprecated; please update to scwrypts v4 format"
|
||||
|
||||
__CHECK_DEPENDENCY zsh || return 1
|
||||
|
||||
[ $(eval echo '$SCWRYPTS_TYPE__'$SCWRYPT_GROUP) ] \
|
||||
&& echo "source $GROUP_PATH/$SCWRYPT_NAME" \
|
||||
|| echo "source $GROUP_PATH/$SCWRYPT_TYPE/$SCWRYPT_NAME" \
|
||||
|
||||
@ -85,8 +85,6 @@ CREATE_VIRTUALENV__scwrypts__py() {
|
||||
|
||||
DEPENDENCIES=(virtualenv) CHECK_ENVIRONMENT || return 1
|
||||
|
||||
local VIRTUALENV_PATH="$1"
|
||||
|
||||
STATUS 'creating python virtualenv'
|
||||
local PY PYTHON
|
||||
for PY in $(echo $SCWRYPTS_PREFERRED_PYTHON_VERSIONS__scwrypts)
|
||||
@ -141,8 +139,6 @@ CREATE_VIRTUALENV__scwrypts__zx() {
|
||||
|
||||
DEPENDENCIES=(nodeenv) CHECK_ENVIRONMENT || return 1
|
||||
|
||||
local VIRTUALENV_PATH="$1"
|
||||
|
||||
STATUS 'setting up nodeenv'
|
||||
nodeenv $VIRTUALENV_PATH --node=$SCWRYPTS_NODE_VERSION__scwrypts \
|
||||
&& SUCCESS 'node virtualenv created' \
|
||||
|
||||
@ -2,22 +2,22 @@ __BLACK='\033[0;30m'
|
||||
__DARK_GRAY='\033[1;30m'
|
||||
|
||||
__RED='\033[0;31m'
|
||||
__LIGHT_RED='\033[1;31m'
|
||||
__BRIGHT_RED='\033[1;31m'
|
||||
|
||||
__GREEN='\033[0;32m'
|
||||
__LIGHT_GREEN='\033[1;32m'
|
||||
__BRIGHT_GREEN='\033[1;32m'
|
||||
|
||||
__ORANGE='\033[0;33m'
|
||||
__YELLOW='\033[1;33m'
|
||||
__YELLOW='\033[0;33m'
|
||||
__BRIGHT_YELLOW='\033[1;33m'
|
||||
|
||||
__BLUE='\033[1;34m'
|
||||
__DARK_BLUE='\033[0;34m'
|
||||
__BLUE='\033[0;34m'
|
||||
__BRIGHT_BLUE='\033[1;34m'
|
||||
|
||||
__PURPLE='\033[1;35m'
|
||||
__DARK_PURPLE='\033[0;35m'
|
||||
__MAGENTA='\033[0;35m'
|
||||
__BRIGHT_MAGENTA='\033[1;35m'
|
||||
|
||||
__CYAN='\033[1;36m'
|
||||
__DARK_CYAN='\033[0;36m'
|
||||
__CYAN='\033[0;36m'
|
||||
__BRIGHT_CYAN='\033[1;36m'
|
||||
|
||||
__WHITE='\033[1;37m'
|
||||
__LIGHT_GRAY='\033[0;37m'
|
||||
@ -27,17 +27,17 @@ __COLOR_RESET='\033[0m'
|
||||
__GET_RANDOM_COLOR() {
|
||||
local COLORS=(
|
||||
$__RED
|
||||
$__LIGHT_RED
|
||||
$__BRIGHT_RED
|
||||
$__GREEN
|
||||
$__LIGHT_GREEN
|
||||
$__ORANGE
|
||||
$__BRIGHT_GREEN
|
||||
$__YELLOW
|
||||
$__BRIGHT_YELLOW
|
||||
$__BLUE
|
||||
$__DARK_BLUE
|
||||
$__PURPLE
|
||||
$__DARK_PURPLE
|
||||
$__BRIGHT_BLUE
|
||||
$__MAGENTA
|
||||
$__BRIGHT_MAGENTA
|
||||
$__CYAN
|
||||
$__DARK_CYAN
|
||||
$__BRIGHT_CYAN
|
||||
$__WHITE
|
||||
)
|
||||
print "$__COLOR_RESET${COLORS[$(shuf -i 1-${#COLORS[@]} -n 1)]}"
|
||||
|
||||
@ -1,13 +1,14 @@
|
||||
__CHECK_DEPENDENCIES() {
|
||||
local DEP ERROR=0
|
||||
local DEP ERRORS=0
|
||||
local SCWRYPTS_LOG_LEVEL=1
|
||||
[ ! $E ] && E=ERROR
|
||||
|
||||
DEPENDENCIES=($(echo $DEPENDENCIES | sed 's/ \+/\n/g' | sort -u))
|
||||
|
||||
for DEP in ${DEPENDENCIES[@]}; do __CHECK_DEPENDENCY $DEP || ((ERROR+=1)); done
|
||||
__CHECK_COREUTILS || ((ERROR+=$?))
|
||||
for DEP in ${DEPENDENCIES[@]}; do __CHECK_DEPENDENCY $DEP || ((ERRORS+=1)); done
|
||||
__CHECK_COREUTILS || ((ERRORS+=$?))
|
||||
|
||||
return $ERROR
|
||||
return $ERRORS
|
||||
}
|
||||
|
||||
__CHECK_DEPENDENCY() {
|
||||
|
||||
@ -1,4 +1,5 @@
|
||||
__CHECK_REQUIRED_ENV() {
|
||||
local SCWRYPTS_LOG_LEVEL=1
|
||||
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
|
||||
|
||||
57
zsh/lib/utils/io.fzf.zsh
Normal file
57
zsh/lib/utils/io.fzf.zsh
Normal file
@ -0,0 +1,57 @@
|
||||
FZF() {
|
||||
[ $CI ] && FAIL 1 'currently in CI, but FZF requires user input'
|
||||
|
||||
local FZF_ARGS=()
|
||||
|
||||
FZF_ARGS+=(-i)
|
||||
FZF_ARGS+=(--ansi)
|
||||
FZF_ARGS+=(--bind=ctrl-c:cancel)
|
||||
FZF_ARGS+=(--height=50%)
|
||||
FZF_ARGS+=(--layout=reverse)
|
||||
|
||||
local SELECTION=$(fzf ${FZF_ARGS[@]} --prompt "$1 : " ${@:2} 2>/dev/tty)
|
||||
PROMPT "$1"
|
||||
|
||||
[ $BE_QUIET ] || {
|
||||
[[ $SCWRYPTS_LOG_LEVEL -ge 1 ]] && echo $SELECTION >&2
|
||||
}
|
||||
echo $SELECTION
|
||||
[ $SELECTION ]
|
||||
}
|
||||
|
||||
FZF_USER_INPUT() { # allow user to type custom answers; reconfirm if ambiguous with select
|
||||
local FZF_OUTPUT=$(BE_QUIET=1 FZF $@ --print-query | sed '/^$/d' | sort -u)
|
||||
[[ $SCWRYPTS_LOG_LEVEL -ge 1 ]] && echo $FZF_OUTPUT | head -n1 >&2
|
||||
[ ! $FZF_OUTPUT ] && return 1
|
||||
|
||||
[[ $(echo "$FZF_OUTPUT" | wc -l) -eq 1 ]] \
|
||||
&& { echo "$FZF_OUTPUT"; return 0; }
|
||||
|
||||
local FZF_OUTPUT=$(
|
||||
echo "$FZF_OUTPUT" \
|
||||
| sed "1s/\$/^$(printf "$__LIGHT_GRAY\\033[3m")<- what you typed$(printf $__COLOR_RESET)/" \
|
||||
| sed "2s/\$/^$(printf "$__LIGHT_GRAY\\033[3m")<- what you selected$(printf $__COLOR_RESET)/" \
|
||||
| column -ts '^' \
|
||||
| BE_QUIET=1 FZF "$@ (clarify)" \
|
||||
)
|
||||
|
||||
[[ $SCWRYPTS_LOG_LEVEL -ge 1 ]] && echo $FZF_OUTPUT >&2
|
||||
FZF_OUTPUT=$(echo $FZF_OUTPUT | sed 's/\s\+<- what you .*$//')
|
||||
echo $FZF_OUTPUT
|
||||
[ $FZF_OUTPUT ]
|
||||
}
|
||||
|
||||
#####################################################################
|
||||
### vvv DEPRECATED vvv ##############################################
|
||||
#####################################################################
|
||||
|
||||
FZF_HEAD() { # prefer user input over selected
|
||||
WARNING 'FZF_HEAD is deprecated and will be unavailable in v4.2; please switch to FZF_USER_INPUT (drop-in fix!)'
|
||||
FZF $@ --print-query | sed '/^$/d' | head -n1;
|
||||
}
|
||||
FZF_TAIL() { # prefer selected over user input
|
||||
WARNING 'FZF_TAIL is deprecated and will be unavailable in v4.2; please switch to FZF_USER_INPUT (drop-in fix!)'
|
||||
FZF $@ --print-query | sed '/^$/d' | tail -n1;
|
||||
}
|
||||
|
||||
#####################################################################
|
||||
38
zsh/lib/utils/io.print.zsh
Normal file
38
zsh/lib/utils/io.print.zsh
Normal file
@ -0,0 +1,38 @@
|
||||
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
|
||||
|
||||
MESSAGE="$(echo "$MESSAGE" | sed 's/%/%%/g')"
|
||||
|
||||
local STYLED_MESSAGE="$({
|
||||
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
|
||||
})"
|
||||
STYLED_MESSAGE="${COLOR}$(echo "$STYLED_MESSAGE" | sed 's/%/%%/g')${__COLOR_RESET}${LAST_LINE_END}"
|
||||
|
||||
[[ $STDERR -eq 1 ]] && printf $STYLED_MESSAGE >&2
|
||||
[[ $STDOUT -eq 1 ]] && printf $STYLED_MESSAGE
|
||||
|
||||
return 0
|
||||
}
|
||||
65
zsh/lib/utils/io.usage.zsh
Normal file
65
zsh/lib/utils/io.usage.zsh
Normal file
@ -0,0 +1,65 @@
|
||||
USAGE() { # formatter for USAGE variable
|
||||
[ ! $USAGE ] && return 0
|
||||
local USAGE_LINE=$(echo $USAGE | grep -i '^[ ]*usage *:' | sed 's/^[ ]*//')
|
||||
|
||||
[ $USAGE__usage ] && echo $USAGE_LINE | grep -q 'usage: -' \
|
||||
&& USAGE_LINE=$(echo $USAGE_LINE | sed "s/usage: -/usage: $USAGE__usage/")
|
||||
|
||||
[ $__SCWRYPT ] \
|
||||
&& USAGE_LINE=$(
|
||||
echo $USAGE_LINE \
|
||||
| sed "s;^[^:]*:;& scwrypts $SCWRYPT_NAME --;" \
|
||||
| sed 's/ \{2,\}/ /g; s/scwrypts -- scwrypts/scwrypts/' \
|
||||
)
|
||||
|
||||
local THE_REST=$(echo $USAGE | grep -vi '^[ ]*usage *:' )
|
||||
|
||||
local DYNAMIC_USAGE_ELEMENT
|
||||
#
|
||||
# create dynamic usage elements (like 'args') by defining USAGE__<element>
|
||||
# then using the syntax "<element>: -" in your USAGE variable
|
||||
#
|
||||
# e.g.
|
||||
#
|
||||
# USAGE__args="
|
||||
# subcommand arg 1 arg 1 description
|
||||
# subcommand arg 2 some other description
|
||||
# "
|
||||
#
|
||||
# USAGE="
|
||||
# usage: some-command [...args...]
|
||||
#
|
||||
# args: -
|
||||
# -h, --help some arguments are applicable everywhere
|
||||
# "
|
||||
#
|
||||
for DYNAMIC_USAGE_ELEMENT in $(echo $THE_REST | sed -n 's/^\([^:]*\): -$/\1/p')
|
||||
do
|
||||
DYNAMIC_USAGE_ELEMENT_TEXT=$(eval echo '$USAGE__'$DYNAMIC_USAGE_ELEMENT)
|
||||
#[ $DYNAMIC_USAGE_ELEMENT_TEXT ] || continue
|
||||
|
||||
|
||||
case $DYNAMIC_USAGE_ELEMENT in
|
||||
description )
|
||||
DYNAMIC_USAGE_ELEMENT_TEXT=$(echo "$DYNAMIC_USAGE_ELEMENT_TEXT" | perl -p0e 's/^[\n\s]+//')
|
||||
DYNAMIC_USAGE_ELEMENT_TEXT="$__YELLOW\\033[03m$DYNAMIC_USAGE_ELEMENT_TEXT\\033[0m"
|
||||
;;
|
||||
* )
|
||||
DYNAMIC_USAGE_ELEMENT_TEXT=$(echo $DYNAMIC_USAGE_ELEMENT_TEXT | sed 's/[^ ]/ &/')
|
||||
;;
|
||||
esac
|
||||
|
||||
THE_REST=$(echo $THE_REST | perl -pe "s$DYNAMIC_USAGE_ELEMENT: -$DYNAMIC_USAGE_ELEMENT:\n$DYNAMIC_USAGE_ELEMENT_TEXT\n\n")
|
||||
done
|
||||
|
||||
# allow for dynamic 'description: -' but delete the 'description:' header line
|
||||
THE_REST=$(echo $THE_REST | sed '/^[ ]*description:$/d')
|
||||
|
||||
echo "$__BLUE$USAGE_LINE$__COLOR_RESET\n\n$THE_REST" \
|
||||
| sed "s/^\t\+//; s/\s\+$//; s/^\\s*$//;" \
|
||||
| sed '/./,$!d; :a; /^\n*$/{$d;N;ba;};' \
|
||||
| perl -p0e 's/\n{2,}/\n\n/g' \
|
||||
| perl -p0e 's/:\n{2,}/:\n/g' \
|
||||
| perl -p0e 's/([a-z]+:)\n([a-z]+:)/\2/g' \
|
||||
>&2
|
||||
}
|
||||
@ -1,218 +1,104 @@
|
||||
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
|
||||
|
||||
MESSAGE="$(echo "$MESSAGE" | sed 's/%/%%/g')"
|
||||
|
||||
local STYLED_MESSAGE="$({
|
||||
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
|
||||
})"
|
||||
STYLED_MESSAGE="${COLOR}$(echo "$STYLED_MESSAGE" | sed 's/%/%%/g')${__COLOR_RESET}${LAST_LINE_END}"
|
||||
|
||||
[[ $STDERR -eq 1 ]] && printf $STYLED_MESSAGE >&2
|
||||
[[ $STDOUT -eq 1 ]] && printf $STYLED_MESSAGE
|
||||
|
||||
return 0
|
||||
}
|
||||
#####################################################################
|
||||
### basic colorized print messages ##################################
|
||||
#####################################################################
|
||||
|
||||
source "${0:a:h}/io.print.zsh"
|
||||
[ ! $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
|
||||
local DISPLAY_USAGE=1
|
||||
|
||||
while [[ $# -gt 0 ]]
|
||||
do
|
||||
case $1 in
|
||||
--no-fail ) FAIL_OUT=0 ;;
|
||||
--no-usage ) DISPLAY_USAGE=0 ;;
|
||||
esac
|
||||
shift 1
|
||||
done
|
||||
|
||||
[ ! $ERRORS ] && ERRORS=0
|
||||
[[ $ERRORS -eq 0 ]] && return 0
|
||||
|
||||
[[ $DISPLAY_USAGE -eq 1 ]] && USAGE
|
||||
|
||||
[[ $FAIL_OUT -eq 1 ]] && exit $ERRORS
|
||||
|
||||
ERROR() { # command encountered an error
|
||||
[[ $SCWRYPTS_LOG_LEVEL -ge 1 ]] \
|
||||
&& PREFIX="ERROR ✖" COLOR=$__RED PRINT "$@"
|
||||
((ERRORS+=1))
|
||||
return $ERRORS
|
||||
}
|
||||
|
||||
USAGE() { # formatter for USAGE variable
|
||||
[ ! $USAGE ] && return 0
|
||||
local USAGE_LINE=$(echo $USAGE | grep -i '^[ ]*usage *:' | sed 's/^[ ]*//')
|
||||
|
||||
[ $USAGE__usage ] && echo $USAGE_LINE | grep -q 'usage: -' \
|
||||
&& USAGE_LINE=$(echo $USAGE_LINE | sed "s/usage: -/usage: $USAGE__usage/")
|
||||
|
||||
[ $__SCWRYPT ] \
|
||||
&& USAGE_LINE=$(
|
||||
echo $USAGE_LINE \
|
||||
| sed "s;^[^:]*:;& scwrypts $SCWRYPT_NAME --;" \
|
||||
| sed 's/ \{2,\}/ /g; s/scwrypts -- scwrypts/scwrypts/' \
|
||||
)
|
||||
|
||||
local THE_REST=$(echo $USAGE | grep -vi '^[ ]*usage *:' )
|
||||
|
||||
local DYNAMIC_USAGE_ELEMENT
|
||||
#
|
||||
# create dynamic usage elements (like 'args') by defining USAGE__<element>
|
||||
# then using the syntax "<element>: -" in your USAGE variable
|
||||
#
|
||||
# e.g.
|
||||
#
|
||||
# USAGE__args="
|
||||
# subcommand arg 1 arg 1 description
|
||||
# subcommand arg 2 some other description
|
||||
# "
|
||||
#
|
||||
# USAGE="
|
||||
# usage: some-command [...args...]
|
||||
#
|
||||
# args: -
|
||||
# -h, --help some arguments are applicable everywhere
|
||||
# "
|
||||
#
|
||||
for DYNAMIC_USAGE_ELEMENT in $(echo $THE_REST | sed -n 's/^\([^:]*\): -$/\1/p')
|
||||
do
|
||||
DYNAMIC_USAGE_ELEMENT_TEXT=$(eval echo '$USAGE__'$DYNAMIC_USAGE_ELEMENT)
|
||||
|
||||
[[ ! $DYNAMIC_USAGE_ELEMENT =~ ^description$ ]] \
|
||||
&& DYNAMIC_USAGE_ELEMENT_TEXT=$(echo $DYNAMIC_USAGE_ELEMENT_TEXT | sed 's/[^ ]/ &/')
|
||||
|
||||
THE_REST=$(echo $THE_REST | perl -pe "s/$DYNAMIC_USAGE_ELEMENT: -/$DYNAMIC_USAGE_ELEMENT:\n$DYNAMIC_USAGE_ELEMENT_TEXT\n\n/")
|
||||
done
|
||||
|
||||
# allow for dynamic 'description: -' but delete the 'description:' header line
|
||||
THE_REST=$(echo $THE_REST | sed '/^[ ]*description:$/d')
|
||||
|
||||
echo "$__DARK_BLUE$USAGE_LINE$__COLOR_RESET\n\n$THE_REST" \
|
||||
| sed "s/^\t\+//; s/\s\+$//; s/^\\s*$//;" \
|
||||
| sed '/./,$!d; :a; /^\n*$/{$d;N;ba;};' \
|
||||
| perl -p0e 's/\n{2,}/\n\n/g' \
|
||||
| perl -p0e 's/:\n{2,}/:\n/g' \
|
||||
>&2
|
||||
SUCCESS() { # command completed successfully
|
||||
[[ $SCWRYPTS_LOG_LEVEL -ge 1 ]] \
|
||||
&& PREFIX="SUCCESS ✔" COLOR=$__GREEN PRINT "$@"
|
||||
}
|
||||
|
||||
INPUT() {
|
||||
REMINDER() { # include sysadmin reminder or other important notice to users
|
||||
[[ $SCWRYPTS_LOG_LEVEL -ge 1 ]] \
|
||||
&& PREFIX="REMINDER " COLOR=$__BRIGHT_MAGENTA PRINT "$@"
|
||||
}
|
||||
|
||||
STATUS() { # general status updates (prefer this to generic 'echo')
|
||||
[[ $SCWRYPTS_LOG_LEVEL -ge 2 ]] \
|
||||
&& PREFIX="STATUS " COLOR=$__BLUE PRINT "$@"
|
||||
}
|
||||
|
||||
WARNING() { # warning-level messages; not errors
|
||||
[[ $SCWRYPTS_LOG_LEVEL -ge 3 ]] \
|
||||
&& PREFIX="WARNING " COLOR=$__YELLOW PRINT "$@"
|
||||
}
|
||||
|
||||
DEBUG() { # helpful during development or (sparingly) to help others' development
|
||||
[[ $SCWRYPTS_LOG_LEVEL -ge 4 ]] \
|
||||
&& PREFIX="DEBUG ℹ" COLOR=$__WHITE PRINT "$@"
|
||||
}
|
||||
|
||||
PROMPT() { # you probably want to use yN or INPUT from below
|
||||
[[ $SCWRYPTS_LOG_LEVEL -ge 1 ]] \
|
||||
&& PREFIX="PROMPT " COLOR=$__CYAN PRINT "$@" \
|
||||
&& PREFIX="USER ⌨" COLOR=$__BRIGHT_CYAN PRINT '' --no-line-end \
|
||||
;
|
||||
}
|
||||
|
||||
FAIL() { SCWRYPTS_LOG_LEVEL=1 ERROR "${@:2}"; exit $1; }
|
||||
ABORT() { FAIL 69 'user abort'; }
|
||||
|
||||
#####################################################################
|
||||
### check for reported errors and format USAGE contents #############
|
||||
#####################################################################
|
||||
|
||||
CHECK_ERRORS() {
|
||||
local FAIL_OUT=true
|
||||
local DISPLAY_USAGE=true
|
||||
|
||||
[ ! $ERRORS ] && ERRORS=0
|
||||
|
||||
while [[ $# -gt 0 ]]
|
||||
do
|
||||
case $1 in
|
||||
--fail ) FAIL_OUT=true ;;
|
||||
--no-fail ) FAIL_OUT=false ;;
|
||||
|
||||
--usage ) DISPLAY_USAGE=true ;;
|
||||
--no-usage ) DISPLAY_USAGE=false ;;
|
||||
esac
|
||||
shift 1
|
||||
done
|
||||
|
||||
[[ $ERRORS -eq 0 ]] && return 0
|
||||
|
||||
[[ $DISPLAY_USAGE =~ true ]] && USAGE
|
||||
|
||||
[[ $FAIL_OUT =~ true ]] && exit $ERRORS || return $ERRORS
|
||||
}
|
||||
|
||||
source "${0:a:h}/io.usage.zsh"
|
||||
|
||||
#####################################################################
|
||||
### facilitate user prompt and input ################################
|
||||
#####################################################################
|
||||
|
||||
# yes/no prompts && = yes (exit code 0)
|
||||
# || = no (exit code 1)
|
||||
Yn() { [[ ! $(READ_YN $@ '[Yn]') =~ [nN] ]]; } # default 'yes'
|
||||
yN() { [[ $(READ_YN $@ '[yN]') =~ [yY] ]]; } # default 'no'
|
||||
|
||||
INPUT() { # read a single line of user input
|
||||
PROMPT "${@:2}"
|
||||
READ $1
|
||||
local VALUE=$(eval echo '$'$1)
|
||||
[ $VALUE ]
|
||||
}
|
||||
|
||||
Yn() {
|
||||
PROMPT "$@ [Yn]"
|
||||
[ $CI ] && { echo y; return 0; }
|
||||
[ $__SCWRYPTS_YES ] && [[ $__SCWRYPTS_YES -eq 1 ]] && { echo y; return 0; }
|
||||
source "${0:a:h}/io.fzf.zsh" # allow user to select from a list of inputs
|
||||
|
||||
local Yn; READ -k Yn; echo >&2
|
||||
[[ $Yn =~ [nN] ]] && return 1 || return 0
|
||||
}
|
||||
|
||||
yN() {
|
||||
PROMPT "$@ [yN]"
|
||||
[ $CI ] && { echo y; return 0; }
|
||||
[ $__SCWRYPTS_YES ] && [[ $__SCWRYPTS_YES -eq 1 ]] && { echo y; return 0; }
|
||||
|
||||
local yN; READ -k yN; echo >&2
|
||||
[[ $yN =~ [yY] ]] && return 0 || return 1
|
||||
}
|
||||
|
||||
CAPTURE() {
|
||||
[ ! $USAGE ] && USAGE="
|
||||
usage: stdout-varname stderr-varname [...cmd and args...]
|
||||
|
||||
captures stdout and stderr on separate variables for a command
|
||||
"
|
||||
{
|
||||
IFS=$'\n' read -r -d '' $2;
|
||||
IFS=$'\n' read -r -d '' $1;
|
||||
} < <((printf '\0%s\0' "$(${@:3})" 1>&2) 2>&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() {
|
||||
EDIT() { # edit a file in user's preferred editor
|
||||
[ $CI ] && {
|
||||
ERROR 'currently in CI, but FZF requires user input'
|
||||
exit 1
|
||||
}
|
||||
|
||||
local FZF_ARGS=()
|
||||
|
||||
FZF_ARGS+=(-i)
|
||||
FZF_ARGS+=(--ansi)
|
||||
FZF_ARGS+=(--bind=ctrl-c:cancel)
|
||||
FZF_ARGS+=(--height=50%)
|
||||
FZF_ARGS+=(--layout=reverse)
|
||||
|
||||
local SELECTION=$(fzf ${FZF_ARGS[@]} --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'
|
||||
WARNING 'currently in CI, skipping EDIT'
|
||||
return 0
|
||||
}
|
||||
|
||||
@ -221,6 +107,12 @@ EDIT() {
|
||||
SUCCESS "finished editing '$1'!"
|
||||
}
|
||||
|
||||
#####################################################################
|
||||
### basic commands with tricky states or default requirements #######
|
||||
#####################################################################
|
||||
|
||||
LESS() { less -R $@ </dev/tty >/dev/tty; }
|
||||
|
||||
YQ() {
|
||||
yq --version | grep -q mikefarah || {
|
||||
yq $@
|
||||
@ -229,3 +121,110 @@ YQ() {
|
||||
|
||||
yq eval '... comments=""' | yq $@
|
||||
}
|
||||
|
||||
#####################################################################
|
||||
### other i/o utilities #############################################
|
||||
#####################################################################
|
||||
|
||||
CAPTURE() {
|
||||
[ ! $USAGE ] && USAGE="
|
||||
usage: stdout-varname stderr-varname [...cmd and args...]
|
||||
|
||||
captures stdout and stderr on separate variables for a command
|
||||
"
|
||||
{
|
||||
IFS=$'\n' read -r -d '' $2;
|
||||
IFS=$'\n' read -r -d '' $1;
|
||||
} < <((printf '\0%s\0' "$(${@:3})" 1>&2) 2>&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; }
|
||||
}
|
||||
|
||||
READ() {
|
||||
[ $CI ] && [ -t 0 ] \
|
||||
&& FAIL 42 'currently in CI, but attempting interactive read; aborting'
|
||||
|
||||
local FORCE_USER_INPUT=false
|
||||
local ARGS=()
|
||||
|
||||
while [[ $# -gt 0 ]]
|
||||
do
|
||||
case $1 in
|
||||
--force-user-input ) FORCE_USER_INPUT=true ;;
|
||||
-k )
|
||||
ARGS+=($1)
|
||||
;;
|
||||
* ) ARGS+=($1) ;;
|
||||
esac
|
||||
shift 1
|
||||
done
|
||||
|
||||
while read -k -t 0; do :; done; # flush user stdin
|
||||
|
||||
case $FORCE_USER_INPUT in
|
||||
true )
|
||||
read ${PREARGS[@]} ${ARGS[@]} $@ </dev/tty
|
||||
;;
|
||||
false )
|
||||
[ -t 0 ] || ARGS=(-u 0 ${ARGS[@]})
|
||||
read ${ARGS[@]} $@
|
||||
;;
|
||||
esac
|
||||
}
|
||||
|
||||
READ_YN() { # yes/no read is suprisingly tricky
|
||||
local FORCE_USER_INPUT=false
|
||||
local USERPROMPT=()
|
||||
local READ_ARGS=()
|
||||
|
||||
while [[ $# -gt 0 ]]
|
||||
do
|
||||
case $1 in
|
||||
--force-user-input )
|
||||
# overrides 'scwrypts -y' and stdin pipe but not CI
|
||||
FORCE_USER_INPUT=true
|
||||
READ_ARGS+=($1)
|
||||
;;
|
||||
* ) USERPROMPT+=($1) ;;
|
||||
esac
|
||||
shift 1
|
||||
done
|
||||
|
||||
##########################################
|
||||
|
||||
local SKIP_USER_INPUT=false
|
||||
|
||||
[ $CI ] \
|
||||
&& SKIP_USER_INPUT=true
|
||||
|
||||
[ $__SCWRYPTS_YES ] && [[ $__SCWRYPTS_YES -eq 1 ]] && [[ $FORCE_USER_INPUT =~ false ]] \
|
||||
&& SKIP_USER_INPUT=true
|
||||
|
||||
##########################################
|
||||
|
||||
local yn
|
||||
PROMPT "${USERPROMPT[@]}"
|
||||
|
||||
case $SKIP_USER_INPUT in
|
||||
true ) yn=y ;;
|
||||
false )
|
||||
[[ $FORCE_USER_INPUT =~ true ]] && [[ $SCWRYPTS_LOG_LEVEL -lt 1 ]] \
|
||||
&& echo -n "${USERPROMPT[@]} : " >&2
|
||||
|
||||
READ ${READ_ARGS[@]} -s -k yn
|
||||
|
||||
[[ $FORCE_USER_INPUT =~ true ]] && [[ $SCWRYPTS_LOG_LEVEL -lt 1 ]] \
|
||||
&& echo $yn >&2
|
||||
;;
|
||||
esac
|
||||
|
||||
[[ $SCWRYPTS_LOG_LEVEL -ge 1 ]] && echo $yn >&2
|
||||
|
||||
echo $yn
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user