feat: Support binRemoveExtension key in 'bpm.toml'. Closes #32

This has the same behavior as the one in `package.sh`. Right now,
the value is a string type, but later when the toml parser matures,
it should, of course, be a boolean

Author: hyperupcall

docs/reference.md

@@ -16,12 +16,20 @@ Set the installation and package checkout prefix (default is `$BPM_ROOT/cellar`)
 
 ## `bpm.toml`
 
-Use `bpm.toml` for more fine grained control of where `bpm` searches for binaries, completions, and man pages
+Use `bpm.toml` for more fine grained control of where `bpm` searches for binaries, completions, and man pages. _Note_ that arrays _must only_ span a single line (the line it was defined on) due to limitations with the toml parser. This should be lifted in the future
 
 ### `dependencies`
 
 ### `binDirs`
 
+### `binRemoveExtensions`
+
+TODO: make boolean option
+
+Set to the string `yes` to remove extensions when linking bins
+
+For example if a file in a repository was at `./bin/git-list-all-aliases.sh`, it would be linked and you would call it as `git-list-all-aliases`
+
 ### `completionDirs`
 
 ### `manDirs`

pkg/lib/commands/do-plumbing-link-bins.sh

@@ -7,73 +7,80 @@ do-plumbing-link-bins() {
 
 	log.info "Linking bin files for '$package'"
 
-	# We want this to be visible to the other functions
-	declare -g remove_extension=
+	local remove_extensions=
 	local -a bins=()
 
 	local bpm_toml_file="$BPM_PACKAGES_PATH/$package/bpm.toml"
 	local package_sh_file="$BPM_PACKAGES_PATH/$package/package.sh"
 
 	if [ -f "$bpm_toml_file" ]; then
+		if util.get_toml_string "$bpm_toml_file" 'binRemoveExtensions'; then
+			if [ "$REPLY" = 'yes' ]; then
+				remove_extensions='yes'
+			fi
+		fi
+
 		if util.get_toml_array "$bpm_toml_file" 'binDirs'; then
 			for dir in "${REPLIES[@]}"; do
 				for file in "$BPM_PACKAGES_PATH/$package/$dir"/*; do
-					symlink_binfile "$file"
+					symlink_binfile "$file" "$remove_extensions"
 				done
 			done
-		else
-			fallback_symlink_bins "$package"
+
+			return
 		fi
+
+		fallback_symlink_bins "$package" "$remove_extensions"
 	elif [ -f "$package_sh_file" ]; then
 		if util.extract_shell_variable "$package_sh_file" 'REMOVE_EXTENSION'; then
-			remove_extension="$REPLY"
+			remove_extensions="$REPLY"
 		fi
 
 		if util.extract_shell_variable "$package_sh_file" 'BINS'; then
 			IFS=':' read -ra bins <<< "$REPLY"
 
 			for file in "${bins[@]}"; do
-				symlink_binfile "$BPM_PACKAGES_PATH/$package/$file"
+				symlink_binfile "$BPM_PACKAGES_PATH/$package/$file" "$remove_extensions"
 			done
 		else
-			fallback_symlink_bins "$package"
+			fallback_symlink_bins "$package" "$remove_extensions"
 		fi
 	else
-		fallback_symlink_bins "$package"
+		fallback_symlink_bins "$package" "$remove_extensions"
 	fi
 }
 
 # @description Use heuristics to locate and symlink the bin files. This is ran when
 # the user does not supply any bin files/dirs with any config
 # @arg $1 package
+# @arg $2 Whether to remove extensions
 fallback_symlink_bins() {
-	declare -ga REPLIES=()
-
 	local package="$1"
-
-	local bins=()
+	local remove_extensions="$2"
 
 	if [ -d "$BPM_PACKAGES_PATH/$package/bin" ]; then
 		for file in "$BPM_PACKAGES_PATH/$package"/bin/*; do
-			symlink_binfile "$file"
+			symlink_binfile "$file" "$remove_extensions"
 		done
 	else
 		for file in "$BPM_PACKAGES_PATH/$package"/*; do
 			if [ -x "$file" ]; then
-				symlink_binfile "$file"
+				symlink_binfile "$file" "$remove_extensions"
 			fi
 		done
 	fi
 }
 
-# @description Actually symlink the bin file to the correct location
+# @description Symlink the bin file to the correct location
 # @arg $1 The full path of the executable
+# @arg $2 Whether to remove extensions
 symlink_binfile() {
 	local fullBinFile="$1"
+	local remove_extensions="$2"
 
 	local binName="${fullBinFile##*/}"
 
-	if [[ "${remove_extension:-no}" == @(yes|true) ]]; then
+	if [[ "${remove_extensions:-no}" == @(yes|true) ]]; then
 		binName="${binName%%.*}"
 	fi
 

tests/do-plumbing-link-bins.bats

@@ -131,6 +131,25 @@ load 'util/init.sh'
 	assert [ "$(readlink $BPM_INSTALL_BIN/exec2)" = "$BPM_PACKAGES_PATH/username/package/bin/exec2.sh" ]
 }
 
+@test "remove extension if binRemoveExtensions is true in bpm.toml" {
+	local package="username/package"
+
+	test_util.setup_pkg "$package"; {
+		echo 'binRemoveExtensions = "yes"' > 'bpm.toml'
+		mkdir bin
+		touch 'bin/exec1'
+		touch 'bin/exec2.sh'
+	}; test_util.finish_pkg
+	test_util.fake_clone "$package"
+
+	run do-plumbing-link-bins username/package
+
+	assert_success
+	assert [ "$(readlink $BPM_INSTALL_BIN/exec1)" = "$BPM_PACKAGES_PATH/username/package/bin/exec1" ]
+	assert [ "$(readlink $BPM_INSTALL_BIN/exec2)" = "$BPM_PACKAGES_PATH/username/package/bin/exec2.sh" ]
+}
+
+
 @test "does not remove extension if REMOVE_EXTENSION is false" {
 	local package="username/package"
 

tests/util/test_util.sh

@@ -1,10 +1,10 @@
 # shellcheck shell=bash
+# shellcheck disable=SC2164
 
 # @description This mocks a command by creating a function for it, which
 # prints all the arguments to the command, in addition to the command name
 test_util.mock_command() {
-	# This creates a function with the first argument (the function to
-	# mock). When called, it prints the command name, along with the arguments
+	# This creates a function with a name of the first argument. When called, it prints the command name, along with the arguments
 	# it was called with
 	eval "$1() { echo \"$1 \$*\"; }"
 }
@@ -35,3 +35,19 @@ test_util.readlink() {
 		readlink -f "$1"
 	fi
 }
+
+# @description Creates a 'bpm package', and cd's into it
+test_util.setup_pkg() {
+	local package="$1"
+
+	create_package "$package"
+	cd "$BPM_ORIGIN_DIR/$package"
+}
+
+# @description Commits changes and cd's out of the package directory
+# into the regular testing directory
+test_util.finish_pkg() {
+	git add .
+	git commit -m "commit"
+	cd "$BPM_CWD"
+}