feat: Add color for print functions

This also removes the behavior of printing only (ex. "Error") if no
message was passed. (now it prints "Error: ")

This changes the print so that `_fn()` prints show parenthesis of the
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
+# @description Change the behavior of Bake. See [guide.md](./docs/guide.md) for details
 # @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,6 +112,12 @@ 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'"
 		;;
@@ -230,15 +236,27 @@ __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
-			printf '%s\n' "  -> ${BASH_REMATCH[3]}"
+			str+="  -> ${BASH_REMATCH[3]}"$'\n'
 		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
@@ -247,13 +265,21 @@ __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 command -v stty &>/dev/null; then
+		if stty size &>/dev/null; then
 			stty size
 		else
-			printf '%s\n' '20 80'
+			if [ -n "$COLUMNS" ]; then
+				printf '%s\n' "20 $COLUMNS"
+			else
+				printf '%s\n' '20 80'
+			fi
 		fi
 	)
 
@@ -276,6 +302,7 @@ __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)
@@ -295,6 +322,10 @@ __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
@@ -311,7 +342,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
@@ -329,8 +360,8 @@ __bake_parse_args() {
 	fi
 
 	if [ "$flag_help" = 'yes' ]; then
-		cat <<-EOF
-		Usage: bake [-h] [-f <Bakefile>] [var=value ...] <task> [args ...]
+		cat <<-"EOF"
+		Usage: bake [-h|-v] [-f <Bakefile>] [var=value ...] <task> [args ...]
 		EOF
 		__bake_print_tasks
 		exit
@@ -343,22 +374,27 @@ __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=
@@ -376,8 +412,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
@@ -397,6 +433,21 @@ __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"

pkg/src/public/bash-core.sh

@@ -308,23 +308,23 @@ core.print_stacktrace() {
 core.print_error_fn() {
 	local msg="$1"
 
-	printf '%s\n' "Error: ${FUNCNAME[1]}${msg:+": "}$msg" >&2
+	core.print_error "${FUNCNAME[1]}()${msg:+": "}$msg"
 }
 
 # @description Print a warning message to standard error
 # @arg $1 string message
 core.print_warn_fn() {
 	local msg="$1"
 
-	printf '%s\n' "Warn: ${FUNCNAME[1]}${msg:+": "}$msg" >&2
+	core.print_warn "${FUNCNAME[1]}()${msg:+": "}$msg"
 }
 
 # @description Print an informative message to standard output
 # @arg $1 string message
 core.print_info_fn() {
 	local msg="$1"
 
-	printf '%s\n' "Info: ${FUNCNAME[1]}${msg:+": "}$msg"
+	core.print_info "${FUNCNAME[1]}()${msg:+": "}$msg"
 }
 
 # @description Print a error message to standard error and die
@@ -339,23 +339,35 @@ core.print_die() {
 core.print_error() {
 	local msg="$1"
 
-	printf '%s\n' "Error${msg:+": "}$msg" >&2
+	if core.private.should_print_color 2; then
+		printf "\033[1;31m%s:\033[0m %s\n" 'Error' "$msg" >&2
+	else
+		printf "%s: %s\n" 'Error' "$msg" >&2
+	fi
 }
 
 # @description Print a warning message to standard error
 # @arg $1 string message
 core.print_warn() {
 	local msg="$1"
 
-	printf '%s\n' "Warn${msg:+": "}$msg" >&2
+	if core.private.should_print_color 2; then
+		printf "\033[1;33m%s:\033[0m %s\n" 'Warn' "$msg" >&2
+	else
+		printf "%s: %s\n" 'Warn' "$msg" >&2
+	fi
 }
 
 # @description Print an informative message to standard output
 # @arg $1 string message
 core.print_info() {
 	local msg="$1"
 
-	printf '%s\n' "Info${msg:+": "}$msg"
+	if core.private.should_print_color 1; then
+		printf "\033[1;32m%s:\033[0m %s\n" 'Info' "$msg" >&2
+	else
+		printf "%s: %s\n" 'Info' "$msg" >&2
+	fi
 }
 
 # @description (DEPRECATED). Determine if color should be printed. Note that this doesn't

pkg/src/util/util.sh

@@ -33,8 +33,23 @@ core.private.util.trap_handler_common() {
 }
 
 # @description Prints the current error stored
+# @internal
 core.private.util.err_print() {
 	printf '%s\n' 'Error found:'
 	printf '%s\n' "  ERRCODE: $ERRCODE" >&2
 	printf '%s\n' "  ERR: $ERR" >&2
+}
+
+core.private.should_print_color() {
+	local fd="$1"
+
+	if [[ ${NO_COLOR+x} || "$TERM" = 'dumb' ]]; then
+		return 1
+	fi
+
+	if [ -t "$fd" ]; then
+		return 0
+	fi
+
+	return 1
 }

tests/print.bats

@@ -12,37 +12,37 @@ infofn() { "$@"; }
 @test "core.print_error_fn works" {
 	run errorfn core.print_error_fn
 	assert_success
-	assert_output 'Error: errorfn'
+	assert_output 'Error: errorfn()'
 
 	run errorfn core.print_error_fn 'Something'
 	assert_success
-	assert_output 'Error: errorfn: Something'
+	assert_output 'Error: errorfn(): Something'
 }
 
 @test "core.print_warn_fn works" {
 	run warnfn core.print_warn_fn
 	assert_success
-	assert_output 'Warn: warnfn'
+	assert_output 'Warn: warnfn()'
 
 	run warnfn core.print_warn_fn 'Something'
 	assert_success
-	assert_output 'Warn: warnfn: Something'
+	assert_output 'Warn: warnfn(): Something'
 }
 
 @test "core.print_info_fn works" {
 	run infofn core.print_info_fn
 	assert_success
-	assert_output 'Info: infofn'
+	assert_output 'Info: infofn()'
 
 	run infofn core.print_info_fn 'Something'
 	assert_success
-	assert_output 'Info: infofn: Something'
+	assert_output 'Info: infofn(): Something'
 }
 
 @test "core.print_error works" {
 	run errorfn core.print_error
 	assert_success
-	assert_output 'Error'
+	assert_output 'Error: '
 
 	run errorfn core.print_error 'Something'
 	assert_success
@@ -52,7 +52,7 @@ infofn() { "$@"; }
 @test "core.print_warn works" {
 	run warnfn core.print_warn
 	assert_success
-	assert_output 'Warn'
+	assert_output 'Warn: '
 
 	run warnfn core.print_warn 'Something'
 	assert_success
@@ -62,7 +62,7 @@ infofn() { "$@"; }
 @test "core.print_info works" {
 	run infofn core.print_info
 	assert_success
-	assert_output 'Info'
+	assert_output 'Info: '
 
 	run infofn core.print_info 'Something'
 	assert_success