feat: Add print formatting functions

Author: hyperupcall

bake

@@ -16,7 +16,7 @@
 # Learn more about it [on GitHub](https://github.com/hyperupcall/bake)
 
 if [ "$0" != "${BASH_SOURCE[0]}" ] && [ "$BAKE_INTERNAL_CAN_SOURCE" != 'yes' ]; then
-	printf '%s\n' 'Error: This file should not be sourced' >&2
+	printf '%s\n' "Error: This file should not be sourced" >&2
 	return 1
 fi
 
@@ -91,12 +91,12 @@ bake.assert_cmd() {
 	fi
 }
 
-# @description Change the behavior of Bake. See [guide.md](./docs/guide.md) for details
+# @description Change the behavior of Bake
 # @arg $1 string Name of config property to change
 # @arg $2 string New value of config property
 bake.cfg() {
-	local cfg="$1"
-	local value="$2"
+	local cfg=$1
+	local value=$2
 
 	case $cfg in
 	stacktrace)
@@ -112,12 +112,6 @@ bake.cfg() {
 			*) __bake_internal_die2 "Config property '$cfg' accepts only either 'yes' or 'no'" ;;
 		esac
 		;;
-	big-print)
-		case $value in
-			yes|no) ;;
-			*) __bake_internal_die2 "Config property '$cfg' accepts only either 'yes' or 'no'" ;;
-		esac
-		;;
 	*)
 		__bake_internal_die2 "No config property matched '$cfg'"
 		;;
@@ -236,27 +230,15 @@ __bake_error() {
 # @description Nicely prints all 'Bakefile.sh' tasks to standard output
 # @internal
 __bake_print_tasks() {
-	printf '%s\n' 'Tasks:'
-	local str=
-
 	# shellcheck disable=SC1007,SC2034
 	local regex="^(([[:space:]]*function[[:space:]]*)?task\.(.*?)\(\)).*"
 	local line=
+	printf '%s\n' 'Tasks:'
 	while IFS= read -r line || [ -n "$line" ]; do
 		if [[ "$line" =~ $regex ]]; then
-			str+="  -> ${BASH_REMATCH[3]}"$'\n'
+			printf '%s\n' "  -> ${BASH_REMATCH[3]}"
 		fi
 	done < "$BAKE_FILE"; unset -v line
-
-	if [ -z "$str" ]; then
-		if __bake_is_color; then
-			str=$'  \033[3mNo tasks\033[0m\n'
-		else
-			str=$'  No tasks\n'
-		fi
-	fi
-
-	printf '%s' "$str"
 } >&2
 
 # @description Prints text that takes up the whole terminal width
@@ -265,21 +247,13 @@ __bake_print_tasks() {
 __bake_print_big() {
 	local print_text="$1"
 
-	if [ "$__bake_cfg_big_print" = 'no' ]; then
-		return
-	fi
-
 	# shellcheck disable=SC1007
 	local _stty_height= _stty_width=
 	read -r _stty_height _stty_width < <(
-		if stty size &>/dev/null; then
+		if command -v stty &>/dev/null; then
 			stty size
 		else
-			if [ -n "$COLUMNS" ]; then
-				printf '%s\n' "20 $COLUMNS"
-			else
-				printf '%s\n' '20 80'
-			fi
+			printf '%s\n' '20 80'
 		fi
 	)
 
@@ -302,7 +276,6 @@ __bake_parse_args() {
 	unset REPLY; REPLY=
 	local -i total_shifts=0
 
-	# FIXME: bug for when passing -v to child task argument
 	local __bake_arg=
 	for arg; do case $arg in
 	-f)
@@ -322,10 +295,6 @@ __bake_parse_args() {
 			__bake_internal_die "Specified file '$BAKE_FILE' is not actually a file"
 		fi
 		;;
-	-v)
-		local bake_version='1.8.2'
-		printf '%s\n' "Version: $bake_version"
-		;;
 	-h)
 		local flag_help='yes'
 		if ! shift; then
@@ -342,7 +311,7 @@ __bake_parse_args() {
 		BAKE_FILE="$BAKE_ROOT/${BAKE_FILE##*/}"
 	else
 		if ! BAKE_ROOT=$(
-			while [ ! -f './Bakefile.sh' ] && [ "$PWD" != / ]; do
+			while [ ! -f 'Bakefile.sh' ] && [ "$PWD" != / ]; do
 				if ! cd ..; then
 					exit 1
 				fi
@@ -360,8 +329,8 @@ __bake_parse_args() {
 	fi
 
 	if [ "$flag_help" = 'yes' ]; then
-		cat <<-"EOF"
-		Usage: bake [-h|-v] [-f <Bakefile>] [var=value ...] <task> [args ...]
+		cat <<-EOF
+		Usage: bake [-h] [-f <Bakefile>] [var=value ...] <task> [args ...]
 		EOF
 		__bake_print_tasks
 		exit
@@ -374,27 +343,22 @@ __bake_parse_args() {
 # @internal
 __bake_main() {
 	__bake_cfg_stacktrace='no'
-	__bake_cfg_big_print='yes'
 
-	# Environment boilerplate
 	set -ETeo pipefail
 	shopt -s dotglob extglob globasciiranges globstar lastpipe shift_verbose
-	export LANG='C' LC_CTYPE='C' LC_NUMERIC='C' LC_TIME='C' LC_COLLATE='C' \
-		LC_MONETARY='C' LC_MESSAGES='C' LC_PAPER='C' LC_NAME='C' LC_ADDRESS='C' \
-		LC_TELEPHONE='C' LC_MEASUREMENT='C' LC_IDENTIFICATION='C' LC_ALL='C'
+	export LANG='C' LC_CTYPE='C' LC_NUMERIC='C' LC_TIME='C' LC_COLLATE='C' LC_MONETARY='C' \
+		LC_MESSAGES='C' LC_PAPER='C' LC_NAME='C' LC_ADDRESS='C' LC_TELEPHONE='C' \
+		LC_MEASUREMENT='C' LC_IDENTIFICATION='C' LC_ALL='C'
 	trap '__bake_trap_err' 'ERR'
-	trap ':' 'INT' # Ensure Ctrl-C ends up printing <- ERROR ==== etc.
 	bake.cfg pedantic-task-cd 'no'
 
-	# Parse arguments
 	# Set `BAKE_{ROOT,FILE}`
 	BAKE_ROOT=; BAKE_FILE=
 	__bake_parse_args "$@"
 	if ! shift "$REPLY"; then
 		__bake_internal_die 'Failed to shift'
 	fi
 
-	# Set variables à la Make
 	# shellcheck disable=SC1007
 	local __bake_key= __bake_value=
 	local __bake_arg=
@@ -412,8 +376,8 @@ __bake_main() {
 			;;
 		*) break
 	esac done; unset -v __bake_arg
+	# Note: Don't unset '__bake_variable' or none of the variables will stay set
 	unset -v __bake_key __bake_value
-	unset -vn __bake_variable
 
 	local __bake_task="$1"
 	if [ -z "$__bake_task" ]; then
@@ -433,21 +397,6 @@ __bake_main() {
 	__bake_task= source "$BAKE_FILE"
 
 	if declare -f task."$__bake_task" >/dev/null 2>&1; then
-		local line=
-		local shouldTestNextLine='no'
-		while IFS= read -r line; do
-			if [ "$shouldTestNextLine" = 'yes' ]; then
-				if [[ $line == *'bake.cfg'*big-print*no* ]]; then
-					__bake_cfg_big_print='no'
-				fi
-				shouldTestNextLine='no'
-			fi
-
-			if [[ $line == @(task."$__bake_task"|init)*'('*')'*'{' ]]; then
-				shouldTestNextLine='yes'
-			fi
-		done < "$BAKE_FILE"; unset -v line shouldTestNextLine
-
 		__bake_print_big "-> RUNNING TASK '$__bake_task'"
 		if declare -f init >/dev/null 2>&1; then
 			init "$__bake_task"

docs/reference.md

@@ -1,10 +1,41 @@
 ## Index
 
+* [std.fprint_error()](#stdfprint_error)
+* [std.fprint_warn()](#stdfprint_warn)
+* [std.fprint_info()](#stdfprint_info)
 * [std.find_parent_file()](#stdfind_parent_file)
 * [std.find_parent_dir()](#stdfind_parent_dir)
-* [std.should_output_color()](#stdshould_output_color)
+* [std.should_print_color_stdout()](#stdshould_print_color_stdout)
+* [std.should_print_color_stderr()](#stdshould_print_color_stderr)
 * [std.get_package_info()](#stdget_package_info)
 
+### std.fprint_error()
+
+Prints a formatted error message
+
+#### Arguments
+
+* **$1** (name): of package
+* **$2** (message):
+
+### std.fprint_warn()
+
+Prints a formated warning message
+
+#### Arguments
+
+* **$1** (name): of package
+* **$2** (message):
+
+### std.fprint_info()
+
+Prints a formated log message
+
+#### Arguments
+
+* **$1** (name): of package
+* **$2** (message):
+
 ### std.find_parent_file()
 
 Finds a parent file
@@ -17,10 +48,17 @@ Finds a parent file
 
 Finds a parent directory
 
-### std.should_output_color()
+### std.should_print_color_stdout()
+
+Determine if color should be printed to standard output
+
+_Function has no arguments._
+
+### std.should_print_color_stderr()
+
+Determine if color should be printed to standard error
 
-Determine if color should be printed. Note that this doesn't
-use tput because simple environment variable checking heuristics suffice
+_Function has no arguments._
 
 ### std.get_package_info()
 

examples/example.sh

@@ -0,0 +1,8 @@
+# shellcheck shell=bash
+
+for f in ./pkg/src/{public,util}/*.sh; do
+	# shellcheck disable=SC1090
+	source "$f"
+done; unset -v f
+
+std.fprint_info 'hookah' 'other'

pkg/src/public/bash-std.sh

@@ -1,5 +1,47 @@
 # shellcheck shell=bash
 
+# @description Prints a formatted error message
+# @arg $1 name of package
+# @arg $2 message
+std.fprint_error () {
+	local custom="$1"
+	local msg="$2"
+
+	if std.should_print_color_stderr; then
+		printf "\033[1;31m%s (%s):\033[0m %s\n" 'Error' "$custom" "$msg" >&2
+	else
+		printf "%s (%s): %s\n" 'Error' "$custom" "$msg" >&2
+	fi
+}
+
+# @description Prints a formated warning message
+# @arg $1 name of package
+# @arg $2 message
+std.fprint_warn () {
+	local custom="$1"
+	local msg="$2"
+
+	if std.should_print_color_stderr; then
+		printf "\033[1;33m%s (%s):\033[0m %s\n" 'Warn' "$custom" "$msg" >&2
+	else
+		printf "%s (%s): %s\n" 'Warn' "$custom" "$msg" >&2
+	fi
+}
+
+# @description Prints a formated log message
+# @arg $1 name of package
+# @arg $2 message
+std.fprint_info () {
+	local custom="$1"
+	local msg="$2"
+
+	if std.should_print_color_stdout; then
+		printf "\033[1;32m%s (%s):\033[0m %s\n" 'Info' "$custom" "$msg"
+	else
+		printf "%s (%s): %s\n" 'Info' "$custom" "$msg"
+	fi
+}
+
 # @description Finds a parent file
 # @arg $1 File name
 std.find_parent_file() {