feat: New printing functions

Author: hyperupcall

docs/api.md

@@ -15,13 +15,17 @@ Core functions for any Bash program
 * [core.err_exists()](#coreerr_exists)
 * [core.panic()](#corepanic)
 * [core.print_stacktrace()](#coreprint_stacktrace)
+* [core.print_fatal_fn()](#coreprint_fatal_fn)
 * [core.print_error_fn()](#coreprint_error_fn)
 * [core.print_warn_fn()](#coreprint_warn_fn)
 * [core.print_info_fn()](#coreprint_info_fn)
+* [core.print_debug_fn()](#coreprint_debug_fn)
 * [core.print_die()](#coreprint_die)
+* [core.print_fatal()](#coreprint_fatal)
 * [core.print_error()](#coreprint_error)
 * [core.print_warn()](#coreprint_warn)
 * [core.print_info()](#coreprint_info)
+* [core.print_debug()](#coreprint_debug)
 * [core.should_output_color()](#coreshould_output_color)
 * [core.get_package_info()](#coreget_package_info)
 * [core.init()](#coreinit)
@@ -155,25 +159,46 @@ core.trap_add 'err_handler' ERR
 
 _Function has no arguments._
 
+### core.print_fatal_fn()
+
+Print a fatal error message including the function name of the callee
+to standard error
+
+#### Arguments
+
+* **$1** (string): message
+
 ### core.print_error_fn()
 
-Print an error message to standard error
+Print an error message including the function name of the callee
+to standard error
 
 #### Arguments
 
 * **$1** (string): message
 
 ### core.print_warn_fn()
 
-Print a warning message to standard error
+Print a warning message including the function name of the callee
+to standard error
 
 #### Arguments
 
 * **$1** (string): message
 
 ### core.print_info_fn()
 
-Print an informative message to standard output
+Print an informative message including the function name of the callee
+to standard output
+
+#### Arguments
+
+* **$1** (string): message
+
+### core.print_debug_fn()
+
+Print a debug message including the function name of the callee
+to standard output
 
 #### Arguments
 
@@ -187,6 +212,14 @@ Print a error message to standard error and die
 
 * **$1** (string): message
 
+### core.print_fatal()
+
+Print a fatal error message to standard error
+
+#### Arguments
+
+* **$1** (string): message
+
 ### core.print_error()
 
 Print an error message to standard error
@@ -211,6 +244,14 @@ Print an informative message to standard output
 
 * **$1** (string): message
 
+### core.print_debug()
+
+Print a debug message to standard output if the environment variable "DEBUG" is present
+
+#### Arguments
+
+* **$1** (string): message
+
 ### core.should_output_color()
 
 (DEPRECATED). Determine if color should be printed. Note that this doesn't

pkg/src/public/bash-core.sh

@@ -279,37 +279,69 @@ core.print_stacktrace() {
 	fi
 } >&2
 
-# @description Print an error message to standard error
+# @description Print a fatal error message including the function name of the callee
+# to standard error
+# @arg $1 string message
+core.print_fatal_fn() {
+	local msg="$1"
+
+	core.print_fatal "${FUNCNAME[1]}()${msg:+": "}$msg"
+}
+
+# @description Print an error message including the function name of the callee
+# to standard error
 # @arg $1 string message
 core.print_error_fn() {
 	local msg="$1"
 
 	core.print_error "${FUNCNAME[1]}()${msg:+": "}$msg"
 }
 
-# @description Print a warning message to standard error
+# @description Print a warning message including the function name of the callee
+# to standard error
 # @arg $1 string message
 core.print_warn_fn() {
 	local msg="$1"
 
 	core.print_warn "${FUNCNAME[1]}()${msg:+": "}$msg"
 }
 
-# @description Print an informative message to standard output
+# @description Print an informative message including the function name of the callee
+# to standard output
 # @arg $1 string message
 core.print_info_fn() {
 	local msg="$1"
 
 	core.print_info "${FUNCNAME[1]}()${msg:+": "}$msg"
 }
+# @description Print a debug message including the function name of the callee
+# to standard output
+# @arg $1 string message
+core.print_debug_fn() {
+	local msg="$1"
+
+	core.print_debug "${FUNCNAME[1]}()${msg:+": "}$msg"
+}
 
 # @description Print a error message to standard error and die
 # @arg $1 string message
 core.print_die() {
-	core.print_error "$1"
+	core.print_fatal "$1"
 	exit 1
 }
 
+# @description Print a fatal error message to standard error
+# @arg $1 string message
+core.print_fatal() {
+	local msg="$1"
+
+	if core.private.should_print_color 2; then
+		printf "\033[1;35m%s:\033[0m %s\n" 'Fatal' "$msg" >&2
+	else
+		printf "%s: %s\n" 'Fatal' "$msg" >&2
+	fi
+}
+
 # @description Print an error message to standard error
 # @arg $1 string message
 core.print_error() {
@@ -346,6 +378,14 @@ core.print_info() {
 	fi
 }
 
+# @description Print a debug message to standard output if the environment variable "DEBUG" is present
+# @arg $1 string message
+core.print_debug() {
+	if [[ -v DEBUG ]]; then
+		printf "%s: %s\n" 'Debug' "$msg"
+	fi
+}
+
 # @description (DEPRECATED). Determine if color should be printed. Note that this doesn't
 # use tput because simple environment variable checking heuristics suffice. Deprecated because this code
 # has been moved to bash-std