feat: Add --force flag to 'remove'. Closes #62

This ensures that packages can be removed, even if the `bpm.toml` file
cannot be parsed

Author: hyperupcall

README.md

@@ -38,7 +38,7 @@ See [Installation](./docs/installation.md) and [Getting Started](./docs/getting-
 - Local and user-wide package installation
 - Configure (optionally) exactly which directories are used for completions, binaries, or man pages
 - Works with essentially all popular Bash projects out of the box
-- 240+ Tests
+- 250+ Tests
 
 ## Alternatives Comparison
 

completions/_bpm.zsh

@@ -59,7 +59,7 @@ case $state in
 			_describe -t commands "gem subcommand" subcommandOptions
 			;;
 		(remove)
-			local -a subcommandOptions=(--all)
+			local -a subcommandOptions=(--all --force)
 			_describe -t commands "gem subcommand" subcommandOptions
 			;;
 		(upgrade)

completions/bpm.bash

@@ -80,7 +80,7 @@ _bpm() {
 				readarray -t COMPREPLY < <(IFS=' ' compgen -W "${subcommandOptions[*]}" -- "$currentWord")
 				;;
 			remove)
-				subcommandOptions=(--all)
+				subcommandOptions=(--all --force)
 				readarray -t COMPREPLY < <(IFS=' ' compgen -W "${subcommandOptions[*]}" -- "$currentWord")
 				;;
 			upgrade)

completions/bpm.fish

@@ -33,7 +33,7 @@ set -l subcommandOptions
 complete -c $cmd -f -n "__fish_seen_subcommand_from $subcmd" -a "$subcommandOptions (bpm complete package-path)"
 
 set subcmd remove
-set -l subcommandOptions --all
+set -l subcommandOptions --all --force
 complete -c $cmd -f -n "__fish_seen_subcommand_from $subcmd" -a "$subcommandOptions (bpm complete upgrade)"
 
 set subcmd upgrade

pkg/lib/commands/do-remove.sh

@@ -2,6 +2,7 @@
 
 do-remove() {
 	local flag_all='no'
+	local flag_force='no'
 
 	util.setup_mode
 
@@ -11,6 +12,9 @@ do-remove() {
 		--all)
 			flag_all='yes'
 			;;
+		--force)
+			flag_force='yes'
+			;;
 		-*)
 			die "Flag '$arg' not recognized"
 			;;
@@ -20,6 +24,10 @@ do-remove() {
 		esac
 	done
 
+	if [[ $flag_all == yes && $flag_force == yes ]]; then
+		die "Flags '--all' and '--force' are mutually exclusive"
+	fi
+
 	if [ "$flag_all" = yes ]; then
 		local bpm_toml_file="$BPM_ROOT/bpm.toml"
 
@@ -34,7 +42,16 @@ do-remove() {
 				do-remove "$pkg"
 			done
 		else
-			log.warn "No dependencies specified in 'dependencies' key"
+			case "$?" in
+			1)
+				log.warn "No dependencies specified in 'dependencies' key"
+				;;
+			2)
+				if [ "$flag_force" = 'no' ]; then
+					exit 1
+				fi
+				;;
+			esac
 		fi
 
 		return
@@ -44,6 +61,10 @@ do-remove() {
 		die "At least one package must be supplied"
 	fi
 
+	if [ "$flag_force" = yes ] && (( ${#pkgs[@]} > 1 )); then
+		die "Only one package may be specified when --force is passed"
+	fi
+
 	for repoSpec in "${pkgs[@]}"; do
 		util.extract_data_from_input "$repoSpec"
 		local site="$REPLY2"
@@ -55,7 +76,13 @@ do-remove() {
 		fi
 
 		if [ -d "$BPM_PACKAGES_PATH/$site/$package" ]; then
-			do_actual_removal "$site/$package"
+			if [ "$flag_force" = yes ]; then
+				log.info "Force removing '$site/$package'"
+				rm -rf "${BPM_PACKAGES_PATH:?}/$site/$package"
+				do-prune
+			else
+				do_actual_removal "$site/$package"
+			fi
 		elif [ -e "$BPM_PACKAGES_PATH/$site/$package" ]; then
 			rm -f "$BPM_PACKAGES_PATH/$site/$package"
 		else
@@ -83,5 +110,4 @@ do_actual_removal() {
 			:
 		fi
 	fi
-
 }

pkg/lib/util/util.sh

@@ -206,11 +206,13 @@ util.get_toml_array() {
 			if [[ ${REPLIES[$i]} =~ $regex ]]; then
 				REPLIES[$i]="${BASH_REMATCH[1]}"
 			else
-				die "Array for key '$keyName' not valid"
+				log.error "Array for key '$keyName' not valid"
+				return 2
 			fi
 		done
 	else
-		die "Key '$keyName' in file '$tomlFile' must be set to an array that spans one line"
+		log.error "Key '$keyName' in file '$tomlFile' must be set to an array that spans one line"
+		return 2
 	fi
 }
 

tests/do-remove.bats

@@ -196,3 +196,50 @@ load 'util/init.sh'
 	assert_failure
 	assert_line -p "Refs must be omitted when removing packages. Remove ref '@v0.1.0'"
 }
+
+@test "--force works" {
+	local site='github.com'
+	local pkg='username/package'
+
+	test_util.setup_pkg "$pkg"; {
+		# Invalid because 'binDirs' must be an array
+		echo 'binDirs = "somebin"' > 'bpm.toml'
+	}; test_util.finish_pkg
+	test_util.mock_clone "$pkg" "$site/$pkg"
+
+	assert [ -d "$BPM_PACKAGES_PATH/$site/$pkg" ]
+
+	run do-remove --force "$pkg"
+
+	assert_success
+	assert_line -p -n 0 "Force removing '$site/$pkg'"
+	assert_line -p -n 1 "Info: Pruning packages"
+
+	assert [ ! -d "$BPM_PACKAGES_PATH/$site/$pkg" ]
+}
+
+@test "fail if give --all and --force flags" {
+	local site='github.com'
+	local pkg='username/package'
+
+	test_util.create_package "$pkg"
+	test_util.mock_clone "$pkg" "$site/$pkg"
+
+	run do-remove --all --force
+
+	assert_failure
+	assert_line -p "Flags '--all' and '--force' are mutually exclusive"
+}
+
+@test "fail if give --force and more than one package" {
+	local site='github.com'
+	local pkg='username/package'
+
+	test_util.create_package "$pkg"
+	test_util.mock_clone "$pkg" "$site/$pkg"
+
+	run do-remove --force "$pkg" "$pkg"
+
+	assert_failure
+	assert_line -p "Only one package may be specified when --force is passed"
+}