Skip to content

Commit

Permalink
Add basic help info
Browse files Browse the repository at this point in the history
  • Loading branch information
aleksandryackovlev committed Jul 17, 2019
1 parent f401c24 commit 753e7e6
Show file tree
Hide file tree
Showing 2 changed files with 54 additions and 0 deletions.
54 changes: 54 additions & 0 deletions bin/bash-utils-help
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
#!/usr/bin/env bash

#: TITLE: bash-utils-help
#: DATE: 2019-04-23
#: VERSION: 0.1.0
#: AUTHOR: "Alex Y" <aleksandryackovlev@yandex.ru>
#: DESCRIPTION: Help information

[[ $bashUtilsHelpLoaded ]] && return

source bash-utils-env
source bash-utils-utils

# DESCRIPTION: Print the usage information
# USAGE: usage
showUsageInfo() {
printf "%s - %s\n" "$(bash-utils-env scriptName)" "$(bash-utils-env description)"
cat <<- HELP
USAGE: "$(bash-utils-env usage)"
See 'bash-utils help <COMMAND>' to read about a specific subcommand.
HELP
}

# DESCRIPTION: Print the version information
# USAGE: version
showVersionInfo() {
printf "%s version %s\n" "$(bash-utils-env scriptName)" "$(bash-utils-env version)"
printf "by %s\n" "$(bash-utils-env author)"
}

# DESCRIPTION: The entry point for the bash-utils-help
# USAGE: bash-utils-help [COMMAND]
bash-utils-help() {
local commandToExec
commandToExec="$1"
shift

if [[ -z $commandToExec ]]; then
showUsageInfo
die "$(bash-utils-env successCode)"
fi

case $commandToExec in
version)
showVersionInfo
;;
*)
die "$(bash-utils-env misuseErrorCode)" "An unknown command bash-utils-help ""$commandToExec"
;;
esac
}

bashUtilsHelpLoaded=1
Empty file added bin/bash-utils-help.bats
Empty file.

0 comments on commit 753e7e6

Please sign in to comment.