From b772e6ace73ea6c9ede74373683577ea2726d9d6 Mon Sep 17 00:00:00 2001
From: John D Pell <John+git@gaelicWizard.net>
Date: Sun, 9 Jan 2022 00:49:44 -0800
Subject: [PATCH] lib/log: `shellcheck` && `shfmt`
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

Alsö, fix tests to load `lib/colors` instead of `lib/appearance`...wut

Alsö, `short-circuit _has_colors()`: If we already looked up colors, and we already have them, then don't run `tput` again.

My apologies to future `git blame` hunters ♥
---
 clean_files.txt |  1 +
 lib/log.bash    | 77 ++++++++++++++++++++++---------------------------
 2 files changed, 36 insertions(+), 42 deletions(-)

diff --git a/clean_files.txt b/clean_files.txt
index a5959798..857ef910 100644
--- a/clean_files.txt
+++ b/clean_files.txt
@@ -78,6 +78,7 @@ completion/available/vuejs.completion.bash
 completion/available/wpscan.completion.bash
 
 # libraries
+lib/log.bash
 lib/utilities.bash
 
 # plugins
diff --git a/lib/log.bash b/lib/log.bash
index 6bc53a12..f1bce9f7 100644
--- a/lib/log.bash
+++ b/lib/log.bash
@@ -1,60 +1,53 @@
-#!/usr/bin/env bash
+# shellcheck shell=bash
+#
+# A collection of logging functions.
 
 export BASH_IT_LOG_LEVEL_ERROR=1
 export BASH_IT_LOG_LEVEL_WARNING=2
 export BASH_IT_LOG_LEVEL_ALL=3
 
-function _has_colors()
-{
-  # Check that stdout is a terminal
-  test -t 1 || return 1
-
-  ncolors=$(tput colors)
-  test -n "$ncolors" && test "$ncolors" -ge 8 || return 1
-  return 0
+function _has_colors() {
+	# Check that stdout is a terminal, and that it has at least 8 colors.
+	[[ -t 1 && "${_bash_it_available_colors:=$(tput colors 2> /dev/null)}" -ge 8 ]]
 }
 
-function _log_general()
-{
-  about 'Internal function used for logging, uses BASH_IT_LOG_PREFIX as a prefix'
-  param '1: color of the message'
-  param '2: log level to print before the prefix'
-  param '3: message to log'
-  group 'log'
+function _log_general() {
+	about 'Internal function used for logging, uses BASH_IT_LOG_PREFIX as a prefix'
+	param '1: color of the message'
+	param '2: log level to print before the prefix'
+	param '3: message to log'
+	group 'log'
 
-  message=$2${BASH_IT_LOG_PREFIX:-default: }$3
-  _has_colors && echo -e "$1${message}${echo_normal:-}" || echo -e "${message}"
+	message=$2${BASH_IT_LOG_PREFIX:-default: }$3
+	_has_colors && echo -e "$1${message}${echo_normal:-}" || echo -e "${message}"
 }
 
-function _log_debug()
-{
-  about 'log a debug message by echoing to the screen. needs BASH_IT_LOG_LEVEL >= BASH_IT_LOG_LEVEL_ALL'
-  param '1: message to log'
-  example '$ _log_debug "Loading plugin git..."'
-  group 'log'
+function _log_debug() {
+	about 'log a debug message by echoing to the screen. needs BASH_IT_LOG_LEVEL >= BASH_IT_LOG_LEVEL_ALL'
+	param '1: message to log'
+	example '$ _log_debug "Loading plugin git..."'
+	group 'log'
 
-  [[ "${BASH_IT_LOG_LEVEL:-0}" -ge $BASH_IT_LOG_LEVEL_ALL ]] || return 0
-  _log_general "${echo_green:-}" "DEBUG: " "$1"
+	[[ "${BASH_IT_LOG_LEVEL:-0}" -ge $BASH_IT_LOG_LEVEL_ALL ]] || return 0
+	_log_general "${echo_green:-}" "DEBUG: " "$1"
 }
 
-function _log_warning()
-{
-  about 'log a message by echoing to the screen. needs BASH_IT_LOG_LEVEL >= BASH_IT_LOG_LEVEL_WARNING'
-  param '1: message to log'
-  example '$ _log_warning "git binary not found, disabling git plugin..."'
-  group 'log'
+function _log_warning() {
+	about 'log a message by echoing to the screen. needs BASH_IT_LOG_LEVEL >= BASH_IT_LOG_LEVEL_WARNING'
+	param '1: message to log'
+	example '$ _log_warning "git binary not found, disabling git plugin..."'
+	group 'log'
 
-  [[ "${BASH_IT_LOG_LEVEL:-0}" -ge $BASH_IT_LOG_LEVEL_WARNING ]] || return 0
-  _log_general "${echo_yellow:-}" " WARN: " "$1"
+	[[ "${BASH_IT_LOG_LEVEL:-0}" -ge $BASH_IT_LOG_LEVEL_WARNING ]] || return 0
+	_log_general "${echo_yellow:-}" " WARN: " "$1"
 }
 
-function _log_error()
-{
-  about 'log a message by echoing to the screen. needs BASH_IT_LOG_LEVEL >= BASH_IT_LOG_LEVEL_ERROR'
-  param '1: message to log'
-  example '$ _log_error "Failed to load git plugin..."'
-  group 'log'
+function _log_error() {
+	about 'log a message by echoing to the screen. needs BASH_IT_LOG_LEVEL >= BASH_IT_LOG_LEVEL_ERROR'
+	param '1: message to log'
+	example '$ _log_error "Failed to load git plugin..."'
+	group 'log'
 
-  [[ "${BASH_IT_LOG_LEVEL:-0}" -ge $BASH_IT_LOG_LEVEL_ERROR ]] || return 0
-  _log_general "${echo_red:-}" "ERROR: " "$1"
+	[[ "${BASH_IT_LOG_LEVEL:-0}" -ge $BASH_IT_LOG_LEVEL_ERROR ]] || return 0
+	_log_general "${echo_red:-}" "ERROR: " "$1"
 }