Getting Bash-it to use the vendored composure
Fixed tests Fixed install.sh and bash_it.sh Added gitattributes to the vendor folder Changed documentationpull/1820/head
buhl
parent
a0b6c4993a
commit
49d7d2e8c4
|
|
@ -38,6 +38,7 @@ repos:
|
|||
types: [file]
|
||||
- id: dot-bash
|
||||
name: Check .bash files against bash-it requirements
|
||||
exclude: "test/test_helper.bash"
|
||||
entry: ./hooks/dot-bash.sh
|
||||
language: system
|
||||
files: "\\.bash$"
|
||||
|
|
|
|||
39
bash_it.sh
39
bash_it.sh
|
|
@ -3,8 +3,7 @@
|
|||
BASH_IT_LOG_PREFIX="core: main: "
|
||||
|
||||
# Only set $BASH_IT if it's not already set
|
||||
if [ -z "$BASH_IT" ];
|
||||
then
|
||||
if [ -z "$BASH_IT" ]; then
|
||||
# Setting $BASH to maintain backwards compatibility
|
||||
export BASH_IT=$BASH
|
||||
BASH="$(bash -c 'echo $BASH')"
|
||||
|
|
@ -13,8 +12,9 @@ then
|
|||
fi
|
||||
|
||||
# Load composure first, so we support function metadata
|
||||
# shellcheck source=./lib/composure.bash
|
||||
source "${BASH_IT}/lib/composure.bash"
|
||||
# shellcheck disable=SC1090
|
||||
source "${BASH_IT}"/vendor/github.com/erichs/composure/composure.sh
|
||||
|
||||
# We need to load logging module first as well in order to be able to log
|
||||
# shellcheck source=./lib/log.bash
|
||||
source "${BASH_IT}/lib/log.bash"
|
||||
|
|
@ -23,22 +23,21 @@ source "${BASH_IT}/lib/log.bash"
|
|||
[ -z "$BASH_IT_OLD_BASH_SETUP" ] || _log_warning "BASH_IT variable not initialized, please upgrade your bash-it version and reinstall it!"
|
||||
|
||||
# For backwards compatibility, look in old BASH_THEME location
|
||||
if [ -z "$BASH_IT_THEME" ];
|
||||
then
|
||||
if [ -z "$BASH_IT_THEME" ]; then
|
||||
_log_warning "BASH_IT_THEME variable not initialized, please upgrade your bash-it version and reinstall it!"
|
||||
export BASH_IT_THEME="$BASH_THEME";
|
||||
unset BASH_THEME;
|
||||
export BASH_IT_THEME="$BASH_THEME"
|
||||
unset BASH_THEME
|
||||
fi
|
||||
|
||||
# support 'plumbing' metadata
|
||||
cite _about _param _example _group _author _version
|
||||
cite about-alias about-plugin about-completion
|
||||
|
||||
# libraries, but skip appearance (themes) for now
|
||||
_log_debug "Loading libraries(except appearance)..."
|
||||
LIB="${BASH_IT}/lib/*.bash"
|
||||
APPEARANCE_LIB="${BASH_IT}/lib/appearance.bash"
|
||||
for _bash_it_config_file in $LIB
|
||||
do
|
||||
for _bash_it_config_file in $LIB; do
|
||||
if [ "$_bash_it_config_file" != "$APPEARANCE_LIB" ]; then
|
||||
filename=${_bash_it_config_file##*/}
|
||||
filename=${filename%.bash}
|
||||
|
|
@ -51,8 +50,7 @@ done
|
|||
|
||||
# Load vendors
|
||||
BASH_IT_LOG_PREFIX="vendor: "
|
||||
for _bash_it_vendor_init in "${BASH_IT}"/vendor/init.d/*.bash
|
||||
do
|
||||
for _bash_it_vendor_init in "${BASH_IT}"/vendor/init.d/*.bash; do
|
||||
_log_debug "Loading \"$(basename "${_bash_it_vendor_init}" .bash)\"..."
|
||||
# shellcheck disable=SC1090
|
||||
source "${_bash_it_vendor_init}"
|
||||
|
|
@ -66,8 +64,7 @@ BASH_IT_LOG_PREFIX="core: main: "
|
|||
source "${BASH_IT}/scripts/reloader.bash"
|
||||
|
||||
# Load enabled aliases, completion, plugins
|
||||
for file_type in "aliases" "plugins" "completion"
|
||||
do
|
||||
for file_type in "aliases" "plugins" "completion"; do
|
||||
# shellcheck source=./scripts/reloader.bash
|
||||
source "${BASH_IT}/scripts/reloader.bash" "skip" "$file_type"
|
||||
done
|
||||
|
|
@ -100,10 +97,8 @@ fi
|
|||
|
||||
BASH_IT_LOG_PREFIX="core: main: "
|
||||
_log_debug "Loading custom aliases, completion, plugins..."
|
||||
for file_type in "aliases" "completion" "plugins"
|
||||
do
|
||||
if [ -e "${BASH_IT}/${file_type}/custom.${file_type}.bash" ]
|
||||
then
|
||||
for file_type in "aliases" "completion" "plugins"; do
|
||||
if [ -e "${BASH_IT}/${file_type}/custom.${file_type}.bash" ]; then
|
||||
BASH_IT_LOG_PREFIX="${file_type}: custom: "
|
||||
_log_debug "Loading component..."
|
||||
# shellcheck disable=SC1090
|
||||
|
|
@ -115,8 +110,7 @@ done
|
|||
BASH_IT_LOG_PREFIX="core: main: "
|
||||
_log_debug "Loading general custom files..."
|
||||
CUSTOM="${BASH_IT_CUSTOM:=${BASH_IT}/custom}/*.bash ${BASH_IT_CUSTOM:=${BASH_IT}/custom}/**/*.bash"
|
||||
for _bash_it_config_file in $CUSTOM
|
||||
do
|
||||
for _bash_it_config_file in $CUSTOM; do
|
||||
if [ -e "${_bash_it_config_file}" ]; then
|
||||
filename=$(basename "${_bash_it_config_file}")
|
||||
filename=${filename%*.bash}
|
||||
|
|
@ -144,14 +138,13 @@ fi
|
|||
|
||||
# Load all the Jekyll stuff
|
||||
|
||||
if [ -e "$HOME/.jekyllconfig" ]
|
||||
then
|
||||
if [ -e "$HOME/.jekyllconfig" ]; then
|
||||
# shellcheck disable=SC1090
|
||||
. "$HOME/.jekyllconfig"
|
||||
fi
|
||||
|
||||
# BASH_IT_RELOAD_LEGACY is set.
|
||||
if ! command -v reload &>/dev/null && [ -n "$BASH_IT_RELOAD_LEGACY" ]; then
|
||||
if ! command -v reload &> /dev/null && [ -n "$BASH_IT_RELOAD_LEGACY" ]; then
|
||||
case $OSTYPE in
|
||||
darwin*)
|
||||
alias reload='source ~/.bash_profile'
|
||||
|
|
|
|||
|
|
@ -23,6 +23,8 @@ hooks
|
|||
#
|
||||
.gitattributes
|
||||
lint_clean_files.sh
|
||||
install.sh
|
||||
bash_it.sh
|
||||
|
||||
# plugins
|
||||
#
|
||||
|
|
@ -92,5 +94,9 @@ aliases/available/dnf.aliases.bash
|
|||
aliases/available/vim.aliases.bash
|
||||
aliases/available/git.aliases.bash
|
||||
|
||||
# tests
|
||||
test/test_helper.bash
|
||||
|
||||
# vendor init files
|
||||
vendor/.gitattributes
|
||||
vendor/init.d
|
||||
|
|
|
|||
|
|
@ -37,9 +37,12 @@ General Load Order
|
|||
The main ``bash_it.sh`` script loads the frameworks individual components in the following order:
|
||||
|
||||
|
||||
* ``lib/composure.bash``
|
||||
|
||||
|
||||
* ``vendor/github.com/erichs/composure/composure.sh``
|
||||
* ``lib/log.bash``
|
||||
* ``vendor/init.d/*.bash``
|
||||
* Files in ``lib`` with the exception of ``appearance.bash`` - this means that ``composure.bash`` is loaded again here (possible improvement?)
|
||||
* Files in ``lib`` with the exception of ``appearance.bash`` - this means that ``log.bash`` is loaded again here (possible improvement?)
|
||||
* Enabled ``aliases``
|
||||
* Enabled ``plugins``
|
||||
* Enabled ``completions``
|
||||
|
|
|
|||
59
install.sh
59
install.sh
|
|
@ -7,11 +7,11 @@ function show_usage() {
|
|||
echo -e "Usage:\n$0 [arguments] \n"
|
||||
echo "Arguments:"
|
||||
echo "--help (-h): Display this help message"
|
||||
echo "--silent (-s): Install default settings without prompting for input";
|
||||
echo "--silent (-s): Install default settings without prompting for input"
|
||||
echo "--interactive (-i): Interactively choose plugins"
|
||||
echo "--no-modify-config (-n): Do not modify existing config file"
|
||||
echo "--append-to-config (-a): Keep existing config file and append bash-it templates at the end"
|
||||
exit 0;
|
||||
exit 0
|
||||
}
|
||||
|
||||
# enable a thing
|
||||
|
|
@ -34,19 +34,17 @@ function load_some() {
|
|||
single_type=$(echo "$file_type" | sed -e "s/aliases$/alias/g" | sed -e "s/plugins$/plugin/g")
|
||||
enable_func="_enable-$single_type"
|
||||
[ -d "$BASH_IT/$file_type/enabled" ] || mkdir "$BASH_IT/$file_type/enabled"
|
||||
for path in "$BASH_IT/${file_type}/available/"[^_]*
|
||||
do
|
||||
for path in "$BASH_IT/${file_type}/available/"[^_]*; do
|
||||
file_name=$(basename "$path")
|
||||
while true
|
||||
do
|
||||
while true; do
|
||||
just_the_name="${file_name%%.*}"
|
||||
read -e -n 1 -p "Would you like to enable the $just_the_name $file_type? [y/N] " RESP
|
||||
read -r -e -n 1 -p "Would you like to enable the $just_the_name $file_type? [y/N] " RESP
|
||||
case $RESP in
|
||||
[yY])
|
||||
$enable_func $just_the_name
|
||||
$enable_func "$just_the_name"
|
||||
break
|
||||
;;
|
||||
[nN]|"")
|
||||
[nN] | "")
|
||||
break
|
||||
;;
|
||||
*)
|
||||
|
|
@ -59,9 +57,9 @@ function load_some() {
|
|||
|
||||
# Back up existing profile
|
||||
function backup() {
|
||||
test -w "$HOME/$CONFIG_FILE" &&
|
||||
cp -aL "$HOME/$CONFIG_FILE" "$HOME/$CONFIG_FILE.bak" &&
|
||||
echo -e "\033[0;32mYour original $CONFIG_FILE has been backed up to $CONFIG_FILE.bak\033[0m"
|
||||
test -w "$HOME/$CONFIG_FILE" \
|
||||
&& cp -aL "$HOME/$CONFIG_FILE" "$HOME/$CONFIG_FILE.bak" \
|
||||
&& echo -e "\033[0;32mYour original $CONFIG_FILE has been backed up to $CONFIG_FILE.bak\033[0m"
|
||||
}
|
||||
|
||||
# Back up existing profile and create new one for bash-it
|
||||
|
|
@ -86,32 +84,37 @@ for param in "$@"; do
|
|||
"--interactive") set -- "$@" "-i" ;;
|
||||
"--no-modify-config") set -- "$@" "-n" ;;
|
||||
"--append-to-config") set -- "$@" "-a" ;;
|
||||
*) set -- "$@" "$param"
|
||||
*) set -- "$@" "$param" ;;
|
||||
esac
|
||||
done
|
||||
|
||||
OPTIND=1
|
||||
while getopts "hsina" opt
|
||||
do
|
||||
while getopts "hsina" opt; do
|
||||
case "$opt" in
|
||||
"h") show_usage; exit 0 ;;
|
||||
"h")
|
||||
show_usage
|
||||
exit 0
|
||||
;;
|
||||
"s") silent=true ;;
|
||||
"i") interactive=true ;;
|
||||
"n") no_modify_config=true ;;
|
||||
"a") append_to_config=true ;;
|
||||
"?") show_usage >&2; exit 1 ;;
|
||||
"?")
|
||||
show_usage >&2
|
||||
exit 1
|
||||
;;
|
||||
esac
|
||||
done
|
||||
shift $(expr $OPTIND - 1)
|
||||
shift $(("$OPTIND" - 1))
|
||||
|
||||
if [[ $silent ]] && [[ $interactive ]]; then
|
||||
echo -e "\033[91mOptions --silent and --interactive are mutually exclusive. Please choose one or the other.\033[m"
|
||||
exit 1;
|
||||
exit 1
|
||||
fi
|
||||
|
||||
if [[ $no_modify_config ]] && [[ $append_to_config ]]; then
|
||||
echo -e "\033[91mOptions --no-modify-config and --append-to-config are mutually exclusive. Please choose one or the other.\033[m"
|
||||
exit 1;
|
||||
exit 1
|
||||
fi
|
||||
|
||||
BASH_IT="$(cd "$(dirname "$0")" && pwd)"
|
||||
|
|
@ -136,7 +139,7 @@ if ! [[ $silent ]] && ! [[ $no_modify_config ]]; then
|
|||
[yY])
|
||||
break
|
||||
;;
|
||||
[nN]|"")
|
||||
[nN] | "")
|
||||
echo -e "\033[91mInstallation aborted. Please come back soon!\033[m"
|
||||
exit 1
|
||||
;;
|
||||
|
|
@ -154,7 +157,7 @@ if ! [[ $silent ]] && ! [[ $no_modify_config ]]; then
|
|||
backup_append
|
||||
break
|
||||
;;
|
||||
[nN]|"")
|
||||
[nN] | "")
|
||||
backup_new
|
||||
break
|
||||
;;
|
||||
|
|
@ -174,15 +177,16 @@ fi
|
|||
# Disable auto-reload in case its enabled
|
||||
export BASH_IT_AUTOMATIC_RELOAD_AFTER_CONFIG_CHANGE=''
|
||||
# Load dependencies for enabling components
|
||||
source "$BASH_IT/lib/composure.bash"
|
||||
# shellcheck disable=SC1090
|
||||
source "${BASH_IT}"/vendor/github.com/erichs/composure/composure.sh
|
||||
# shellcheck source=./lib/utilities.bash
|
||||
source "$BASH_IT/lib/utilities.bash"
|
||||
cite _about _param _example _group _author _version
|
||||
# shellcheck source=./lib/helpers.bash
|
||||
source "$BASH_IT/lib/helpers.bash"
|
||||
|
||||
if [[ $interactive ]] && ! [[ $silent ]] ;
|
||||
then
|
||||
for type in "aliases" "plugins" "completion"
|
||||
do
|
||||
if [[ $interactive ]] && ! [[ $silent ]]; then
|
||||
for type in "aliases" "plugins" "completion"; do
|
||||
echo -e "\033[0;32mEnabling $type\033[0m"
|
||||
load_some $type
|
||||
done
|
||||
|
|
@ -198,6 +202,7 @@ fi
|
|||
|
||||
echo ""
|
||||
echo -e "\033[0;32mInstallation finished successfully! Enjoy bash-it!\033[0m"
|
||||
# shellcheck disable=SC2086
|
||||
echo -e "\033[0;32mTo start using it, open a new tab or 'source "$HOME/$CONFIG_FILE"'.\033[0m"
|
||||
echo ""
|
||||
echo "To show the available aliases/completions/plugins, type one of the following:"
|
||||
|
|
|
|||
|
|
@ -1,380 +0,0 @@
|
|||
# composure - by erichs
|
||||
# light-hearted functions for intuitive shell programming
|
||||
|
||||
# install: source this script in your ~/.profile or ~/.${SHELL}rc script
|
||||
|
||||
# latest source available at http://git.io/composure
|
||||
# known to work on bash, zsh, and ksh93
|
||||
|
||||
# 'plumbing' functions
|
||||
|
||||
composure_keywords ()
|
||||
{
|
||||
echo "about author example group param version"
|
||||
}
|
||||
|
||||
letterpress ()
|
||||
{
|
||||
typeset rightcol="$1" leftcol="${2:- }"
|
||||
|
||||
if [ -z "$rightcol" ]; then
|
||||
return
|
||||
fi
|
||||
|
||||
printf "%-20s%s\n" "$leftcol" "$rightcol"
|
||||
}
|
||||
|
||||
transcribe ()
|
||||
{
|
||||
typeset func=$1
|
||||
typeset file=$2
|
||||
typeset operation="$3"
|
||||
|
||||
if git --version >/dev/null 2>&1; then
|
||||
if [ -d ~/.composure ]; then
|
||||
(
|
||||
cd ~/.composure
|
||||
if git rev-parse 2>/dev/null; then
|
||||
if [ ! -f $file ]; then
|
||||
printf "%s\n" "Oops! Couldn't find $file to version it for you..."
|
||||
return
|
||||
fi
|
||||
cp $file ~/.composure/$func.inc
|
||||
git add --all .
|
||||
git commit -m "$operation $func"
|
||||
fi
|
||||
)
|
||||
else
|
||||
if [ "$USE_COMPOSURE_REPO" = "0" ]; then
|
||||
return # if you say so...
|
||||
fi
|
||||
printf "%s\n" "I see you don't have a ~/.composure repo..."
|
||||
typeset input
|
||||
typeset valid=0
|
||||
while [ $valid != 1 ]; do
|
||||
printf "\n%s" 'would you like to create one? y/n: '
|
||||
read input
|
||||
case $input in
|
||||
y|yes|Y|Yes|YES)
|
||||
(
|
||||
echo 'creating git repository for your functions...'
|
||||
mkdir ~/.composure
|
||||
cd ~/.composure
|
||||
git init
|
||||
echo "composure stores your function definitions here" > README.txt
|
||||
git add README.txt
|
||||
git commit -m 'initial commit'
|
||||
)
|
||||
# if at first you don't succeed...
|
||||
transcribe "$func" "$file" "$operation"
|
||||
valid=1
|
||||
;;
|
||||
n|no|N|No|NO)
|
||||
printf "%s\n" "ok. add 'export USE_COMPOSURE_REPO=0' to your startup script to disable this message."
|
||||
valid=1
|
||||
;;
|
||||
*)
|
||||
printf "%s\n" "sorry, didn't get that..."
|
||||
;;
|
||||
esac
|
||||
done
|
||||
fi
|
||||
fi
|
||||
}
|
||||
|
||||
typeset_functions ()
|
||||
{
|
||||
# unfortunately, there does not seem to be a easy, portable way to list just the
|
||||
# names of the defined shell functions...
|
||||
|
||||
# first, determine our shell:
|
||||
typeset shell
|
||||
if [ -n "$SHELL" ]; then
|
||||
shell=$(basename $SHELL) # we assume this is set correctly!
|
||||
else
|
||||
# we'll have to try harder
|
||||
# here's a hack I modified from a StackOverflow post:
|
||||
# we loop over the ps listing for the current process ($$), and print the last column (CMD)
|
||||
# stripping any leading hyphens bash sometimes throws in there
|
||||
typeset x ans
|
||||
typeset this=$(for x in $(ps -p $$); do ans=$x; done; printf "%s\n" $ans | sed 's/^-*//')
|
||||
typeset shell=$(basename $this) # e.g. /bin/bash => bash
|
||||
fi
|
||||
case "$shell" in
|
||||
bash)
|
||||
typeset -F | awk '{print $3}'
|
||||
;;
|
||||
*)
|
||||
# trim everything following '()' in ksh
|
||||
typeset +f | sed 's/().*$//'
|
||||
;;
|
||||
esac
|
||||
}
|
||||
|
||||
|
||||
# bootstrap metadata keywords for porcelain functions
|
||||
for f in $(composure_keywords)
|
||||
do
|
||||
eval "$f() { :; }"
|
||||
done
|
||||
unset f
|
||||
|
||||
|
||||
# 'porcelain' functions
|
||||
|
||||
cite ()
|
||||
{
|
||||
about creates one or more meta keywords for use in your functions
|
||||
param one or more keywords
|
||||
example '$ cite url username'
|
||||
example '$ url http://somewhere.com'
|
||||
example '$ username alice'
|
||||
group composure
|
||||
|
||||
# this is the storage half of the 'metadata' system:
|
||||
# we create dynamic metadata keywords with function wrappers around
|
||||
# the NOP command, ':'
|
||||
|
||||
# anything following a keyword will get parsed as a positional
|
||||
# parameter, but stay resident in the ENV. As opposed to shell
|
||||
# comments, '#', which do not get parsed and are not available
|
||||
# at runtime.
|
||||
|
||||
# a BIG caveat--your metadata must be roughly parsable: do not use
|
||||
# contractions, and consider single or double quoting if it contains
|
||||
# non-alphanumeric characters
|
||||
|
||||
if [ -z "$1" ]; then
|
||||
printf '%s\n' 'missing parameter(s)'
|
||||
reference cite
|
||||
return
|
||||
fi
|
||||
|
||||
typeset keyword
|
||||
for keyword in $*; do
|
||||
eval "$keyword() { :; }"
|
||||
done
|
||||
}
|
||||
|
||||
draft ()
|
||||
{
|
||||
about wraps command from history into a new function, default is last command
|
||||
param 1: name to give function
|
||||
param 2: optional history line number
|
||||
example '$ ls'
|
||||
example '$ draft list'
|
||||
example '$ draft newfunc 1120 # wraps command at history line 1120 in newfunc()'
|
||||
group composure
|
||||
|
||||
typeset func=$1
|
||||
typeset num=$2
|
||||
typeset cmd
|
||||
|
||||
if [ -z "$func" ]; then
|
||||
printf '%s\n' 'missing parameter(s)'
|
||||
reference draft
|
||||
return
|
||||
fi
|
||||
|
||||
# aliases bind tighter than function names, disallow them
|
||||
if [ -n "$(LANG=C type -t $func 2>/dev/null | grep 'alias')" ]; then
|
||||
printf '%s\n' "sorry, $(type -a $func). please choose another name."
|
||||
return
|
||||
fi
|
||||
|
||||
if [ -z "$num" ]; then
|
||||
# parse last command from fc output
|
||||
# some versions of 'fix command, fc' need corrective lenses...
|
||||
typeset myopic=$(fc -ln -1 | grep draft)
|
||||
typeset lines=1
|
||||
if [ -n "$myopic" ]; then
|
||||
lines=2
|
||||
fi
|
||||
cmd=$(fc -ln -$lines | head -1 | sed 's/^[[:blank:]]*//')
|
||||
else
|
||||
# parse command from history line number
|
||||
cmd=$(eval "history | grep '^[[:blank:]]*$num' | head -1" | sed 's/^[[:blank:][:digit:]]*//')
|
||||
fi
|
||||
eval "$func() { $cmd; }"
|
||||
typeset file=$(mktemp -t draft.XXXX)
|
||||
typeset -f $func > $file
|
||||
transcribe $func $file draft
|
||||
rm $file 2>/dev/null
|
||||
}
|
||||
|
||||
glossary ()
|
||||
{
|
||||
about displays help summary for all functions, or summary for a group of functions
|
||||
param 1: optional, group name
|
||||
example '$ glossary'
|
||||
example '$ glossary misc'
|
||||
group composure
|
||||
|
||||
typeset targetgroup=${1:-}
|
||||
|
||||
for func in $(typeset_functions); do
|
||||
if [ -n "$targetgroup" ]; then
|
||||
typeset group="$(typeset -f $func | metafor group)"
|
||||
if [ "$group" != "$targetgroup" ]; then
|
||||
continue # skip non-matching groups, if specified
|
||||
fi
|
||||
fi
|
||||
typeset about="$(typeset -f $func | metafor about)"
|
||||
letterpress "$about" $func
|
||||
done
|
||||
}
|
||||
|
||||
metafor ()
|
||||
{
|
||||
about prints function metadata associated with keyword
|
||||
param 1: meta keyword
|
||||
example '$ typeset -f glossary | metafor example'
|
||||
group composure
|
||||
|
||||
typeset keyword=$1
|
||||
|
||||
if [ -z "$keyword" ]; then
|
||||
printf '%s\n' 'missing parameter(s)'
|
||||
reference metafor
|
||||
return
|
||||
fi
|
||||
|
||||
# this sed-fu is the retrieval half of the 'metadata' system:
|
||||
# 'grep' for the metadata keyword, and then parse/filter the matching line
|
||||
|
||||
# grep keyword # strip trailing '|"|; # ignore thru keyword and leading '|"
|
||||
sed -n "/$keyword / s/['\";]*$//;s/^[ ]*$keyword ['\"]*\([^([].*\)*$/\1/p"
|
||||
}
|
||||
|
||||
reference ()
|
||||
{
|
||||
about displays apidoc help for a specific function
|
||||
param 1: function name
|
||||
example '$ reference revise'
|
||||
group composure
|
||||
|
||||
typeset func=$1
|
||||
if [ -z "$func" ]; then
|
||||
printf '%s\n' 'missing parameter(s)'
|
||||
reference reference
|
||||
return
|
||||
fi
|
||||
|
||||
typeset line
|
||||
|
||||
typeset about="$(typeset -f $func | metafor about)"
|
||||
letterpress "$about" $func
|
||||
|
||||
typeset author="$(typeset -f $func | metafor author)"
|
||||
if [ -n "$author" ]; then
|
||||
letterpress "$author" 'author:'
|
||||
fi
|
||||
|
||||
typeset version="$(typeset -f $func | metafor version)"
|
||||
if [ -n "$version" ]; then
|
||||
letterpress "$version" 'version:'
|
||||
fi
|
||||
|
||||
if [ -n "$(typeset -f $func | metafor param)" ]; then
|
||||
printf "parameters:\n"
|
||||
typeset -f $func | metafor param | while read line
|
||||
do
|
||||
letterpress "$line"
|
||||
done
|
||||
fi
|
||||
|
||||
if [ -n "$(typeset -f $func | metafor example)" ]; then
|
||||
printf "examples:\n"
|
||||
typeset -f $func | metafor example | while read line
|
||||
do
|
||||
letterpress "$line"
|
||||
done
|
||||
fi
|
||||
}
|
||||
|
||||
revise ()
|
||||
{
|
||||
about loads function into editor for revision
|
||||
param 1: name of function
|
||||
example '$ revise myfunction'
|
||||
group composure
|
||||
|
||||
typeset func=$1
|
||||
typeset temp=$(mktemp -t revise.XXXX)
|
||||
|
||||
if [ -z "$func" ]; then
|
||||
printf '%s\n' 'missing parameter(s)'
|
||||
reference revise
|
||||
return
|
||||
fi
|
||||
|
||||
# populate tempfile...
|
||||
if [ -f ~/.composure/$func.inc ]; then
|
||||
# ...with contents of latest git revision...
|
||||
cat ~/.composure/$func.inc >> $temp
|
||||
else
|
||||
# ...or from ENV if not previously versioned
|
||||
typeset -f $func >> $temp
|
||||
fi
|
||||
|
||||
if [ -z "$EDITOR" ]
|
||||
then
|
||||
typeset EDITOR=vi
|
||||
fi
|
||||
|
||||
$EDITOR $temp
|
||||
. $temp # source edited file
|
||||
|
||||
transcribe $func $temp revise
|
||||
rm $temp
|
||||
}
|
||||
|
||||
write ()
|
||||
{
|
||||
about writes one or more composed function definitions to stdout
|
||||
param one or more function names
|
||||
example '$ write finddown foo'
|
||||
example '$ write finddown'
|
||||
group composure
|
||||
|
||||
if [ -z "$1" ]; then
|
||||
printf '%s\n' 'missing parameter(s)'
|
||||
reference write
|
||||
return
|
||||
fi
|
||||
|
||||
# bootstrap metadata
|
||||
cat <<END
|
||||
for f in $(composure_keywords)
|
||||
do
|
||||
eval "\$f() { :; }"
|
||||
done
|
||||
unset f
|
||||
END
|
||||
|
||||
# include cite() to enable custom keywords
|
||||
typeset -f cite $*
|
||||
}
|
||||
|
||||
: <<EOF
|
||||
License: The MIT License
|
||||
|
||||
Copyright © 2012 Erich Smith
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy of this
|
||||
software and associated documentation files (the "Software"), to deal in the Software
|
||||
without restriction, including without limitation the rights to use, copy, modify,
|
||||
merge, publish, distribute, sublicense, and/or sell copies of the Software, and to
|
||||
permit persons to whom the Software is furnished to do so, subject to the following
|
||||
conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all copies
|
||||
or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
|
||||
INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
|
||||
PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
|
||||
HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
|
||||
CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE
|
||||
OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
||||
EOF
|
||||
|
|
@ -1,7 +1,7 @@
|
|||
#!/usr/bin/env bats
|
||||
|
||||
load ../test_helper
|
||||
load ../../lib/composure
|
||||
load "${BASH_IT}/vendor/github.com/erichs/composure/composure.sh"
|
||||
|
||||
function local_setup {
|
||||
setup_test_fixture
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
#!/usr/bin/env bats
|
||||
|
||||
load ../test_helper
|
||||
load ../../lib/composure
|
||||
load "${BASH_IT}/vendor/github.com/erichs/composure/composure.sh"
|
||||
load ../../completion/available/bash-it.completion
|
||||
|
||||
function local_setup {
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
#!/usr/bin/env bats
|
||||
|
||||
load ../test_helper
|
||||
load ../../lib/composure
|
||||
load "${BASH_IT}/vendor/github.com/erichs/composure/composure.sh"
|
||||
|
||||
# Determine which config file to use based on OS.
|
||||
case $OSTYPE in
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
#!/usr/bin/env bats
|
||||
|
||||
load ../test_helper
|
||||
load ../../lib/composure
|
||||
load "${BASH_IT}/vendor/github.com/erichs/composure/composure.sh"
|
||||
|
||||
# Determine which config file to use based on OS.
|
||||
case $OSTYPE in
|
||||
|
|
|
|||
|
|
@ -1,9 +1,9 @@
|
|||
#!/usr/bin/env bats
|
||||
|
||||
load ../test_helper
|
||||
load ../../lib/composure
|
||||
load "${BASH_IT}/vendor/github.com/erichs/composure/composure.sh"
|
||||
|
||||
@test "lib composure: composure_keywords()" {
|
||||
run composure_keywords
|
||||
@test "lib composure: _composure_keywords()" {
|
||||
run _composure_keywords
|
||||
assert_output "about author example group param version"
|
||||
}
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
#!/usr/bin/env bats
|
||||
|
||||
load ../test_helper
|
||||
load ../../lib/composure
|
||||
load "${BASH_IT}/vendor/github.com/erichs/composure/composure.sh"
|
||||
load ../../lib/log
|
||||
load ../../lib/utilities
|
||||
load ../../lib/search
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
#!/usr/bin/env bats
|
||||
|
||||
load ../test_helper
|
||||
load ../../lib/composure
|
||||
load "${BASH_IT}/vendor/github.com/erichs/composure/composure.sh"
|
||||
load ../../lib/appearance
|
||||
load ../../plugins/available/base.plugin
|
||||
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
#!/usr/bin/env bats
|
||||
|
||||
load ../test_helper
|
||||
load ../../lib/composure
|
||||
load "${BASH_IT}/vendor/github.com/erichs/composure/composure.sh"
|
||||
load ../../lib/log
|
||||
load ../../lib/helpers
|
||||
load ../../lib/utilities
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
#!/usr/bin/env bats
|
||||
|
||||
load ../test_helper
|
||||
load ../../lib/composure
|
||||
load "${BASH_IT}/vendor/github.com/erichs/composure/composure.sh"
|
||||
load ../../lib/helpers
|
||||
load ../../lib/utilities
|
||||
load ../../lib/search
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
#!/usr/bin/env bats
|
||||
|
||||
load ../test_helper
|
||||
load ../../lib/composure
|
||||
load "${BASH_IT}/vendor/github.com/erichs/composure/composure.sh"
|
||||
load ../../lib/log
|
||||
load ../../lib/helpers
|
||||
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
#!/usr/bin/env bats
|
||||
|
||||
load ../test_helper
|
||||
load ../../lib/composure
|
||||
load "${BASH_IT}/vendor/github.com/erichs/composure/composure.sh"
|
||||
load ../../plugins/available/base.plugin
|
||||
|
||||
@test 'plugins base: ips()' {
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
#!/usr/bin/env bats
|
||||
|
||||
load ../test_helper
|
||||
load ../../lib/composure
|
||||
load "${BASH_IT}/vendor/github.com/erichs/composure/composure.sh"
|
||||
|
||||
cite _about _param _example _group _author _version
|
||||
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
|
||||
load ../test_helper
|
||||
load ../../lib/helpers
|
||||
load ../../lib/composure
|
||||
load "${BASH_IT}/vendor/github.com/erichs/composure/composure.sh"
|
||||
|
||||
load ../../plugins/available/cmd-returned-notify.plugin
|
||||
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
|
||||
load ../test_helper
|
||||
load ../../lib/helpers
|
||||
load ../../lib/composure
|
||||
load "${BASH_IT}/vendor/github.com/erichs/composure/composure.sh"
|
||||
|
||||
@test 'ensure _go_pathmunge_wrap is defined' {
|
||||
{ [[ $CI ]] || _command_exists go; } || skip 'golang not found'
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
|
||||
load ../test_helper
|
||||
load ../../lib/helpers
|
||||
load ../../lib/composure
|
||||
load "${BASH_IT}/vendor/github.com/erichs/composure/composure.sh"
|
||||
load ../../plugins/available/ruby.plugin
|
||||
|
||||
function local_setup {
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
|
||||
load ../test_helper
|
||||
load ../../lib/helpers
|
||||
load ../../lib/composure
|
||||
load "${BASH_IT}/vendor/github.com/erichs/composure/composure.sh"
|
||||
|
||||
load ../../plugins/available/xterm.plugin
|
||||
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
#!/usr/bin/env bats
|
||||
load ../../lib/composure
|
||||
load "${BASH_IT}/vendor/github.com/erichs/composure/composure.sh"
|
||||
|
||||
unset BASH_IT_THEME
|
||||
unset GIT_HOSTING
|
||||
|
|
@ -39,8 +39,7 @@ setup_test_fixture() {
|
|||
lib_directory="$(cd "$(dirname "$0")" && pwd)"
|
||||
local src_topdir="$lib_directory/../../../.."
|
||||
|
||||
if command -v rsync &> /dev/null
|
||||
then
|
||||
if command -v rsync &> /dev/null; then
|
||||
# Use rsync to copy Bash-it to the temp folder
|
||||
rsync -qavrKL -d --delete-excluded --exclude=.git --exclude=enabled "$src_topdir" "$BASH_IT"
|
||||
else
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
#!/usr/bin/env bats
|
||||
|
||||
load ../test_helper
|
||||
load ../../lib/composure
|
||||
load "${BASH_IT}/vendor/github.com/erichs/composure/composure.sh"
|
||||
load ../../lib/log
|
||||
|
||||
cite _about _param _example _group _author _version
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
#!/usr/bin/env bats
|
||||
|
||||
load ../test_helper
|
||||
load ../../lib/composure
|
||||
load "${BASH_IT}/vendor/github.com/erichs/composure/composure.sh"
|
||||
load ../../lib/log
|
||||
|
||||
cite _about _param _example _group _author _version
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
#!/usr/bin/env bats
|
||||
|
||||
load ../test_helper
|
||||
load ../../lib/composure
|
||||
load "${BASH_IT}/vendor/github.com/erichs/composure/composure.sh"
|
||||
load ../../lib/log
|
||||
|
||||
cite _about _param _example _group _author _version
|
||||
|
|
|
|||
|
|
@ -0,0 +1,2 @@
|
|||
* -whitespace
|
||||
init.d/*.bash text eol=lf
|
||||
Loading…
Reference in New Issue