bashly 0.3.4 → 0.3.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7839064a69e5280ef2fcf0112ee9a4442912f99308a8c99dd3cf57c48fc905d2
-  data.tar.gz: '0923d678dd93f16ec6beb2bb796e679b355fe971fc7141910c5b62d025ccfc4b'
+  metadata.gz: 95bc5fa6ee6c14e2e4cd269aecbfef7af9f005e7837c182c2f222d4640778e40
+  data.tar.gz: c8214a96d5d63094cb6f86e07022022f30b471da362b4aa087fe16ddaf96aada
 SHA512:
-  metadata.gz: ec45676addca44ee7ce775b505d368b29723ed689e890592608a96a36fc64f8570dfd15a2df3a82b6a7e4bd2081db6338d11de0b285488d4af8145a83205cdb1
-  data.tar.gz: cd6303a9834570a1d7a4a8d17ee796c72a116454cc1831af7a8897113419557840e1e1c94117abb06f9510dfb4b2aa4e7aafc67ce65eca2fcd0cd8ee56d0f8cd
+  metadata.gz: e25fd6d234783d9eb96a5e4f4a5bcc836740cbb6ee5ff2f5486a4fcea376a5e61c31f6b5eb762693708225ee8b2a2aac3d163d23d37d07dfe902687ee8d4a22b
+  data.tar.gz: 8bc3e1595cdb52c6001d55600f7fb4a1fda2d7d525b933641e04f4041de694354895eeb37d0e53d6c0cdc286b632643dfb812c8fb40cf958e93f94a5a005dcf5

data/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:

data/lib/bashly/models/command.rb

@@ -136,6 +136,11 @@ module Bashly
         parents.empty?
       end
 
+      # Returns true if one of the flags matches the provided short code
+      def short_flag_exist?(flag)
+        flags.select { |f| f.short == flag }.any?
+      end
+
       # Returns a constructed string suitable for Usage pattern
       def usage_string
         result = [full_name]

data/lib/bashly/templates/strings.yml

@@ -14,8 +14,6 @@ group: "%{group} Commands:"
 command_shortcut: "Shortcut: %{short}"
 default_command_summary: "%{summary} (default)"
 required: "(required)"
-help_flag: "--help | -h"
-version_flag: "--version"
 
 # Fixed flags help text
 help_flag_text: Show this help

data/lib/bashly/version.rb

@@ -1,3 +1,3 @@
 module Bashly
-  VERSION = "0.3.4"
+  VERSION = "0.3.5"
 end

data/lib/bashly/views/command/fixed_flags_filter.erb

@@ -1,11 +1,19 @@
 # :command.fixed_flag_filter
 case "$1" in
+<%- if short_flag_exist? "-v" -%>
 --version )
+<%- else -%>
+--version | -v )
+<%- end -%>
   version_command
   exit 1
   ;;
 
---help | -h ) 
+<%- if short_flag_exist? "-h" -%>
+--help )
+<%- else -%>
+--help | -h )
+<%- end -%>
   long_usage=yes
   <%= function_name %>_usage
   exit 1

data/lib/bashly/views/command/usage.erb

@@ -23,12 +23,12 @@
   printf "<%= strings[:usage] %>\n"
   printf "  <%= usage_string %>\n"
   <%- if commands.any? -%>
-  printf "  <%= full_name %> [command] --help | -h\n"
+  printf "  <%= full_name %> [command] --help<%= " | -h" unless short_flag_exist? "-h" -%>\n"
   <%- else -%>
-  printf "  <%= full_name %> <%= strings[:help_flag] %>\n"
+  printf "  <%= full_name %> --help<%= " | -h" unless short_flag_exist? "-h" -%>\n"
   <%- end -%>
   <%- if root_command? -%>
-  printf "  <%= full_name %> <%= strings[:version_flag] %>\n"
+  printf "  <%= full_name %> --version<%= " | -v" unless short_flag_exist? "-v" -%>\n"
   <%- end -%>
   echo
 <%= render(:usage_commands).indent 2 if commands.any? %>

data/lib/bashly/views/command/usage_fixed_flags.erb

@@ -1,9 +1,17 @@
 # :command.usage_fixed_flags
+<%- if short_flag_exist? "-h" -%>
+echo "  --help"
+<%- else -%>
 echo "  --help, -h"
+<%- end -%>
 printf "    <%= strings[:help_flag_text] %>\n"
 echo
 <%- if root_command? -%>
+<%- if short_flag_exist? "-v" -%>
 echo "  --version"
+<%- else -%>
+echo "  --version, -v"
+<%- end -%>
 printf "    <%= strings[:version_flag_text] %>\n"
 echo
 <%- end -%>

data/lib/bashly/views/flag/case.erb

@@ -6,7 +6,7 @@
     shift
     shift
   else
-    printf "<%= strings[:flag_requires_an_argument] % { long: long, usage: usage_string } %>\n"
+    printf "%s\n" "<%= strings[:flag_requires_an_argument] % { long: long, usage: usage_string } %>"
     exit 1
   fi
   <%- else -%>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bashly
 version: !ruby/object:Gem::Version
-  version: 0.3.4
+  version: 0.3.5
 platform: ruby
 authors:
 - Danny Ben Shitrit
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-12-19 00:00:00.000000000 Z
+date: 2019-12-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colsole