374 lines
12 KiB
Bash
374 lines
12 KiB
Bash
# shellcheck shell=bash
|
||
#
|
||
# Search by Konstantin Gredeskoul «github.com/kigster»
|
||
#———————————————————————————————————————————————————————————————————————————————
|
||
# This function returns list of aliases, plugins and completions in bash-it,
|
||
# whose name or description matches one of the search terms provided as arguments.
|
||
#
|
||
# Usage:
|
||
# ❯ bash-it search [-|@]term1 [-|@]term2 ... \
|
||
# [ --enable | -e ] \
|
||
# [ --disable | -d ] \
|
||
# [ --no-color | -c ] \
|
||
# [ --refresh | -r ] \
|
||
# [ --help | -h ]
|
||
#
|
||
# Single dash, as in "-chruby", indicates a negative search term.
|
||
# Double dash indicates a command that is to be applied to the search result.
|
||
# At the moment only --help, --enable and --disable are supported.
|
||
# An '@' sign indicates an exact (not partial) match.
|
||
#
|
||
# Examples:
|
||
# ❯ bash-it search ruby rbenv rvm gem rake
|
||
# aliases: bundler
|
||
# plugins: chruby chruby-auto ruby rbenv rvm ruby
|
||
# completions: rvm gem rake
|
||
#
|
||
# ❯ bash-it search ruby rbenv rvm gem rake -chruby
|
||
# aliases: bundler
|
||
# plugins: ruby rbenv rvm ruby
|
||
# completions: rvm gem rake
|
||
#
|
||
# Examples of enabling or disabling results of the search:
|
||
#
|
||
# ❯ bash-it search ruby
|
||
# aliases: bundler
|
||
# plugins: chruby chruby-auto ruby
|
||
#
|
||
# ❯ bash-it search ruby -chruby --enable
|
||
# aliases: bundler
|
||
# plugins: ruby
|
||
#
|
||
# Examples of using exact match:
|
||
|
||
# ❯ bash-it search @git @ruby
|
||
# aliases: git
|
||
# plugins: git ruby
|
||
# completions: git
|
||
#
|
||
|
||
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'
|
||
|
||
local component
|
||
local BASH_IT_SEARCH_USE_COLOR="${BASH_IT_SEARCH_USE_COLOR:=true}"
|
||
local -a BASH_IT_COMPONENTS=('aliases' 'plugins' 'completions')
|
||
|
||
if [[ $# -eq 0 ]]; then
|
||
_bash-it-search-help
|
||
return 0
|
||
fi
|
||
|
||
local -a args=()
|
||
for word in "$@"; do
|
||
case "${word}" in
|
||
'-h' | '--help')
|
||
_bash-it-search-help
|
||
return 0
|
||
;;
|
||
'-r' | '--refresh')
|
||
_bash-it-component-cache-clean
|
||
;;
|
||
'-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
|
||
_bash-it-search-component "${component}" "${args[@]}"
|
||
done
|
||
fi
|
||
|
||
return 0
|
||
}
|
||
|
||
function _bash-it-search-help() {
|
||
printf '%b' "${echo_normal-}
|
||
${echo_underline_yellow-}USAGE${echo_normal-}
|
||
|
||
bash-it search [-|@]term1 [-|@]term2 ... \\
|
||
[ --enable | -e ] \\
|
||
[ --disable | -d ] \\
|
||
[ --no-color | -c ] \\
|
||
[ --refresh | -r ] \\
|
||
[ --help | -h ]
|
||
|
||
${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
|
||
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).
|
||
|
||
In addition to simply finding the right component, you can use the results
|
||
of the search to enable or disable all components that the search returns.
|
||
|
||
When search is used to enable/disable components it becomes clear that
|
||
you must be able to perform not just a partial match, but an exact match,
|
||
as well as be able to exclude some components.
|
||
|
||
* To exclude a component (or all components matching a substring) use
|
||
a search term with minus as a prefix, eg '-flow'
|
||
|
||
* 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-}EXAMPLES${echo_normal-}
|
||
|
||
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-}
|
||
|
||
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-}
|
||
|
||
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_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
|
||
negative terms, or specify an exact matches of any number of terms. Once
|
||
you created the search command that returns ONLY the modules you need,
|
||
simply append '--enable' or '--disable' at the end to activate/deactivate
|
||
each module.
|
||
|
||
"
|
||
}
|
||
|
||
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}"
|
||
}
|
||
|
||
function _bash-it-component-term-matches-negation() {
|
||
local match="$1"
|
||
shift
|
||
local negative
|
||
for negative in "$@"; do
|
||
[[ "${match}" =~ ${negative} ]] && return 0
|
||
done
|
||
|
||
return 1
|
||
}
|
||
|
||
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')
|
||
for search_command in "${search_commands[@]}"; do
|
||
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}"
|
||
break
|
||
fi
|
||
done
|
||
|
||
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
|
||
|
||
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
|
||
continue
|
||
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
|
||
while IFS='' read -r line; do
|
||
partial_terms+=("$line")
|
||
done < <(_bash-it-component-list-matching "${component}" "${term}")
|
||
|
||
fi
|
||
done
|
||
|
||
local -a total_matches=()
|
||
while IFS='' read -r line; do
|
||
total_matches+=("$line")
|
||
done < <(_bash-it-array-dedup "${exact_terms[@]:-}" "${partial_terms[@]:-}")
|
||
|
||
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=0
|
||
fi
|
||
((include_match)) && matches+=("${match}")
|
||
done
|
||
|
||
_bash-it-search-result "${component}" "${action:-}" "${action_func:-}" "${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 match_color compatible_action suffix opposite_suffix
|
||
local color_sep=':' line match matched temp
|
||
local -i modified=0 enabled=0 len
|
||
local -a matches=()
|
||
|
||
# Discard any empty arguments
|
||
while IFS='' read -r line; do
|
||
[[ -n "${line}" ]] && matches+=("$line")
|
||
done < <(_bash-it-array-dedup "${@}")
|
||
|
||
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'
|
||
else
|
||
color_component=''
|
||
suffix_enable=' ✓ ︎'
|
||
suffix_disable=' '
|
||
color_enable=''
|
||
color_disable=''
|
||
color_off=''
|
||
fi
|
||
|
||
if [[ "${#matches[@]}" -gt 0 ]]; then
|
||
printf "${color_component}%13s${color_sep}${color_off} " "${component}"
|
||
|
||
for match in "${matches[@]}"; do
|
||
enabled=0
|
||
_bash-it-component-item-is-enabled "${component}" "${match}" && enabled=1
|
||
|
||
if ((enabled)); then
|
||
match_color="${color_enable}"
|
||
suffix="${suffix_enable}"
|
||
opposite_suffix="${suffix_disable}"
|
||
compatible_action="disable"
|
||
else
|
||
match_color="${color_disable}"
|
||
suffix="${suffix_disable}"
|
||
opposite_suffix="${suffix_enable}"
|
||
compatible_action="enable"
|
||
fi
|
||
|
||
matched="${match}${suffix}"
|
||
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
|
||
# shellcheck disable=SC2034 # no idea if `$result` is ever used
|
||
result=$("${action_func}" "${match}")
|
||
temp="color_${compatible_action}"
|
||
match_color="${!temp}"
|
||
_bash-it-rewind "${len}"
|
||
printf '%b' "${match_color}${match}${opposite_suffix}"
|
||
fi
|
||
|
||
printf '%b' "${color_off} "
|
||
done
|
||
|
||
((modified)) && _bash-it-component-cache-clean "${component}"
|
||
printf "\n"
|
||
fi
|
||
}
|
||
|
||
function _bash-it-rewind() {
|
||
local -i len="${1:-0}"
|
||
printf '%b' "\033[${len}D"
|
||
}
|
||
|
||
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.2
|
||
local color
|
||
[[ "${#term}" -gt 0 ]] && len="${#term}"
|
||
|
||
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 '%b' "${color}${term}"
|
||
done
|
||
}
|
||
|
||
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
|
||
}
|