refactor: Fix and unify utility printing functions

hyperupcall · hyperupcall · commit 739d064eb742 · 2021-10-09T14:21:59.000-07:00
diff --git a/pkg/lib/cmd/basalt.sh b/pkg/lib/cmd/basalt.sh
@@ -24,7 +24,7 @@ basalt.main() {
 		exit
 		;;
 	-*)
-		print.die "Top level flag '$arg' is not recognized"
+		bprint.die "Top level flag '$arg' is not recognized"
 		;;
 	*)
 		break
@@ -48,7 +48,7 @@ basalt.main() {
 				list) shift; do-global-list "$@" ;;
 				*)
 					if [ -n "$1" ]; then
-						print.die "Global subcommand '$1' is not a valid"
+						bprint.die "Global subcommand '$1' is not a valid"
 					else
 						util.show_help
 					fi
@@ -57,7 +57,7 @@ basalt.main() {
 			;;
 		*)
 			if [ -n "$1" ]; then
-				print.die "Subcommand '$1' is not valid"
+				bprint.die "Subcommand '$1' is not valid"
 			else
 				util.show_help
 			fi
diff --git a/pkg/lib/commands/do-add.sh b/pkg/lib/commands/do-add.sh
@@ -6,15 +6,15 @@ do-add() {
 	local -a pkgs=()
 	for arg; do case "$arg" in
 	-*)
-		print.die "Flag '$arg' not recognized"
+		bprint.die "Flag '$arg' not recognized"
 		;;
 	*)
 		pkgs+=("$arg")
 		;;
 	esac done
 
 	if ((${#pkgs[@]} == 0)); then
-		print.indent-yellow 'Warning' "No packages were specified"
+		bprint.warn "No packages were specified"
 	fi
 
 	# Package parsing (WET)
@@ -23,7 +23,7 @@ do-add() {
 		local repo_type="$REPLY1" url="$REPLY2" site="$REPLY3" package="$REPLY4" version="$REPLY5"
 
 		if ! util.does_package_exist "$repo_type" "$url"; then
-			print.die "Package located at '$url' does not exist"
+			bprint.die "Package located at '$url' does not exist"
 		fi
 
 		if [ -z "$version" ]; then
diff --git a/pkg/lib/commands/do-global-add.sh b/pkg/lib/commands/do-global-add.sh
@@ -6,23 +6,23 @@ do-global-add() {
 	local -a pkgs=()
 	for arg; do case "$arg" in
 	-*)
-		print.die "Flag '$arg' not recognized"
+		bprint.die "Flag '$arg' not recognized"
 		;;
 	*)
 		pkgs+=("$arg")
 		;;
 	esac done
 
 	if ((${#pkgs[@]} == 0)); then
-		newindent.die "Must specify at least one package"
+		bprint.die "Must specify at least one package"
 	fi
 
 	for pkg in "${pkgs[@]}"; do
 		util.get_package_info "$pkg"
 		local repo_type="$REPLY1" url="$REPLY2" site="$REPLY3" package="$REPLY4" version="$REPLY5"
 
 		if ! util.does_package_exist "$repo_type" "$url"; then
-			print.die "Package located at '$url' does not exist"
+			bprint.die "Package located at '$url' does not exist"
 		fi
 
 		if [ -z "$version" ]; then
diff --git a/pkg/lib/commands/do-global-init.sh b/pkg/lib/commands/do-global-init.sh
@@ -37,7 +37,7 @@ do-global-init() {
 	local shell="$1"
 
 	if [ -z "$shell" ]; then
-		print.die "Shell not specified"
+		bprint.die "Shell not specified"
 	fi
 
 	# Set common basalt variables; add PATH
diff --git a/pkg/lib/commands/do-global-install.sh b/pkg/lib/commands/do-global-install.sh
@@ -4,11 +4,11 @@ do-global-install() {
 	util.init_global
 
 	if (($# != 0)); then
-		newindent.die "No arguments or flags must be specified"
+		bprint.die "No arguments or flags must be specified"
 	fi
 
 	if ! rm -rf "$BASALT_GLOBAL_DATA_DIR/global/.basalt"; then
-		print.indent-die "Could not remove global '.basalt' directory"
+		bprint.die "Could not remove global '.basalt' directory"
 	fi
 
 	local -a dependencies=()
diff --git a/pkg/lib/commands/do-global-list.sh b/pkg/lib/commands/do-global-list.sh
@@ -4,7 +4,7 @@ do-global-list() {
 	util.init_global
 
 	if (($# != 0)); then
-		newindent.die "No arguments or flags must be specified"
+		bprint.die "No arguments or flags must be specified"
 	fi
 
 	printf '%s\n' "$(<"$BASALT_GLOBAL_DATA_DIR/global/dependencies")"
diff --git a/pkg/lib/commands/do-global-remove.sh b/pkg/lib/commands/do-global-remove.sh
@@ -10,23 +10,23 @@ do-global-remove() {
 		flag_force='yes'
 		;;
 	-*)
-		print.die "Flag '$arg' not recognized"
+		bprint.die "Flag '$arg' not recognized"
 		;;
 	*)
 		pkgs+=("$arg")
 		;;
 	esac done
 
 	if ((${#pkgs[@]} == 0)); then
-		newindent.die "Must specify at least one package"
+		bprint.die "Must specify at least one package"
 	fi
 
 	for pkg in "${pkgs[@]}"; do
 		util.get_package_info "$pkg"
 		local url="$REPLY2" version="$REPLY5"
 
 		if [ -n "$version" ]; then
-			newindent.die "Must not specify ref when removing packages"
+			bprint.die "Must not specify ref when removing packages"
 		fi
 
 		util.text_remove_dependency "$BASALT_GLOBAL_DATA_DIR/global/dependencies" "$url" "$flag_force"
diff --git a/pkg/lib/commands/do-init.sh b/pkg/lib/commands/do-init.sh
@@ -2,7 +2,7 @@
 
 do-init() {
 	if [ -e basalt.toml ]; then
-		print.die "File 'basalt.toml' already exists"
+		bprint.die "File 'basalt.toml' already exists"
 	fi
 
 	cat >| basalt.toml <<-"EOF"
@@ -28,5 +28,5 @@ do-init() {
 	[run.shoptOptions]
 	EOF
 
-	print.info "Created basalt.toml"
+	bprint.info "Created basalt.toml"
 }
diff --git a/pkg/lib/commands/do-install.sh b/pkg/lib/commands/do-install.sh
@@ -4,11 +4,11 @@ do-install() {
 	util.init_local
 
 	if (($# != 0)); then
-		newindent.die "No arguments or flags must be specified"
+		bprint.die "No arguments or flags must be specified"
 	fi
 
 	if ! rm -rf "$BASALT_LOCAL_PROJECT_DIR/.basalt"; then
-		print.die "Could not remove local '.basalt' directory"
+		bprint.die "Could not remove local '.basalt' directory"
 	fi
 
 	# 'basalt.toml' is guaranteed to exist due to 'util.init_local'
diff --git a/pkg/lib/commands/do-remove.sh b/pkg/lib/commands/do-remove.sh
@@ -6,15 +6,15 @@ do-remove() {
 	local -a pkgs=()
 	for arg; do case "$arg" in
 	-*)
-		print.die "Flag '$arg' not recognized"
+		bprint.die "Flag '$arg' not recognized"
 		;;
 	*)
 		pkgs+=("$arg")
 		;;
 	esac done
 
 	if ((${#pkgs[@]} == 0)); then
-		print.indent-yellow 'Warning' "No packages were specified"
+		bprint.warn "No packages were specified"
 	fi
 
 	for pkg in "${pkgs[@]}"; do
diff --git a/pkg/lib/commands/do-run.sh b/pkg/lib/commands/do-run.sh
@@ -6,24 +6,24 @@ do-run() {
 	local -a args=()
 	for arg; do case "$arg" in
 	-*)
-		print.die "Flag '$arg' not recognized"
+		bprint.die "Flag '$arg' not recognized"
 		;;
 	*)
 		args+=("$arg")
 		;;
 	esac done
 
 	if ((${#args[@]} > 1)); then
-		newindent.die "The only argument must be the executable name"
+		bprint.die "The only argument must be the executable name"
 	fi
 
 	local bin_name="${args[0]}"
 	local bin_file="$BASALT_LOCAL_PROJECT_DIR/.basalt/bin/$bin_name"
 	if [ -x "$bin_file" ]; then
 		exec "$bin_file"
 	elif [ -f "$bin_file" ]; then
-		newindent.die "File '$bin_name' is found, but the package providing it has not made it executable"
+		bprint.die "File '$bin_name' is found, but the package providing it has not made it executable"
 	else
-		newindent.die "No executable called '$bin_name' was found"
+		bprint.die "No executable called '$bin_name' was found"
 	fi
 }
diff --git a/pkg/lib/util/ensure.sh b/pkg/lib/util/ensure.sh
@@ -9,7 +9,7 @@ ensure.cd() {
 	ensure.nonzero 'dir'
 
 	if ! cd "$dir"; then
-		print.internal_die "Could not cd to directory '$dir'"
+		bprint.fatal "Could not cd to directory '$dir'"
 	fi
 }
 
@@ -19,20 +19,20 @@ ensure.not_absolute_path() {
 	ensure.nonzero 'path'
 
 	if [ "${path::1}" = / ]; then
-		print.die "Path '$path' is not absolute"
+		bprint.die "Path '$path' is not absolute"
 	fi
 }
 # @description Ensure that a variable name is non-zero
 ensure.nonzero() {
 	local name="$1"
 
 	if [ -z "$name" ]; then
-		print.internal_die "Argument 'name' for function 'ensure.nonzero' is empty"
+		bprint.fatal "Argument 'name' for function 'ensure.nonzero' is empty"
 	fi
 
 	local -n value="$name"
 	if [ -z "$value" ]; then
-		print.internal_die "Argument '$name' for function '${FUNCNAME[1]} ${FUNCNAME[2]} ${FUNCNAME[3]}' is empty"
+		bprint.fatal "Argument '$name' for function '${FUNCNAME[1]} ${FUNCNAME[2]} ${FUNCNAME[3]}' is empty"
 	fi
 }
 
@@ -42,6 +42,6 @@ ensure.dir() {
 	ensure.nonzero 'dir'
 
 	if [ ! -d "$dir" ]; then
-		print.internal_die "A directory at '$dir' was expected to exist"
+		bprint.fatal "A directory at '$dir' was expected to exist"
 	fi
 }
diff --git a/pkg/lib/util/pkg.sh b/pkg/lib/util/pkg.sh
@@ -61,7 +61,7 @@ pkg.phase_download_tarball() {
 
 	# Use cache if it already exists
 	if [ -e "$download_dest" ]; then
-		print.indent-green "Downloaded" "$package_id (cached)"
+		bprint.green "Downloaded" "$package_id (cached)"
 		return
 	fi
 
@@ -73,10 +73,10 @@ pkg.phase_download_tarball() {
 		if curl -fLso "$download_dest" "$download_url"; then
 			if ! util.file_is_targz "$download_dest"; then
 				rm -rf "$download_dest"
-				print.indent-die "File '$download_dest' is not actually a tarball"
+				bprint.die "File '$download_dest' is not actually a tarball"
 			fi
 
-			print.indent-green "Downloaded" "$package_id"
+			bprint.green "Downloaded" "$package_id"
 			return
 		fi
 
@@ -87,26 +87,26 @@ pkg.phase_download_tarball() {
 	# TODO Print warning if a local dependency has a dirty index
 	if [ "$repo_type" = 'local' ]; then
 		:
-		# print.indent-yellow 'Warning' "Local dependency at '$url' has a dirty index"
+		# bprint.warn "Local dependency at '$url' has a dirty index"
 	fi
 
 	rm -rf "$BASALT_GLOBAL_DATA_DIR/scratch"
 	if ! git clone --quiet "$url" "$BASALT_GLOBAL_DATA_DIR/scratch/$package_id"; then
-		print.indent-die "Could not clone repository for $package_id"
+		bprint.die "Could not clone repository for $package_id"
 	fi
 
 	if ! git -C "$BASALT_GLOBAL_DATA_DIR/scratch/$package_id" archive --prefix="prefix/" -o "$download_dest" "$version" 2>/dev/null; then
 		rm -rf "$BASALT_GLOBAL_DATA_DIR/scratch" "$download_dest"
-		print.indent-die "Could not download archive or extract archive from temporary Git repository of $package_id"
+		bprint.die "Could not download archive or extract archive from temporary Git repository of $package_id"
 	fi
 	rm -rf "$BASALT_GLOBAL_DATA_DIR/scratch"
 
 	if ! util.file_is_targz "$download_dest"; then
 		rm -rf "$download_dest"
-		print.indent-die "File '$download_dest' is not actually a tarball"
+		bprint.die "File '$download_dest' is not actually a tarball"
 	fi
 
-	print.indent-green "Downloaded" "$package_id"
+	bprint.green "Downloaded" "$package_id"
 }
 
 # @description Extracts the tarballs in the global store to a directory
@@ -119,21 +119,21 @@ pkg.phase_extract_tarball() {
 
 	# Use cache if it already exists
 	if [ -d "$tarball_dest" ]; then
-		print.indent-green "Extracted" "$package_id (cached)"
+		bprint.green "Extracted" "$package_id (cached)"
 		return
 	fi
 
 	# Actually extract
 	mkdir -p "$tarball_dest"
 	if ! tar xf "$tarball_src" -C "$tarball_dest" --strip-components 1 2>/dev/null; then
-		print.indent-die "Error" "Could not extract package $package_id"
+		bprint.die "Error" "Could not extract package $package_id"
 	else
-		print.indent-green "Extracted" "$package_id"
+		bprint.green "Extracted" "$package_id"
 	fi
 
 	# Ensure extraction actually worked
 	if [ ! -d "$tarball_dest" ]; then
-		print.indent-die "Extracted tarball is not a directory at '$tarball_dest'"
+		bprint.die "Extracted tarball is not a directory at '$tarball_dest'"
 	fi
 }
 
@@ -154,7 +154,7 @@ pkg.phase_global_integration() {
 		fi
 	fi
 
-	print.indent-green "Transformed" "$package_id"
+	bprint.green "Transformed" "$package_id"
 }
 
 # Create a './.basalt' directory for a particular project directory
diff --git a/pkg/lib/util/print.sh b/pkg/lib/util/print.sh
diff --git a/pkg/lib/util/symlink.sh b/pkg/lib/util/symlink.sh
diff --git a/pkg/lib/util/util-temporary.sh b/pkg/lib/util/util-temporary.sh
diff --git a/pkg/lib/util/util.sh b/pkg/lib/util/util.sh
diff --git a/tests/util-get-package-id.bats b/tests/util-get-package-id.bats
