improve help

Author: kurowski

Dockerfile

@@ -4,6 +4,11 @@ FROM mcr.microsoft.com/devcontainers/php:8.3
 RUN sed -i 's/^UMASK\s*022/UMASK 002/' /etc/login.defs
 RUN usermod -aG www-data vscode
 
+# Add glow for formatting command usage output (and because it's just nice)
+sudo mkdir -p /etc/apt/keyrings
+curl -fsSL https://repo.charm.sh/apt/gpg.key | sudo gpg --dearmor -o /etc/apt/keyrings/charm.gpg
+echo "deb [signed-by=/etc/apt/keyrings/charm.gpg] https://repo.charm.sh/apt/ * *" | sudo tee /etc/apt/sources.list.d/charm.list
+
 # Install MariaDB and Redis and PHP (incl Apache) and Cypress dependencies
 RUN apt-get update && export DEBIAN_FRONTEND=noninteractive \
     && apt-get install -y libpng-dev libzip-dev libicu-dev \
@@ -14,7 +19,7 @@ RUN apt-get update && export DEBIAN_FRONTEND=noninteractive \
     && docker-php-ext-enable redis zip \
     && apt-get install -y mariadb-client redis-tools \
     && apt-get install -y npm libgtk2.0-0 libgtk-3-0 libgbm-dev libnotify-dev libnss3 libxss1 libasound2 libxtst6 xauth xvfb \
-    && apt-get install -y dnsutils pv \
+    && apt-get install -y dnsutils glow pv \
     && apt-get clean -y && rm -rf /var/lib/apt/lists/*
 
 # Configure PHP, make memory_limit and upload_max_filesize match Pantheon

local/etc/uceap.d/help.sh

@@ -0,0 +1,38 @@
+function help() {
+	if [ $# -eq 1 ]; then
+		command="$1"
+		func=("${command//-/_}")
+		if [[ " ${funcs[@]} " =~ " ${func} " ]]; then
+			help="_${func}_help"
+			echo "${!help}" | glow
+		else
+			echo "[error] Unknown command: $func"
+			_help | glow
+		fi
+	else
+		_help | glow
+	fi
+}
+
+function _help() {
+	echo 'Available commands:'
+	echo
+	for func in "${funcs[@]}"; do
+		command=("${func//_/-}")
+		desc="_${func}_desc"
+		echo "- **$command**: ${!desc}"
+		echo
+	done
+	echo
+	echo 'Please run **uceap \<command\>** to execute a command.'
+	echo 'Please run **uceap help \<command\>** to see the help for a command.'
+}
+_help_desc='Displays help for `uceap` commands'
+_help_help='
+# Usage
+
+``` sh
+uceap help
+uceap help <command>
+```
+'

local/etc/uceap.sh

@@ -8,42 +8,12 @@ if [ -d $source_dir/uceap.d ]; then
 	done
 fi
 unset func
-
 funcs=($(typeset -F | cut -d' ' -f3 | grep -vE '^_'))
 
-function uceap_help() {
-	echo "Available commands:"
-	echo
-	for func in "${funcs[@]}"; do
-		command=("${func//_/-}")
-		desc="_${func}_desc"
-		echo "  $command: ${!desc}"
-		echo
-	done
-	echo
-	echo "Please run 'uceap <command>' to execute a command."
-	echo "Please run 'uceap help <command>' to see the help for a command."
-}
-
 function uceap() {
 	if [ $# -eq 0 ]; then
-		uceap_help
+		help
 		return 0
-	fi
-	if [ "$1" == "help" ]; then
-		if [ $# -eq 2 ]; then
-			command="$2"
-			func=("${command//-/_}")
-			if [[ " ${funcs[@]} " =~ " ${func} " ]]; then
-				help="_${func}_help"
-				echo "${!help}"
-			else
-				echo "[error] Unknown command: $func"
-				uceap_help
-			fi
-		else
-			uceap_help
-		fi
 	else
 		command="$1"
 		func=("${command//-/_}")
@@ -52,7 +22,7 @@ function uceap() {
 			eval "$func" "$@"
 		else
 			echo "[error] Unknown command: $func"
-			uceap_help
+			help
 		fi
 	fi
 }