Merge pull request #1932 from gaelicWizard/search
Lib/search: lint, cleanup, and small fixespull/2075/head
Noah Gorny
GitHub
commit
39e5652ee5
|
|
@ -83,6 +83,7 @@ completion/available/wpscan.completion.bash
|
|||
lib/helpers.bash
|
||||
lib/log.bash
|
||||
lib/preexec.bash
|
||||
lib/search.bash
|
||||
lib/utilities.bash
|
||||
|
||||
# plugins
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
#!/usr/bin/env bash
|
||||
# shellcheck shell=bash
|
||||
#
|
||||
# Search by Konstantin Gredeskoul «github.com/kigster»
|
||||
#———————————————————————————————————————————————————————————————————————————————
|
||||
|
|
@ -47,39 +47,42 @@
|
|||
# completions: git
|
||||
#
|
||||
|
||||
_bash-it-search() {
|
||||
function _bash-it-search() {
|
||||
_about 'searches for given terms amongst bash-it plugins, aliases and completions'
|
||||
_param '1: term1'
|
||||
_param '2: [ term2 ]...'
|
||||
_example '$ _bash-it-search @git ruby -rvm rake bundler'
|
||||
|
||||
[[ -z "$(type _bash-it-array-contains-element 2>/dev/null)" ]] && source "${BASH_IT}/lib/utilities.bash"
|
||||
|
||||
local component
|
||||
export BASH_IT_SEARCH_USE_COLOR=true
|
||||
declare -a BASH_IT_COMPONENTS=(aliases plugins completions)
|
||||
local BASH_IT_SEARCH_USE_COLOR="${BASH_IT_SEARCH_USE_COLOR:=true}"
|
||||
local -a BASH_IT_COMPONENTS=('aliases' 'plugins' 'completions')
|
||||
|
||||
if [[ -z "$*" ]] ; then
|
||||
if [[ $# -eq 0 ]]; then
|
||||
_bash-it-search-help
|
||||
return 0
|
||||
fi
|
||||
|
||||
local -a args=()
|
||||
for word in $@; do
|
||||
if [[ ${word} == "--help" || ${word} == "-h" ]]; then
|
||||
for word in "$@"; do
|
||||
case "${word}" in
|
||||
'-h' | '--help')
|
||||
_bash-it-search-help
|
||||
return 0
|
||||
elif [[ ${word} == "--refresh" || ${word} == "-r" ]]; then
|
||||
;;
|
||||
'-r' | '--refresh')
|
||||
_bash-it-clean-component-cache
|
||||
elif [[ ${word} == "--no-color" || ${word} == '-c' ]]; then
|
||||
export BASH_IT_SEARCH_USE_COLOR=false
|
||||
else
|
||||
args=(${args[@]} ${word})
|
||||
fi
|
||||
;;
|
||||
'-c' | '--no-color')
|
||||
BASH_IT_SEARCH_USE_COLOR=false
|
||||
;;
|
||||
*)
|
||||
args+=("${word}")
|
||||
;;
|
||||
esac
|
||||
done
|
||||
|
||||
if [[ ${#args} -gt 0 ]]; then
|
||||
for component in "${BASH_IT_COMPONENTS[@]}" ; do
|
||||
for component in "${BASH_IT_COMPONENTS[@]}"; do
|
||||
_bash-it-search-component "${component}" "${args[@]}"
|
||||
done
|
||||
fi
|
||||
|
|
@ -87,9 +90,9 @@ _bash-it-search() {
|
|||
return 0
|
||||
}
|
||||
|
||||
_bash-it-search-help() {
|
||||
printf "${echo_normal}
|
||||
${echo_underline_yellow}USAGE${echo_normal}
|
||||
function _bash-it-search-help() {
|
||||
printf '%b' "${echo_normal-}
|
||||
${echo_underline_yellow-}USAGE${echo_normal-}
|
||||
|
||||
bash-it search [-|@]term1 [-|@]term2 ... \\
|
||||
[ --enable | -e ] \\
|
||||
|
|
@ -98,9 +101,9 @@ ${echo_underline_yellow}USAGE${echo_normal}
|
|||
[ --refresh | -r ] \\
|
||||
[ --help | -h ]
|
||||
|
||||
${echo_underline_yellow}DESCRIPTION${echo_normal}
|
||||
${echo_underline_yellow-}DESCRIPTION${echo_normal-}
|
||||
|
||||
Use ${echo_bold_green}search${echo_normal} bash-it command to search for a list of terms or term negations
|
||||
Use ${echo_bold_green-}search${echo_normal-} bash-it command to search for a list of terms or term negations
|
||||
across all components: aliases, completions and plugins. Components that are
|
||||
enabled are shown in green (or with a check box if --no-color option is used).
|
||||
|
||||
|
|
@ -117,42 +120,42 @@ ${echo_underline_yellow}DESCRIPTION${echo_normal}
|
|||
* To perform an exact match, use character '@' in front of the term,
|
||||
eg. '@git' would only match aliases, plugins and completions named 'git'.
|
||||
|
||||
${echo_underline_yellow}FLAGS${echo_normal}
|
||||
--enable | -e ${echo_purple}Enable all matching componenents.${echo_normal}
|
||||
--disable | -d ${echo_purple}Disable all matching componenents.${echo_normal}
|
||||
--help | -h ${echo_purple}Print this help.${echo_normal}
|
||||
--refresh | -r ${echo_purple}Force a refresh of the search cache.${echo_normal}
|
||||
--no-color | -c ${echo_purple}Disable color output and use monochrome text.${echo_normal}
|
||||
${echo_underline_yellow-}FLAGS${echo_normal-}
|
||||
--enable | -e ${echo_purple-}Enable all matching componenents.${echo_normal-}
|
||||
--disable | -d ${echo_purple-}Disable all matching componenents.${echo_normal-}
|
||||
--help | -h ${echo_purple-}Print this help.${echo_normal-}
|
||||
--refresh | -r ${echo_purple-}Force a refresh of the search cache.${echo_normal-}
|
||||
--no-color | -c ${echo_purple-}Disable color output and use monochrome text.${echo_normal-}
|
||||
|
||||
${echo_underline_yellow}EXAMPLES${echo_normal}
|
||||
${echo_underline_yellow-}EXAMPLES${echo_normal-}
|
||||
|
||||
For example, ${echo_bold_green}bash-it search git${echo_normal} would match any alias, completion
|
||||
For example, ${echo_bold_green-}bash-it search git${echo_normal-} would match any alias, completion
|
||||
or plugin that has the word 'git' in either the module name or
|
||||
it's description. You should see something like this when you run this
|
||||
command:
|
||||
|
||||
${echo_bold_green}❯ bash-it search git${echo_bold_blue}
|
||||
${echo_bold_yellow}aliases: ${echo_bold_green}git ${echo_normal}gitsvn
|
||||
${echo_bold_yellow}plugins: ${echo_normal}autojump ${echo_bold_green}git ${echo_normal}git-subrepo jgitflow jump
|
||||
${echo_bold_yellow}completions: ${echo_bold_green}git ${echo_normal}git_flow git_flow_avh${echo_normal}
|
||||
${echo_bold_green-}❯ bash-it search git${echo_bold_blue-}
|
||||
${echo_bold_yellow-}aliases: ${echo_bold_green-}git ${echo_normal-}gitsvn
|
||||
${echo_bold_yellow-}plugins: ${echo_normal-}autojump ${echo_bold_green-}git ${echo_normal-}git-subrepo jgitflow jump
|
||||
${echo_bold_yellow-}completions: ${echo_bold_green-}git ${echo_normal-}git_flow git_flow_avh${echo_normal-}
|
||||
|
||||
You can exclude some terms by prefixing a term with a minus, eg:
|
||||
|
||||
${echo_bold_green}❯ bash-it search git -flow -svn${echo_bold_blue}
|
||||
${echo_bold_yellow}aliases: ${echo_normal}git
|
||||
${echo_bold_yellow}plugins: ${echo_normal}autojump git git-subrepo jump
|
||||
${echo_bold_yellow}completions: ${echo_normal}git${echo_normal}
|
||||
${echo_bold_green-}❯ bash-it search git -flow -svn${echo_bold_blue-}
|
||||
${echo_bold_yellow-}aliases: ${echo_normal-}git
|
||||
${echo_bold_yellow-}plugins: ${echo_normal-}autojump git git-subrepo jump
|
||||
${echo_bold_yellow-}completions: ${echo_normal-}git${echo_normal-}
|
||||
|
||||
Finally, if you prefix a term with '@' symbol, that indicates an exact
|
||||
match. Note, that we also pass the '--enable' flag, which would ensure
|
||||
that all matches are automatically enabled. The example is below:
|
||||
|
||||
${echo_bold_green}❯ bash-it search @git --enable${echo_bold_blue}
|
||||
${echo_bold_yellow}aliases: ${echo_normal}git
|
||||
${echo_bold_yellow}plugins: ${echo_normal}git
|
||||
${echo_bold_yellow}completions: ${echo_normal}git${echo_normal}
|
||||
${echo_bold_green-}❯ bash-it search @git --enable${echo_bold_blue-}
|
||||
${echo_bold_yellow-}aliases: ${echo_normal-}git
|
||||
${echo_bold_yellow-}plugins: ${echo_normal-}git
|
||||
${echo_bold_yellow-}completions: ${echo_normal-}git${echo_normal-}
|
||||
|
||||
${echo_underline_yellow}SUMMARY${echo_normal}
|
||||
${echo_underline_yellow-}SUMMARY${echo_normal-}
|
||||
|
||||
Take advantage of the search functionality to discover what Bash-It can do
|
||||
for you. Try searching for partial term matches, mix and match with the
|
||||
|
|
@ -164,41 +167,41 @@ ${echo_underline_yellow}SUMMARY${echo_normal}
|
|||
"
|
||||
}
|
||||
|
||||
_bash-it-is-partial-match() {
|
||||
local component="$1"
|
||||
local term="$2"
|
||||
function _bash-it-is-partial-match() {
|
||||
local component="${1?${FUNCNAME[0]}: component type must be specified}"
|
||||
local term="${2:-}"
|
||||
_bash-it-component-help "${component}" | _bash-it-egrep -i -q -- "${term}"
|
||||
}
|
||||
|
||||
_bash-it-component-term-matches-negation() {
|
||||
local match="$1"; shift
|
||||
function _bash-it-component-term-matches-negation() {
|
||||
local match="$1"
|
||||
shift
|
||||
local negative
|
||||
for negative in "$@"; do
|
||||
[[ "${match}" =~ "${negative}" ]] && return 0
|
||||
[[ "${match}" =~ ${negative} ]] && return 0
|
||||
done
|
||||
|
||||
return 1
|
||||
}
|
||||
|
||||
_bash-it-search-component() {
|
||||
local component="$1"
|
||||
shift
|
||||
|
||||
function _bash-it-search-component() {
|
||||
_about 'searches for given terms amongst a given component'
|
||||
_param '1: component type, one of: [ aliases | plugins | completions ]'
|
||||
_param '2: term1 term2 @term3'
|
||||
_param '3: [-]term4 [-]term5 ...'
|
||||
_example '$ _bash-it-search-component aliases @git rake bundler -chruby'
|
||||
|
||||
local component="${1?${FUNCNAME[0]}: component type must be specified}"
|
||||
shift
|
||||
|
||||
# if one of the search terms is --enable or --disable, we will apply
|
||||
# this action to the matches further ` down.
|
||||
local component_singular action action_func
|
||||
local -a search_commands=(enable disable)
|
||||
local -a search_commands=('enable' 'disable')
|
||||
for search_command in "${search_commands[@]}"; do
|
||||
if $(_bash-it-array-contains-element "--${search_command}" "$@"); then
|
||||
component_singular=${component}
|
||||
component_singular=${component_singular/es/} # aliases -> alias
|
||||
component_singular=${component_singular/ns/n} # plugins -> plugin
|
||||
if _bash-it-array-contains-element "--${search_command}" "$@"; then
|
||||
component_singular="${component/es/}" # aliases -> alias
|
||||
component_singular="${component_singular/ns/n}" # plugins -> plugin
|
||||
|
||||
action="${search_command}"
|
||||
action_func="_${action}-${component_singular}"
|
||||
|
|
@ -206,155 +209,168 @@ _bash-it-search-component() {
|
|||
fi
|
||||
done
|
||||
|
||||
local -a terms=($@) # passed on the command line
|
||||
|
||||
unset exact_terms
|
||||
unset partial_terms
|
||||
unset negative_terms
|
||||
local -a terms=("$@") # passed on the command line
|
||||
|
||||
local -a exact_terms=() # terms that should be included only if they match exactly
|
||||
local -a partial_terms=() # terms that should be included if they match partially
|
||||
local -a negative_terms=() # negated partial terms that should be excluded
|
||||
|
||||
unset component_list
|
||||
local -a component_list=( $(_bash-it-component-list "${component}") )
|
||||
local term
|
||||
local term line
|
||||
|
||||
local -a component_list=()
|
||||
while IFS='' read -r line; do
|
||||
component_list+=("$line")
|
||||
done < <(_bash-it-component-list "${component}")
|
||||
|
||||
for term in "${terms[@]}"; do
|
||||
local search_term="${term:1}"
|
||||
if [[ "${term:0:2}" == "--" ]] ; then
|
||||
if [[ "${term:0:2}" == "--" ]]; then
|
||||
continue
|
||||
elif [[ "${term:0:1}" == "-" ]] ; then
|
||||
negative_terms=(${negative_terms[@]} "${search_term}")
|
||||
elif [[ "${term:0:1}" == "@" ]] ; then
|
||||
if $(_bash-it-array-contains-element "${search_term}" "${component_list[@]}"); then
|
||||
exact_terms=(${exact_terms[@]} "${search_term}")
|
||||
elif [[ "${term:0:1}" == "-" ]]; then
|
||||
negative_terms+=("${search_term}")
|
||||
elif [[ "${term:0:1}" == "@" ]]; then
|
||||
if _bash-it-array-contains-element "${search_term}" "${component_list[@]:-}"; then
|
||||
exact_terms+=("${search_term}")
|
||||
fi
|
||||
else
|
||||
partial_terms=(${partial_terms[@]} $(_bash-it-component-list-matching "${component}" "${term}") )
|
||||
while IFS='' read -r line; do
|
||||
partial_terms+=("$line")
|
||||
done < <(_bash-it-component-list-matching "${component}" "${term}")
|
||||
|
||||
fi
|
||||
done
|
||||
|
||||
local -a total_matches=( $(_bash-it-array-dedup ${exact_terms[@]} ${partial_terms[@]}) )
|
||||
local -a total_matches=()
|
||||
while IFS='' read -r line; do
|
||||
total_matches+=("$line")
|
||||
done < <(_bash-it-array-dedup "${exact_terms[@]:-}" "${partial_terms[@]:-}")
|
||||
|
||||
unset matches
|
||||
declare -a matches=()
|
||||
for match in ${total_matches[@]}; do
|
||||
local include_match=true
|
||||
local -a matches=()
|
||||
for match in "${total_matches[@]}"; do
|
||||
local -i include_match=1
|
||||
if [[ ${#negative_terms[@]} -gt 0 ]]; then
|
||||
( _bash-it-component-term-matches-negation "${match}" "${negative_terms[@]}" ) && include_match=false
|
||||
_bash-it-component-term-matches-negation "${match}" "${negative_terms[@]:-}" && include_match=0
|
||||
fi
|
||||
( ${include_match} ) && matches=(${matches[@]} "${match}")
|
||||
((include_match)) && matches+=("${match}")
|
||||
done
|
||||
_bash-it-search-result "${component}" "${action}" "${action_func}" "${matches[@]}"
|
||||
unset matches final_matches terms
|
||||
|
||||
_bash-it-search-result "${component}" "${action:-}" "${action_func:-}" "${matches[@]:-}"
|
||||
}
|
||||
|
||||
_bash-it-search-result() {
|
||||
local component="$1"; shift
|
||||
local action="$1"; shift
|
||||
local action_func="$1"; shift
|
||||
local -a matches=($@)
|
||||
function _bash-it-search-result() {
|
||||
local component="${1?${FUNCNAME[0]}: component type must be specified}"
|
||||
shift
|
||||
local action="${1:-}"
|
||||
shift
|
||||
local action_func="${1:-}"
|
||||
shift
|
||||
|
||||
local color_component color_enable color_disable color_off
|
||||
local color_sep=':' line
|
||||
|
||||
color_sep=':'
|
||||
local -a matches=()
|
||||
# Discard any empty arguments
|
||||
while IFS='' read -r line; do
|
||||
[[ -n "${line}" ]] && matches+=("$line")
|
||||
done < <(_bash-it-array-dedup "${@}")
|
||||
|
||||
( ${BASH_IT_SEARCH_USE_COLOR} ) && {
|
||||
if [[ "${BASH_IT_SEARCH_USE_COLOR}" == "true" ]]; then
|
||||
color_component='\e[1;34m'
|
||||
color_enable='\e[1;32m'
|
||||
suffix_enable=''
|
||||
suffix_disable=''
|
||||
color_disable='\e[0;0m'
|
||||
color_off='\e[0;0m'
|
||||
}
|
||||
|
||||
( ${BASH_IT_SEARCH_USE_COLOR} ) || {
|
||||
else
|
||||
color_component=''
|
||||
suffix_enable=' ✓ ︎'
|
||||
suffix_disable=' '
|
||||
color_enable=''
|
||||
color_disable=''
|
||||
color_off=''
|
||||
}
|
||||
fi
|
||||
|
||||
local match
|
||||
local modified=0
|
||||
local -i modified=0
|
||||
|
||||
if [[ "${#matches[@]}" -gt 0 ]] ; then
|
||||
printf "${color_component}%13s${color_sep} ${color_off}" "${component}"
|
||||
if [[ "${#matches[@]}" -gt 0 ]]; then
|
||||
printf "${color_component}%13s${color_sep}${color_off} " "${component}"
|
||||
|
||||
for match in "${matches[@]}"; do
|
||||
local enabled=0
|
||||
( _bash-it-component-item-is-enabled "${component}" "${match}" ) && enabled=1
|
||||
local -i enabled=0
|
||||
_bash-it-component-item-is-enabled "${component}" "${match}" && enabled=1
|
||||
|
||||
local match_color compatible_action suffix opposite_suffix
|
||||
|
||||
(( ${enabled} )) && {
|
||||
match_color=${color_enable}
|
||||
suffix=${suffix_enable}
|
||||
opposite_suffix=${suffix_disable}
|
||||
if ((enabled)); then
|
||||
match_color="${color_enable}"
|
||||
suffix="${suffix_enable}"
|
||||
opposite_suffix="${suffix_disable}"
|
||||
compatible_action="disable"
|
||||
}
|
||||
|
||||
(( ${enabled} )) || {
|
||||
match_color=${color_disable}
|
||||
suffix=${suffix_disable}
|
||||
opposite_suffix=${suffix_enable}
|
||||
compatible_action="enable"
|
||||
}
|
||||
|
||||
local m="${match}${suffix}"
|
||||
local len
|
||||
len=${#m}
|
||||
|
||||
printf " ${match_color}${match}${suffix}" # print current state
|
||||
if [[ "${action}" == "${compatible_action}" ]]; then
|
||||
if [[ ${action} == "enable" && ${BASH_IT_SEARCH_USE_COLOR} == false ]]; then
|
||||
_bash-it-flash-term ${len} "${match}${suffix}"
|
||||
else
|
||||
_bash-it-erase-term ${len}
|
||||
match_color="${color_disable}"
|
||||
suffix="${suffix_disable}"
|
||||
opposite_suffix="${suffix_enable}"
|
||||
compatible_action="enable"
|
||||
fi
|
||||
|
||||
local matched="${match}${suffix}"
|
||||
local -i len="${#matched}"
|
||||
|
||||
printf '%b' "${match_color}${matched}" # print current state
|
||||
if [[ "${action}" == "${compatible_action}" ]]; then
|
||||
if [[ "${action}" == "enable" && "${BASH_IT_SEARCH_USE_COLOR}" == "true" ]]; then
|
||||
_bash-it-flash-term "${len}" "${matched}"
|
||||
else
|
||||
_bash-it-erase-term "${len}" "${matched}"
|
||||
fi
|
||||
modified=1
|
||||
result=$(${action_func} ${match})
|
||||
# shellcheck disable=SC2034 # no idea if `$result` is ever used
|
||||
result=$("${action_func}" "${match}")
|
||||
local temp="color_${compatible_action}"
|
||||
match_color=${!temp}
|
||||
_bash-it-rewind ${len}
|
||||
printf "${match_color}${match}${opposite_suffix}"
|
||||
match_color="${!temp}"
|
||||
_bash-it-rewind "${len}"
|
||||
printf '%b' "${match_color}${match}${opposite_suffix}"
|
||||
fi
|
||||
|
||||
printf "${color_off}"
|
||||
printf '%b' "${color_off} "
|
||||
done
|
||||
|
||||
[[ ${modified} -gt 0 ]] && _bash-it-clean-component-cache ${component}
|
||||
((modified)) && _bash-it-clean-component-cache "${component}"
|
||||
printf "\n"
|
||||
fi
|
||||
}
|
||||
|
||||
_bash-it-rewind() {
|
||||
local len="$1"
|
||||
printf "\033[${len}D"
|
||||
function _bash-it-rewind() {
|
||||
local -i len="${1:-0}"
|
||||
printf '%b' "\033[${len}D"
|
||||
}
|
||||
|
||||
_bash-it-flash-term() {
|
||||
local len="$1"
|
||||
local match="$2"
|
||||
function _bash-it-flash-term() {
|
||||
local -i len="${1:-0}" # redundant
|
||||
local term="${2:-}"
|
||||
# as currently implemented, `$match` has already been printed to screen the first time
|
||||
local delay=0.1
|
||||
local color
|
||||
[[ "${#term}" -gt 0 ]] && len="${#term}"
|
||||
|
||||
for color in ${text_black} ${echo_bold_blue} ${bold_yellow} ${bold_red} ${echo_bold_green} ; do
|
||||
sleep ${delay}
|
||||
for color in "${echo_black-}" "${echo_bold_blue-}" "${echo_bold_yellow-}" "${echo_bold_red-}" "${echo_bold_green-}" "${echo_normal-}"; do
|
||||
sleep "${delay}"
|
||||
_bash-it-rewind "${len}"
|
||||
printf "${color}${match}"
|
||||
printf '%b' "${color}${term}"
|
||||
done
|
||||
}
|
||||
|
||||
_bash-it-erase-term() {
|
||||
local len="$1"
|
||||
_bash-it-rewind ${len}
|
||||
for a in {0..30}; do
|
||||
[[ ${a} -gt ${len} ]] && break
|
||||
printf "%.*s" $a " "
|
||||
sleep 0.05
|
||||
function _bash-it-erase-term() {
|
||||
local -i len="${1:-0}" i
|
||||
local delay=0.05
|
||||
local term="${2:-}" # calculate length ourselves
|
||||
[[ "${#term}" -gt 0 ]] && len="${#term}"
|
||||
|
||||
_bash-it-rewind "${len}"
|
||||
# white-out the already-printed term by printing blanks
|
||||
for ((i = 0; i <= len; i++)); do
|
||||
printf "%.*s" "$i" " "
|
||||
sleep "${delay}"
|
||||
done
|
||||
}
|
||||
|
|
|
|||
|
|
@ -77,6 +77,6 @@ function local_teardown {
|
|||
run _bash-it-search '@git' --no-color
|
||||
|
||||
assert_line -n 0 ' aliases: git '
|
||||
assert_line -n 0 ' aliases: git '
|
||||
assert_line -n 1 ' plugins: git '
|
||||
assert_line -n 2 ' completions: git '
|
||||
}
|
||||
|
|
|
|||
Loading…
Reference in New Issue