bashly 0.3.2 → 0.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 665f22f00a1ebc72e1d6e549cfea6030410a386a9375f39734a00e4091290e89
-  data.tar.gz: 7e2a7b0afb183f1103d7a789fa6955e7520b63505130e764b91b14a3d3e15235
+  metadata.gz: 51726b1606a72cbed1bd541c1ec4043e1d3ee8fd84dcea162746cb953e6684f9
+  data.tar.gz: 965346a4e52205af43220f893b9c30978df49f376f1067ce4a25d8a4dda3c0b8
 SHA512:
-  metadata.gz: 77d14c4d2ce85b462aea89a4cce5aadef3bf70ca6373bf782b58bedcf17fcd52d2fbe2bfd26569d9c0a03fecea2a1eec8c630eec51003438bdf8fe099b28bf3e
-  data.tar.gz: c6b803f2390630053483ca5507df869c95f0fa50752d3f3cf9595807a5779b01724c99460ee8bf0c5a258959769100199a5876bafe62430189e925d697abd979
+  metadata.gz: bb165ce7cd9ed5a399d1792993d15e3939879e4462d23b89cb3ebad8e8964d75ab629c2ab5286b293a456a78d9daf567b2ac0235c00fc568da20cd4c201d2137
+  data.tar.gz: b87760cde516cb1964a90ce6017ea922198d67530c741e95c1c75e6568d9bb57653b3ed79b5613307ef188827ada05f4f4c97ba4f7e576e07d15962a126fddbb

data/lib/bashly/models/environment_variable.rb

@@ -3,7 +3,7 @@ module Bashly
     class EnvironmentVariable < Base
       def usage_string(extended: false)
         result = [name.upcase]
-        result << "(required)" if required and extended
+        result << strings[:required] if required and extended
         result.join " "
       end
     end

data/lib/bashly/models/flag.rb

@@ -14,7 +14,7 @@ module Bashly
       def usage_string(extended: false)
         result = [aliases.join(", ")]
         result << arg.upcase if arg
-        result << "(required)" if required and extended
+        result << strings[:required] if required and extended
         result.join " "
       end
     end

data/lib/bashly/templates/strings.yml

@@ -1,3 +1,6 @@
+# When overriding from the user folder, feel free to delete everything
+# you do not plan on overriding to keep the default string.
+
 # Usage captions
 usage: "Usage:"
 options: "Options:"
@@ -6,6 +9,13 @@ commands: "Commands:"
 examples: "Examples:"
 environment_variables: "Environment Variables:"
 
+# Usage helpers
+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
 version_flag_text: Show version number

data/lib/bashly/version.rb

@@ -1,3 +1,3 @@
 module Bashly
-  VERSION = "0.3.2"
+  VERSION = "0.3.3"
 end

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

@@ -14,15 +14,21 @@
     printf "<%= caption_string %>\n"
     echo 
   fi
+
+  <%- if short -%>
+  printf "<%= strings[:command_shortcut] % { short: short } %>\n"
+  echo
+  <%- end -%>
+
   printf "<%= strings[:usage] %>\n"
   printf "  <%= usage_string %>\n"
   <%- if commands.any? -%>
   printf "  <%= full_name %> [command] --help | -h\n"
   <%- else -%>
-  printf "  <%= full_name %> --help | -h\n"
+  printf "  <%= full_name %> <%= strings[:help_flag] %>\n"
   <%- end -%>
   <%- if root_command? -%>
-  printf "  <%= full_name %> --version\n"
+  printf "  <%= full_name %> <%= strings[:version_flag] %>\n"
   <%- end -%>
   echo
 <%= render(:usage_commands).indent 2 if commands.any? %>

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

@@ -3,7 +3,7 @@ printf "<%= strings[:commands] %>\n"
 <%- maxlen = command_names.map(&:size).max -%>
 <%- commands.each do |command| -%>
 <%- summary = command.summary -%>
-<%- summary = "#{summary} (default)" if command.default -%>
+<%- summary = strings[:default_command_summary] % { summary: summary } if command.default -%>
 echo "  <%= command.name.ljust maxlen %>   <%= summary %>"
 <%- end -%>
 echo

metadata

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