refactor: standardize help generation
This commit is contained in:
@@ -1,6 +1,6 @@
|
||||
#!/usr/bin/env bash
|
||||
[[ " storage:help help " == *" $1 "* ]] || exit "$DOKKU_NOT_IMPLEMENTED_EXIT"
|
||||
source "$PLUGIN_AVAILABLE_PATH/storage/internal-functions"
|
||||
source "$PLUGIN_AVAILABLE_PATH/storage/help-functions"
|
||||
set -eo pipefail
|
||||
[[ $DOKKU_TRACE ]] && set -x
|
||||
|
||||
|
||||
35
plugins/storage/help-functions
Executable file
35
plugins/storage/help-functions
Executable file
@@ -0,0 +1,35 @@
|
||||
#!/usr/bin/env bash
|
||||
set -eo pipefail
|
||||
[[ $DOKKU_TRACE ]] && set -x
|
||||
|
||||
cmd-storage-help() {
|
||||
declare desc="help command"
|
||||
declare CMD="$1"
|
||||
local plugin_name="storage"
|
||||
local plugin_description="Manage mounted volumes"
|
||||
|
||||
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
|
||||
storage:list <app>, List bind mounts for app's container(s) (host:container)
|
||||
storage:mount <app> <host-dir:container-dir>, Create a new bind mount
|
||||
storage:report [<app>] [<flag>], Displays a checks report for one or more apps
|
||||
storage:unmount <app> <host-dir:container-dir>, Remove an existing bind mount
|
||||
help_content
|
||||
}
|
||||
@@ -75,33 +75,6 @@ fn-storage-bind-mounts() {
|
||||
fi
|
||||
}
|
||||
|
||||
storage_help_content_func() {
|
||||
declare desc="return storage plugin help content"
|
||||
cat <<help_content
|
||||
storage:list <app>, List bind mounts for app's container(s) (host:container)
|
||||
storage:mount <app> <host-dir:container-dir>, Create a new bind mount
|
||||
storage:report [<app>] [<flag>], Displays a checks report for one or more apps
|
||||
storage:unmount <app> <host-dir:container-dir>, Remove an existing bind mount
|
||||
help_content
|
||||
}
|
||||
|
||||
cmd-storage-help() {
|
||||
if [[ $1 == "storage:help" ]]; then
|
||||
echo -e 'Usage: dokku storage[:COMMAND]'
|
||||
echo ''
|
||||
echo 'Mount local volume / directories inside containers.'
|
||||
echo ''
|
||||
echo 'Additional commands:'
|
||||
storage_help_content_func | sort | column -c2 -t -s,
|
||||
elif [[ $(ps -o command= $PPID) == *"--all"* ]]; then
|
||||
storage_help_content_func
|
||||
else
|
||||
cat <<help_desc
|
||||
storage, Mount local volume / directories inside containers
|
||||
help_desc
|
||||
fi
|
||||
}
|
||||
|
||||
cmd-storage-list() {
|
||||
declare desc="List all bound mounts"
|
||||
local cmd="storage:list"
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
#!/usr/bin/env bash
|
||||
set -eo pipefail
|
||||
[[ $DOKKU_TRACE ]] && set -x
|
||||
source "$PLUGIN_AVAILABLE_PATH/storage/internal-functions"
|
||||
source "$PLUGIN_AVAILABLE_PATH/storage/help-functions"
|
||||
|
||||
cmd-storage-help "storage:help"
|
||||
|
||||
Reference in New Issue
Block a user