feat: Automatically call 'core.init' if it has not been called

Author: hyperupcall

.hooks/pre-commit

@@ -4,3 +4,5 @@ source "${0%/*}/.hookah/lib.sh"
 hookah.init
 
 hookah.run ./bake test
+hookah.run ./bake docs
+git add './docs/api.md'

README.md

@@ -8,7 +8,7 @@ The following are functions available for use. See [api.md](./docs/api.md) for m
 
 ### `init`
 
-- `core.init`
+- `core.util.init`
 
 Initialize global variables used by other functions
 

docs/api.md

@@ -19,6 +19,7 @@ Core functions for any Bash program
 ### core.init()
 
 Initiates global variables used by other functions
+@deprecated
 
 _Function has no arguments._
 
@@ -110,7 +111,7 @@ Sets an error.
 ### core.err_clear()
 
 Clears any of the global error state (sets to empty string).
-This means any `core.err_exists` calls after this _will_ return `true`
+This means any `core.err_exists` calls after this _will_ `return 1`
 
 _Function has no arguments._
 

pkg/src/public/bash-core.sh

@@ -4,15 +4,10 @@
 # @description Core functions for any Bash program
 
 # @description Initiates global variables used by other functions
+# @deprecated
 # @noargs
 core.init() {
-	if [ ${___global_bash_core_has_init__+x} ]; then
-		return
-	fi
-
-	___global_bash_core_has_init__=
-	declare -Ag ___global_trap_table___=()
-	declare -ag ___global_shopt_stack___=()
+	core.util.init
 }
 
 # @description Adds a handler for a particular `trap` signal or event. Noticably,
@@ -25,6 +20,9 @@ core.init() {
 #   kill -USR1 $$
 #   core.trap_remove 'some_handler' 'USR1'
 core.trap_add() {
+	if ! [ ${___global_bash_core_has_init__+x} ]; then
+		core.util.init
+	fi
 	local function="$1"
 
 	# validation
@@ -82,6 +80,9 @@ core.trap_add() {
 #   kill -USR1 $$
 #   core.trap_remove 'some_handler' 'USR1'
 core.trap_remove() {
+	if ! [ ${___global_bash_core_has_init__+x} ]; then
+		core.util.init
+	fi
 	local function="$1"
 
 	# validation
@@ -146,6 +147,9 @@ core.trap_remove() {
 #   [[ 'variable' == @(foxtrot|golf|echo|variable) ]] && printf '%s\n' 'Woof!'
 #   core.shopt_pop
 core.shopt_push() {
+	if ! [ ${___global_bash_core_has_init__+x} ]; then
+		core.util.init
+	fi
 	local shopt_action="$1"
 	local shopt_name="$2"
 
@@ -195,6 +199,10 @@ core.shopt_push() {
 #   [[ 'variable' == @(foxtrot|golf|echo|variable) ]] && printf '%s\n' 'Woof!'
 #   core.shopt_pop
 core.shopt_pop() {
+	if ! [ ${___global_bash_core_has_init__+x} ]; then
+		core.util.init
+	fi
+
 	if (( ${#___global_shopt_stack___[@]} == 0 )); then
 		printf '%s\n' "Error: core.shopt_pop: Unable to pop as nothing is in the shopt stack"
 		return 1
@@ -330,6 +338,7 @@ core.should_color_output() {
 # @set REPLY The full path to the directory
 # @internal
 core.get_package_dir() {
+	
 	# local start_dir="${1:-"${BASH_SOURCE[1]}"}"
 
 	# while [ ! -f 'basalt.toml' ] && [ "$PWD" != / ]; do

pkg/src/util/util.sh

@@ -1,5 +1,15 @@
 # shellcheck shell=bash
 
+core.util.init() {
+	if [ ${___global_bash_core_has_init__+x} ]; then
+		return
+	fi
+
+	___global_bash_core_has_init__=
+	declare -gA ___global_trap_table___=()
+	declare -ga ___global_shopt_stack___=()
+}
+
 core.util.trap_handler_common() {
 	local signal_spec="$1"
 

tests/trap.bats

@@ -46,7 +46,6 @@ load './util/init.sh'
 
 @test "core.trap_add adds trap function properly" {
 	somefunction() { :; }
-	core.init
 	core.trap_add 'somefunction' 'USR1'
 
 	[ "${___global_trap_table___[nokey]}" != $'\x1Csomefunction' ]
@@ -56,7 +55,6 @@ load './util/init.sh'
 @test "core.trap_add adds function properly 2" {
 	somefunction() { :; }
 	somefunction2() { :; }
-	core.init
 	core.trap_add 'somefunction' 'USR1'
 	core.trap_add 'somefunction2' 'USR1'
 
@@ -66,7 +64,6 @@ load './util/init.sh'
 
 @test "core.trap_add adds function properly 3" {
 	somefunction() { :; }
-	core.init
 	core.trap_add 'somefunction' 'USR1' 'USR2'
 
 	[ "${___global_trap_table___[nokey]}" != $'\x1Csomefunction' ]
@@ -104,7 +101,6 @@ load './util/init.sh'
 
 @test "core.trap_remove removes trap function properly" {
 	somefunction() { :; }
-	core.init
 	core.trap_add 'somefunction' 'USR1'
 	core.trap_remove 'somefunction' 'USR1'
 
@@ -114,7 +110,6 @@ load './util/init.sh'
 @test "core.trap_remove removes trap function properly 2" {
 	somefunction() { :; }
 	somefunction2() { :; }
-	core.init
 	core.trap_add 'somefunction' 'USR1'
 	core.trap_add 'somefunction2' 'USR1'
 	core.trap_remove 'somefunction' 'USR1'
@@ -125,7 +120,6 @@ load './util/init.sh'
 
 @test "core.trap_add removes function properly 3" {
 	somefunction() { :; }
-	core.init
 	core.trap_add 'somefunction' 'USR1'
 	core.trap_add 'somefunction' 'USR2'
 	core.trap_remove 'somefunction' 'USR1' 'USR2'
@@ -137,7 +131,6 @@ load './util/init.sh'
 @test "core.trap_remove removes trap function properly 4" {
 	somefunction() { :; }
 	somefunction2() { :; }
-	core.init
 	core.trap_add 'somefunction' 'USR1'
 	core.trap_add 'somefunction2' 'USR1'
 	core.trap_remove 'somefunction2' 'USR1'