- Add support for color usage elements

Author: DannyBen

examples/custom-strings/src/bashly-strings.yml

@@ -1,8 +1,8 @@
 # Usage captions
-usage: "== Usage ==\\n"
-options: "== Options ==\\n"
-arguments: "== Arguments ==\\n"
-commands: "== Commands ==\\n"
+usage: "== Usage ==\n"
+options: "== Options ==\n"
+arguments: "== Arguments ==\n"
+commands: "== Commands ==\n"
 
 # Fixed flags help text
 help_flag_text: Show this helpful help

lib/bashly/extensions/string.rb

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

lib/bashly/settings.rb

@@ -4,7 +4,7 @@ class << self
       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 @@ def target_dir
         @target_dir ||= get :target_dir
       end
 
+      def usage_colors
+        @usage_colors ||= get :usage_colors
+      end
+
     private
 
       def get(key)

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: ~

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

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?

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?

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?
   >

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
 

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|