Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Uses a help tokens array to replace tokens in help text #255

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Uses a help tokens array to replace tokens in help text #255

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6e0d762
Replace help tokens without --help-filter
nkakouros Sep 28, 2019
b34c9d4
Updates help help text
nkakouros Sep 28, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 22 additions & 3 deletions libexec/help
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,17 @@
# values, to keep the text in sync automatically. It's good practice to parse
# tokens within `{{` and `}}` as is common with templating engines, but it's not
# enforced.
#
# An alternative way to perform token replacement (for Bash version >= 4) is to
# use the _GO_HELP_TOKENS associative array. The index of an item is the token
# to be searched and replaced and the value of the item is the replacement
# value. For instance:
#
# declare -A _GO_HELP_TOKENS=([project_dir]=~/Projects/my-project)
#
# will replace 'project_dir' in the help text with '~/Projects/my-project'. By
# default, this array is empty and you will have to declare it and add tokens to
# it.

[email protected]() {
local cmd_paths=("$_GO_SCRIPTS_DIR")
Expand Down Expand Up @@ -116,14 +127,22 @@ [email protected]_message_for_command() {

local filter_pattern='# [Hh]elp [Ff]ilter['$'\n\r'']'

if [[ "$(< "$__go_cmd_path")" =~ $filter_pattern ]]; then
if [[ "$(<"$__go_cmd_path")" =~ $filter_pattern ]]; then
__go_cmd_desc="$([email protected]_command_script "$__go_cmd_path" --help-filter \
"$__go_cmd_desc")"
fi

if [[ "$(declare -p _GO_HELP_TOKENS 2>/dev/null || :)" =~ declare\ -A ]]; then
for token in "${!_GO_HELP_TOKENS[@]}"; do
__go_cmd_desc="${__go_cmd_desc//{{$token\}\}/${_GO_HELP_TOKENS[$token]}}"
done
fi

if [[ -d "${__go_cmd_path}.d" ]]; then
__go_cmd_desc+="$(printf '\nSubcommands:\n\n'; \
[email protected]_builtin 'commands' --summaries "${__go_cmd_path}.d")"
__go_cmd_desc+="$(
printf '\nSubcommands:\n\n'
[email protected]_builtin 'commands' --summaries "${__go_cmd_path}.d"
)"
fi
@go.printf "$_GO_CMD $cmd_name - $__go_cmd_desc\n"
}
Expand Down
30 changes: 30 additions & 0 deletions tests/help.bats
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -168,6 +168,36 @@ teardown() {
assert_success "${expected[@]}"
}

@test "$SUITE: replace help tokens using _GO_HELP_TOKENS" {
if [[ "${BASH_VERSINFO[0]}" -lt 4 ]]; then
skip
fi

local cmd_script=(
'#'
'# Does foo stuff'
'#'
'# Usage: {{go}} {{cmd}} <{{FOO_VALID_ARGS}}>'
''
'declare -r FOO_VALID_ARGS=("bar" "baz" "quux")'
''
)
@go.create_test_command_script 'foo' "${cmd_script[@]}"

@go.create_test_go_script \
"declare -gA _GO_HELP_TOKENS=(['FOO_VALID_ARGS']='bar|baz|quux')" \
'@go "$@"'


run "$TEST_GO_SCRIPT" help foo

local expected=(
"$TEST_GO_SCRIPT foo - Does foo stuff"
''
"Usage: $TEST_GO_SCRIPT foo <bar|baz|quux>")
assert_success "${expected[@]}"
}

@test "$SUITE: add subcommand summaries" {
local cmd_template=$'# Does {{CMD}} stuff\n'
cmd_template+=$'#\n'
Expand Down