lib/utilities: `shfmt`

My apologies to future `git blame` hunters ♥
pull/1933/head
John D Pell 2021-09-21 23:25:31 -07:00
parent 8cf24f19a2
commit 5fcd16e6cf
2 changed files with 85 additions and 84 deletions

View File

@ -74,6 +74,9 @@ completion/available/vault.completion.bash
completion/available/vuejs.completion.bash completion/available/vuejs.completion.bash
completion/available/wpscan.completion.bash completion/available/wpscan.completion.bash
# libraries
lib/utilities.bash
# plugins # plugins
# #
plugins/available/alias-completion.plugin.bash plugins/available/alias-completion.plugin.bash

View File

@ -6,24 +6,24 @@
# Generic utilies # Generic utilies
########################################################################### ###########################################################################
_bash-it-get-component-name-from-path() { function _bash-it-get-component-name-from-path() {
# filename without path # filename without path
filename="${1##*/}" filename="${1##*/}"
# filename without path or priority # filename without path or priority
filename="${filename##*---}" filename="${filename##*---}"
# filename without path, priority or extension # filename without path, priority or extension
echo "${filename%.*.bash}" echo "${filename%.*.bash}"
} }
_bash-it-get-component-type-from-path() { function _bash-it-get-component-type-from-path() {
local filename local filename
# filename without path # filename without path
filename="${1##*/}" filename="${1##*/}"
# filename without extension # filename without extension
filename="${filename%.bash}" filename="${filename%.bash}"
# extension without priority or name # extension without priority or name
filename="${filename##*.}" filename="${filename##*.}"
echo "${filename}" echo "${filename}"
} }
# This function searches an array for an exact match against the term passed # This function searches an array for an exact match against the term passed
@ -45,99 +45,97 @@ _bash-it-get-component-type-from-path() {
# contains pear! # contains pear!
# #
# #
_bash-it-array-contains-element() { function _bash-it-array-contains-element() {
local e local e
for e in "${@:2}"; do for e in "${@:2}"; do
[[ "$e" == "$1" ]] && return 0 [[ "$e" == "$1" ]] && return 0
done done
return 1 return 1
} }
# Dedupe a simple array of words without spaces. # Dedupe a simple array of words without spaces.
_bash-it-array-dedup() { function _bash-it-array-dedup() {
local IFS=$'\n' local IFS=$'\n'
echo "$@" | tr ' ' '\n' | sort -u echo "$@" | tr ' ' '\n' | sort -u
} }
# Outputs a full path of the grep found on the filesystem # Outputs a full path of the grep found on the filesystem
function _bash-it-grep() function _bash-it-grep() {
{
: "${BASH_IT_GREP:=$(type -p egrep || type -p grep)}" : "${BASH_IT_GREP:=$(type -p egrep || type -p grep)}"
printf "%s" "${BASH_IT_GREP:-'/usr/bin/grep'}" printf "%s" "${BASH_IT_GREP:-'/usr/bin/grep'}"
} }
########################################################################### ###########################################################################
# Component-specific functions (component is either an alias, a plugin, or a # Component-specific functions (component is either an alias, a plugin, or a
# completion). # completion).
########################################################################### ###########################################################################
function _bash-it-component-help() function _bash-it-component-help() {
{ local component file func
local component file func component="$(_bash-it-pluralize-component "${1}")"
component="$(_bash-it-pluralize-component "${1}")" file="$(_bash-it-component-cache-file "${component}")"
file="$(_bash-it-component-cache-file "${component}")" if [[ ! -s "${file}" || -z "$(find "${file}" -mmin -300)" ]]; then
if [[ ! -s "${file}" || -z "$(find "${file}" -mmin -300)" ]] ; then rm -f "${file}" 2> /dev/null
rm -f "${file}" 2>/dev/null func="_bash-it-${component}"
func="_bash-it-${component}" "${func}" | ${BASH_IT_GREP:-$(_bash-it-grep)} -E ' \[' > "${file}"
"${func}" | ${BASH_IT_GREP:-$(_bash-it-grep)} -E ' \[' > "${file}" fi
fi cat "${file}"
cat "${file}"
} }
function _bash-it-component-cache-file() { function _bash-it-component-cache-file() {
local component file local component file
component="$(_bash-it-pluralize-component "${1}")" component="$(_bash-it-pluralize-component "${1}")"
file="${BASH_IT}/tmp/cache/${component}" file="${BASH_IT?}/tmp/cache/${component}"
[[ -f "${file}" ]] || mkdir -p "${file%/*}" [[ -f "${file}" ]] || mkdir -p "${file%/*}"
printf '%s' "${file}" printf '%s' "${file}"
} }
_bash-it-pluralize-component() { function _bash-it-pluralize-component() {
local component="${1}" local component="${1}"
local -i len=$(( ${#component} - 1 )) local -i len=$((${#component} - 1))
# pluralize component name for consistency # pluralize component name for consistency
[[ "${component:${len}:1}" != 's' ]] && component="${component}s" [[ "${component:${len}:1}" != 's' ]] && component="${component}s"
[[ "${component}" == "alias" ]] && component="aliases" [[ "${component}" == "alias" ]] && component="aliases"
printf '%s' "${component}" printf '%s' "${component}"
} }
_bash-it-clean-component-cache() { function _bash-it-clean-component-cache() {
local component="$1" local component="$1"
local cache local cache
local -a BASH_IT_COMPONENTS=(aliases plugins completions) local -a BASH_IT_COMPONENTS=(aliases plugins completions)
if [[ -z "${component}" ]] ; then if [[ -z "${component}" ]]; then
for component in "${BASH_IT_COMPONENTS[@]}" ; do for component in "${BASH_IT_COMPONENTS[@]}"; do
_bash-it-clean-component-cache "${component}" _bash-it-clean-component-cache "${component}"
done done
else else
cache="$(_bash-it-component-cache-file "${component}")" cache="$(_bash-it-component-cache-file "${component}")"
if [[ -f "${cache}" ]] ; then if [[ -f "${cache}" ]]; then
rm -f "${cache}" rm -f "${cache}"
fi fi
fi fi
} }
# Returns an array of items within each compoenent. # Returns an array of items within each compoenent.
_bash-it-component-list() { function _bash-it-component-list() {
local IFS=$'\n' component="$1" local IFS=$'\n' component="$1"
_bash-it-component-help "${component}" | awk '{print $1}' | sort -u _bash-it-component-help "${component}" | awk '{print $1}' | sort -u
} }
_bash-it-component-list-matching() { function _bash-it-component-list-matching() {
local component="$1"; shift local component="$1"
local term="$1" shift
_bash-it-component-help "${component}" | ${BASH_IT_GREP:-$(_bash-it-grep)} -E -- "${term}" | awk '{print $1}' | sort -u local term="$1"
_bash-it-component-help "${component}" | ${BASH_IT_GREP:-$(_bash-it-grep)} -E -- "${term}" | awk '{print $1}' | sort -u
} }
_bash-it-component-list-enabled() { function _bash-it-component-list-enabled() {
local IFS=$'\n' component="$1" local IFS=$'\n' component="$1"
_bash-it-component-help "${component}" | ${BASH_IT_GREP:-$(_bash-it-grep)} -E '\[x\]' | awk '{print $1}' | sort -u _bash-it-component-help "${component}" | ${BASH_IT_GREP:-$(_bash-it-grep)} -E '\[x\]' | awk '{print $1}' | sort -u
} }
_bash-it-component-list-disabled() { function _bash-it-component-list-disabled() {
local IFS=$'\n' component="$1" local IFS=$'\n' component="$1"
_bash-it-component-help "${component}" | ${BASH_IT_GREP:-$(_bash-it-grep)} -E -v '\[x\]' | awk '{print $1}' | sort -u _bash-it-component-help "${component}" | ${BASH_IT_GREP:-$(_bash-it-grep)} -E -v '\[x\]' | awk '{print $1}' | sort -u
} }
# Checks if a given item is enabled for a particular component/file-type. # Checks if a given item is enabled for a particular component/file-type.
@ -148,10 +146,10 @@ _bash-it-component-list-disabled() {
# #
# Examples: # Examples:
# _bash-it-component-item-is-enabled alias git && echo "git alias is enabled" # _bash-it-component-item-is-enabled alias git && echo "git alias is enabled"
_bash-it-component-item-is-enabled() { function _bash-it-component-item-is-enabled() {
local component="$1" local component="$1"
local item="$2" local item="$2"
_bash-it-component-help "${component}" | ${BASH_IT_GREP:-$(_bash-it-grep)} -E '\[x\]' | ${BASH_IT_GREP:-$(_bash-it-grep)} -E -q -- "^${item}\s" _bash-it-component-help "${component}" | ${BASH_IT_GREP:-$(_bash-it-grep)} -E '\[x\]' | ${BASH_IT_GREP:-$(_bash-it-grep)} -E -q -- "^${item}\s"
} }
# Checks if a given item is disabled for a particular component/file-type. # Checks if a given item is disabled for a particular component/file-type.
@ -162,8 +160,8 @@ _bash-it-component-item-is-enabled() {
# #
# Examples: # Examples:
# _bash-it-component-item-is-disabled alias git && echo "git aliases are disabled" # _bash-it-component-item-is-disabled alias git && echo "git aliases are disabled"
_bash-it-component-item-is-disabled() { function _bash-it-component-item-is-disabled() {
local component="$1" local component="$1"
local item="$2" local item="$2"
_bash-it-component-help "${component}" | ${BASH_IT_GREP:-$(_bash-it-grep)} -E -v '\[x\]' | ${BASH_IT_GREP:-$(_bash-it-grep)} -E -q -- "^${item}\s" _bash-it-component-help "${component}" | ${BASH_IT_GREP:-$(_bash-it-grep)} -E -v '\[x\]' | ${BASH_IT_GREP:-$(_bash-it-grep)} -E -q -- "^${item}\s"
} }