Relinquish -v and -h if the user wants them

README.md

@@ -163,7 +163,7 @@ bash function.
 ### Flag options
 
 The flag's value will be available to you as `${args[--output]}` in your 
-bash function (regardless of whether the user provided ut with the long or 
+bash function (regardless of whether the user provided it with the long or 
 short form).
 
  Option    | Description
@@ -174,6 +174,12 @@ short form).
 `arg`      | If the flag requires an argument, specify its name here.
 `required` | Specify if this flag is required.
 
+#### Special handling for -v and -h
+
+The `-v` and `-h` flags will be used as the short options for `--version` and
+`--help` respectively **only if you are not using them in any of your own
+flags**.
+
 ### Environment Variable options
 
 The below configuration generates this environment variable usage text:

Runfile

@@ -38,9 +38,10 @@ def examples
     "examples/environment-variables/cli",
     "examples/git-like/git",
     "examples/minimal/download",
+    "examples/minus-v/cli",
     "examples/multiline/multi",
     "examples/yaml/yaml",
-    "spec/fixtures/workspaces/short-flag/rush",
+    "spec/fixtures/workspaces/short-command-code/rush",
   ]
 end
 

examples/colors/colorly

@@ -33,7 +33,7 @@ colorly_usage() {
   printf "Usage:\n"
   printf "  colorly [MESSAGE] [options]\n"
   printf "  colorly --help | -h\n"
-  printf "  colorly --version\n"
+  printf "  colorly --version | -v\n"
   echo
 
   if [[ -n $long_usage ]]; then
@@ -42,7 +42,7 @@ colorly_usage() {
     echo "  --help, -h"
     printf "    Show this help\n"
     echo
-    echo "  --version"
+    echo "  --version, -v"
     printf "    Show version number\n"
     echo
 
@@ -104,12 +104,12 @@ cyan_underlined() { printf "\e[4;36m%b\e[0m\n" "$*"; }
 parse_requirements() {
   # :command.fixed_flag_filter
   case "$1" in
-  --version )
+  --version | -v )
     version_command
     exit 1
     ;;
 
-  --help | -h ) 
+  --help | -h )
     long_usage=yes
     colorly_usage
     exit 1

examples/command-default/ftp

@@ -20,7 +20,7 @@ ftp_usage() {
   printf "Usage:\n"
   printf "  ftp [command] [options]\n"
   printf "  ftp [command] --help | -h\n"
-  printf "  ftp --version\n"
+  printf "  ftp --version | -v\n"
   echo
   # :command.usage_commands
   printf "Commands:\n"
@@ -34,7 +34,7 @@ ftp_usage() {
     echo "  --help, -h"
     printf "    Show this help\n"
     echo
-    echo "  --version"
+    echo "  --version, -v"
     printf "    Show version number\n"
     echo
 
@@ -142,12 +142,12 @@ ftp_download_command() {
 parse_requirements() {
   # :command.fixed_flag_filter
   case "$1" in
-  --version )
+  --version | -v )
     version_command
     exit 1
     ;;
 
-  --help | -h ) 
+  --help | -h )
     long_usage=yes
     ftp_usage
     exit 1
@@ -215,12 +215,12 @@ parse_requirements() {
 ftp_upload_parse_requirements() {
   # :command.fixed_flag_filter
   case "$1" in
-  --version )
+  --version | -v )
     version_command
     exit 1
     ;;
 
-  --help | -h ) 
+  --help | -h )
     long_usage=yes
     ftp_upload_usage
     exit 1
@@ -269,12 +269,12 @@ ftp_upload_parse_requirements() {
 ftp_download_parse_requirements() {
   # :command.fixed_flag_filter
   case "$1" in
-  --version )
+  --version | -v )
     version_command
     exit 1
     ;;
 
-  --help | -h ) 
+  --help | -h )
     long_usage=yes
     ftp_download_usage
     exit 1

examples/command-groups/ftp

@@ -20,7 +20,7 @@ ftp_usage() {
   printf "Usage:\n"
   printf "  ftp [command] [options]\n"
   printf "  ftp [command] --help | -h\n"
-  printf "  ftp --version\n"
+  printf "  ftp --version | -v\n"
   echo
   # :command.usage_commands
   printf "File Commands:\n"
@@ -37,7 +37,7 @@ ftp_usage() {
     echo "  --help, -h"
     printf "    Show this help\n"
     echo
-    echo "  --version"
+    echo "  --version, -v"
     printf "    Show version number\n"
     echo
 
@@ -207,12 +207,12 @@ ftp_logout_command() {
 parse_requirements() {
   # :command.fixed_flag_filter
   case "$1" in
-  --version )
+  --version | -v )
     version_command
     exit 1
     ;;
 
-  --help | -h ) 
+  --help | -h )
     long_usage=yes
     ftp_usage
     exit 1
@@ -288,12 +288,12 @@ parse_requirements() {
 ftp_download_parse_requirements() {
   # :command.fixed_flag_filter
   case "$1" in
-  --version )
+  --version | -v )
     version_command
     exit 1
     ;;
 
-  --help | -h ) 
+  --help | -h )
     long_usage=yes
     ftp_download_usage
     exit 1
@@ -342,12 +342,12 @@ ftp_download_parse_requirements() {
 ftp_upload_parse_requirements() {
   # :command.fixed_flag_filter
   case "$1" in
-  --version )
+  --version | -v )
     version_command
     exit 1
     ;;
 
-  --help | -h ) 
+  --help | -h )
     long_usage=yes
     ftp_upload_usage
     exit 1
@@ -396,12 +396,12 @@ ftp_upload_parse_requirements() {
 ftp_login_parse_requirements() {
   # :command.fixed_flag_filter
   case "$1" in
-  --version )
+  --version | -v )
     version_command
     exit 1
     ;;
 
-  --help | -h ) 
+  --help | -h )
     long_usage=yes
     ftp_login_usage
     exit 1
@@ -438,12 +438,12 @@ ftp_login_parse_requirements() {
 ftp_logout_parse_requirements() {
   # :command.fixed_flag_filter
   case "$1" in
-  --version )
+  --version | -v )
     version_command
     exit 1
     ;;
 
-  --help | -h ) 
+  --help | -h )
     long_usage=yes
     ftp_logout_usage
     exit 1

examples/commands-nested/cli

@@ -20,7 +20,7 @@ cli_usage() {
   printf "Usage:\n"
   printf "  cli [command] [options]\n"
   printf "  cli [command] --help | -h\n"
-  printf "  cli --version\n"
+  printf "  cli --version | -v\n"
   echo
   # :command.usage_commands
   printf "Commands:\n"
@@ -34,7 +34,7 @@ cli_usage() {
     echo "  --help, -h"
     printf "    Show this help\n"
     echo
-    echo "  --version"
+    echo "  --version, -v"
     printf "    Show version number\n"
     echo
 
@@ -291,12 +291,12 @@ cli_file_edit_command() {
 parse_requirements() {
   # :command.fixed_flag_filter
   case "$1" in
-  --version )
+  --version | -v )
     version_command
     exit 1
     ;;
 
-  --help | -h ) 
+  --help | -h )
     long_usage=yes
     cli_usage
     exit 1
@@ -358,12 +358,12 @@ parse_requirements() {
 cli_dir_parse_requirements() {
   # :command.fixed_flag_filter
   case "$1" in
-  --version )
+  --version | -v )
     version_command
     exit 1
     ;;
 
-  --help | -h ) 
+  --help | -h )
     long_usage=yes
     cli_dir_usage
     exit 1
@@ -425,12 +425,12 @@ cli_dir_parse_requirements() {
 cli_dir_list_parse_requirements() {
   # :command.fixed_flag_filter
   case "$1" in
-  --version )
+  --version | -v )
     version_command
     exit 1
     ;;
 
-  --help | -h ) 
+  --help | -h )
     long_usage=yes
     cli_dir_list_usage
     exit 1
@@ -479,12 +479,12 @@ cli_dir_list_parse_requirements() {
 cli_dir_remove_parse_requirements() {
   # :command.fixed_flag_filter
   case "$1" in
-  --version )
+  --version | -v )
     version_command
     exit 1
     ;;
 
-  --help | -h ) 
+  --help | -h )
     long_usage=yes
     cli_dir_remove_usage
     exit 1
@@ -539,12 +539,12 @@ cli_dir_remove_parse_requirements() {
 cli_file_parse_requirements() {
   # :command.fixed_flag_filter
   case "$1" in
-  --version )
+  --version | -v )
     version_command
     exit 1
     ;;
 
-  --help | -h ) 
+  --help | -h )
     long_usage=yes
     cli_file_usage
     exit 1
@@ -606,12 +606,12 @@ cli_file_parse_requirements() {
 cli_file_show_parse_requirements() {
   # :command.fixed_flag_filter
   case "$1" in
-  --version )
+  --version | -v )
     version_command
     exit 1
     ;;
 
-  --help | -h ) 
+  --help | -h )
     long_usage=yes
     cli_file_show_usage
     exit 1
@@ -660,12 +660,12 @@ cli_file_show_parse_requirements() {
 cli_file_edit_parse_requirements() {
   # :command.fixed_flag_filter
   case "$1" in
-  --version )
+  --version | -v )
     version_command
     exit 1
     ;;
 
-  --help | -h ) 
+  --help | -h )
     long_usage=yes
     cli_file_edit_usage
     exit 1