- Add suport for auto-organizing command files in subfolders

Author: DannyBen

lib/bashly/extensions/string.rb

@@ -12,6 +12,10 @@ def indent(offset)
   def to_underscore
     gsub(/(.)([A-Z])/, '\1_\2').gsub(/[- ]/, '_').downcase
   end
+  
+  def to_path
+    gsub(/ /, '/').downcase
+  end
 
   def wrap(length = 80)
     strip!

lib/bashly/libraries/settings/settings.yml

@@ -18,9 +18,15 @@ config_path: "%{source_dir}/bashly.yml"
 # The path to use for creating the bash script
 target_dir: .
 
-# The path to use for common library files, relative to the source dir
+# The path to use for common library files, relative to source_dir
 lib_dir: lib
 
+# The path to use for command files, relative to source_dir
+# When set to nil (~), command files will be placed directly under source_dir
+# When set to any other string, command files will be placed under this
+# directory, and each command will get its own subdirectory
+commands_dir: ~
+
 # Configure the bash options that will be added to the initialize function:
 # strict: true       Bash strict mode (set -euo pipefail)
 # strict: false      Only exit on errors (set -e)

lib/bashly/script/command.rb

@@ -159,10 +159,10 @@ def examples
         options['examples'].is_a?(Array) ? options['examples'] : [options['examples']]
       end
 
-      # Returns the bash filename that is expected to hold the user code
-      # for this command
+      # Returns the filename that is expected to hold the user code for this
+      # command
       def filename
-        options['filename'] || "#{action_name.to_underscore}_command.#{Settings.partials_extension}"
+        options['filename'] || implicit_filename
       end
 
       # Returns an array of Flags
@@ -314,6 +314,18 @@ def whitelisted_args
       def whitelisted_flags
         flags.select(&:allowed)
       end
+
+    private
+
+      # Returns either a flat filename (docker_status_command.sh) or a nested
+      # path (commands/docker/status.sh)
+      def implicit_filename
+        if Settings.commands_dir
+          "#{Settings.commands_dir}/#{action_name.to_path}.#{Settings.partials_extension}"
+        else
+          "#{action_name.to_underscore}_command.#{Settings.partials_extension}"
+        end
+      end
     end
   end
 end

lib/bashly/settings.rb

@@ -4,6 +4,7 @@ class << self
       include AssetHelper
 
       attr_writer(
+        :commands_dir,
         :compact_short_flags,
         :config_path,
         :lib_dir,
@@ -15,6 +16,10 @@ class << self
         :usage_colors
       )
 
+      def commands_dir
+        @commands_dir ||= get :commands_dir
+      end
+
       def compact_short_flags
         @compact_short_flags ||= get :compact_short_flags
       end