refactor: standardize help generation

plugins/nginx-vhosts/commands

@@ -1,6 +1,6 @@
 #!/usr/bin/env bash
 [[ " help nginx:help " == *" $1 "* ]] || exit "$DOKKU_NOT_IMPLEMENTED_EXIT"
-source "$PLUGIN_AVAILABLE_PATH/nginx-vhosts/internal-functions"
+source "$PLUGIN_AVAILABLE_PATH/nginx-vhosts/help-functions"
 set -eo pipefail
 [[ $DOKKU_TRACE ]] && set -x
 

plugins/nginx-vhosts/help-functions

@@ -0,0 +1,38 @@
+#!/usr/bin/env bash
+set -eo pipefail
+[[ $DOKKU_TRACE ]] && set -x
+
+cmd-nginx-vhosts-help() {
+  declare desc="help command"
+  declare CMD="$1"
+  local plugin_name="nginx"
+  local plugin_description="Manage the nginx proxy"
+
+  if [[ "$CMD" == "$plugin_name:help" ]]; then
+    echo -e "Usage: dokku $plugin_name[:COMMAND]"
+    echo ''
+    echo "$plugin_description"
+    echo ''
+    echo 'Additional commands:'
+    fn-help-content | sort | column -c2 -t -s,
+  elif [[ $(ps -o command= $PPID) == *"--all"* ]]; then
+    fn-help-content
+  else
+    cat <<help_desc
+    $plugin_name, $plugin_description
+help_desc
+  fi
+}
+
+fn-help-content() {
+  declare desc="return help content"
+  cat <<help_content
+    nginx:access-logs <app> [-t], Show the nginx access logs for an application (-t follows)
+    nginx:build-config <app>, (Re)builds nginx config for given app
+    nginx:error-logs <app> [-t], Show the nginx error logs for an application (-t follows)
+    nginx:report [<app>] [<flag>], Displays an nginx report for one or more apps
+    nginx:set <app> <property> (<value>), Set or clear an nginx property for an app
+    nginx:show-conf <app>, Display app nginx config
+    nginx:validate [<app>] [--clean], Validates and optionally cleans up invalid nginx configurations
+help_content
+}

plugins/nginx-vhosts/internal-functions

@@ -204,36 +204,6 @@ nginx_vhosts_conf_clean_func() {
   rm -f "$NGINX_CONF"
 }
 
-nginx_vhosts_help_content_func() {
-  declare desc="return nginx plugin help content"
-  cat <<help_content
-    nginx:access-logs <app> [-t], Show the nginx access logs for an application (-t follows)
-    nginx:build-config <app>, (Re)builds nginx config for given app
-    nginx:error-logs <app> [-t], Show the nginx error logs for an application (-t follows)
-    nginx:report [<app>] [<flag>], Displays an nginx report for one or more apps
-    nginx:set <app> <property> (<value>), Set or clear an nginx property for an app
-    nginx:show-conf <app>, Display app nginx config
-    nginx:validate [<app>] [--clean], Validates and optionally cleans up invalid nginx configurations
-help_content
-}
-
-cmd-nginx-vhosts-help() {
-  if [[ $1 == "nginx:help" ]]; then
-    echo -e 'Usage: dokku nginx[:COMMAND]'
-    echo ''
-    echo 'Interact with Dokku'"'"'s Nginx proxy.'
-    echo ''
-    echo 'Additional commands:'
-    nginx_vhosts_help_content_func | sort | column -c2 -t -s,
-  elif [[ $(ps -o command= $PPID) == *"--all"* ]]; then
-    nginx_vhosts_help_content_func
-  else
-    cat <<help_desc
-    nginx, Interact with Dokku's Nginx proxy
-help_desc
-  fi
-}
-
 nginx_clear_config() {
   declare desc="Remove the nginx conf file"
   declare APP="$1"

plugins/nginx-vhosts/subcommands/default

@@ -1,6 +1,6 @@
 #!/usr/bin/env bash
 set -eo pipefail
 [[ $DOKKU_TRACE ]] && set -x
-source "$PLUGIN_AVAILABLE_PATH/nginx-vhosts/internal-functions"
+source "$PLUGIN_AVAILABLE_PATH/nginx-vhosts/help-functions"
 
 cmd-nginx-vhosts-help "nginx:help"