breaking: Deprecate print_die functions

These functions were initially used because a 'die' function is
necessary in most scripts. Because of othe other `_fn`s, a
`print_die_fn` was made, which makes little sense, as if the function
name is required to be printed on fault, it would be better to show the
stacktrace anyways (and implement some functionality for that)

There was also an issue of switching the `die` function from calling
`core.print_error` to `core.print_fatal`. This semantically causes some
issues; for example, internal faults should be treated as "fatal", while
user-input errors should be treated as "errors".

Any `die` functions should be created at hyperupcall/bash-std

Author: hyperupcall

docs/api.md

@@ -15,13 +15,11 @@ Core functions for any Bash program
 * [core.err_exists()](#coreerr_exists)
 * [core.panic()](#corepanic)
 * [core.print_stacktrace()](#coreprint_stacktrace)
-* [core.print_die_fn()](#coreprint_die_fn)
 * [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)
@@ -31,6 +29,8 @@ Core functions for any Bash program
 * [core.get_package_info()](#coreget_package_info)
 * [core.init()](#coreinit)
 * [core.stacktrace_print()](#corestacktrace_print)
+* [core.print_die_fn()](#coreprint_die_fn)
+* [core.print_die()](#coreprint_die)
 
 ### core.trap_add()
 
@@ -160,15 +160,6 @@ core.trap_add 'err_handler' ERR
 
 _Function has no arguments._
 
-### core.print_die_fn()
-
-Print a error message to standard error including the function name
-of the callee to standard error and die
-
-#### Arguments
-
-* **$1** (string): message
-
 ### core.print_fatal_fn()
 
 Print a fatal error message including the function name of the callee
@@ -214,14 +205,6 @@ to standard output
 
 * **$1** (string): message
 
-### core.print_die()
-
-Print a error message to standard error and die
-
-#### Arguments
-
-* **$1** (string): message
-
 ### core.print_fatal()
 
 Print a fatal error message to standard error
@@ -296,3 +279,20 @@ _Function has no arguments._
 
 * [core.print_stacktrace](#coreprint_stacktrace)
 
+### core.print_die_fn()
+
+(DEPRECATED) Print a error message to standard error including the function name
+of the callee to standard error and die
+
+#### Arguments
+
+* **$1** (string): message
+
+### core.print_die()
+
+(DEPRECATED) Print a error message to standard error and die
+
+#### Arguments
+
+* **$1** (string): message
+

pkg/src/public/bash-core.sh

@@ -285,15 +285,6 @@ core.print_stacktrace() {
 	fi
 } >&2
 
-# @description Print a error message to standard error including the function name
-# of the callee to standard error and die
-# @arg $1 string message
-core.print_die_fn() {
-	local msg="$1"
-
-	core.print_die "${FUNCNAME[1]}()${msg:+": "}$msg"
-}
-
 # @description Print a fatal error message including the function name of the callee
 # to standard error
 # @arg $1 string message
@@ -338,13 +329,6 @@ core.print_debug_fn() {
 	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_fatal "$1"
-	exit 1
-}
-
 # @description Print a fatal error message to standard error
 # @arg $1 string message
 core.print_fatal() {
@@ -446,4 +430,20 @@ core.init() {
 core.stacktrace_print() {
 	core.print_warn "The function 'core.stacktrace_print' is deprecated in favor of 'core.print_stacktrace'"
 	core.print_stacktrace "$@"
+}
+
+# @description (DEPRECATED) Print a error message to standard error including the function name
+# of the callee to standard error and die
+# @arg $1 string message
+core.print_die_fn() {
+	local msg="$1"
+
+	core.print_die "${FUNCNAME[1]}()${msg:+": "}$msg"
+}
+
+# @description (DEPRECATED) Print a error message to standard error and die
+# @arg $1 string message
+core.print_die() {
+	core.print_fatal "$1"
+	exit 1
 }