feat: Support linking more man directories. Closes #26

This extra directory search occurs automatically when specifying a
directory to serach along with the automatic man page detection

Author: hyperupcall

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

@@ -22,8 +22,11 @@ do-plumbing-link-man() {
 					if [ -f "$file" ]; then
 						symlink_manfile "$file"
 					elif [ -d "$file" ]; then
-						:
-						# TODO: Implement 2
+						for actualFile in "$file"/*; do
+							if [ -f "$actualFile" ]; then
+								symlink_manfile "$actualFile"
+							fi
+						done
 					fi
 				done
 			done
@@ -39,7 +42,15 @@ do-plumbing-link-man() {
 # the user does not supply any man files/dirs with any config
 fallback_symlink_mans() {
 	for file in "$BPM_PACKAGES_PATH/$package"/{,man/}*; do
-		symlink_manfile "$file"
+		if [ -f "$file" ]; then
+			symlink_manfile "$file"
+		elif [ -d "$file" ]; then
+			for actualFile in "$file"/*; do
+				if [ -f "$actualFile" ]; then
+					symlink_manfile "$actualFile"
+				fi
+			done
+		fi
 	done
 }
 

tests/do-plumbing-link-man.bats

@@ -17,6 +17,47 @@ load 'util/init.sh'
 	assert [ "$(readlink "$BPM_INSTALL_MAN/man2/exec.2")" = "$BPM_PACKAGES_PATH/username/package/man/exec.2" ]
 }
 
+@test "manual man dir links subdirs" {
+	local package="username/package"
+
+	test_util.setup_pkg "$package"; {
+		echo 'manDirs = [ "a_dir" ]' > 'bpm.toml'
+		# Leave a '_' suffix to directory to be extra flexible
+		mkdir -p 'a_dir/man1_'
+		touch 'a_dir/man1_/exec.1'
+
+		mkdir -p 'a_dir/man5_'
+		touch 'a_dir/man5_/execcfg.5'
+	}; test_util.finish_pkg
+	test_util.fake_clone "$package"
+
+	run do-plumbing-link-man "$package"
+
+	assert_success
+	assert [ "$(readlink "$BPM_INSTALL_MAN/man1/exec.1")" = "$BPM_PACKAGES_PATH/$package/a_dir/man1_/exec.1" ]
+	assert [ "$(readlink "$BPM_INSTALL_MAN/man5/execcfg.5")" = "$BPM_PACKAGES_PATH/$package/a_dir/man5_/execcfg.5" ]
+}
+
+@test "heuristic search links subdirs" {
+	local package="username/package"
+
+	test_util.setup_pkg "$package"; {
+		# Leave a '_' suffix to directory to be extra flexible
+		mkdir -p 'man/man1_'
+		touch 'man/man1_/exec.1'
+
+		mkdir -p 'man5_'
+		touch 'man5_/execcfg.5'
+	}; test_util.finish_pkg
+	test_util.fake_clone "$package"
+
+	run do-plumbing-link-man "$package"
+
+	assert_success
+	assert [ "$(readlink "$BPM_INSTALL_MAN/man1/exec.1")" = "$BPM_PACKAGES_PATH/$package/man/man1_/exec.1" ]
+	assert [ "$(readlink "$BPM_INSTALL_MAN/man5/execcfg.5")" = "$BPM_PACKAGES_PATH/$package/man5_/execcfg.5" ]
+}
+
 @test "links mans from bpm.toml to prefix/man" {
 	local package='username/package'
 

tests/util/test_util.sh

@@ -40,7 +40,14 @@ test_util.readlink() {
 test_util.setup_pkg() {
 	local package="$1"
 
-	create_package "$package"
+	mkdir -p "$BPM_ORIGIN_DIR/$package"
+	cd "$BPM_ORIGIN_DIR/$package"
+
+	git init .
+	touch 'README.md'
+	git add .
+	git commit -m "Initial commit"
+
 	cd "$BPM_ORIGIN_DIR/$package"
 }