feat: Add core.print_ functions

Author: hyperupcall

docs/api.md

@@ -15,6 +15,9 @@ Core functions for any Bash program
 * [core.err_clear()](#coreerr_clear)
 * [core.err_exists()](#coreerr_exists)
 * [core.stacktrace_print()](#corestacktrace_print)
+* [core.print_error()](#coreprint_error)
+* [core.print_warn()](#coreprint_warn)
+* [core.print_info()](#coreprint_info)
 * [core.should_output_color()](#coreshould_output_color)
 * [core.get_package_info()](#coreget_package_info)
 
@@ -145,6 +148,30 @@ core.trap_add 'err_handler' ERR
 
 _Function has no arguments._
 
+### core.print_error()
+
+Print an error message to standard error
+
+#### Arguments
+
+* **$1** (string): message
+
+### core.print_warn()
+
+Print a warning message to standard error
+
+#### Arguments
+
+* **$1** (string): message
+
+### core.print_info()
+
+Print an informative message to standard output
+
+#### Arguments
+
+* **$1** (string): message
+
 ### core.should_output_color()
 
 Determine if color should be printed. Note that this doesn't

pkg/src/public/bash-core.sh

@@ -309,6 +309,30 @@ core.stacktrace_print() {
 	fi
 } >&2
 
+# @description Print an error message to standard error
+# @arg $1 string message
+core.print_error() {
+	local msg="$1"
+
+	printf '%s\n' "Error: ${FUNCNAME[1]}${msg:+": "}$msg" >&2
+}
+
+# @description Print a warning message to standard error
+# @arg $1 string message
+core.print_warn() {
+	local msg="$1"
+
+	printf '%s\n' "Warn: ${FUNCNAME[1]}${msg:+": "}$msg" >&2
+}
+
+# @description Print an informative message to standard output
+# @arg $1 string message
+core.print_info() {
+	local msg="$1"
+
+	printf '%s\n' "Info: ${FUNCNAME[1]}${msg:+": "}$msg"
+}
+
 # @description Determine if color should be printed. Note that this doesn't
 # use tput because simple environment variable checking heuristics suffice
 core.should_output_color() {
@@ -353,7 +377,7 @@ core.get_package_info() {
 	local toml_file="$basalt_package_dir/basalt.toml"
 
 	if [ ! -f "$toml_file" ]; then
-		printf '%s\n' "Error: core.get_package_data: File '$toml_file' could not be found"
+		printf '%s\n' "Error: core.get_package_info: File '$toml_file' could not be found"
 	fi
 
 	local regex="^[ \t]*${key_name}[ \t]*=[ \t]*['\"](.*)['\"]"

tests/print.bats

@@ -0,0 +1,40 @@
+#!/usr/bin/env bats
+
+load './util/init.sh'
+
+# The following functions are defined so the names of the function
+# at the callsite can be tested. Otherwise, the function names are
+# automatically generated by Bats (and are more difficult to test)
+errorfn() { "$@"; }
+warnfn() { "$@"; }
+infofn() { "$@"; }
+
+@test "core.print_error works" {
+	run errorfn core.print_error
+	assert_success
+	assert_output 'Error: errorfn'
+
+	run errorfn core.print_error 'Something'
+	assert_success
+	assert_output 'Error: errorfn: Something'
+}
+
+@test "core.print_warn works" {
+	run warnfn core.print_warn
+	assert_success
+	assert_output 'Warn: warnfn'
+
+	run warnfn core.print_warn 'Something'
+	assert_success
+	assert_output 'Warn: warnfn: Something'
+}
+
+@test "core.print_info works" {
+	run infofn core.print_info
+	assert_success
+	assert_output 'Info: infofn'
+
+	run infofn core.print_info 'Something'
+	assert_success
+	assert_output 'Info: infofn: Something'
+}