refactor: standardize help generation
This commit is contained in:
@@ -1,36 +1,9 @@
|
||||
#!/usr/bin/env bash
|
||||
[[ " help docker-options:help " == *" $1 "* ]] || exit "$DOKKU_NOT_IMPLEMENTED_EXIT"
|
||||
source "$PLUGIN_AVAILABLE_PATH/docker-options/help-functions"
|
||||
set -eo pipefail
|
||||
[[ $DOKKU_TRACE ]] && set -x
|
||||
|
||||
docker_options_help_content_func() {
|
||||
declare desc="return docker-options plugin help content"
|
||||
cat <<help_content
|
||||
docker-options <app> [phase(s)], [DEPRECATED] Alternative for docker-options:report
|
||||
docker-options:add <app> <phase(s)> OPTION, Add Docker option to app for phase (comma separated phase list)
|
||||
docker-options:clear <app> [phase(s)], Clear a docker options from application with an optional phase (comma separated phase list)
|
||||
docker-options:remove <app> <phase(s)> OPTION, Remove Docker option from app for phase (comma separated phase list)
|
||||
docker-options:report [<app>] [<flag>], Displays a docker options report for one or more apps
|
||||
help_content
|
||||
}
|
||||
|
||||
cmd-docker-options-help() {
|
||||
if [[ $1 == "docker-options:help" ]]; then
|
||||
echo -e 'Usage: dokku docker-options[:COMMAND]'
|
||||
echo ''
|
||||
echo 'Display app'"'"'s Docker options for all phases.'
|
||||
echo ''
|
||||
echo 'Additional commands:'
|
||||
docker_options_help_content_func | sort | column -c2 -t -s,
|
||||
elif [[ $(ps -o command= $PPID) == *"--all"* ]]; then
|
||||
docker_options_help_content_func
|
||||
else
|
||||
cat <<help_desc
|
||||
docker-options, Pass options to Docker the various stages of an app
|
||||
help_desc
|
||||
fi
|
||||
}
|
||||
|
||||
case "$1" in
|
||||
help | docker-options:help)
|
||||
cmd-docker-options-help "$@"
|
||||
|
||||
36
plugins/docker-options/help-functions
Executable file
36
plugins/docker-options/help-functions
Executable file
@@ -0,0 +1,36 @@
|
||||
#!/usr/bin/env bash
|
||||
set -eo pipefail
|
||||
[[ $DOKKU_TRACE ]] && set -x
|
||||
|
||||
cmd-docker-options-help() {
|
||||
declare desc="help command"
|
||||
declare CMD="$1"
|
||||
local plugin_name="docker-options"
|
||||
local plugin_description="Manage docker options for an app"
|
||||
|
||||
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
|
||||
docker-options <app> [phase(s)], [DEPRECATED] Alternative for docker-options:report
|
||||
docker-options:add <app> <phase(s)> OPTION, Add Docker option to app for phase (comma separated phase list)
|
||||
docker-options:clear <app> [phase(s)], Clear a docker options from application with an optional phase (comma separated phase list)
|
||||
docker-options:remove <app> <phase(s)> OPTION, Remove Docker option from app for phase (comma separated phase list)
|
||||
docker-options:report [<app>] [<flag>], Displays a docker options report for one or more apps
|
||||
help_content
|
||||
}
|
||||
Reference in New Issue
Block a user