bashly 0.7.10 → 0.8.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 471a0ae8e462a056c196ebf128f02f3f30ff3a100c10aff2d2c010757d6d942e
-  data.tar.gz: d78cf8473f40b241ee412a00d819be124a244acda1f487f20e105dee1cba9842
+  metadata.gz: bc4a83c90c751c1df692c55db4f7335619c927cb86a30de4fcb7eef5115710a1
+  data.tar.gz: 343ede4e31e7a0833b6335a9690c9ecbe060da1983d829cfbdf197bbfe5dc640
 SHA512:
-  metadata.gz: 77617bc6668796730c67d33621d497a8a454a6208d7f42d7c28ecb26e940da2e4edee6b3aefd8fc98b301d8480a13f14c1f6b292ff7f4d29b6030e601cdc1b08
-  data.tar.gz: d7b851826c9dde19201f2fb48b5f4b5ff0cd9a2421f4770ed3fdbc1c340943b9d0c3b3703b26646e46dfb012dca0c2a10728c568786ac4c381ab1431dc191695
+  metadata.gz: 3b5873adb5c173a4676ae071f6d83b11975053addd8b39e50613375032d441b227d6f27c4ad860719bdf22e37f7ce8882217e5c622c607dcff048fe7dfdaab18
+  data.tar.gz: c01a6a3c20aee19338c3cddfbac0254d7316c5b9aa8f2423bbd6ba65746b439e1ce7e3eec2f2654087c3a6b55388fdeca645dfe786e4adcac97997f1a0f778e4

data/lib/bashly/commands/base.rb

@@ -6,10 +6,28 @@ module Bashly
     class Base < MisterBin::Command
       include AssetHelper
 
+      def config
+        @config ||= Config.new "#{Settings.source_dir}/bashly.yml"
+      end
+
+      def config_validator
+        @config_validator ||= ConfigValidator.new config
+      end
+
       def validate_config
-        config = Config.new "#{Settings.source_dir}/bashly.yml"
-        validator = ConfigValidator.new config
-        validator.validate
+        config_validator.validate
+      end
+
+      def with_valid_config
+        validate_config
+        yield
+        show_deprecations
+      end
+
+      def show_deprecations
+        return if config_validator.deprecations.empty? or ENV['BASHLY_HIDE_DEPRECATIONS']
+        messages = "\n" + config_validator.deprecations.map(&:message).join("\n\n") + "\n\n"
+        say! messages
       end
     end
   end

data/lib/bashly/commands/generate.rb

@@ -1,3 +1,5 @@
+require 'filewatcher'
+
 module Bashly
   module Commands
     class Generate < Base
@@ -9,7 +11,8 @@ module Bashly
       option "-f --force", "Overwrite existing files"
       option "-q --quiet", "Disable on-screen progress report"
       option "-u --upgrade", "Upgrade all added library functions"
-      option "-w --wrap FUNCTION", "Wrap the entire script in a function so it can also be sourced"
+      option "-w --watch", "Watch the source directory for changes and regenerate on change"
+      option "-r --wrap FUNCTION", "Wrap the entire script in a function so it can also be sourced"
       option "-e --env ENV", "Force the generation environment (see BASHLY_ENV)"
 
       environment "BASHLY_SOURCE_DIR", "The path containing the bashly configuration and source files [default: src]"
@@ -27,23 +30,61 @@ module Bashly
 
       example "bashly generate --force"
       example "bashly generate --wrap my_function"
+      example "bashly g -uw"
+
+      attr_reader :watching
 
       def run
-        validate_config
         Settings.env = args['--env'] if args['--env']
-        quiet_say "creating !txtgrn!production!txtrst! version" if Settings.production?
-        create_user_files
-        upgrade_libs if args['--upgrade']
-        create_master_script
-        quiet_say "run !txtpur!#{master_script_path} --help!txtrst! to test your bash script"
+        @watching = args['--watch']
+
+        generate
+        watch if watching
       end
 
     private
 
+      def watch
+        quiet_say "!txtgrn!watching!txtrst! #{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}"
+
+        ensure
+          quiet_say "!txtgrn!waiting\n"
+        
+        end
+      end
+
+      def generate
+        with_valid_config do
+          quiet_say "creating !txtgrn!production!txtrst! version" if Settings.production?
+          generate_all_files
+          quiet_say "run !txtpur!#{master_script_path} --help!txtrst! to test your bash script" unless watching
+        end
+      end
+
+      def reset
+        @config = nil
+        @config_validator = nil
+        @command = nil
+        @script = nil
+      end
+
       def quiet_say(message)
         say message unless args['--quiet']
       end
 
+      def generate_all_files
+        create_user_files
+        upgrade_libs if args['--upgrade']
+        create_master_script
+      end
+
       def upgrade_libs
         generated_files.each do |file|
           content = File.read file
@@ -128,10 +169,6 @@ module Bashly
         "#{Settings.target_dir}/#{command.name}"
       end
 
-      def config
-        @config ||= Config.new "#{Settings.source_dir}/bashly.yml"
-      end
-
       def command
         @command ||= Script::Command.new config
       end

data/lib/bashly/commands/preview.rb

@@ -9,10 +9,11 @@ module Bashly
       environment "BASHLY_SOURCE_DIR", "The path containing the bashly configuration and source files [default: src]"
 
       def run
-        config = Config.new "#{Settings.source_dir}/bashly.yml"
-        command = Script::Command.new(config)
-        script = Script::Wrapper.new command
-        puts script.code
+        with_valid_config do
+          command = Script::Command.new config
+          script = Script::Wrapper.new command
+          puts script.code
+        end
       end
     end
   end

data/lib/bashly/commands/validate.rb

@@ -10,7 +10,13 @@ module Bashly
 
       def run
         validate_config
-        say "!txtgrn!OK"
+        show_deprecations
+        deprecations = config_validator.deprecations
+        if deprecations.empty?
+          say "!txtgrn!OK"
+        else
+          say "!txtred!WARNING!txtrst! Found #{deprecations.count} deprecations"
+        end
       end
     end
   end

data/lib/bashly/concerns/completions.rb

@@ -1,51 +1,76 @@
 require 'completely'
 
 module Bashly
-  # This is a `Command` concern responsible for providing bash completion data
+  # This is a `Command` and `Flag` concern responsible for providing bash
+  # completion data
   module Completions
-    def completion_data(with_version: true)
-      result = { full_name => completion_words(with_version: with_version) }
-      
-      commands.each do |command|
-        result.merge! command.completion_data(with_version: false)
-      end
+    module Flag
+      def completion_data(command_full_name)
+        result = {}
+        comps = allowed || completions
 
-      result
-    end
+        if comps
+          aliases.each do |name|
+            result["#{command_full_name}*#{name}"] = comps
+          end
+        end
 
-    def completion_script
-      completion_generator.script
+        result
+      end
     end
 
-    def completion_function(name = nil)
-      completion_generator.wrapper_function(name)
-    end
+    module Command
+      def completion_data(with_version: true)
+        result = {}
 
-  private
+        all_full_names.each do |name|
+          result[name] = completion_words(with_version: with_version)
+          flags.each do |flag|
+            result.merge! flag.completion_data(name)
+          end
+        end
+        
+        commands.each do |command|
+          result.merge! command.completion_data(with_version: false)
+        end
 
-    def completion_generator
-      Completely::Completions.new(completion_data)
-    end
+        result
+      end
 
-    def completion_flag_names
-      flags.map(&:name) + flags.map(&:short)
-    end
+      def completion_script
+        completion_generator.script
+      end
 
-    def completion_allowed_args
-      flags.map(&:allowed).flatten + args.map(&:allowed).flatten
-    end
+      def completion_function(name = nil)
+        completion_generator.wrapper_function(name)
+      end
 
-    def completion_words(with_version: false)
-      trivial_flags = %w[--help -h]
-      trivial_flags += %w[--version -v] if with_version
-      all = (
-        command_names + trivial_flags +
-        completion_flag_names + completion_allowed_args
-      )
+    private
 
-      all += completions if completions
-      all.compact.uniq.sort
-    end
+      def completion_generator
+        Completely::Completions.new(completion_data)
+      end
+
+      def completion_flag_names
+        flags.map(&:name) + flags.map(&:short)
+      end
+
+      def completion_allowed_args
+        args.map(&:allowed).flatten
+      end
+
+      def completion_words(with_version: false)
+        trivial_flags = %w[--help -h]
+        trivial_flags += %w[--version -v] if with_version
+        all = (
+          command_aliases + trivial_flags + 
+          completion_flag_names + completion_allowed_args
+        )
 
+        all += completions if completions
+        all.compact.uniq.sort
+      end
+
+    end
   end
-end
+end

data/lib/bashly/concerns/renderable.rb

@@ -18,6 +18,22 @@ module Bashly
       "# #{id}" unless Settings.production?
     end
 
+    # Reads a file from the userspace (Settings.source_dir) and returns
+    # its contents. If the file is not found, returns a string with a hint.
+    def load_user_file(file, placeholder: true)
+      path = "#{Settings.source_dir}/#{file}"
+
+      content = if File.exist? path
+        File.read(path).remove_front_matter
+      elsif placeholder
+        %q[echo "error: cannot load file"]
+      else
+        ''
+      end
+
+      Settings.production? ? content : "#{view_marker path}\n#{content}"
+    end
+
   private
 
     def view_path(view)

data/lib/bashly/concerns/validation_helpers.rb

@@ -0,0 +1,75 @@
+module Bashly
+  # This is a `ConfigValidator` concern responsible for providing basic
+  # assertion methods.
+  module ValidationHelpers
+
+    def deprecations
+      @deprecations ||= []
+    end
+
+  protected
+
+    def assert(valid, message)
+      raise ConfigurationError, message unless valid
+    end
+
+    def refute(invalid, message)
+      assert !invalid, message
+    end
+
+    def deprecate(key, **options)
+      deprecations.push Deprecation.new(key, **options)
+    end
+
+    def assert_string(key, value)
+      assert value.is_a?(String), "#{key} must be a string"
+    end
+
+    def assert_optional_string(key, value)
+      assert_string key, value if value
+    end
+
+    def assert_boolean(key, value)
+      assert [true, false, nil].include?(value), "#{key} must be a boolean" 
+    end
+
+    def assert_array(key, value, of: nil)
+      return unless value
+      assert value.is_a?(Array), "#{key} must be an array"
+      if of
+        value.each_with_index do |val, i|
+          send "assert_#{of}".to_sym, "#{key}[#{i}]", val
+        end
+      end
+    end
+
+    def assert_hash(key, value, whitelist = nil)
+      assert value.is_a?(Hash), "#{key} must be a hash"
+      
+      if whitelist
+        invalid_keys = value.keys.map(&:to_sym) - whitelist
+        assert invalid_keys.empty?, "#{key} contains invalid options: #{invalid_keys.join(', ')}"
+      end
+    end
+
+    def assert_uniq(key, value, array_keys)
+      return unless value
+      array_keys = [array_keys] unless array_keys.is_a? Array
+      list = []
+      array_keys.each do |array_key|
+        list += value.map { |c| c[array_key] }.compact.flatten
+      end
+
+      nonuniqs = list.nonuniq
+      assert nonuniqs.empty?, "#{key} contains non-unique elements (#{nonuniqs.join ', '}) in #{array_keys.join ' or '}"
+    end
+
+    def assert_string_or_array(key, value)
+      return unless value
+      assert [Array, String].include?(value.class),
+        "#{key} must be a string or an array"
+
+      assert_array key, value, of: :string if value.is_a? Array
+    end
+  end
+end

data/lib/bashly/config_validator.rb

@@ -1,5 +1,7 @@
 module Bashly
   class ConfigValidator
+    include ValidationHelpers
+
     attr_reader :data
 
     def initialize(data)
@@ -12,45 +14,6 @@ module Bashly
 
   private
 
-    def assert(valid, message)
-      raise ConfigurationError, message unless valid
-    end
-
-    def refute(invalid, message)
-      assert !invalid, message
-    end
-
-    def assert_string(key, value)
-      assert value.is_a?(String), "#{key} must be a string"
-    end
-
-    def assert_optional_string(key, value)
-      assert_string key, value if value
-    end
-
-    def assert_boolean(key, value)
-      assert [true, false, nil].include?(value), "#{key} must be a boolean" 
-    end
-
-    def assert_array(key, value, of: nil)
-      return unless value
-      assert value.is_a?(Array), "#{key} must be an array"
-      if of
-        value.each_with_index do |val, i|
-          send "assert_#{of}".to_sym, "#{key}[#{i}]", val
-        end
-      end
-    end
-
-    def assert_hash(key, value, whitelist = nil)
-      assert value.is_a?(Hash), "#{key} must be a hash"
-      
-      if whitelist
-        invalid_keys = value.keys.map(&:to_sym) - whitelist
-        assert invalid_keys.empty?, "#{key} contains invalid options: #{invalid_keys.join(', ')}"
-      end
-    end
-
     def assert_version(key, value)
       return unless value
       assert [String, Integer, Float].include?(value.class),
@@ -78,6 +41,11 @@ module Bashly
         "#{key} must be a boolean or a string" 
     end
 
+    def assert_expose(key, value)
+      return unless value
+      assert [true, false, nil, 'always'].include?(value), "#{key} must be a boolean, or the string 'always'" 
+    end
+
     def assert_arg(key, value)
       assert_hash key, value, Script::Argument.option_keys
       assert_string "#{key}.name", value['name']
@@ -98,6 +66,8 @@ module Bashly
       assert_hash key, value, Script::Flag.option_keys
       assert value['short'] || value['long'], "#{key} must have at least one of long or short name"
 
+      refute value['allowed'] && value['completions'], "#{key} cannot have both allowed and completions"
+
       assert_optional_string "#{key}.long", value['long']
       assert_optional_string "#{key}.short", value['short']
       assert_optional_string "#{key}.help", value['help']
@@ -109,6 +79,7 @@ module Bashly
       assert_boolean "#{key}.required", value['required']
       assert_array "#{key}.allowed", value['allowed'], of: :string
       assert_array "#{key}.conflicts", value['conflicts'], of: :string
+      assert_array "#{key}.completions", value['completions'], of: :string
 
       assert value['long'].match(/^--[a-zA-Z0-9_\-]+$/), "#{key}.long must be in the form of '--name'" if value['long']
       assert value['short'].match(/^-[a-zA-Z0-9]$/), "#{key}.short must be in the form of '-n'" if value['short']
@@ -123,6 +94,10 @@ module Bashly
       if value['allowed']
         assert value['arg'], "#{key}.allowed does not make sense without arg"
       end
+
+      if value['completions']
+        assert value['arg'], "#{key}.completions does not make sense without arg"
+      end
     end
 
     def assert_env_var(key, value)
@@ -140,7 +115,6 @@ module Bashly
       refute value['commands'] && value['flags'], "#{key} cannot have both commands and flags"
 
       assert_string "#{key}.name", value['name']
-      assert_optional_string "#{key}.short", value['short']
       assert_optional_string "#{key}.help", value['help']
       assert_optional_string "#{key}.footer", value['footer']
       assert_optional_string "#{key}.group", value['group']
@@ -148,8 +122,10 @@ module Bashly
 
       assert_boolean "#{key}.private", value['private']
       assert_boolean "#{key}.default", value['default']
+      assert_expose "#{key}.expose", value['expose']
       assert_version "#{key}.version", value['version']
       assert_catch_all "#{key}.catch_all", value['catch_all']
+      assert_string_or_array "#{key}.alias", value['alias']
       assert_extensible "#{key}.extensible", value['extensible']
       
       assert_array "#{key}.args", value['args'], of: :arg
@@ -161,20 +137,35 @@ module Bashly
       assert_array "#{key}.environment_variables", value['environment_variables'], of: :env_var
       assert_array "#{key}.examples", value['examples'], of: :string
 
+      assert_uniq "#{key}.commands", value['commands'], ['name', 'alias']
+      assert_uniq "#{key}.flags", value['flags'], 'long'
+      assert_uniq "#{key}.flags", value['flags'], 'short'
+      assert_uniq "#{key}.args", value['args'], 'name'
+
       if value['catch_all'] and value['args']
         repeatable_arg = value['args'].select { |a| a['repeatable'] }.first&.dig 'name'
         refute repeatable_arg, "#{key}.catch_all makes no sense with repeatable arg (#{repeatable_arg})"
       end
 
+      if value['expose']
+        assert value['commands'], "#{key}.expose makes no sense without commands"
+      end
+
       if key == "root"
-        refute value['short'], "#{key}.short makes no sense"
+        refute value['alias'], "#{key}.alias makes no sense"
         refute value['group'], "#{key}.group makes no sense"
         refute value['default'], "#{key}.default makes no sense"
         refute value['private'], "#{key}.private makes no sense"
+        refute value['expose'], "#{key}.expose makes no sense"
       else
         refute value['version'], "#{key}.version makes no sense"
         refute value['extensible'], "#{key}.extensible makes no sense"
       end
+
+      # DEPRECATION 0.8.0
+      if value['short']
+        deprecate "#{key}.short", replacement: "alias", reference: "https://github.com/DannyBen/bashly/pull/220"
+      end
     end
   end
 end

data/lib/bashly/deprecation.rb

@@ -0,0 +1,25 @@
+module Bashly
+  class Deprecation
+    attr_reader :old, :replacement, :reference
+
+    def initialize(old, replacement: nil, reference: nil)
+      @old, @replacement, @reference = old, replacement, reference
+    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.map { |line| "!txtred!▐!txtrst! #{line}"}.join("\n")
+    end
+
+    def to_h
+      {
+        old: old,
+        replacement: replacement,
+        reference: reference
+      }
+    end
+  end
+end

data/lib/bashly/extensions/array.rb

@@ -4,4 +4,9 @@ class Array
     indentation = " " * offset
     map { |line| "#{indentation}#{line}" }
   end
+
+  def nonuniq
+    tally.select { |key, count| count > 1 }.keys
+  end
+
 end

data/lib/bashly/script/command.rb

@@ -1,21 +1,25 @@
 module Bashly
   module Script
     class Command < Base
-      include Completions
-      include CommandScopes
+      include Completions::Command
 
       class << self
         def option_keys
           @option_keys ||= %i[
-            args catch_all commands completions
+            alias args catch_all commands completions
             default dependencies environment_variables examples
-            extensible filename filters flags
+            extensible expose filename filters flags
             footer group help name
-            private short version
+            private version
+            short
           ]
+          # DEPRECATION 0.8.0
         end
       end
 
+      attr_accessor :parent_command
+      attr_writer :parents
+
       # Returns the name to be used as an action.
       # - If it is the root command, the action is "root"
       # - Else, it is all the parents, except the first one (root) joined
@@ -27,7 +31,25 @@ module Bashly
 
       # Returns all the possible aliases for this command
       def aliases
-        short ? [name, short] : [name]
+        [name] + alt
+      end
+
+      # Returns an array of all full names (including aliases and aliases of
+      # parents)
+      def all_full_names
+        if parent_command
+          parent_command.all_full_names.product(aliases).map { |a| a.join ' ' }
+        else
+          aliases
+        end
+      end
+
+      # Returns an array of alternative aliases if any
+      def alt
+        # DEPRECATION 0.8.0
+        options['alias'] ||= options['short']
+        return [] unless options["alias"]
+        options['alias'].is_a?(String) ? [options['alias']] : options['alias']
       end
 
       # Returns an array of Arguments
@@ -47,15 +69,81 @@ module Bashly
         @catch_all ||= CatchAll.from_config options['catch_all']
       end
 
+      # Returns a full list of the Command names and aliases combined
+      def command_aliases
+        commands.map(&:aliases).flatten
+      end
+
+      # Returns a data structure for displaying subcommands help
+      def command_help_data
+        result = {}
+
+        public_commands.each do |command|
+          result[command.group_string] ||= {}
+          result[command.group_string][command.name] = { summary: command.summary_string }
+          next unless command.expose
+
+          command.public_commands.each do |subcommand|
+            result[command.group_string]["#{command.name} #{subcommand.name}"] = {
+              summary: subcommand.summary_string,
+              help_only: command.expose != 'always'
+            }
+          end
+        end
+
+        result
+      end
+
+      # Returns only the names of the Commands
+      def command_names
+        commands.map &:name
+      end
+
       # Returns an array of the Commands
       def commands
         return [] unless options["commands"]
         options["commands"].map do |options|
-          options['parents'] = parents + [name]
-          Command.new options
+          result = Command.new options
+          result.parents = parents + [name]
+          result.parent_command = self
+          result
         end
       end
 
+      # Returns a flat array containing all the commands in this tree.
+      # This includes self + children + grandchildres + ...
+      def deep_commands
+        result = []
+        commands.each do |command|
+          result << command
+          if command.commands.any?
+            result += command.deep_commands
+          end
+        end
+        result
+      end
+
+      # If any of this command's subcommands has the default option set to
+      # true, this default command will be returned, nil otherwise.
+      def default_command
+        commands.find { |c| c.default }
+      end
+
+      # Returns an array of all the default Args
+      def default_args
+        args.select &:default
+      end
+
+      # Returns an array of all the default Environment Variables
+      def default_environment_variables
+        environment_variables.select &:default
+      end
+
+      # Returns an array of all the default Flags
+      def default_flags
+        flags.select &:default
+      end
+
       # Returns an array of EnvironmentVariables
       def environment_variables
         return [] unless options["environment_variables"]
@@ -89,27 +177,24 @@ module Bashly
         parents.any? ? (parents + [name]).join(' ') : name
       end
 
-      # Reads a file from the userspace (Settings.source_dir) and returns
-      # its contents. 
-      # If the file is not found, returns a string with a hint.
-      def load_user_file(file, placeholder: true)
-        path = "#{Settings.source_dir}/#{file}"
-
-        content = if File.exist? path
-          File.read(path).remove_front_matter
-        elsif placeholder
-          %q[echo "error: cannot load file"]
+      # Returns the string for the group caption
+      def group_string
+        if group
+          strings[:group] % { group: group } 
         else
-          ''
+          strings[:commands]
         end
-
-        Settings.production? ? content : "#{view_marker path}\n#{content}"
       end
 
       # Returns an array of all parents. For example, the command 
       # "docker container run" will have [docker, container] as its parents
       def parents
-        options['parents'] || []
+        @parents ||= []
+      end
+
+      # Returns only commands that are not private
+      def public_commands
+        commands.reject &:private
       end
 
       # Returns true if one of the args is repeatable
@@ -117,6 +202,21 @@ module Bashly
         args.select(&:repeatable).any?
       end
 
+      # Returns an array of all the required Arguments
+      def required_args
+        args.select &:required
+      end
+
+      # Returns an array of all the required EnvironmentVariables
+      def required_environment_variables
+        environment_variables.select &:required
+      end
+
+      # Returns an array of all the required Flags
+      def required_flags
+        flags.select &:required
+      end
+
       # Returns true if this is the root command (no parents)
       def root_command?
         parents.empty?
@@ -127,6 +227,15 @@ module Bashly
         flags.select { |f| f.short == flag }.any?
       end
 
+      # Returns the summary string
+      def summary_string
+        if default
+          strings[:default_command_summary] % { summary: summary }
+        else
+          summary
+        end
+      end
+
       # Returns a constructed string suitable for Usage pattern
       def usage_string
         result = [full_name]
@@ -146,6 +255,15 @@ module Bashly
         @user_lib ||= Dir["#{Settings.full_lib_dir}/**/*.sh"].sort
       end
 
+      # Returns an array of all the args with a whitelist
+      def whitelisted_args
+        args.select &:allowed
+      end
+
+      # Returns an array of all the flags with a whitelist arg
+      def whitelisted_flags
+        flags.select &:allowed
+      end
     end
   end
 end

data/lib/bashly/script/flag.rb

@@ -1,11 +1,13 @@
 module Bashly
   module Script
     class Flag < Base
+      include Completions::Flag
+
       class << self
         def option_keys
           @option_keys ||= %i[
-            allowed arg conflicts default help long repeatable required
-            short validate
+            allowed arg completions conflicts default help long repeatable
+            required short validate
           ]
         end
       end

data/lib/bashly/templates/bashly.yml

@@ -8,7 +8,7 @@ environment_variables:
 
 commands:
 - name: download
-  short: d
+  alias: d
   help: Download a file
 
   args:
@@ -32,7 +32,7 @@ commands:
     help: Set the default location to download to
 
 - name: upload
-  short: u
+  alias: u
   help: Upload a file
   args:
   - name: source

data/lib/bashly/templates/strings.yml

@@ -11,7 +11,7 @@ environment_variables: "Environment Variables:"
 group: "%{group} Commands:"
 
 # Usage helpers
-command_shortcut: "Shortcut: %{short}"
+command_alias: "Alias: %{alias}"
 default_command_summary: "%{summary} (default)"
 required: "(required)"
 repeatable: "(repeatable)"

data/lib/bashly/version.rb

@@ -1,3 +1,3 @@
 module Bashly
-  VERSION = "0.7.10"
+  VERSION = "0.8.2"
 end

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

@@ -15,8 +15,8 @@
     echo 
   fi
 
-  <%- if short -%>
-  printf "<%= strings[:command_shortcut] % { short: short } %>\n"
+  <%- if alt&.any? -%>
+  printf "<%= strings[:command_alias] % { alias: alt.join(', ') } %>\n"
   echo
   <%- end -%>
 

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

@@ -1,18 +1,13 @@
 <%= view_marker %>
-% unless commands.first.group
-printf "<%= strings[:commands] %>\n"
-% end
-% maxlen = command_names.map(&:size).max
-% commands.reject(&:private).each do |command|
-% summary = command.summary
-% summary = strings[:default_command_summary] % { summary: summary } if command.default
-% if command.group
-% if command.name == commands.first.name
-printf "<%= strings[:group] % { group: command.group } %>\n"
+% maxlen = command_help_data.values.map(&:keys).flatten.map(&:size).max
+% command_help_data.each do |group, commands|
+printf "<%= group %>\n"
+% commands.each do |command, info|
+% if info[:help_only]
+[[ -n $long_usage ]] && echo "  <%= command.ljust maxlen %>   <%= info[:summary] %>"
 % else
-printf "\n<%= strings[:group] % { group: command.group } %>\n"
-% end
+echo "  <%= command.ljust maxlen %>   <%= info[:summary] %>"
 % end
-echo "  <%= command.name.ljust maxlen %>   <%= summary %>"
 % end
 echo
+% end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bashly
 version: !ruby/object:Gem::Version
-  version: 0.7.10
+  version: 0.8.2
 platform: ruby
 authors:
 - Danny Ben Shitrit
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-04-29 00:00:00.000000000 Z
+date: 2022-06-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colsole
@@ -16,28 +16,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.6'
+        version: '0.7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.6'
+        version: '0.7'
 - !ruby/object:Gem::Dependency
   name: completely
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.3'
+        version: 0.4.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.3'
+        version: 0.4.2
 - !ruby/object:Gem::Dependency
   name: mister_bin
   requirement: !ruby/object:Gem::Requirement
@@ -58,14 +58,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: '0.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+- !ruby/object:Gem::Dependency
+  name: filewatcher
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: '1.1'
 description: Generate bash command line tools using YAML configuration
 email: db@dannyben.com
 executables:
@@ -84,11 +98,12 @@ files:
 - lib/bashly/commands/preview.rb
 - lib/bashly/commands/validate.rb
 - lib/bashly/concerns/asset_helper.rb
-- lib/bashly/concerns/command_scopes.rb
 - lib/bashly/concerns/completions.rb
 - lib/bashly/concerns/renderable.rb
+- lib/bashly/concerns/validation_helpers.rb
 - lib/bashly/config.rb
 - lib/bashly/config_validator.rb
+- lib/bashly/deprecation.rb
 - lib/bashly/exceptions.rb
 - lib/bashly/extensions/array.rb
 - lib/bashly/extensions/file.rb
@@ -198,7 +213,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.3
+rubygems_version: 3.3.14
 signing_key: 
 specification_version: 4
 summary: Bash Command Line Tool Generator

data/lib/bashly/concerns/command_scopes.rb

@@ -1,68 +0,0 @@
-module Bashly
-  # This is a `Command` concern responsible for providing additional scopes.
-  module CommandScopes
-    # Returns only the names of the Commands
-    def command_names
-      commands.map &:name
-    end
-
-    # Returns a flat array containing all the commands in this tree.
-    # This includes self + children + grandchildres + ...
-    def deep_commands
-      result = []
-      commands.each do |command|
-        result << command
-        if command.commands.any?
-          result += command.deep_commands
-        end
-      end
-      result
-    end
-
-    # If any of this command's subcommands has the default option set to
-    # true, this default command will be returned, nil otherwise.
-    def default_command
-      commands.find { |c| c.default }
-    end
-
-    # Returns an array of all the default Args
-    def default_args
-      args.select &:default
-    end
-
-    # Returns an array of all the default Environment Variables
-    def default_environment_variables
-      environment_variables.select &:default
-    end
-
-    # Returns an array of all the default Flags
-    def default_flags
-      flags.select &:default
-    end
-
-    # Returns an array of all the required Arguments
-    def required_args
-      args.select &:required
-    end
-
-    # Returns an array of all the required EnvironmentVariables
-    def required_environment_variables
-      environment_variables.select &:required
-    end
-
-    # Returns an array of all the required Flags
-    def required_flags
-      flags.select &:required
-    end
-
-    # Returns an array of all the args with a whitelist
-    def whitelisted_args
-      args.select &:allowed
-    end
-
-    # Returns an array of all the flags with a whitelist arg
-    def whitelisted_flags
-      flags.select &:allowed
-    end
-  end
-end