Add "help" method in "frontend-search" plugin

This commit is contained in:
willmendesneto 2014-07-03 22:53:00 -03:00 committed by Marc Cornellà
parent f1472f1f64
commit ff706f3ef8
2 changed files with 32 additions and 3 deletions

View File

@ -17,9 +17,16 @@ plugins=( <your-plugins-list>... frontend-search)
## Commands ##
All command searches are accept only in format
All command searches are accept only in formats
* `frontend <search-content> <search-term>`
* `<search-content> <search-term>`
For more informations, please run help command (are similars)
* `frontend -h`
* `frontend --help`
* `frontend help`
The search content are

View File

@ -29,14 +29,36 @@ function frontend() {
unheap 'http://www.unheap.com/?s='
)
# show help for commands list
if [[ $1 =~ '(help|--help|-h)' ]]
then
echo "Usage:"
echo "\n\tfrontend <search-content>\n\t<search-content>\n\tfrontend <search-content> <search-term>"
echo ""
echo "Where <search-content> is one of:"
echo "jquery, mdn, compass, html5please, caniuse, aurajs, dartlang, qunit, fontello,"
echo "bootsnipp, cssflow, codepen, unheap, bem, smacss, angularjs, reactjs, emberjs"
echo "help"
echo ""
echo "Where <search-term> is a term to search in allowed repositories"
echo ""
echo "frontend --help show plugin help"
echo "frontend -h show plugin help"
echo ""
echo "It is allowed to directly access all search contents."
echo ""
return 1
fi
# no keyword provided, simply show how call methods
if [[ $# -le 1 ]]; then
if [[ $# -le 1 ]]
then
echo "Please provide a search-content and a search-term for app.\nEx:\nfrontend <search-content> <search-term>\n"
return 1
fi
# check whether the search engine is supported
if [[ -z "$urls[$1]" ]]; then
if [[ -z "$urls[$1]" ]]
then
echo "Search valid search content $1 not supported."
echo "Valid contents: (formats 'frontend <search-content>' or '<search-content>')"