Getting Bash-it to use the vendored composure

Fixed tests Fixed install.sh and bash_it.sh Added gitattributes to the vendor folder Changed documentation
Bash-it · Jan 31, 2021 · a7e113a · a7e113a
1 parent a0b6c49
commit a7e113a
Show file tree

Hide file tree

Showing 27 changed files with 319 additions and 690 deletions.
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -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$"

diff --git a/bash_it.sh b/bash_it.sh
@@ -3,163 +3,156 @@
 BASH_IT_LOG_PREFIX="core: main: "
 
 # Only set $BASH_IT if it's not already set
-if [ -z "$BASH_IT" ];
-then
-  # Setting $BASH to maintain backwards compatibility
-  export BASH_IT=$BASH
-  BASH="$(bash -c 'echo $BASH')"
-  export BASH
-  BASH_IT_OLD_BASH_SETUP=true
+if [ -z "$BASH_IT" ]; then
+	# Setting $BASH to maintain backwards compatibility
+	export BASH_IT=$BASH
+	BASH="$(bash -c 'echo $BASH')"
+	export BASH
+	BASH_IT_OLD_BASH_SETUP=true
 fi
 
+# Load vendors
 # 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"
 
+BASH_IT_LOG_PREFIX="vendor: "
+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}"
+done
+unset _bash_it_vendor_init
+
 # We can only log it now
 [ -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
-  _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;
+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
 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
-  if [ "$_bash_it_config_file" != "$APPEARANCE_LIB" ]; then
-    filename=${_bash_it_config_file##*/}
-    filename=${filename%.bash}
-    BASH_IT_LOG_PREFIX="lib: ${filename}: "
-    _log_debug "Loading library file..."
-    # shellcheck disable=SC1090
-    source "$_bash_it_config_file"
-  fi
+for _bash_it_config_file in $LIB; do
+	if [ "$_bash_it_config_file" != "$APPEARANCE_LIB" ]; then
+		filename=${_bash_it_config_file##*/}
+		filename=${filename%.bash}
+		BASH_IT_LOG_PREFIX="lib: ${filename}: "
+		_log_debug "Loading library file..."
+		# shellcheck disable=SC1090
+		source "$_bash_it_config_file"
+	fi
 done
 
-# Load vendors
-BASH_IT_LOG_PREFIX="vendor: "
-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}"
-done
-unset _bash_it_vendor_init
-
 BASH_IT_LOG_PREFIX="core: main: "
 # Load the global "enabled" directory
 # "family" param is empty so that files get sources in glob order
 # shellcheck source=./scripts/reloader.bash
 source "${BASH_IT}/scripts/reloader.bash"
 
 # Load enabled aliases, completion, plugins
-for file_type in "aliases" "plugins" "completion"
-do
-  # shellcheck source=./scripts/reloader.bash
-  source "${BASH_IT}/scripts/reloader.bash" "skip" "$file_type"
+for file_type in "aliases" "plugins" "completion"; do
+	# shellcheck source=./scripts/reloader.bash
+	source "${BASH_IT}/scripts/reloader.bash" "skip" "$file_type"
 done
 
 # Load theme, if a theme was set
 if [[ -n "${BASH_IT_THEME}" ]]; then
-  _log_debug "Loading \"${BASH_IT_THEME}\" theme..."
-  # Load colors and helpers first so they can be used in base theme
-  BASH_IT_LOG_PREFIX="themes: colors: "
-  # shellcheck source=./themes/colors.theme.bash
-  source "${BASH_IT}/themes/colors.theme.bash"
-  BASH_IT_LOG_PREFIX="themes: githelpers: "
-  # shellcheck source=./themes/githelpers.theme.bash
-  source "${BASH_IT}/themes/githelpers.theme.bash"
-  BASH_IT_LOG_PREFIX="themes: p4helpers: "
-  # shellcheck source=./themes/p4helpers.theme.bash
-  source "${BASH_IT}/themes/p4helpers.theme.bash"
-  BASH_IT_LOG_PREFIX="themes: command_duration: "
-  # shellcheck source=./themes/command_duration.theme.bash
-  source "${BASH_IT}/themes/command_duration.theme.bash"
-  BASH_IT_LOG_PREFIX="themes: base: "
-  # shellcheck source=./themes/base.theme.bash
-  source "${BASH_IT}/themes/base.theme.bash"
-
-  BASH_IT_LOG_PREFIX="lib: appearance: "
-  # appearance (themes) now, after all dependencies
-  # shellcheck source=./lib/appearance.bash
-  source "$APPEARANCE_LIB"
+	_log_debug "Loading \"${BASH_IT_THEME}\" theme..."
+	# Load colors and helpers first so they can be used in base theme
+	BASH_IT_LOG_PREFIX="themes: colors: "
+	# shellcheck source=./themes/colors.theme.bash
+	source "${BASH_IT}/themes/colors.theme.bash"
+	BASH_IT_LOG_PREFIX="themes: githelpers: "
+	# shellcheck source=./themes/githelpers.theme.bash
+	source "${BASH_IT}/themes/githelpers.theme.bash"
+	BASH_IT_LOG_PREFIX="themes: p4helpers: "
+	# shellcheck source=./themes/p4helpers.theme.bash
+	source "${BASH_IT}/themes/p4helpers.theme.bash"
+	BASH_IT_LOG_PREFIX="themes: command_duration: "
+	# shellcheck source=./themes/command_duration.theme.bash
+	source "${BASH_IT}/themes/command_duration.theme.bash"
+	BASH_IT_LOG_PREFIX="themes: base: "
+	# shellcheck source=./themes/base.theme.bash
+	source "${BASH_IT}/themes/base.theme.bash"
+
+	BASH_IT_LOG_PREFIX="lib: appearance: "
+	# appearance (themes) now, after all dependencies
+	# shellcheck source=./lib/appearance.bash
+	source "$APPEARANCE_LIB"
 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
-    BASH_IT_LOG_PREFIX="${file_type}: custom: "
-    _log_debug "Loading component..."
-    # shellcheck disable=SC1090
-    source "${BASH_IT}/${file_type}/custom.${file_type}.bash"
-  fi
+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
+		source "${BASH_IT}/${file_type}/custom.${file_type}.bash"
+	fi
 done
 
 # Custom
 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
-  if [ -e "${_bash_it_config_file}" ]; then
-    filename=$(basename "${_bash_it_config_file}")
-    filename=${filename%*.bash}
-    BASH_IT_LOG_PREFIX="custom: $filename: "
-    _log_debug "Loading custom file..."
-    # shellcheck disable=SC1090
-    source "$_bash_it_config_file"
-  fi
+for _bash_it_config_file in $CUSTOM; do
+	if [ -e "${_bash_it_config_file}" ]; then
+		filename=$(basename "${_bash_it_config_file}")
+		filename=${filename%*.bash}
+		BASH_IT_LOG_PREFIX="custom: $filename: "
+		_log_debug "Loading custom file..."
+		# shellcheck disable=SC1090
+		source "$_bash_it_config_file"
+	fi
 done
 
 unset _bash_it_config_file
 if [[ $PROMPT ]]; then
-  export PS1="\[""$PROMPT""\]"
+	export PS1="\[""$PROMPT""\]"
 fi
 
 # Adding Support for other OSes
 PREVIEW="less"
 
 if [ -s /usr/bin/gloobus-preview ]; then
-  PREVIEW="gloobus-preview"
+	PREVIEW="gloobus-preview"
 elif [ -s /Applications/Preview.app ]; then
-  # shellcheck disable=SC2034
-  PREVIEW="/Applications/Preview.app"
+	# shellcheck disable=SC2034
+	PREVIEW="/Applications/Preview.app"
 fi
 
 # Load all the Jekyll stuff
 
-if [ -e "$HOME/.jekyllconfig" ]
-then
-  # shellcheck disable=SC1090
-  . "$HOME/.jekyllconfig"
+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
-  case $OSTYPE in
-    darwin*)
-      alias reload='source ~/.bash_profile'
-      ;;
-    *)
-      alias reload='source ~/.bashrc'
-      ;;
-  esac
+if ! command -v reload &> /dev/null && [ -n "$BASH_IT_RELOAD_LEGACY" ]; then
+	case $OSTYPE in
+		darwin*)
+			alias reload='source ~/.bash_profile'
+			;;
+		*)
+			alias reload='source ~/.bashrc'
+			;;
+	esac
 fi
 
 # Disable trap DEBUG on subshells - https://github.com/Bash-it/bash-it/pull/1040

diff --git a/clean_files.txt b/clean_files.txt
@@ -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
diff --git a/docs/development.rst b/docs/development.rst
@@ -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``