bashly 0.9.3 → 0.9.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 310bcfcf9a37601cdf37bd37f81c96fc8e33e4e38e601a4d496a2b8fed20e319
-  data.tar.gz: 72c4644b4051c9a290192c4d497bdcb80c8bdc5d473fe3c7bb01c40209f62a3d
+  metadata.gz: 810dfb8f0b25029420a1479aa38d682a79787716112d9b5f9c816533fc3e97ea
+  data.tar.gz: c6782bd0bf01a475b137487dcdec634645484c877386b1ccaaa8432d53831595
 SHA512:
-  metadata.gz: 8b655051b58edb3182e022405484e006ef1ac6a7a0815fe6be77f38cbe57a5f9bf90adfa45be713719d718221451f9ab88087e4253fb7356651ff03f7ddc5b61
-  data.tar.gz: 992d1f15fdb7649375b2c1f8f09054b73dc7aef92c7e980995b7fd4c28671b42c9635078617ff10bba81a49836852b53151ef5559b53a55cf7070197a5937a01
+  metadata.gz: 3c6cb7413b619b50cd76ecfa66d704623780f05f3316e1e9bcb9e7a3c02a4a3b9a9215759e928e32e4d6492993fb5b5cbcb6ba0379bd0fe638f6ab1182b791a4
+  data.tar.gz: e83491e2a1ab364701351a74bbef05377bbe479521fe907b8f9b1dc3fa567be4f5b53f87c4f4d4dd4313e9fff16ab84e07dd5cbfae5ed7ff0f4c2d44b98d69bd

data/lib/bashly/commands/doc.rb

@@ -69,7 +69,7 @@ module Bashly
         result = raw_data.select { |k, _v| k.include? args['SEARCH'] }
         return result if result.any?
 
-        raise Error, "No match"
+        raise Error, 'No match'
       end
 
       def raw_data

data/lib/bashly/commands/validate.rb

@@ -1,3 +1,5 @@
+require 'lp'
+
 module Bashly
   module Commands
     class Validate < Base

data/lib/bashly/extensions/string.rb

@@ -37,4 +37,12 @@ class String
       "\t" * (::Regexp.last_match(1).size / tabstop)
     end
   end
+
+  def color(marker)
+    color = Bashly::Settings.usage_colors[marker.to_s]
+    return self unless color
+
+    text, spaces = match(/(.*?)(\s*)$/).captures
+    %[$(#{color} "#{text}")#{spaces}]
+  end
 end

data/lib/bashly/settings.rb

@@ -4,7 +4,7 @@ module Bashly
       include AssetHelper
 
       attr_writer :compact_short_flags, :lib_dir, :partials_extension,
-        :source_dir, :strict, :tab_indent, :target_dir
+        :source_dir, :strict, :tab_indent, :target_dir, :usage_colors
 
       def compact_short_flags
         @compact_short_flags ||= get :compact_short_flags
@@ -50,6 +50,10 @@ module Bashly
         @target_dir ||= get :target_dir
       end
 
+      def usage_colors
+        @usage_colors ||= get :usage_colors
+      end
+
     private
 
       def get(key)

data/lib/bashly/templates/settings.yml

@@ -33,3 +33,15 @@ env: development
 
 # The extension to use when reading/writing partial script snippets.
 partials_extension: sh
+
+# Display various usage elements in color by providing the name of the color
+# function. The value for each property is a name of a function that is
+# available in your script, for example: `green` or `bold`.
+# You can run `bashly add colors` to add a standard colors library.
+# This option cannot be set via environment variables.
+usage_colors:
+  caption: ~
+  command: ~
+  arg: ~
+  flag: ~
+  environment_variable: ~

data/lib/bashly/version.rb

@@ -1,3 +1,3 @@
 module Bashly
-  VERSION = '0.9.3'
+  VERSION = '0.9.4'
 end

data/lib/bashly/views/argument/usage.gtx

@@ -1,6 +1,6 @@
 = view_marker
 
-> echo "  {{ label }}"
+> printf "  %s\n" "{{ label.color(:arg) }}"
 > printf "{{ help.wrap(76).indent(4).sanitize_for_print }}\n"
 
 if allowed

data/lib/bashly/views/command/long_usage.gtx

@@ -1,7 +1,7 @@
 = view_marker
 
 > if [[ -n $long_usage ]]; then
->   printf "{{ strings[:options] }}\n"
+>   printf "%s\n" "{{ strings[:options].color(:caption) }}"
 >
 = render(:usage_fixed_flags).indent 2
 = render(:usage_flags).indent 2 if flags.any?

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

@@ -25,7 +25,7 @@ if alt&.any?
 end
 
 >
->   printf "{{ strings[:usage] }}\n"
+>   printf "%s\n" "{{ strings[:usage].color(:caption) }}"
 >   printf "  {{ usage_string }}\n"
 
 if commands.any?

data/lib/bashly/views/command/usage_args.gtx

@@ -1,6 +1,6 @@
 = view_marker
 
-> printf "{{ strings[:arguments] }}\n"
+> printf "%s\n" "{{ strings[:arguments].color(:caption) }}"
 
 if args.any?
   >

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

@@ -3,13 +3,13 @@
 maxlen = command_help_data.values.map(&:keys).flatten.map(&:size).max
 
 command_help_data.each do |group, commands|
-  > printf "{{ group }}\n"
+  > printf "%s\n" "{{ group.color(:caption) }}"
 
   commands.each do |command, info|
     if info[:help_only]
-      > [[ -n $long_usage ]] && echo "  {{ command.ljust maxlen }}   {{ info[:summary] }}"
+      > [[ -n $long_usage ]] && printf "  %s   {{ info[:summary] }}\n" "{{ command.ljust(maxlen).color(:command) }}"
     else
-      > echo "  {{ command.ljust maxlen }}   {{ info[:summary] }}"
+      > printf "  %s   {{ info[:summary] }}\n" "{{ command.ljust(maxlen).color(:command) }}"
     end
   end
 

data/lib/bashly/views/command/usage_environment_variables.gtx

@@ -1,6 +1,6 @@
 = view_marker
 
-> printf "{{ strings[:environment_variables] }}\n"
+> printf "%s\n" "{{ strings[:environment_variables].color(:caption) }}"
 > 
 
 environment_variables.reject(&:private).each do |env_var|

data/lib/bashly/views/command/usage_examples.gtx

@@ -1,6 +1,6 @@
 = view_marker
 
-> printf "{{ strings[:examples] }}\n"
+> printf "%s\n" "{{ strings[:examples].color(:caption) }}"
 
 examples.each do |example|
   > printf "{{ example.wrap(78).indent(2).sanitize_for_print }}\n"

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

@@ -1,11 +1,20 @@
 = view_marker
 
-= short_flag_exist?("-h") ? 'echo "  --help"' : 'echo "  --help, -h"'
+if short_flag_exist?("-h")
+  > printf "  %s\n" "{{ '--help'.color(:flag) }}"
+else
+  > printf "  %s\n" "{{ '--help, -h'.color(:flag) }}"
+end
+
 > printf "    {{ strings[:help_flag_text] }}\n"
 > echo
 
 if root_command?
-  = short_flag_exist?("-v") ? 'echo "  --version"' : 'echo "  --version, -v"'
+  if short_flag_exist?("-v")
+    > printf "  %s\n" "{{ '--version'.color(:flag) }}"
+  else
+    > printf "  %s\n" "{{ '--version, -v'.color(:flag) }}"
+  end
   > printf "    {{ strings[:version_flag_text] }}\n"
   > echo
 end

data/lib/bashly/views/environment_variable/usage.gtx

@@ -1,6 +1,6 @@
 = view_marker
 
-> echo "  {{ usage_string extended: true }}"
+> printf "  %s\n" "{{ usage_string(extended: true).color(:environment_variable) }}"
 > printf "{{ help.wrap(76).indent(4).sanitize_for_print }}\n"
 
 if default

data/lib/bashly/views/flag/usage.gtx

@@ -1,6 +1,6 @@
 = view_marker
 
-> echo "  {{ usage_string extended: true }}"
+> printf "  %s\n" "{{ usage_string(extended: true).color(:flag) }}"
 > printf "{{ help.wrap(76).indent(4).sanitize_for_print }}\n"
 
 if allowed

data/lib/bashly.rb

@@ -6,7 +6,6 @@ if ENV['BYEBUG']
 end
 
 requires 'bashly/concerns'
-
 requires 'bashly/extensions'
 requires 'bashly/settings'
 requires 'bashly/exceptions'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bashly
 version: !ruby/object:Gem::Version
-  version: 0.9.3
+  version: 0.9.4
 platform: ruby
 authors:
 - Danny Ben Shitrit
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-12-24 00:00:00.000000000 Z
+date: 2022-12-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: completely
@@ -100,14 +100,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.2'
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.2'
+        version: '1.0'
 description: Generate bash command line tools using YAML configuration
 email: db@dannyben.com
 executables: