bashly 0.9.3 → 0.9.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 310bcfcf9a37601cdf37bd37f81c96fc8e33e4e38e601a4d496a2b8fed20e319
-  data.tar.gz: 72c4644b4051c9a290192c4d497bdcb80c8bdc5d473fe3c7bb01c40209f62a3d
+  metadata.gz: 34993542fcfa09d73fa8a1e0a0dceff571612efd1fa93211d3656279301c6f95
+  data.tar.gz: '04218807cb6464dd9cfb5bcf2d8e3b442b67885cd44d91942b5e3f900a3c29b6'
 SHA512:
-  metadata.gz: 8b655051b58edb3182e022405484e006ef1ac6a7a0815fe6be77f38cbe57a5f9bf90adfa45be713719d718221451f9ab88087e4253fb7356651ff03f7ddc5b61
-  data.tar.gz: 992d1f15fdb7649375b2c1f8f09054b73dc7aef92c7e980995b7fd4c28671b42c9635078617ff10bba81a49836852b53151ef5559b53a55cf7070197a5937a01
+  metadata.gz: f03c2c3cb8a8fa45c12fcc9a06c5d12a21303b2917c0ada24b60e6895606eac42b5fcfb411702aa24e8bc0885e454f7ad8f4b874294888fb673b323178bbcd81
+  data.tar.gz: 1c1e28ac06bbc58d573d9b4e2270cde6628059af9ac4377c4c1c8393f488646ccfcb3cc2d8abc8b1e2332219720a8340b2f15b6e829f66725a27024d772e3d5e

data/README.md

@@ -13,7 +13,7 @@ Create feature-rich bash scripts using simple YAML configuration
 
 ---
 
-![demo](demo/cast.svg)
+![demo](demo/cast.gif)
 
 </div>
 

data/bin/bashly

@@ -12,6 +12,6 @@ rescue Bashly::Interrupt
   exit 1
 rescue => e
   puts e.backtrace.reverse if ENV['DEBUG']
-  say! "!undred!#{e.class}!txtrst!\n#{e.message}"
+  say! "rib` #{e.class} `\n#{e.message}"
   exit 1
 end

data/lib/bashly/cli.rb

@@ -7,7 +7,7 @@ module Bashly
     def self.runner
       runner = MisterBin::Runner.new version: Bashly::VERSION,
         header: 'Bashly - Bash CLI Generator',
-        footer: "Help: !txtpur!bashly COMMAND --help!txtrst!\nDocs: !undblu!https://bashly.dannyb.co"
+        footer: "Help: m`bashly COMMAND --help`\nDocs: bu`https://bashly.dannyb.co`"
 
       runner.route 'init',      to: Commands::Init
       runner.route 'preview',   to: Commands::Preview

data/lib/bashly/commands/add.rb

@@ -124,18 +124,18 @@ module Bashly
       def safe_write(path, content)
         if !skip_src_check && !Dir.exist?(Settings.source_dir)
           raise InitError, <<~ERROR
-            Directory !txtgrn!#{Settings.source_dir}!txtrst! does not exist
-            Run !txtpur!bashly init!txtrst! first
+            Directory g`#{Settings.source_dir}` does not exist
+            Run m`bashly init` first
           ERROR
         end
 
         if File.exist?(path) && !args['--force']
-          say "!txtblu!skipped!txtrst! #{path} (exists)"
+          say "b`skipped` #{path} (exists)"
           false
 
         else
           File.deep_write path, content
-          say "!txtgrn!created!txtrst! #{path}"
+          say "g`created` #{path}"
           true
 
         end

data/lib/bashly/commands/doc.rb

@@ -35,27 +35,27 @@ module Bashly
       end
 
       def show_key(key)
-        say "!txtgrn!#{key}"
+        say "g`#{key}`"
         say ''
       end
 
       def show_url(url)
-        say "  See !undblu!#{url}"
+        say "  See bu`#{url}`"
         say ''
       end
 
       def show_example(example)
         example = word_wrap "    #{example}"
-        example.gsub!(/^(\s*- )?(\s*\w+):/, '\1!txtblu!\2!txtrst!:')
-        example.gsub!(/^(\s*- )/, '!txtylw!\1!txtrst!')
-        example.gsub!(/^(\s*#.+)/, '!txtpur!\1!txtrst!')
+        example.gsub!(/^(\s*- )?(\s*\w+):/, '\1b`\2`:')
+        example.gsub!(/^(\s*- )/, 'y`\1`')
+        example.gsub!(/^(\s*#.+)/, 'm`\1`')
         say example
         say ''
       end
 
       def show_help(help)
         help = word_wrap "  #{help}"
-        help.gsub!(/`([^`]+)`/, '!txtgrn!\1!txtrst!')
+        help.gsub!(/`([^`]+)`/, 'g`\1`')
         say help
         say ''
       end
@@ -63,13 +63,13 @@ module Bashly
       def data
         return raw_data unless args['SEARCH']
 
-        result = raw_data.select { |k, _v| k.== args['SEARCH'] }
+        result = raw_data.select { |k, _v| k == args['SEARCH'] }
         return result if result.any?
 
         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/generate.rb

@@ -52,25 +52,25 @@ module Bashly
     private
 
       def watch
-        quiet_say "!txtgrn!watching!txtrst! #{Settings.source_dir}\n"
+        quiet_say "g`watching` #{Settings.source_dir}\n"
 
         Filewatcher.new([Settings.source_dir]).watch do
           reset
           generate
 
         rescue Bashly::ConfigurationError => e
-          say! "!undred!#{e.class}!txtrst!\n#{e.message}"
+          say! "rib` #{e.class} `\n#{e.message}"
 
         ensure
-          quiet_say "!txtgrn!waiting\n"
+          quiet_say "g`waiting`\n"
         end
       end
 
       def generate
         with_valid_config do
-          quiet_say 'creating !txtgrn!production!txtrst! version' if Settings.production?
+          quiet_say 'creating g`production` version' if Settings.production?
           generate_all_files
-          quiet_say "run !txtpur!#{master_script_path} --help!txtrst! to test your bash script" unless watching
+          quiet_say "run m`#{master_script_path} --help` to test your bash script" unless watching
         end
       end
 
@@ -110,7 +110,7 @@ module Bashly
         if Library.exist? library_name
           upgrade! existing_file, library_name, *args
         else
-          quiet_say "!txtred!warning!txtrst! not upgrading !txtcyn!#{existing_file}!txtrst!, " \
+          quiet_say "r`warning` not upgrading c`#{existing_file}`, " \
             "unknown library '#{library_name}'"
         end
       end
@@ -121,14 +121,14 @@ module Bashly
 
         if file
           File.deep_write file[:path], file[:content]
-          quiet_say "!txtcyn!updated!txtrst! #{file[:path]}"
+          quiet_say "c`updated` #{file[:path]}"
         else
-          quiet_say "!txtred!warning!txtrst! not upgrading !txtcyn!#{existing_file}!txtrst!, path mismatch"
+          quiet_say "r`warning` not upgrading c`#{existing_file}`, path mismatch"
         end
       end
 
       def create_user_files
-        quiet_say "creating user files in !txtgrn!#{Settings.source_dir}"
+        quiet_say "creating user files in g`#{Settings.source_dir}`"
 
         create_file "#{Settings.source_dir}/initialize.#{Settings.partials_extension}",
           command.render(:default_initialize_script)
@@ -156,17 +156,17 @@ module Bashly
 
       def create_file(file, content)
         if File.exist?(file) && !args['--force']
-          quiet_say "!txtblu!skipped!txtrst! #{file} (exists)"
+          quiet_say "b`skipped` #{file} (exists)"
         else
           File.deep_write file, content
-          quiet_say "!txtgrn!created!txtrst! #{file}"
+          quiet_say "g`created` #{file}"
         end
       end
 
       def create_master_script
         File.write master_script_path, script.code(tab_indent: Settings.tab_indent)
         FileUtils.chmod '+x', master_script_path
-        quiet_say "!txtgrn!created!txtrst! #{master_script_path}"
+        quiet_say "g`created` #{master_script_path}"
       end
 
       def script

data/lib/bashly/commands/init.rb

@@ -13,13 +13,13 @@ module Bashly
 
       def run
         if Dir.exist?(target_dir) && !Dir.empty?(target_dir)
-          raise InitError, "Directory !txtgrn!#{target_dir}!txtrst! already exists and is not empty"
+          raise InitError, "Directory g`#{target_dir}` already exists and is not empty"
         end
 
         FileUtils.mkdir_p target_dir
         File.write "#{target_dir}/bashly.yml", yaml_content
-        say "!txtgrn!created!txtrst! #{target_dir}/bashly.yml"
-        say 'run !txtpur!bashly generate!txtrst! to create the bash script'
+        say "g`created` #{target_dir}/bashly.yml"
+        say 'run m`bashly generate` to create the bash script'
       end
 
     private

data/lib/bashly/commands/validate.rb

@@ -1,3 +1,5 @@
+require 'lp'
+
 module Bashly
   module Commands
     class Validate < Base
@@ -20,9 +22,9 @@ module Bashly
         show_deprecations
         deprecations = config_validator.deprecations
         if deprecations.empty?
-          say '!txtgrn!OK'
+          say 'g`OK`'
         else
-          say "!txtred!WARNING!txtrst! Found #{deprecations.count} deprecations"
+          say "r`WARNING` Found #{deprecations.count} deprecations"
         end
       end
     end

data/lib/bashly/deprecation.rb

@@ -9,11 +9,11 @@ module Bashly
     end
 
     def message
-      result = ['Deprecation Warning:', "!txtred!#{old}!txtrst! is deprecated"]
-      result.push "use !txtgrn!#{replacement}!txtrst! instead" if replacement
-      result.push "see !undblu!#{reference}!txtrst!" if reference
+      result = ['Deprecation Warning:', "r`#{old}` is deprecated"]
+      result.push "use g`#{replacement}` instead" if replacement
+      result.push "see bu`#{reference}`" if reference
 
-      result.map { |line| "!txtred!▐!txtrst! #{line}" }.join("\n")
+      result.map { |line| "r`▐` #{line}" }.join("\n")
     end
 
     def to_h

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/libraries/completions_function.rb

@@ -12,11 +12,11 @@ module Bashly
 
       def post_install_message
         <<~MESSAGE
-          In order to enable completions in your script, create a command or a flag (for example: !txtgrn!#{command.name} completions!txtrst! or !txtgrn!#{command.name} --completions!txtrst!) that calls the !txtgrn!#{function_name}!txtrst! function.
+          In order to enable completions in your script, create a command or a flag (for example: g`#{command.name} completions` or g`#{command.name} --completions`) that calls the g`#{function_name}` function.
 
           Your users can then run something like this to enable completions:
 
-            !txtpur!$ eval "$(#{command.name} completions)"
+            m`$ eval "$(#{command.name} completions)"`
         MESSAGE
       end
 

data/lib/bashly/libraries/completions_script.rb

@@ -14,7 +14,7 @@ module Bashly
         <<~MESSAGE
           In order to enable completions, run:
 
-            !txtpur!$ source #{target_path}
+            m`$ source #{target_path}`
         MESSAGE
       end
 

data/lib/bashly/libraries/completions_yaml.rb

@@ -12,7 +12,7 @@ module Bashly
 
       def post_install_message
         <<~MESSAGE
-          This file can be converted to a completions script using the !txtgrn!completely!txtrst! gem.
+          This file can be converted to a completions script using the g`completely` gem.
         MESSAGE
       end
 

data/lib/bashly/libraries/help.rb

@@ -16,12 +16,12 @@ module Bashly
         <<~MESSAGE
           Add this as a command to your bashly.yml:
 
-            !txtgrn!commands:
-              !txtgrn!- name: !txtpur!help
-              !txtgrn!  help: !txtpur!Show help about a command
-              !txtgrn!  args:
-                !txtgrn!- name: !txtpur!command
-                !txtgrn!  help: !txtpur!Help subject
+            g`commands`:
+              g`- name`: m`help`
+              g`  help`: m`Show help about a command`
+              g`  args`:
+                g`- name`: m`command`
+                g`  help`: m`Help subject`
 
         MESSAGE
       end

data/lib/bashly/libraries.yml

@@ -37,11 +37,11 @@ test:
       target: "%{user_target_dir}/test/approve"
 
   post_install_message: |
-    Edit your tests in !txtgrn!test/approve!txtrst! and then run:
+    Edit your tests in g`test/approve` and then run:
 
-      !txtpur!$ test/approve!txtrst!
+      m`$ test/approve`
 
-    Docs: !undblu!https://github.com/DannyBen/approvals.bash
+    Docs: bu`https://github.com/DannyBen/approvals.bash`
 
 validations:
   files:

data/lib/bashly/refinements/compose_refinements.rb

@@ -25,9 +25,9 @@ module ComposeRefinements
       loaded = YAML.properly_load_file path
       return loaded if loaded.is_a?(Array) || loaded.is_a?(Hash)
 
-      raise Bashly::ConfigurationError, "Cannot find a valid YAML in !txtgrn!#{path}"
+      raise Bashly::ConfigurationError, "Cannot find a valid YAML in g`#{path}`"
     rescue Errno::ENOENT
-      raise Bashly::ConfigurationError, "Cannot find import file !txtgrn!#{path}"
+      raise Bashly::ConfigurationError, "Cannot find import file g`#{path}`"
     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.5'
 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,71 +1,77 @@
 --- !ruby/object:Gem::Specification
 name: bashly
 version: !ruby/object:Gem::Version
-  version: 0.9.3
+  version: 0.9.5
 platform: ruby
 authors:
 - Danny Ben Shitrit
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-12-24 00:00:00.000000000 Z
+date: 2023-01-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: completely
+  name: colsole
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.5.1
+        version: 0.8.1
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.8.1
+    - - "<"
       - !ruby/object:Gem::Version
-        version: 0.5.1
+        version: '2'
 - !ruby/object:Gem::Dependency
-  name: gtx
+  name: completely
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.0
+        version: '0.5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.0
+        version: '0.5'
 - !ruby/object:Gem::Dependency
-  name: colsole
+  name: filewatcher
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.7'
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.7'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
-  name: filewatcher
+  name: gtx
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '0.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '0.1'
 - !ruby/object:Gem::Dependency
   name: lp
   requirement: !ruby/object:Gem::Requirement
@@ -86,28 +92,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.7.2
+        version: '0.7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.7.2
+        version: '0.7'
 - !ruby/object:Gem::Dependency
   name: requires
   requirement: !ruby/object:Gem::Requirement
     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:
@@ -252,7 +258,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.0
+rubygems_version: 3.4.5
 signing_key: 
 specification_version: 4
 summary: Bash Command Line Tool Generator